Operation-patient-match.xml

Operation Definition

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Patient-match"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Find patient matches using MPI based logic</h2>
      <p>OPERATION: Find patient matches using MPI based logic</p>
      <div>
        <p>A Master Patient Index (
          <a href="http://en.wikipedia.org/wiki/Enterprise_master_patient_index">MPI</a> ) is a service used to manage patient identification in a context where multiple patient
           databases exist. Healthcare applications and middleware use the MPI to match patients
           between the databases, and as new patient details are encountered. MPIs are highly specialized
           applications, often tailored extensively to the institution's particular mix of patients.
           MPIs can also be run on a regional and national basis.
        </p>

        <p>To ask an MPI to match a patient, clients use the &quot;mpi&quot; query, which takes either
           a candidate patient resource, or a set of normal search parameters defined for patient.
           The data provided is interpreted as an MPI input and  passed to an MPI algorithm of some
           kind that uses them to determine the most appropriate matches in the patient set.</p>

        <p>Note that different MPI matching algorithms have different required inputs. The generic
           $match operation does not specify any particular algorithm, nor a minimum set of information
           that must be provided when asking for an MPI match operation to be performed, but may
           implementations will have a set of minimum information, which may be declared in their
           definition of the $match operation</p>

      </div>
      <p>URL: [base]/Patient/$match</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>patient</td>
          <td>0..1</td>
          <td>Patient</td>
          <td/>
          <td>
            <div>
              <p>Use this to provide an entire set of patient details for the MPI to match against (e.g.
                 POST a patient record to Patient/$match). If a patient record is not provided, then one
                 or more of the other parameters must be provided</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>family</td>
          <td>0..1</td>
          <td>string</td>
          <td/>
          <td>
            <div>
              <p>The family name for matching</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>given</td>
          <td>0..1</td>
          <td>string</td>
          <td/>
          <td>
            <div>
              <p>The given name for matching</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>gender</td>
          <td>0..1</td>
          <td>string</td>
          <td/>
          <td>
            <div>
              <p>The gender for matching</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>birthdate</td>
          <td>0..1</td>
          <td>string</td>
          <td/>
          <td>
            <div>
              <p>The birth date of the patient for matching</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>identifier</td>
          <td>0..1</td>
          <td>string</td>
          <td/>
          <td>
            <div>
              <p>An identifier to use for the matching</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>telecom</td>
          <td>0..1</td>
          <td>string</td>
          <td/>
          <td>
            <div>
              <p>Some kind of telecom to use for the matching</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>phone</td>
          <td>0..1</td>
          <td>string</td>
          <td/>
          <td>
            <div>
              <p>A phone number to use for matching</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>email</td>
          <td>0..1</td>
          <td>string</td>
          <td/>
          <td>
            <div>
              <p>An email address to use for matching</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>postcode</td>
          <td>0..1</td>
          <td>string</td>
          <td/>
          <td>
            <div>
              <p>A postcode to use for matching</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>userid</td>
          <td>0..1</td>
          <td>string</td>
          <td/>
          <td>
            <div>
              <p>This optional parameter is used to pass the user details from a trusted client to the
                 MPI. This may be used by the MPI to restrict the possible matches that are returned, based
                 on the user's rights. For example, a staff member covered by policies, etc., may well
                 get a different result than a patient trying to find their own record. Note that this
                 parameter is used where the user would not be expected to log in to the MPI directly;
                 whether this is appropriate or not is a deployment choice.</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>count</td>
          <td>0..1</td>
          <td>integer</td>
          <td/>
          <td>
            <div>
              <p>The maximum number of records to return. If no value is provided, the server decides how
                 many matches to return. Note that clients should be careful when using this, as it may
                 prevent probable - and valid - matches from being returned</p>

            </div>
          </td>
        </tr>
        <tr>
          <td>OUT</td>
          <td>return</td>
          <td>1..1</td>
          <td>Bundle</td>
          <td/>
          <td>
            <div>
              <p>A bundle contain a set of Patient records that represent possible matches</p>

            </div>
          </td>
        </tr>
      </table>
      <div>
        <p>The response from an &quot;mpi&quot; query is a bundle containing patient records, ordered
           from most likely to least likely. If there are no patient matches, the MPI SHALL return
           an empty search set with no error, but may include an operation outcome with further advice
           regarding patient selection. All patient records SHALL have a search score from 0 to 1,
           where 1 is the most certain match, along with an extension &quot;
          <a href="extension-match-grade.html">match-grade</a>&quot; that indicates the MPI's position on the match quality.
        </p>

      </div>
    </div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/Patient-match"/>
  <name value="Find patient matches using MPI based logic"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2016-12-06T12:22: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="A Master Patient Index ([MPI](http://en.wikipedia.org/wiki/Enterprise_master_patient_index)
   ) is a service used to manage patient identification in a context where multiple patient
   databases exist. Healthcare applications and middleware use the MPI to match patients
   between the databases, and as new patient details are encountered. MPIs are highly specialized
   applications, often tailored extensively to the institution's particular mix of patients.
   MPIs can also be run on a regional and national basis.  To ask an MPI to match a patient,
   clients use the &quot;mpi&quot; query, which takes either a candidate patient resource,
   or a set of normal search parameters defined for patient. The data provided is interpreted
   as an MPI input and  passed to an MPI algorithm of some kind that uses them to determine
   the most appropriate matches in the patient set.   Note that different MPI matching algorithms
   have different required inputs. The generic $match operation does not specify any particular
   algorithm, nor a minimum set of information that must be provided when asking for an MPI
   match operation to be performed, but may implementations will have a set of minimum information,
   which may be declared in their definition of the $match operation"/>
  <code value="match"/>
  <comment value="The response from an &quot;mpi&quot; query is a bundle containing patient records, ordered
   from most likely to least likely. If there are no patient matches, the MPI SHALL return
   an empty search set with no error, but may include an operation outcome with further advice
   regarding patient selection. All patient records SHALL have a search score from 0 to 1,
   where 1 is the most certain match, along with an extension &quot;[match-grade](extension-match-grade
  .html)&quot; that indicates the MPI's position on the match quality."/>
  <resource value="Patient"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="false"/>
  <parameter>
    <name value="patient"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Use this to provide an entire set of patient details for the MPI to match against (e.g.
     POST a patient record to Patient/$match). If a patient record is not provided, then one
     or more of the other parameters must be provided"/>
    <type value="Patient"/>
  </parameter>
  <parameter>
    <name value="family"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The family name for matching"/>
    <type value="string"/>
    <searchType value="string"/>
  </parameter>
  <parameter>
    <name value="given"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The given name for matching"/>
    <type value="string"/>
    <searchType value="string"/>
  </parameter>
  <parameter>
    <name value="gender"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The gender for matching"/>
    <type value="string"/>
    <searchType value="token"/>
  </parameter>
  <parameter>
    <name value="birthdate"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The birth date of the patient for matching"/>
    <type value="string"/>
    <searchType value="date"/>
  </parameter>
  <parameter>
    <name value="identifier"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="An identifier to use for the matching"/>
    <type value="string"/>
    <searchType value="token"/>
  </parameter>
  <parameter>
    <name value="telecom"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Some kind of telecom to use for the matching"/>
    <type value="string"/>
    <searchType value="token"/>
  </parameter>
  <parameter>
    <name value="phone"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="A phone number to use for matching"/>
    <type value="string"/>
    <searchType value="token"/>
  </parameter>
  <parameter>
    <name value="email"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="An email address to use for matching"/>
    <type value="string"/>
    <searchType value="token"/>
  </parameter>
  <parameter>
    <name value="postcode"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="A postcode to use for matching"/>
    <type value="string"/>
    <searchType value="string"/>
  </parameter>
  <parameter>
    <name value="userid"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="This optional parameter is used to pass the user details from a trusted client to the
     MPI. This may be used by the MPI to restrict the possible matches that are returned, based
     on the user's rights. For example, a staff member covered by policies, etc., may well
     get a different result than a patient trying to find their own record. Note that this
     parameter is used where the user would not be expected to log in to the MPI directly;
     whether this is appropriate or not is a deployment choice."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="count"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The maximum number of records to return. If no value is provided, the server decides how
     many matches to return. Note that clients should be careful when using this, as it may
     prevent probable - and valid - matches from being returned"/>
    <type value="integer"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="A bundle contain a set of Patient records that represent possible matches"/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>