Patient-mpi-search.xml

Patient MPI Query (id = "patient-mpi")

<OperationDefinition xmlns="http://hl7.org/fhir"> 
  <id value="patient-mpi"/>
  <text><status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: patient-mpi</p><p><b>url</b>: <a>http://hl7.org/fhir/OperationDefinitino/patient-mpi</a></p><p><b>name</b>: Patient MPI (Multiple Patient Index) search</p><p><b>status</b>: draft</p><p><b>kind</b>: query</p><p><b>experimental</b>: false</p><p><b>publisher</b>: HL7, Inc</p><h3>Contacts</h3><table><tr><td>-</td><td><b>Telecom</b></td></tr><tr><td>*</td><td>http://hl7.org/fhir</td></tr></table><p><b>date</b>: 18/08/2015</p><p><b>description</b>: An MPI search differs from a normal search because the parameters are interpreted as
         inputs to an MPI match process, rather than as direct match criteria on the returned resources</p><p><b>requirements</b>: This query is defined to allow an MPI to be integrated in a FHIR server environment,
         and to allow a client to delegate the matching process to a specialist. MPI algorithms
         are often highly tailored to a particular patient set</p><p><b>idempotent</b>: true</p><p><b>code</b>: mpi</p><p><b>notes</b>: All the standard search parameters apply, and are interpreted as inputs to the MPI algorithm.
         The _sort parameter is not used. Matches are returned in order of highest match to lowest
         match, with both a % in the score, and an asessement of the match using the extension
         http://hl7.org/fhir/StructureDefinition/patient-mpi-match</p><p><b>system</b>: false</p><p><b>type</b>: Patient</p><p><b>instance</b>: false</p><blockquote><p><b>parameter</b></p><p><b>name</b>: userid</p><p><b>use</b>: in</p><p><b>min</b>: 0</p><p><b>max</b>: 1</p><p><b>documentation</b>: User identity for the MPI to consider when creating a return set. This paraemter is
           defined in the assumption that the MPI ay be a separate module from other FHIR Servers,
           with a trust relationship to it. Actualy deployment scenarios will determine whether this
           parameter is used</p><p><b>type</b>: string</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: result</p><p><b>use</b>: out</p><p><b>min</b>: 0</p><p><b>max</b>: *</p><p><b>documentation</b>: Patients that match this MPI query</p><p><b>type</b>: Patient</p></blockquote></div></text><url value="http://hl7.org/fhir/OperationDefinitino/patient-mpi"/>
  <name value="Patient MPI (Multiple Patient Index) search"/>
  <status value="draft"/>
  <kind value="query"/>
  <experimental value="false"/>
  <publisher value="HL7, Inc"/>
  <contact>  
    <telecom>
      <system value="other"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <date value="2015-08-18"/>
  <description value="An MPI search differs from a normal search because the parameters are interpreted as inputs
   to an MPI match process, rather than as direct match criteria on the returned resources"/>
  <requirements value="This query is defined to allow an MPI to be integrated in a FHIR server environment, and
   to allow a client to delegate the matching process to a specialist. MPI algorithms are
   often highly tailored to a particular patient set"/>
  <idempotent value="true"/>
  <code value="mpi"/>
  <notes value="All the standard search parameters apply, and are interpreted as inputs to the MPI algorithm.
   The _sort parameter is not used. Matches are returned in order of highest match to lowest
   match, with both a % in the score, and an asessement of the match using the extension
   http://hl7.org/fhir/StructureDefinition/patient-mpi-match"/>
  <system value="false"/>
  <type value="Patient"/>
  <instance value="false"/>
  <!--    in addition to all the standard patient parameters, this one:    -->
  <parameter> 
    <name value="userid"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="User identity for the MPI to consider when creating a return set. This paraemter is defined
     in the assumption that the MPI ay be a separate module from other FHIR Servers, with a
     trust relationship to it. Actualy deployment scenarios will determine whether this parameter
     is used"/>
    <type value="string"/>
  </parameter>  
  <parameter> 
    <name value="result"/>
    <use value="out"/>
    <min value="0"/>
    <max value="*"/>
    <documentation value="Patients that match this MPI query"/>
    <type value="Patient"/>
  </parameter>  
</OperationDefinition>