Release 4B 5

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0: R5 - STU ). The This is the current published version which supercedes in it's permanent home (it will always be available at this version is 5.0.0 . URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R5 R4B

Notification-handshake.json

Example SubscriptionStatus/54f808cf-d159-4c9b-accb-c33eb20f0ecc (JSON)

FHIR Infrastructure Work Group Maturity Level : N/A Standards Status : Informative Compartments : Not linked to any No defined compartments

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

Example of a Subscription Handshake message (first message on Bundle (establish channel) 

{
  "resourceType": "Bundle",
  "id": "54f808cf-d159-4c9b-accb-c33eb20f0ecc",
  "type": "history",
  "timestamp": "2020-04-17T10:24:13.1882432-05:00",
  "entry": [
    {
      "fullUrl": "urn:uuid:231e7f38-2dd1-45ac-9161-d7bd87c403bd",
      "resource": {
        "resourceType": "SubscriptionStatus",
        "id": "231e7f38-2dd1-45ac-9161-d7bd87c403bd",
        "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 &quot;231e7f38-2dd1-45ac-9161-d7bd87c403bd&quot; </p></div><p><b>status</b>: requested</p><p><b>type</b>: handshake</p><p><b>eventsSinceSubscriptionStart</b>: 0</p><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": "requested",
        "type": "handshake",
        "eventsSinceSubscriptionStart": "0",
        "subscription": {
          "reference": "http://example.org/FHIR/R4B/Subscription/123"
        },
        "topic": "http://example.org/FHIR/R4B/SubscriptionTopic/admission"

  "resourceType" : "Bundle",
  "id" : "54f808cf-d159-4c9b-accb-c33eb20f0ecc",
  "type" : "subscription-notification",
  "timestamp" : "2020-04-17T10:24:13.1882432-05:00",
  "entry" : [{
    "fullUrl" : "urn:uuid:231e7f38-2dd1-45ac-9161-d7bd87c403bd",
    "resource" : {
      "resourceType" : "SubscriptionStatus",
      "id" : "231e7f38-2dd1-45ac-9161-d7bd87c403bd",
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: SubscriptionStatus</b><a name=\"231e7f38-2dd1-45ac-9161-d7bd87c403bd\"> </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;231e7f38-2dd1-45ac-9161-d7bd87c403bd&quot; </p></div><p><b>status</b>: requested</p><p><b>type</b>: handshake</p><p><b>eventsSinceSubscriptionStart</b>: 0</p><p><b>subscription</b>: <a href=\"broken-link.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>"

      },
      "request": {
        "method": "GET",
        "url": "Subscription/123/$status"

      "status" : "requested",
      "type" : "handshake",
      "eventsSinceSubscriptionStart" : "0",
      "subscription" : {
        "reference" : "http://example.org/FHIR/R5/Subscription/123"

      },
      "response": {
        "status": "200"
      }

      "topic" : "http://example.org/FHIR/R5/SubscriptionTopic/admission"

    }
  ]

  }]

}

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.