This page is part of the FHIR Specification (v4.3.0: R4B - STU). 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 Subscription notification with payload: full-resource that includes a referenced Patient
{ "resourceType": "Bundle", "id": "fdd78223-f79f-43b4-8979-ad49d4ac248c", "type": "history", "timestamp": "2020-04-17T10:24:13.1882432-05:00", "entry": [ { "fullUrl": "urn:uuid:641244a4-7c34-44e9-8df3-0a04c6ba5fa7", "resource": { "resourceType": "SubscriptionStatus", "id": "641244a4-7c34-44e9-8df3-0a04c6ba5fa7", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource "641244a4-7c34-44e9-8df3-0a04c6ba5fa7" </p></div><p><b>status</b>: active</p><p><b>type</b>: event-notification</p><p><b>eventsSinceSubscriptionStart</b>: 2</p><h3>NotificationEvents</h3><table class=\"grid\"><tr><td>-</td><td><b>EventNumber</b></td><td><b>Focus</b></td><td><b>AdditionalContext</b></td></tr><tr><td>*</td><td>2</td><td><a href=\"todo.html\">http://example.org/FHIR/R4B/Encounter/2</a></td><td><a href=\"todo.html\">http://example.org/FHIR/R4B/Patient/ABC</a></td></tr></table><p><b>subscription</b>: <a href=\"todo.html\">http://example.org/FHIR/R4B/Subscription/123</a></p><p><b>topic</b>: <a href=\"http://example.org/FHIR/R4B/SubscriptionTopic/admission\">http://example.org/FHIR/R4B/SubscriptionTopic/admission</a></p></div>" }, "status": "active", "type": "event-notification", "eventsSinceSubscriptionStart": "2", "notificationEvent": [ { "eventNumber": "2", "focus": { "reference": "http://example.org/FHIR/R4B/Encounter/2" }, "additionalContext": [ { "reference": "http://example.org/FHIR/R4B/Patient/ABC" } ] } ], "subscription": { "reference": "http://example.org/FHIR/R4B/Subscription/123" }, "topic": "http://example.org/FHIR/R4B/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" }, "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource "2" Version "1" Updated "2019-08-07T10:49:22Z" </p></div><p><b>status</b>: in-progress</p><p><b>class</b>: virtual (Details: http://terminology.hl7.org/CodeSystem/v3-ActCode code VR = 'virtual', stated as 'virtual')</p><p><b>subject</b>: <a href=\"todo.html\">Patient/123</a></p></div>" }, "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" } }, { "fullUrl": "https://example.org/FHIR/R4/Patient/ABC", "resource": { "resourceType": "Patient", "id": "ABC", "meta": { "versionId": "1", "lastUpdated": "2019-08-07T10:49:22Z" }, "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Patient Example (OFFICIAL)</b> (no stated gender), DoB Unknown</p></div>" }, "name": [ { "use": "official", "family": "Example", "given": [ "Patient" ] } ] }, "request": { "method": "GET", "url": "Patient/ABC" }, "response": { "status": "200" } } ] }
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.