Release 4


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

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

Example of subscription for beginning of a clinical encounter

  "resourceType": "Subscription",
  "id": "admission",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: admission</p><p><b>name</b>: AdmissionExample</p><p><b>status</b>: active</p><p><b>topic</b>: <a>Topic/admission</a></p><p><b>end</b>: Aug 7, 2019 11:15:18 AM</p><p><b>reason</b>: subscription for beginning of a clinical encounter for patient 123</p><h3>FilterBies</h3><table><tr><td>-</td><td><b>Name</b></td><td><b>Value</b></td></tr><tr><td>*</td><td>patient</td><td>Patient/123</td></tr></table><blockquote><p><b>channel</b></p><p><b>type</b>: Rest Hook <span>(Details : { code 'rest-hook' = 'Rest Hook', given as 'Rest Hook'})</span></p><p><b>endpoint</b>: <a></a></p><p><b>header</b>: Authorization: Bearer secret-token-abc-123</p><p><b>heartbeatPeriod</b>: 60</p><h3>Payloads</h3><table><tr><td>-</td><td><b>ContentType</b></td><td><b>Content</b></td></tr><tr><td>*</td><td>application/fhir+json</td><td>id-only</td></tr></table></blockquote></div>"
  "name": "AdmissionExample",
  "status": "active",
  "topic": {
    "reference": "Topic/admission"
  "end": "2019-08-07T11:15:18Z",
  "reason": "subscription for beginning of a clinical encounter for patient 123",
  "filterBy": [
      "name": "patient",
      "value": "Patient/123"
  "channel": {
    "type": {
      "coding": [
          "system": "",
          "code": "rest-hook",
          "display": "Rest Hook"
      "text": "Rest Hook"
    "endpoint": "",
    "header": [
      "Authorization: Bearer secret-token-abc-123"
    "heartbeatPeriod": 60,
    "payload": {
      "contentType": "application/fhir+json",
      "content": "id-only"

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.