Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Example SubscriptionStatus/787e69f6-81a8-44e4-b404-257013dec332 (JSON)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

Raw JSON (canonical form + also see JSON Format Specification)

Subscription Query-Event Bundle (query for sent or missed events)

{
  "resourceType": "Bundle",
  "id": "787e69f6-81a8-44e4-b404-257013dec332",
  "type": "subscription-notification",
  "timestamp": "2020-04-17T10:24:13.1882432-05:00",
  "entry": [
    {
      "fullUrl": "urn:uuid:63c7e4fb-0a83-4cd9-9f42-cdcf7d5cd3ed",
      "resource": {
        "resourceType": "SubscriptionStatus",
        "id": "815477f2-a94c-4197-a82a-9f974155debc",
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: SubscriptionStatus</b><a name=\"815477f2-a94c-4197-a82a-9f974155debc\"> </a></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 SubscriptionStatus &quot;815477f2-a94c-4197-a82a-9f974155debc&quot; </p></div><p><b>status</b>: active</p><p><b>type</b>: query-event</p><p><b>eventsSinceSubscriptionStart</b>: 310</p><blockquote><p><b>notificationEvent</b></p><p><b>eventNumber</b>: 307</p><p><b>focus</b>: <a href=\"todo.html\">http://example.org/FHIR/R5/Encounter/307</a></p><p><b>additionalContext</b>: <a href=\"todo.html\">http://example.org/FHIR/R5/Patient/ABC</a></p></blockquote><blockquote><p><b>notificationEvent</b></p><p><b>eventNumber</b>: 308</p><p><b>focus</b>: <a href=\"todo.html\">http://example.org/FHIR/R5/Encounter/308</a></p><p><b>additionalContext</b>: <a href=\"todo.html\">http://example.org/FHIR/R5/Patient/ABC</a></p></blockquote><p><b>subscription</b>: <a href=\"todo.html\">http://example.org/FHIR/R5/Subscription/123</a></p><p><b>topic</b>: <a href=\"http://example.org/FHIR/R5/SubscriptionTopic/admission\">http://example.org/FHIR/R5/SubscriptionTopic/admission</a></p></div>"
        },
        "status": "active",
        "type": "query-event",
        "eventsSinceSubscriptionStart": "310",
        "notificationEvent": [
          {
            "eventNumber": "307",
            "focus": {
              "reference": "http://example.org/FHIR/R5/Encounter/307"
            },
            "additionalContext": [
              {
                "reference": "http://example.org/FHIR/R5/Patient/ABC"
              }
            ]
          },
          {
            "eventNumber": "308",
            "focus": {
              "reference": "http://example.org/FHIR/R5/Encounter/308"
            },
            "additionalContext": [
              {
                "reference": "http://example.org/FHIR/R5/Patient/ABC"
              }
            ]
          }
        ],
        "subscription": {
          "reference": "http://example.org/FHIR/R5/Subscription/123"
        },
        "topic": "http://example.org/FHIR/R5/SubscriptionTopic/admission"
      }
    },
    {
      "fullUrl": "https://example.org/FHIR/R5/Encounter/307",
      "resource": {
        "resourceType": "Encounter",
        "id": "307",
        "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: Encounter</b><a name=\"307\"> </a></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 Encounter &quot;307&quot; Version &quot;1&quot; Updated &quot;2019-08-07T10:49:22Z&quot; </p></div><p><b>status</b>: in-progress</p><p><b>class</b>: virtual <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/3.1.0/CodeSystem-v3-ActCode.html\">ActCode</a>#VR)</span></p><p><b>subject</b>: <a href=\"todo.html\">Patient/ABC</a></p></div>"
        },
        "status": "in-progress",
        "class": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                "code": "VR",
                "display": "virtual"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/ABC"
        }
      },
      "request": {
        "method": "PUT",
        "url": "Encounter/307"
      },
      "response": {
        "status": "201"
      }
    },
    {
      "fullUrl": "https://example.org/FHIR/R5/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"
            ]
          }
        ]
      }
    },
    {
      "fullUrl": "https://example.org/FHIR/R5/Encounter/308",
      "resource": {
        "resourceType": "Encounter",
        "id": "308",
        "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: Encounter</b><a name=\"308\"> </a></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 Encounter &quot;308&quot; Version &quot;1&quot; Updated &quot;2019-08-07T10:49:22Z&quot; </p></div><p><b>status</b>: in-progress</p><p><b>class</b>: virtual <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/3.1.0/CodeSystem-v3-ActCode.html\">ActCode</a>#VR)</span></p><p><b>subject</b>: <a href=\"todo.html\">Patient/ABC</a></p></div>"
        },
        "status": "in-progress",
        "class": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                "code": "VR",
                "display": "virtual"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/ABC"
        }
      },
      "request": {
        "method": "PUT",
        "url": "Encounter/308"
      },
      "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.