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
These events are triggered when a Fast Healthcare Interoperability Resources (FHIR®) Observation is created, updated, or deleted by calling the FHIR service REST APIs.
Event name | Description |
---|---|
FhirResourceCreated | The event emitted after a FHIR Observation resource is created successfully. |
FhirResourceUpdated | The event emitted after a FHIR Observation resource is updated successfully. |
FhirResourceDeleted | The event emitted after a FHIR Observation resource is 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 is created successfully. |
DicomImageDeleted | The event emitted after a DICOM image is deleted successfully. |
DicomImageUpdated | The event emitted after a DICOM image is updated successfully. |
Example events
This section contains examples of what Azure Health Data Services Events message data would look like for each FHIR Observation 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": "d674b9b7-7d1c-9b0a-8c48-139f3eb86c48",
"source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
"specversion": "1.0",
"type": "Microsoft.HealthcareApis.FhirResourceCreated",
"dataschema": "#1",
"subject": "{fhir-account}.fhir.azurehealthcareapis.com/Patient/e87ef649-abe1-485c-8c09-549d85dfe30b",
"time": "2022-02-03T16:48:09.6223354Z",
"data": {
"resourceType": "Patient",
"resourceFhirAccount": "{fhir-account}.fhir.azurehealthcareapis.com",
"resourceFhirId": "e87ef649-abe1-485c-8c09-549d85dfe30b",
"resourceVersionId": 1
}
}
FhirResourceUpdated event
{
"id": "5e45229e-c663-ea98-72d2-833428f48ad0",
"source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
"specversion": "1.0",
"type": "Microsoft.HealthcareApis.FhirResourceUpdated",
"dataschema": "#2",
"subject": "{fhir-account}.fhir.azurehealthcareapis.com/Patient/e87ef649-abe1-485c-8c09-549d85dfe30b",
"time": "2022-02-03T16:48:33.5147352Z",
"data": {
"resourceType": "Patient",
"resourceFhirAccount": "{fhir-account}.fhir.azurehealthcareapis.com",
"resourceFhirId": "e87ef649-abe1-485c-8c09-549d85dfe30b",
"resourceVersionId": 2
}
}
FhirResourceDeleted event
{
"id": "14648a6e-d978-950e-ee9c-f84c70dba8d3",
"source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
"specversion": "1.0",
"type": "Microsoft.HealthcareApis.FhirResourceDeleted",
"dataschema": "#3",
"subject": "{fhir-account}.fhir.azurehealthcareapis.com/Patient/e87ef649-abe1-485c-8c09-549d85dfe30b",
"time": "2022-02-03T16:48:38.7338799Z",
"data": {
"resourceType": "Patient",
"resourceFhirAccount": "{fhir-account}.fhir.azurehealthcareapis.com",
"resourceFhirId": "e87ef649-abe1-485c-8c09-549d85dfe30b",
"resourceVersionId": 3
}
}
DicomImageCreated
{
"source": "/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",
"type": "Microsoft.HealthcareApis.DicomImageCreated",
"time": "2022-09-15T01:14:04.5613214Z",
"id": "d621839d-958b-4142-a638-bb966b4f7dfd",
"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
},
"specVersion": "1.0"
}
DicomImageDeleted
{
"source": "/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",
"type": "Microsoft.HealthcareApis.DicomImageDeleted",
"time": "2022-09-15T01:14:04.5613214Z",
"id": "eac1c1a0-ffa8-4b28-97cc-1d8b9a0a6021",
"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
},
"specVersion": "1.0"
}
DicomImageUpdated
{
"source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}",
"subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/partitions/Microsoft.Default/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",
"type": "Microsoft.HealthcareApis.DicomImageUpdated",
"time": "2022-09-15T01:14:04.5613214Z",
"id": "7e8aca04-e815-4387-82a8-9fcf15a3114b",
"data": {
"partitionName": "Microsoft.Default",
"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
},
"specversion": "1.0"
}
Next steps
- For an overview of the Azure Health Data Services Events feature, see What are Events?.
- To learn how to deploy the Azure Health Data Services Events feature in the Azure portal, see Deploy Events using the Azure portal.
FHIR® is a registered trademark of Health Level Seven International, registered in the U.S. Trademark Office and is used with their permission.