Release 5 Draft Ballot

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

Subscriptiontopic-example-admission.json

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

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

Beginning of clinical encounter

{
  "resourceType": "SubscriptionTopic",
  "id": "admission",
  "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;admission&quot; </p></div><p><b>url</b>: <a href=\"http://example.org/FHIR/R5/SubscriptionTopic/admission\">http://example.org/FHIR/R5/SubscriptionTopic/admission</a></p><p><b>title</b>: admission</p><p><b>status</b>: active</p><p><b>description</b>: Example admission topic</p><blockquote><p><b>resourceTrigger</b></p><p><b>description</b>: Encounter resource moving to state 'in-progress'</p><p><b>resource</b>: <a href=\"encounter.html\">Encounter</a></p><p><b>supportedInteraction</b>: create, update</p><h3>QueryCriteria</h3><table class=\"grid\"><tr><td>-</td><td><b>Previous</b></td><td><b>ResultForCreate</b></td><td><b>Current</b></td><td><b>ResultForDelete</b></td><td><b>RequireBoth</b></td></tr><tr><td>*</td><td>status:not=in-progress</td><td>test-passes</td><td>status=in-progress</td><td>test-fails</td><td>true</td></tr></table><p><b>fhirPathCriteria</b>: %previous.status!='in-progress' and %current.status='in-progress'</p></blockquote><h3>EventTriggers</h3><table class=\"grid\"><tr><td>-</td><td><b>Description</b></td><td><b>Event</b></td><td><b>Resource</b></td></tr><tr><td>*</td><td>Patient admission is covered by HL7v2 ADT^A01</td><td>ADT/ACK - Admit/visit notification <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/3.1.0/CodeSystem-v2-0003.html\">eventType</a>#A01)</span></td><td><a href=\"encounter.html\">Encounter</a></td></tr></table><h3>CanFilterBies</h3><table class=\"grid\"><tr><td>-</td><td><b>Description</b></td><td><b>Resource</b></td><td><b>FilterParameter</b></td><td><b>Modifier</b></td></tr><tr><td>*</td><td>Matching based on the Patient (subject) of an Encounter or based on the Patient's group membership (in/not-in).</td><td><a href=\"encounter.html\">Encounter</a></td><td>patient</td><td>=, in, not-in</td></tr></table><h3>NotificationShapes</h3><table class=\"grid\"><tr><td>-</td><td><b>Resource</b></td><td><b>Include</b></td></tr><tr><td>*</td><td><a href=\"encounter.html\">Encounter</a></td><td>Encounter:patient, Encounter:practitioner, Encounter:service-provider, Encounter:account, Encounter:diagnosis, Encounter:observation, Encounter:location</td></tr></table></div>"
  },
  "url": "http://example.org/FHIR/R5/SubscriptionTopic/admission",
  "title": "admission",
  "status": "active",
  "description": "Example admission topic",
  "resourceTrigger": [
    {
      "description": "Encounter resource moving to state 'in-progress'",
      "resource": "http://hl7.org/fhir/StructureDefinition/Encounter",
      "supportedInteraction": [
        "create",
        "update"
      ],
      "queryCriteria": {
        "previous": "status:not=in-progress",
        "resultForCreate": "test-passes",
        "current": "status=in-progress",
        "resultForDelete": "test-fails",
        "requireBoth": true
      },
      "fhirPathCriteria": "%previous.status!='in-progress' and %current.status='in-progress'"
    }
  ],
  "eventTrigger": [
    {
      "description": "Patient admission is covered by HL7v2 ADT^A01",
      "event": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0003",
            "code": "A01",
            "display": "ADT/ACK - Admit/visit notification"
          }
        ]
      },
      "resource": "http://hl7.org/fhir/StructureDefinition/Encounter"
    }
  ],
  "canFilterBy": [
    {
      "description": "Matching based on the Patient (subject) of an Encounter or based on the Patient's group membership (in/not-in).",
      "resource": "Encounter",
      "filterParameter": "patient",
      "modifier": [
        "=",
        "in",
        "not-in"
      ]
    }
  ],
  "notificationShape": [
    {
      "resource": "Encounter",
      "include": [
        "Encounter:patient",
        "Encounter:practitioner",
        "Encounter:service-provider",
        "Encounter:account",
        "Encounter:diagnosis",
        "Encounter:observation",
        "Encounter:location"
      ]
    }
  ]
}

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.