Operation Definition

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

  
  
    
    
      
      
      
      
        
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
          
            
          
        
        
          
          
          
          
          
            
          
          
          
            

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="MedicinalProductDefinition-everything"/> 
  <text> 
    <status value="extensions"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> URL: [base]/MedicinalProductDefinition/$everything</p> 
      <p> URL: [base]/MedicinalProductDefinition/[id]/$everything</p> 
      <p> Parameters</p> 
      <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> _since</td> 
          <td/>  
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#instant">instant</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> Resources updated after this period will be included in the response. The intent
                 of this parameter is to allow a client to request only records that have changed
                 since the last request, based on either the return header time, or or (for asynchronous
                 use), the transaction time
            
          
        
        
          
          
          
          
          
            
          
          
          
            

                 use), the transaction time</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> _count</td> 
          <td/>  
          <td> 0..1</td> 
          <td> 
            <a href="datatypes.html#integer">integer</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> See discussion below on the utility of paging through the results of the $everything
                 operation
            
          
        
        
          
          
          
          
          
            
          
          
          
            
              
            
          
        
      
      

                 operation</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 bundle type is &quot;searchset&quot;</p> 


            </div> 
          </td> 
        </tr> 
      </table> 
      <div> 
        <p> The key differences between this operation and simply performing a search and using
           _include and _revinclude are:
        

           _include and _revinclude are:</p> 

        <ul> 



          <li> unless the client requests otherwise, the server returns the entire result set
             in a single bundle (rather than using paging)

             in a single bundle (rather than using paging)</li> 


          <li> the server is responsible for determining what resources to return as included
             resources (rather than the client specifying which ones).
        

             resources (rather than the client specifying which ones).</li> 

        </ul> 



        <p> This frees the client from needing to determine what it could or should ask for,
           particularly with regard to included resources. It also makes for a much shorter
           and easier to construct query string. Servers should consider returning appropriate
           Provenance and AuditTrail on the returned resources, even though these are not
           directly part of the product data.

           directly part of the product data.</p> 


        <p> When this operation is used to access multiple product records at once, the return
           bundle could be rather a lot of data; servers may choose to require that such requests
           are made 
          , and associated with 

           are made 
          <a href="async.html">asynchronously</a> , and associated with 
          <a href="resource-formats.html#bulk">bulk data formats</a> . Alternatively, clients may choose to page through the result set (or servers
           may require this). Paging through the results is done the same as for 
          , using the 

           may require this). Paging through the results is done the same as for 
          <a href="http.html#paging">Searching</a> , using the 
          <a href="search.html#count">_count</a>  parameter, and Bundle links. Implementers should note that paging will be slower
           than simply returning all the results at once (more network traffic, multiple latency
           delays) but may be required in order not to exhaust available memory reading or
           writing the whole response in a single package. Unlike searching, there is no inherent
           user-display order for the $everything operation. Servers might consider sorting
           the returned resources in descending order of last record update, but are not required
           to do so.
        

           to do so.
        </p> 



        <p> The _since parameter is provided to support periodic queries to get additional
           information that has changed about the product since the last query. This means
           that the _since parameter is based on record time. The value of the _since parameter
           should be set to the time from the server. If using direct response, this is the
           timestamp in the response header. If using the async interface, this is the transaction
           timestamp in the json response. Servers should ensure that the timestamps a managed
           such that the client does not miss any changes. Clients should be able to handle
           getting the same response more than once in the case that the transaction falls
           on a time boundary. Clients should ensure that the other query parameters are constant
           to ensure a coherent set of records when doing periodic queries.
      
    
  
  
    
  
  
    
  
  
  
  
  
  
  
  
  
  
  
    
      
      
    
    
      
      
    
  

           to ensure a coherent set of records when doing periodic queries.</p> 

      </div> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1"/> 
  </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="brr"/> 
  </extension> 
  <url value="http://hl7.org/fhir/OperationDefinition/MedicinalProductDefinition-everything"/> 
  <version value="6.0.0-ballot1"/> 
  <name value="Everything"/> 
  <title value="Fetch Product Record"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <experimental value="false"/> 
  <date value="2023-12-18T15:12:07+11:00"/> 
  <publisher value="HL7 International / Biomedical Research and Regulation"/> 
  <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/rcrim"/> 
    </telecom> 
  </contact> 
  <description value="This operation is used to return all the information related to one or more products
   described in the resource or context on which this operation is invoked. The response
   is a bundle of type &quot;searchset&quot;. At a minimum, the product resource(s)
   itself is returned, along with any other resources that the server has that are
   related to the products(s), and that are available for the given user. This is
   typically the marketing authorizations, ingredients, packages, therapeutic indications
   and so on. The server also returns whatever resources are needed to support the
   records - e.g. linked organizations, document references etc.
  
    
      
      
      
    
  
  
  

   records - e.g. linked organizations, document references etc."/> 
  <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="everything"/> 
  <comment value="The key differences between this operation and simply performing a search and using
   _include and _revinclude are:    

   _include and _revinclude are:    


* unless the client requests otherwise, the server returns the entire result set
   in a single bundle (rather than using paging)  

   in a single bundle (rather than using paging)  

* the server is responsible for determining what resources to return as included
   resources (rather than the client specifying which ones). 

   resources (rather than the client specifying which ones). 


This frees the client from needing to determine what it could or should ask for,
   particularly with regard to included resources. It also makes for a much shorter
   and easier to construct query string. Servers should consider returning appropriate
   Provenance and AuditTrail on the returned resources, even though these are not
   directly part of the product data. 

   directly part of the product data. 


When this operation is used to access multiple product records at once, the return
   bundle could be rather a lot of data; servers may choose to require that such requests
   are made [asynchronously](async.html), and associated with [bulk data formats](resource-forma
  ts.html#bulk). Alternatively, clients may choose to page through the result set
   (or servers may require this). Paging through the results is done the same as for
   [Searching](http.html#paging), using the [_count](search.html#count) parameter,
   and Bundle links. Implementers should note that paging will be slower than simply
   returning all the results at once (more network traffic, multiple latency delays)
   but may be required in order not to exhaust available memory reading or writing
   the whole response in a single package. Unlike searching, there is no inherent
   user-display order for the $everything operation. Servers might consider sorting
   the returned resources in descending order of last record update, but are not required
   to do so.

   to do so.


The _since parameter is provided to support periodic queries to get additional
   information that has changed about the product since the last query. This means
   that the _since parameter is based on record time. The value of the _since parameter
   should be set to the time from the server. If using direct response, this is the
   timestamp in the response header. If using the async interface, this is the transaction
   timestamp in the json response. Servers should ensure that the timestamps a managed
   such that the client does not miss any changes. Clients should be able to handle
   getting the same response more than once in the case that the transaction falls
   on a time boundary. Clients should ensure that the other query parameters are constant
   to ensure a coherent set of records when doing periodic queries.
  
  
  
  
  
    
    
    
    

   to ensure a coherent set of records when doing periodic queries."/> 
  <resource value="MedicinalProductDefinition"/> 
  <system value="false"/> 
  <type value="true"/> 
  <instance value="true"/> 
  <parameter> 
    <name value="_since"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="Resources updated after this period will be included in the response. The intent
     of this parameter is to allow a client to request only records that have changed
     since the last request, based on either the return header time, or or (for asynchronous
     use), the transaction time
    
  
  
    
    
    
    

     use), the transaction time"/> 
    <type value="instant"/> 
  </parameter> 
  <parameter> 
    <name value="_count"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="See discussion below on the utility of paging through the results of the $everything
     operation
    
  
  
    
    
    
    
    
    
  

     operation"/> 
    <type value="integer"/> 
  </parameter> 
  <parameter> 
    <name value="return"/> 
    <use value="out"/> 
    <min value="1"/> 
    <max value="1"/> 
    <documentation value="The bundle type is &quot;searchset&quot;"/> 
    <type value="Bundle"/> 
  </parameter> 


</

OperationDefinition

>