fhir_services

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

Overview

Name	fhir_services
Type	Resource
Id	azure_extras.health_data_services.fhir_services

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
acrConfiguration	object	Fhir Service Azure container registry configuration.
authenticationConfiguration	object	Fhir Service authentication configuration.
corsConfiguration	object	Fhir Service Cors configuration.
encryption	object	The encryption settings of the FHIR service.
etag	string	An etag associated with the resource, used for optimistic concurrency when editing it.
eventState	string	Fhir Service event support status. Known values are: "Disabled", "Enabled", and "Updating". (Disabled, Enabled, Updating)
exportConfiguration	object	Fhir Service export configuration.
identity	object	Setting indicating whether the service has a managed identity associated with it.
implementationGuidesConfiguration	object	Implementation Guides configuration.
importConfiguration	object	Fhir Service import configuration.
kind	string	The kind of the service. Known values are: "fhir-Stu3" and "fhir-R4". (fhir-Stu3, fhir-R4)
location	string	The common properties for any location based resource, tracked or proxy.
privateEndpointConnections	array	The list of private endpoint connections that are set up for this resource.
provisioningState	string	The provisioning state. Known values are: "Deleting", "Succeeded", "Creating", "Accepted", "Verifying", "Updating", "Failed", "Canceled", "Deprovisioned", "Moving", "Suspended", "Warned", and "SystemMaintenance". (Deleting, Succeeded, Creating, Accepted, Verifying, Updating, Failed, Canceled, Deprovisioned, Moving, Suspended, Warned, SystemMaintenance)
publicNetworkAccess	string	Control permission for data plane traffic coming from public networks while private endpoint is enabled. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
resourceVersionPolicyConfiguration	object	Determines tracking of history for resources.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	The common properties of tracked resources in the service.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_workspace

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
acrConfiguration	object	Fhir Service Azure container registry configuration.
authenticationConfiguration	object	Fhir Service authentication configuration.
corsConfiguration	object	Fhir Service Cors configuration.
encryption	object	The encryption settings of the FHIR service.
etag	string	An etag associated with the resource, used for optimistic concurrency when editing it.
eventState	string	Fhir Service event support status. Known values are: "Disabled", "Enabled", and "Updating". (Disabled, Enabled, Updating)
exportConfiguration	object	Fhir Service export configuration.
identity	object	Setting indicating whether the service has a managed identity associated with it.
implementationGuidesConfiguration	object	Implementation Guides configuration.
importConfiguration	object	Fhir Service import configuration.
kind	string	The kind of the service. Known values are: "fhir-Stu3" and "fhir-R4". (fhir-Stu3, fhir-R4)
location	string	The common properties for any location based resource, tracked or proxy.
privateEndpointConnections	array	The list of private endpoint connections that are set up for this resource.
provisioningState	string	The provisioning state. Known values are: "Deleting", "Succeeded", "Creating", "Accepted", "Verifying", "Updating", "Failed", "Canceled", "Deprovisioned", "Moving", "Suspended", "Warned", and "SystemMaintenance". (Deleting, Succeeded, Creating, Accepted, Verifying, Updating, Failed, Canceled, Deprovisioned, Moving, Suspended, Warned, SystemMaintenance)
publicNetworkAccess	string	Control permission for data plane traffic coming from public networks while private endpoint is enabled. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
resourceVersionPolicyConfiguration	object	Determines tracking of history for resources.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	The common properties of tracked resources in the service.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, fhir_service_name, subscription_id		Gets the properties of the specified FHIR Service.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		Lists all FHIR Services for the given workspace.
create_or_update	insert	resource_group_name, workspace_name, fhir_service_name, subscription_id		Creates or updates a FHIR Service resource with the specified parameters.
update	update	resource_group_name, fhir_service_name, workspace_name, subscription_id		Patch FHIR Service details.
create_or_update	replace	resource_group_name, workspace_name, fhir_service_name, subscription_id		Creates or updates a FHIR Service resource with the specified parameters.
delete	delete	resource_group_name, fhir_service_name, workspace_name, subscription_id		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
fhir_service_name	string	The name of FHIR Service resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of workspace resource. Required.

SELECT examples

get

Gets the properties of the specified FHIR Service.

SELECT
id,
name,
acrConfiguration,
authenticationConfiguration,
corsConfiguration,
encryption,
etag,
eventState,
exportConfiguration,
identity,
implementationGuidesConfiguration,
importConfiguration,
kind,
location,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
resourceVersionPolicyConfiguration,
systemData,
tags,
type
FROM azure_extras.health_data_services.fhir_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND fhir_service_name = '{{ fhir_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workspace

Lists all FHIR Services for the given workspace.

SELECT
id,
name,
acrConfiguration,
authenticationConfiguration,
corsConfiguration,
encryption,
etag,
eventState,
exportConfiguration,
identity,
implementationGuidesConfiguration,
importConfiguration,
kind,
location,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
resourceVersionPolicyConfiguration,
systemData,
tags,
type
FROM azure_extras.health_data_services.fhir_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure_extras.health_data_services.fhir_services (
properties,
tags,
location,
etag,
identity,
kind,
resource_group_name,
workspace_name,
fhir_service_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ etag }}',
'{{ identity }}',
'{{ kind }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ fhir_service_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: fhir_services
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the fhir_services resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the fhir_services resource.
  - name: fhir_service_name
    value: "{{ fhir_service_name }}"
    description: Required parameter for the fhir_services resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the fhir_services resource.
  - name: properties
    description: |
      Fhir Service configuration.
    value:
      provisioningState: "{{ provisioningState }}"
      acrConfiguration:
        loginServers:
          - "{{ loginServers }}"
        ociArtifacts:
          - loginServer: "{{ loginServer }}"
            imageName: "{{ imageName }}"
            digest: "{{ digest }}"
      authenticationConfiguration:
        authority: "{{ authority }}"
        audience: "{{ audience }}"
        smartProxyEnabled: {{ smartProxyEnabled }}
        smartIdentityProviders:
          - authority: "{{ authority }}"
            applications: "{{ applications }}"
      corsConfiguration:
        origins:
          - "{{ origins }}"
        headers:
          - "{{ headers }}"
        methods:
          - "{{ methods }}"
        maxAge: {{ maxAge }}
        allowCredentials: {{ allowCredentials }}
      exportConfiguration:
        storageAccountName: "{{ storageAccountName }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      eventState: "{{ eventState }}"
      resourceVersionPolicyConfiguration:
        default: "{{ default }}"
        resourceTypeOverrides: "{{ resourceTypeOverrides }}"
      importConfiguration:
        integrationDataStore: "{{ integrationDataStore }}"
        initialImportMode: {{ initialImportMode }}
        enabled: {{ enabled }}
      implementationGuidesConfiguration:
        usCoreMissingData: {{ usCoreMissingData }}
      encryption:
        customerManagedKeyEncryption:
          keyEncryptionKeyUrl: "{{ keyEncryptionKeyUrl }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      The common properties of tracked resources in the service.
  - name: location
    value: "{{ location }}"
    description: |
      The common properties for any location based resource, tracked or proxy.
  - name: etag
    value: "{{ etag }}"
    description: |
      An etag associated with the resource, used for optimistic concurrency when editing it.
  - name: identity
    description: |
      Setting indicating whether the service has a managed identity associated with it.
    value:
      type: "{{ type }}"
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      The kind of the service. Known values are: "fhir-Stu3" and "fhir-R4".
    valid_values: ['fhir-Stu3', 'fhir-R4']

UPDATE examples

update

Patch FHIR Service details.

UPDATE azure_extras.health_data_services.fhir_services
SET 
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND fhir_service_name = '{{ fhir_service_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

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

REPLACE azure_extras.health_data_services.fhir_services
SET 
properties = '{{ properties }}',
tags = '{{ tags }}',
location = '{{ location }}',
etag = '{{ etag }}',
identity = '{{ identity }}',
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND fhir_service_name = '{{ fhir_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a FHIR Service.

DELETE FROM azure_extras.health_data_services.fhir_services
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND fhir_service_name = '{{ fhir_service_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;