Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B

Example SubscriptionTopic/admission (Turtle)

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

Raw Turtle (+ also see Turtle/RDF Format Specification)

Beginning of clinical encounter

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

[a fhir:SubscriptionTopic;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "admission"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ];
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: SubscriptionTopic</b><a name=\"admission\"> </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 SubscriptionTopic &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>identifier</b>: id: urn:oid:2.16.840.1.113883.4.642.24.1</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>"
  ];
  fhir:SubscriptionTopic.url [ fhir:value "http://example.org/FHIR/R5/SubscriptionTopic/admission"];
  fhir:SubscriptionTopic.identifier [
     fhir:index 0;
     fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ];
     fhir:Identifier.value [ fhir:value "urn:oid:2.16.840.1.113883.4.642.24.1" ]
  ];
  fhir:SubscriptionTopic.title [ fhir:value "admission"];
  fhir:SubscriptionTopic.status [ fhir:value "active"];
  fhir:SubscriptionTopic.description [ fhir:value "Example admission topic"];
  fhir:SubscriptionTopic.resourceTrigger [
     fhir:index 0;
     fhir:SubscriptionTopic.resourceTrigger.description [ fhir:value "Encounter resource moving to state 'in-progress'" ];
     fhir:SubscriptionTopic.resourceTrigger.resource [ fhir:value "http://hl7.org/fhir/StructureDefinition/Encounter" ];
     fhir:SubscriptionTopic.resourceTrigger.supportedInteraction [
       fhir:value "create";
       fhir:index 0
     ], [
       fhir:value "update";
       fhir:index 1
     ];
     fhir:SubscriptionTopic.resourceTrigger.queryCriteria [
       fhir:SubscriptionTopic.resourceTrigger.queryCriteria.previous [ fhir:value "status:not=in-progress" ];
       fhir:SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreate [ fhir:value "test-passes" ];
       fhir:SubscriptionTopic.resourceTrigger.queryCriteria.current [ fhir:value "status=in-progress" ];
       fhir:SubscriptionTopic.resourceTrigger.queryCriteria.resultForDelete [ fhir:value "test-fails" ];
       fhir:SubscriptionTopic.resourceTrigger.queryCriteria.requireBoth [ fhir:value "true"^^xsd:boolean ]
     ];
     fhir:SubscriptionTopic.resourceTrigger.fhirPathCriteria [ fhir:value "%previous.status!='in-progress' and %current.status='in-progress'" ]
  ];
  fhir:SubscriptionTopic.eventTrigger [
     fhir:index 0;
     fhir:SubscriptionTopic.eventTrigger.description [ fhir:value "Patient admission is covered by HL7v2 ADT^A01" ];
     fhir:SubscriptionTopic.eventTrigger.event [
       fhir:CodeableConcept.coding [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/v2-0003" ];
         fhir:Coding.code [ fhir:value "A01" ];
         fhir:Coding.display [ fhir:value "ADT/ACK - Admit/visit notification" ]
       ]
     ];
     fhir:SubscriptionTopic.eventTrigger.resource [ fhir:value "http://hl7.org/fhir/StructureDefinition/Encounter" ]
  ];
  fhir:SubscriptionTopic.canFilterBy [
     fhir:index 0;
     fhir:SubscriptionTopic.canFilterBy.description [ fhir:value "Matching based on the Patient (subject) of an Encounter or based on the Patient's group membership (in/not-in)." ];
     fhir:SubscriptionTopic.canFilterBy.resource [ fhir:value "Encounter" ];
     fhir:SubscriptionTopic.canFilterBy.filterParameter [ fhir:value "patient" ];
     fhir:SubscriptionTopic.canFilterBy.modifier [
       fhir:value "=";
       fhir:index 0
     ], [
       fhir:value "in";
       fhir:index 1
     ], [
       fhir:value "not-in";
       fhir:index 2
     ]
  ];
  fhir:SubscriptionTopic.notificationShape [
     fhir:index 0;
     fhir:SubscriptionTopic.notificationShape.resource [ fhir:value "Encounter" ];
     fhir:SubscriptionTopic.notificationShape.include [
       fhir:value "Encounter:patient";
       fhir:index 0
     ], [
       fhir:value "Encounter:practitioner";
       fhir:index 1
     ], [
       fhir:value "Encounter:service-provider";
       fhir:index 2
     ], [
       fhir:value "Encounter:account";
       fhir:index 3
     ], [
       fhir:value "Encounter:diagnosis";
       fhir:index 4
     ], [
       fhir:value "Encounter:observation";
       fhir:index 5
     ], [
       fhir:value "Encounter:location";
       fhir:index 6
     ]
  ]] .

# - ontology header ------------------------------------------------------------

[a owl:Ontology;
  owl:imports fhir:fhir.ttl] .

# -------------------------------------------------------------------------------------


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.