This page is part of the FHIR Specification (v4.3.0-snapshot1: Release 4B Snapshot #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
. Page versions: R5 R4B
| FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
Raw JSON (canonical form + also see JSON Format Specification)
Example of a notification wrapped in FHIR Messaging
{
"resourceType": "Bundle",
"id": "0f322dbe-4f8d-4cbd-9ecb-bc8dc6f65f6a",
"type": "message",
"timestamp": "2020-04-17T10:24:13.1882432-05:00",
"entry": [
{
"fullUrl": "urn:uuid:801728e4-75e9-42e6-b6d0-0cc3e835a70d",
"resource": {
"resourceType": "MessageHeader",
"id": "801728e4-75e9-42e6-b6d0-0cc3e835a70d",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><div><p>Resource "801728e4-75e9-42e6-b6d0-0cc3e835a70d" </p></div><p><b>event</b>: subscription-notification (Details: http://example.org/fhir/message-events code subscription-notification = 'subscription-notification', stated as 'null')</p><h3>Sources</h3><table><tr><td>-</td><td><b>Endpoint</b></td></tr><tr><td>*</td><td><a>http://example.org/FHIR/R4</a></td></tr></table><p><b>focus</b>: <a>urn:uuid:c13b0b59-525c-4e41-b874-b5b87538a5b7</a></p></div>"
},
"eventCoding": {
"system": "http://example.org/fhir/message-events",
"code": "subscription-notification"
},
"source": {
"endpoint": "http://example.org/FHIR/R4"
},
"focus": [
{
"reference": "urn:uuid:c13b0b59-525c-4e41-b874-b5b87538a5b7"
}
]
}
},
{
"fullUrl": "urn:uuid:c13b0b59-525c-4e41-b874-b5b87538a5b7",
"resource": {
"resourceType": "Bundle",
"id": "c13b0b59-525c-4e41-b874-b5b87538a5b7",
"type": "history",
"timestamp": "2020-04-17T10:24:13.1882432-05:00",
"entry": [
{
"fullUrl": "urn:uuid:bef7e5fb-b5ad-4b59-a618-1bace2bbf5c0",
"resource": {
"resourceType": "SubscriptionStatus",
"id": "bef7e5fb-b5ad-4b59-a618-1bace2bbf5c0",
"status": "active",
"type": "event-notification",
"eventsSinceSubscriptionStart": "2",
"eventsInNotification": 1,
"notificationEvent": [
{
"eventNumber": "2",
"focus": {
"reference": "http://example.org/FHIR/R4/Encounter/2"
}
}
],
"subscription": {
"reference": "http://example.org/FHIR/R4/Subscription/123"
},
"topic": "http://example.org/FHIR/R4/SubscriptionTopic/admission"
},
"request": {
"method": "GET",
"url": "Subscription/123/$status"
},
"response": {
"status": "200"
}
},
{
"fullUrl": "https://example.org/FHIR/R4/Encounter/2",
"resource": {
"resourceType": "Encounter",
"id": "2",
"meta": {
"versionId": "1",
"lastUpdated": "2019-08-07T10:49:22Z"
},
"status": "in-progress",
"class": {
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "VR",
"display": "virtual"
},
"subject": {
"reference": "Patient/123"
}
},
"request": {
"method": "PUT",
"url": "Encounter/2"
},
"response": {
"status": "201"
}
}
]
}
}
]
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.