This page is part of the Subscriptions R5 Backport (v1.1.0: STU 1.1) based on FHIR v4.3.0. This is the current published version. For a full list of available versions, see the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Subscription Events Operation - XML Representation

Raw xml | Download

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="backport-subscription-events"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/Subscription/[id]/$events</p><p>Parameters</p><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>eventsSinceNumber</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4B/datatypes.html#string">string</a></td><td/><td><div><p>The starting event number, inclusive of this event (lower bound).</p>
</div></td></tr><tr><td>IN</td><td>eventsUntilNumber</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4B/datatypes.html#string">string</a></td><td/><td><div><p>The ending event number, inclusive of this event (upper bound).</p>
</div></td></tr><tr><td>IN</td><td>content</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4B/datatypes.html#code">code</a></td><td/><td><div><p>Requested content style of returned data. Codes from backport-content-value-set (e.g., empty, id-only, full-resource). This is a hint to the server what a client would prefer, and MAY be ignored.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td>1..1</td><td><a href="http://hl7.org/fhir/R4B/bundle.html">Bundle</a></td><td/><td><div><p>The operation returns a valid notification bundle, with the first entry being the subscription status information resource. The bundle type is &quot;history&quot;.</p>
</div></td></tr></table></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="0"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/>
  </extension>
  <url
       value="http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events"/>
  <version value="1.1.0"/>
  <name value="R5SubscriptionEvents"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2020-11-30"/>
  <publisher value="HL7 FHIR Infrastructure WG"/>
  <contact>
    <name value="HL7 FHIR Infrastructure WG"/>
    <telecom>
      <system value="url"/>
      <value value="https://hl7.org/Special/committees/fiwg"/>
    </telecom>
  </contact>
  <contact>
    <name value="Gino Canessa"/>
    <telecom>
      <system value="email"/>
      <value value="mailto:gino.canessa@microsoft.com"/>
    </telecom>
  </contact>
  <contact>
    <name value="Eric Haas"/>
    <telecom>
      <system value="email"/>
      <value value="mailto:ehaas@healthedatainc.com"/>
    </telecom>
  </contact>
  <description
               value="This operation is used to search for and return notifications that have been previously triggered by a topic-based Subscription in R4."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <affectsState value="false"/>
  <code value="events"/>
  <resource value="Subscription"/>
  <system value="false"/>
  <type value="false"/>
  <instance value="true"/>
  <parameter>
    <name value="eventsSinceNumber"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The starting event number, inclusive of this event (lower bound)."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="eventsUntilNumber"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The ending event number, inclusive of this event (upper bound)."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="content"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Requested content style of returned data. Codes from backport-content-value-set (e.g., empty, id-only, full-resource). This is a hint to the server what a client would prefer, and MAY be ignored."/>
    <type value="code"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The operation returns a valid notification bundle, with the first entry being the subscription status information resource. The bundle type is &quot;history&quot;."/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>