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 (XML)

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

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

Jump past Narrative

Beginning of clinical encounter (id = "admission")

<?xml version="1.0" encoding="UTF-8"?>

<SubscriptionTopic xmlns="http://hl7.org/fhir">
  <id value="admission"/> 
  <text> <status value="generated"/> <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> </text> <url value="http://example.org/FHIR/R5/SubscriptionTopic/admission"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.24.1"/> 
  </identifier> 
  <title value="admission"/> 
  <status value="active"/> 
  <description value="Example admission topic"/> 
  <resourceTrigger> 
    <description value="Encounter resource moving to state 'in-progress'"/> 
    <resource value="http://hl7.org/fhir/StructureDefinition/Encounter"/> 
    <supportedInteraction value="create"/> 
    <supportedInteraction value="update"/> 
    <queryCriteria> 
      <previous value="status:not=in-progress"/> 
      <resultForCreate value="test-passes"/> 
      <current value="status=in-progress"/> 
      <resultForDelete value="test-fails"/> 
      <requireBoth value="true"/> 
    </queryCriteria> 
    <fhirPathCriteria value="%previous.status!='in-progress' and %current.status='in-progress'"/> 
  </resourceTrigger> 
  <eventTrigger> 
    <description value="Patient admission is covered by HL7v2 ADT^A01"/> 
    <event> 
      <coding> 
        <system value="http://terminology.hl7.org/CodeSystem/v2-0003"/> 
        <code value="A01"/> 
        <display value="ADT/ACK - Admit/visit notification"/> 
      </coding> 
    </event> 
    <resource value="http://hl7.org/fhir/StructureDefinition/Encounter"/> 
  </eventTrigger> 
  <canFilterBy> 
    <description value="Matching based on the Patient (subject) of an Encounter or based on the Patient's
     group membership (in/not-in)."/> 
    <resource value="Encounter"/> 
    <filterParameter value="patient"/> 
    <modifier value="="/> 
    <modifier value="in"/> 
    <modifier value="not-in"/> 
  </canFilterBy> 
  <notificationShape> 
    <resource value="Encounter"/> 
    <include value="Encounter:patient"/> 
    <include value="Encounter:practitioner"/> 
    <include value="Encounter:service-provider"/> 
    <include value="Encounter:account"/> 
    <include value="Encounter:diagnosis"/> 
    <include value="Encounter:observation"/> 
    <include value="Encounter:location"/> 
  </notificationShape> 
</SubscriptionTopic> 

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.