Release 5

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

Example Subscription/example (JSON)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: No defined compartments

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

Example of subscription

{
  "resourceType" : "Subscription",
  "id" : "example",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: Subscription</b><a name=\"example\"> </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 Subscription &quot;example&quot; </p></div><p><b>identifier</b>: id:\u00a0urn:uuid:97e5aa1e-5916-4512-a36e-24eef784e3cc</p><p><b>name</b>: Example</p><p><b>status</b>: active</p><p><b>topic</b>: <a href=\"http://example.org/R5/SubscriptionTopic/example\">http://example.org/R5/SubscriptionTopic/example</a></p><p><b>contact</b>: ph: (555) 555-1212(WORK)</p><p><b>reason</b>: Example subscription for example topic</p><h3>FilterBies</h3><table class=\"grid\"><tr><td>-</td><td><b>ResourceType</b></td><td><b>FilterParameter</b></td><td><b>Value</b></td></tr><tr><td>*</td><td><a href=\"encounter.html\">Encounter</a></td><td>patient</td><td>Patient/123</td></tr></table><p><b>channelType</b>: rest-hook (Details: [not stated] code rest-hook = 'rest-hook', stated as 'null')</p></div>"
  },
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:uuid:97e5aa1e-5916-4512-a36e-24eef784e3cc"
  }],
  "name" : "Example",
  "status" : "active",
  "topic" : "http://example.org/R5/SubscriptionTopic/example",
  "contact" : [{
    "system" : "phone",
    "value" : "(555) 555-1212",
    "use" : "work"
  }],
  "reason" : "Example subscription for example topic",
  "filterBy" : [{
    "resourceType" : "http://hl7.org/fhir/StructureDefinition/Encounter",
    "filterParameter" : "patient",
    "value" : "Patient/123"
  }],
  "channelType" : {
    "code" : "rest-hook"
  }
}

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.