Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions


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</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;admission&quot; </p></div><p><b>name</b>: AdmissionExample</p><p><b>status</b>: active</p><p><b>topic</b>: <a href=\"\"></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 class=\"grid\"><tr><td>-</td><td><b>FilterParameter</b></td><td><b>Value</b></td></tr><tr><td>*</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><p><b>endpoint</b>: <a href=\"\"></a></p><p><b>header</b>: Authorization: Bearer secret-token-abc-123</p><p><b>heartbeatPeriod</b>: 60</p><p><b>timeout</b>: 5</p><p><b>contentType</b>: application/fhir+json</p><p><b>content</b>: id-only</p><p><b>maxCount</b>: 100</p></div>"
  "name": "AdmissionExample",
  "status": "active",
  "topic": "",
  "end": "2019-08-07T11:15:18Z",
  "reason": "subscription for beginning of a clinical encounter for patient 123",
  "filterBy": [
      "filterParameter": "patient",
      "value": "Patient/123"
  "channelType": {
    "code": "rest-hook"
  "endpoint": "",
  "header": [
    "Authorization: Bearer secret-token-abc-123"
  "heartbeatPeriod": 60,
  "timeout": 5,
  "contentType": "application/fhir+json",
  "content": "id-only",
  "maxCount": 100

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.