Azure Health Data Services as an Event Grid source
This article provides the properties and schema for Azure Health Data Services events. For an introduction to event schemas, see Azure Event Grid event schema.
Available event types
List of events for Azure Health Data Services REST APIs
The following Fast Healthcare Interoperability Resources (FHIR®) resource events are triggered when calling the REST APIs.
Event name | Description |
---|---|
FhirResourceCreated | The event emitted after a FHIR resource gets created successfully. |
FhirResourceUpdated | The event emitted after a FHIR resource gets updated successfully. |
FhirResourceDeleted | The event emitted after a FHIR resource gets soft deleted successfully. |
These events are triggered when a DICOM image is created or deleted by calling the DICOM service REST APIs.
Event name | Description |
---|---|
DicomImageCreated | The event emitted after a DICOM image gets created successfully. |
DicomImageDeleted | The event emitted after a DICOM image gets deleted successfully. |
Example events
This section contains examples of what events message data would look like for each FHIR resource and DICOM image event.
Note
Events data looks similar to these examples with the metadataVersion
property set to a value of 1
.
For more information, see Azure Event Grid event schema properties.
FhirResourceCreated event
{
"id": "e4c7f556-d72c-e7f7-1069-1e82ac76ab41",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
"subject": "{fhir-account}.fhir.azurehealthcareapis.com/Patient/e0a1f743-1a70-451f-830e-e96477163902",
"data": {
"resourceType": "Patient",
"resourceFhirAccount": "{fhir-account}.fhir.azurehealthcareapis.com",
"resourceFhirId": "e0a1f743-1a70-451f-830e-e96477163902",
"resourceVersionId": 1
},
"eventType": "Microsoft.HealthcareApis.FhirResourceCreated",
"dataVersion": "1",
"metadataVersion": "1",
"eventTime": "2021-09-08T01:14:04.5613214Z"
}
FhirResourceUpdated event
{
"id": "634bd421-8467-f23c-b8cb-f6a31e41c32a",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
"subject": "{fhir-account}.fhir.azurehealthcareapis.com/Patient/e0a1f743-1a70-451f-830e-e96477163902",
"data": {
"resourceType": "Patient",
"resourceFhirAccount": "{fhir-account}.fhir.azurehealthcareapis.com",
"resourceFhirId": "e0a1f743-1a70-451f-830e-e96477163902",
"resourceVersionId": 2
},
"eventType": "Microsoft.HealthcareApis.FhirResourceUpdated",
"dataVersion": "2",
"metadataVersion": "1",
"eventTime": "2021-09-08T01:29:12.0618739Z"
}
FhirResourceDeleted event
{
"id": "ef289b93-3159-b833-3a44-dc6b86ed1a8a",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
"subject": "{fhir-account}.fhir.azurehealthcareapis.com/Patient/e0a1f743-1a70-451f-830e-e96477163902",
"data": {
"resourceType": "Patient",
"resourceFhirAccount": "{fhir-account}.fhir.azurehealthcareapis.com",
"resourceFhirId": "e0a1f743-1a70-451f-830e-e96477163902",
"resourceVersionId": 3
},
"eventType": "Microsoft.HealthcareApis.FhirResourceDeleted",
"dataVersion": "3",
"metadataVersion": "1",
"eventTime": "2021-09-08T01:31:58.5175837Z"
}
DicomImageCreated
{
"id": "d621839d-958b-4142-a638-bb966b4f7dfd",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
"subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
"data": {
"imageStudyInstanceUid": "1.2.3.4.3",
"imageSeriesInstanceUid": "1.2.3.4.3.9423673",
"imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
"serviceHostName": "{dicom-account}.dicom.azurehealthcareapis.com",
"sequenceNumber": 1
},
"eventType": "Microsoft.HealthcareApis.DicomImageCreated",
"dataVersion": "1",
"metadataVersion": "1",
"eventTime": "2022-09-15T01:14:04.5613214Z"
}
DicomImageDeleted
{
"id": "eac1c1a0-ffa8-4b28-97cc-1d8b9a0a6021",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
"subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
"data": {
"imageStudyInstanceUid": "1.2.3.4.3",
"imageSeriesInstanceUid": "1.2.3.4.3.9423673",
"imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442",
"serviceHostName": "{dicom-account}.dicom.azurehealthcareapis.com",
"sequenceNumber": 2
},
"eventType": "Microsoft.HealthcareApis.DicomImageDeleted",
"dataVersion": "1",
"metadataVersion": "1",
"eventTime": "2022-09-15T01:16:07.5692209Z"
}
Next steps
See the following tutorial: Deploy Events using the Azure portal.
(FHIR®) is a registered trademark of HL7 and is used with the permission of HL7.
Feedback
Submit and view feedback for