Operation Definition

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


  
  
    
    
      
      
      
        
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
        
        
          
          
          
          
          
            
          
          
          
            
              

            
          
        
        
          
          
          
          
          
            
          
          
          
            
              

            
          
        
        
          
          
          
          
          
            
          
          
             (Required)
          
          
            

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Subscription-events"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p class="res-header-id">
        <b> Generated Narrative: OperationDefinition Subscription-events</b> 
      </p> 
      <a name="Subscription-events"> </a> 
      <a name="hcSubscription-events"> </a> 
      <a name="Subscription-events-en-AU"> </a> 
      <p> URL: [base]/Subscription/[id]/$events</p> 
      <h3> Parameters</h3> 
      <table class="grid">
        <tr> 
          <td> 
            <b> Use</b> 
          </td> 
          <td> 
            <b> Name</b> 
          </td> 
          <td> 
            <b> Scope</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/>  
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#integer64">integer64</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/>  
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#integer64">integer64</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/>  
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#code">code</a> 
          </td> 
          <td> 
            <a href="valueset-subscription-payload-content.html">Subscription Payload Content</a>  (Required)
          </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.

            
          
        
        
          
          
          
          
          
            
          
          
          
            

                 would prefer, and MAY be ignored.</p> 
            </div>           </td>         </tr>         <tr>           <td> OUT</td>           <td> return</td>           <td/>            <td> 1..1</td>           <td>             <a href="bundle.html">Bundle</a>           </td>           <td/>            <td>             <div> 
              <p> The operation returns a valid notification bundle, with the first entry being a
                 SubscriptionStatus resource. The bundle type is &quot;subscription-notification&quot;.

            
          
        
      
    
  
  
    
  
  
    
  
  
  
  
  
  
  
  
  
  
  
    
      
      
    
    
      
      
    
  

                 SubscriptionStatus resource. The bundle type is &quot;subscription-notification&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>   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">    <valueCode value="fhir"/>   </extension>   <url value="http://hl7.org/fhir/OperationDefinition/Subscription-events"/>   <version value="6.0.0-ballot3"/>   <name value="Events"/>   <title value="Search and retrieve prior events for a Subscription"/>   <status value="draft"/>   <kind value="operation"/>   <experimental value="false"/>   <date value="2025-04-01T12:16:37+11:00"/>   <publisher value="HL7 International / FHIR Infrastructure"/>   <contact>     <telecom>       <system value="url"/>       <value value="http://hl7.org/fhir"/>     </telecom>     <telecom>       <system value="email"/>       <value value="fhir@lists.hl7.org"/>     </telecom>   </contact>   <contact>     <telecom>       <system value="url"/>       <value value="http://www.hl7.org/Special/committees/fiwg"/>     </telecom>   </contact> 
  <description value="This operation is used to search for and return notifications that have been previously
   triggered by a topic-based Subscription.
  
    
      
      
      
    
  
  
  
  
  
  
  
  
    
    
    
    
    
    
  
  
    
    
    
    
    
    
  
  
    
    
    
    

   triggered by a topic-based Subscription."/> 
  <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="integer64"/>   </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="integer64"/>   </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.
    
    
      
      
    
  
  
    
    
    
    

     would prefer, and MAY be ignored."/> 
    <type value="code"/>     <binding>       <strength value="required"/>       <valueSet value="http://hl7.org/fhir/ValueSet/subscription-payload-content|6.0.0-ballot3"/>     </binding>   </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 a
     SubscriptionStatus resource. The bundle type is &quot;subscription-notification&quot;.
    
  

     SubscriptionStatus resource. The bundle type is &quot;subscription-notification&quot;."/> 
    <type value="Bundle"/>   </parameter> 


</

OperationDefinition

>