fhir_services

Creates, updates, deletes, gets or lists a fhir_services resource.

Overview

Name	fhir_services
Type	Resource
Id	azure_extras.healthcare.fhir_services

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
identity	object	Setting indicating whether the service has a managed identity associated with it.
kind	string	The kind of the service.
properties	object	Fhir Service configuration.
systemData	object	Metadata pertaining to creation and last modification of the resource.

list_by_workspace

List of FHIR Services.

Name	Datatype	Description
identity	object	Setting indicating whether the service has a managed identity associated with it.
kind	string	The kind of the service.
properties	object	Fhir Service configuration.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, subscriptionId, workspaceName, fhirServiceName		Gets the properties of the specified FHIR Service.
list_by_workspace	select	resourceGroupName, subscriptionId, workspaceName		Lists all FHIR Services for the given workspace
create_or_update	insert	resourceGroupName, subscriptionId, workspaceName, fhirServiceName		Creates or updates a FHIR Service resource with the specified parameters.
update	update	resourceGroupName, subscriptionId, fhirServiceName, workspaceName		Patch FHIR Service details.
delete	delete	subscriptionId, resourceGroupName, fhirServiceName, workspaceName		Deletes a FHIR Service.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
fhirServiceName	string	The name of FHIR Service resource.
resourceGroupName	string	The name of the resource group that contains the service instance.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of workspace resource.

SELECT examples

get

Gets the properties of the specified FHIR Service.

SELECT
identity,
kind,
properties,
systemData
FROM azure_extras.healthcare.fhir_services
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND fhirServiceName = '{{ fhirServiceName }}' -- required
;

list_by_workspace

Lists all FHIR Services for the given workspace

SELECT
identity,
kind,
properties,
systemData
FROM azure_extras.healthcare.fhir_services
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

INSERT examples

create_or_update

Creates or updates a FHIR Service resource with the specified parameters.

INSERT INTO azure_extras.healthcare.fhir_services (
data__identity,
data__kind,
data__properties,
resourceGroupName,
subscriptionId,
workspaceName,
fhirServiceName
)
SELECT 
'{{ identity }}',
'{{ kind }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ fhirServiceName }}'
RETURNING
identity,
kind,
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: fhir_services
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the fhir_services resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the fhir_services resource.
    - name: workspaceName
      value: string
      description: Required parameter for the fhir_services resource.
    - name: fhirServiceName
      value: string
      description: Required parameter for the fhir_services resource.
    - name: identity
      value: object
      description: |
        Setting indicating whether the service has a managed identity associated with it.
    - name: kind
      value: string
      description: |
        The kind of the service.
      valid_values: ['fhir-Stu3', 'fhir-R4']
    - name: properties
      value: object
      description: |
        Fhir Service configuration.

UPDATE examples

update

Patch FHIR Service details.

UPDATE azure_extras.healthcare.fhir_services
SET 
data__tags = '{{ tags }}',
data__identity = '{{ identity }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND fhirServiceName = '{{ fhirServiceName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
RETURNING
identity,
kind,
properties,
systemData;

DELETE examples

delete

Deletes a FHIR Service.

DELETE FROM azure_extras.healthcare.fhir_services
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND fhirServiceName = '{{ fhirServiceName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
;