Operation-encounter-everything.xml

Operation Definition

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Encounter-everything"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2> Fetch Encounter Record</h2> 
      <p> OPERATION: Fetch Encounter Record</p> 
      <p> The official URL for this operation definition is: </p> 
      <pre> http://hl7.org/fhir/OperationDefinition/Encounter-everything</pre> 
      <div> 
        <p> This operation is used to return all the information related to an encounter described
           in the resource on which this operation is invoked. The response is a bundle of type &quot;searchset
          &quot;. At a minimum, the encounter resource itself is returned, along with any other resources
           that the server has available for the given encounter for the user. The server also returns
           whatever resources are needed to support the records - e.g. linked practitioners, locations,
           organizations etc. The principle intended use for this operation is to provide a patient
           with access to their record, or to allow a client to retrieve everything for an encounter
           for efficient display).</p> 

        <p> The server SHOULD return all resources it has that:</p> 

        <ul> 

          <li> are included in the encounter compartment for the identified encounter (have a reference
             to the encounter)</li> 

          <li> are referenced by the standard extenstion for associating an encounter (where no reference
             element exists) http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter</li> 

          <li> the server believes are relevant to the context of the encounter for any other reason
             (internally defined/decided)</li> 

          <li> any resource referenced by the above, including binaries and attachments (to make a more
             complete package)</li> 

        </ul> 

        <p> In the US Realm, at a mimimum, the resources returned SHALL include all the data covered
           by the meaningful use common data elements (see 
          <a href="http://hl7.org/fhir/us/daf">DAF</a>  for further guidance). Other applicable implementation guides may make additional rules
           about the information that is returned.   Note that for many resources, the exact nature
           of the link to encounter can be ambiguous (e.g. for a DiagnosticReport, is it the encounter
           when it was initiated, or when it was reported?)
        </p> 

      </div> 
      <p> URL: [base]/Encounter/[id]/$everything</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> OUT</td> 
          <td> return</td> 
          <td> 1..1</td> 
          <td> Bundle</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 searching the encounter compartment
           are:  * unless the client requests otherwise, the server returns the entire result set
           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)</p> 

      </div> 
    </div> 
  </text> 
  <url value="http://hl7.org/fhir/OperationDefinition/Encounter-everything"/> 
  <name value="Fetch Encounter Record"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <date value="2017-12-20T15:52:34+11:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="This operation is used to return all the information related to an encounter described
   in the resource on which this operation is invoked. The response is a bundle of type &quot;searchset
  &quot;. At a minimum, the encounter resource itself is returned, along with any other resources
   that the server has available for the given encounter for the user. The server also returns
   whatever resources are needed to support the records - e.g. linked practitioners, locations,
   organizations etc. The principle intended use for this operation is to provide a patient
   with access to their record, or to allow a client to retrieve everything for an encounter
   for efficient display).

The server SHOULD return all resources it has that:

* are included in the encounter compartment for the identified encounter (have a reference
   to the encounter)
* are referenced by the standard extenstion for associating an encounter (where no reference
   element exists) http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
* the server believes are relevant to the context of the encounter for any other reason
   (internally defined/decided)
* any resource referenced by the above, including binaries and attachments (to make a
   more complete package)

In the US Realm, at a mimimum, the resources returned SHALL include all the data covered
   by the meaningful use common data elements (see [DAF](http://hl7.org/fhir/us/daf) for
   further guidance). Other applicable implementation guides may make additional rules about
   the information that is returned.   Note that for many resources, the exact nature of
   the link to encounter can be ambiguous (e.g. for a DiagnosticReport, is it the encounter
   when it was initiated, or when it was reported?)"/> 
  <code value="everything"/> 
  <comment value="The key differences between this operation and simply searching the encounter compartment
   are:  * unless the client requests otherwise, the server returns the entire result set
   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)"/> 
  <resource value="Encounter"/> 
  <system value="false"/> 
  <type value="false"/> 
  <instance value="true"/> 
  <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>