Skip to main content

fhir_destinations

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

Overview

Namefhir_destinations
TypeResource
Idazure_extras.health_data_services.fhir_destinations

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
etagstringAn etag associated with the resource, used for optimistic concurrency when editing it.
fhirMappingobjectFHIR Mappings. Required.
fhirServiceResourceIdstringFully qualified resource id of the FHIR service to connect to. Required.
locationstringThe resource location.
provisioningStatestringThe 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)
resourceIdentityResolutionTypestringDetermines how resource identity is resolved on the destination. Required. Known values are: "Create" and "Lookup". (Create, Lookup)
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_by_iot_connectorselectresource_group_name, workspace_name, iot_connector_name, subscription_idLists all FHIR destinations for the given IoT Connector.

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.

NameDatatypeDescription
iot_connector_namestringThe name of IoT Connector resource. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring
workspace_namestringThe name of workspace resource. Required.

SELECT examples

Lists all FHIR destinations for the given IoT Connector.

SELECT
id,
name,
etag,
fhirMapping,
fhirServiceResourceId,
location,
provisioningState,
resourceIdentityResolutionType,
systemData,
type
FROM azure_extras.health_data_services.fhir_destinations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND iot_connector_name = '{{ iot_connector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;