Operation-patient-everything.xml

Operation Definition

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Patient-everything"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2> Fetch Patient Record</h2> 
      <p> OPERATION: Fetch Patient Record</p> 
      <p> The official URL for this operation definition is: </p> 
      <pre> http://hl7.org/fhir/OperationDefinition/Patient-everything</pre> 
      <div> 
        <p> This operation is used to return all the information related to one or mores patient 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 patient resource(s) itself is returned,
           along with any other resources that the server has that are related to the patient(s),
           and that are available for the given user. The server also returns whatever resources
           are needed to support the records - e.g. linked practitioners, medications, locations,
           organizations etc. The intended use for this operation is to provide a patient with access
           to their entire record (e.g. &quot;Blue Button&quot;), or for bulk data download.  The
           server SHOULD return at least all resources that it has that are in the patient compartment
           for the identified patient(s), and any resource referenced from those, including binaries
           and attachments. In the US Realm, at a mimimum, the resources returned SHALL include all
           the data covered by the meaningful use common data elements as defined in 
          <a href="http://hl7.org/fhir/us/daf">DAF</a> . Other applicable implementation guides may make additional rules about how much information
           that is returned
        </p> 

      </div> 
      <p> URL: [base]/Patient/$everything</p> 
      <p> URL: [base]/Patient/[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> IN</td> 
          <td> start</td> 
          <td> 0..1</td> 
          <td> date</td> 
          <td/>  
          <td> 
            <div> 
              <p> The date range relates to care dates, not record currency dates - e.g. all records relating
                 to care provided in a certain date range. If no start date is provided, all records prior
                 to the end date are in scope.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> end</td> 
          <td> 0..1</td> 
          <td> date</td> 
          <td/>  
          <td> 
            <div> 
              <p> The date range relates to care dates, not record currency dates - e.g. all records relating
                 to care provided in a certain date range. If no end date is provided, all records subsequent
                 to the start date are in scope.</p> 

            </div> 
          </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 patient compartment
           are:
          <br/>  
        </p> 

        <ul> 

          <li> unless the client requests otherwise, the server returns the entire result set 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). This frees the client from needing to
             determine what it could or should ask for</li> 

        </ul> 

        <p> It is assumed that the server has identified and secured the context appropriately, and
           can either associate the authorization context with a single patient, or determine whether
           the context has the rights to the nominated patient, if there is one, or can determine
           an appropriate list of patients to provide data for from the context of the request. If
           there is no nominated patient (e.g. the operation is invoked at the system level) and
           the context is not associated with a single patient record, then the server may choose
           to return an error. Specifying the relationship between the context, a user and patient
           records is outside the scope of this specification.</p> 

        <p> When this operation is used to access multiple patient records at once (GET /Patient/$everything),
           the actual list of patients is all patients that the user associated with the request
           has access to. This may be all patients in the family that the patient has access to,
           or it may be all patients that a care provider has access to. In the second case, this
           could be a lot of patient; servers may choose to require that the such requests are made
           
          <a href="http.html#async">asynchronously</a> , and associated with 
          <a href="formats.html#bulk">bulk data formats</a> .
        </p> 

      </div> 
    </div> 
  </text> 
  <url value="http://hl7.org/fhir/OperationDefinition/Patient-everything"/> 
  <name value="Fetch Patient 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 one or mores patient 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 patient resource(s) itself is returned,
   along with any other resources that the server has that are related to the patient(s),
   and that are available for the given user. The server also returns whatever resources
   are needed to support the records - e.g. linked practitioners, medications, locations,
   organizations etc. The intended use for this operation is to provide a patient with access
   to their entire record (e.g. &quot;Blue Button&quot;), or for bulk data download.  The
   server SHOULD return at least all resources that it has that are in the patient compartment
   for the identified patient(s), and any resource referenced from those, including binaries
   and attachments. In the US Realm, at a mimimum, the resources returned SHALL include all
   the data covered by the meaningful use common data elements as defined in [DAF](http://hl7.org/fhir/
  us/daf). Other applicable implementation guides may make additional rules about how much
   information that is returned"/> 
  <code value="everything"/> 
  <comment value="The key differences between this operation and simply searching the patient 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). This frees the client from needing to
   determine what it could or should ask for

It is assumed that the server has identified and secured the context appropriately, and
   can either associate the authorization context with a single patient, or determine whether
   the context has the rights to the nominated patient, if there is one, or can determine
   an appropriate list of patients to provide data for from the context of the request. If
   there is no nominated patient (e.g. the operation is invoked at the system level) and
   the context is not associated with a single patient record, then the server may choose
   to return an error. Specifying the relationship between the context, a user and patient
   records is outside the scope of this specification.

When this operation is used to access multiple patient records at once (GET /Patient/$everything),
   the actual list of patients is all patients that the user associated with the request
   has access to. This may be all patients in the family that the patient has access to,
   or it may be all patients that a care provider has access to. In the second case, this
   could be a lot of patient; servers may choose to require that the such requests are made
   [asynchronously](http.html#async), and associated with [bulk data formats](formats.html#bulk)."/> 
  <resource value="Patient"/> 
  <system value="false"/> 
  <type value="true"/> 
  <instance value="true"/> 
  <parameter> 
    <name value="start"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="The date range relates to care dates, not record currency dates - e.g. all records relating
     to care provided in a certain date range. If no start date is provided, all records prior
     to the end date are in scope."/> 
    <type value="date"/> 
  </parameter> 
  <parameter> 
    <name value="end"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="1"/> 
    <documentation value="The date range relates to care dates, not record currency dates - e.g. all records relating
     to care provided in a certain date range. If no end date is provided, all records subsequent
     to the start date are in scope."/> 
    <type value="date"/> 
  </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>