Carequality Subscription Implementation Guide for Push Notifications
1.0.0 - CI Build

This page is part of the Carequality Subscription Implementation Guide for Push Notifications (v1.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: Example Subscribing - JSON Representation

Raw json | Download

{
  "resourceType" : "Subscription",
  "id" : "CEQSubscriptionExample",
  "meta" : {
    "profile" : [
      🔗 "https://carequality.org/IG/push-notifications/StructureDefinition/CEQsubscription"
    ]
  },
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Subscription CEQSubscriptionExample</b></p><a name=\"CEQSubscriptionExample\"> </a><a name=\"hcCEQSubscriptionExample\"> </a><a name=\"CEQSubscriptionExample-en-US\"> </a><blockquote><p><b>Carequality Subscription Required Elements</b></p><ul><li>subIdentifier: sub123</li><li>searchParamName: PatientID</li><li>searchModifier: eq</li><li>endUser: Dr. David AnyDoc</li><li>CQOrganization: 02yr0qwy40</li></ul></blockquote><p><b>Backport R5 Subscription Topic Canonical</b>: <code>http://www.carequality.org/CEQTopic/snradmit</code></p><p><b>status</b>: Active</p><p><b>contact</b>: ph: 555-555-5555</p><p><b>end</b>: 2021-01-01 00:00:00+0000</p><p><b>reason</b>: Example</p><p><b>criteria</b>: Patient?identifier=MRN123</p><h3>Channels</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Type</b></td><td><b>Endpoint</b></td></tr><tr><td style=\"display: none\">*</td><td>Rest Hook</td><td><a href=\"http://www.example.org/fhir/subscription/sub123\">http://www.example.org/fhir/subscription/sub123</a></td></tr></table></div>"
  },
  "extension" : [
    {
      "extension" : [
        {
          "url" : "subIdentifier",
          "valueString" : "sub123"
        },
        {
          "url" : "searchParamName",
          "valueString" : "PatientID"
        },
        {
          "url" : "searchModifier",
          "valueCode" : "eq"
        },
        {
          "url" : "endUser",
          "valueString" : "Dr. David AnyDoc"
        },
        {
          "url" : "CQOrganization",
          "valueString" : "02yr0qwy40"
        }
      ],
      "url" : "https://carequality.org/IG/push-notifications/StructureDefinition/CEQextension"
    },
    {
      "url" : "https://carequality.org/IG/push-notifications/StructureDefinition/backport-topic-canonical",
      "valueCanonical" : "http://www.carequality.org/CEQTopic/snradmit"
    }
  ],
  "status" : "active",
  "contact" : [
    {
      "system" : "phone",
      "value" : "555-555-5555"
    }
  ],
  "end" : "2021-01-01T00:00:00Z",
  "reason" : "Example",
  "criteria" : "Patient?identifier=MRN123",
  "channel" : {
    "type" : "rest-hook",
    "endpoint" : "http://www.example.org/fhir/subscription/sub123"
  }
}