Operation-patient-everything.xml

Operation Definition

Raw XML

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Patient-everything"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/Patient-everything"/>
  <name value="Fetch Patient Record"/>
  <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 patient described in the
   resource on which this operation is invoked. The response is a bundle of type &quot;searchset&quot;.
   At a minimum, the patient resource itself is returned, along with any other resources
   that the server has available for the given 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 rhis operation is to provide a patient with access
   to their records (e.g. &quot;Blue Button&quot;).  The server SHOULD return all resources
   that it has that are in the patient compartment for the identified patient, 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 (ref to be provided). Other applicable implementation guides may make additional
   rules about the information that is returned. Note: the expectations here will be refined
   after experience with this at connectathon."/>
  <status value="draft"/>
  <date value="2015-04-03T14:24:32+11:00"/>
  <kind value="operation"/>
  <code value="everything"/>
  <notes 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)  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. 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 should return an error.
   Speciying the relationship between the context, a user and patient records is outside
   the scope of this specification."/>
  <system value="false"/>
  <type value="Patient"/>
  <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 date is provided, all records 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 date is provided, all records 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>