ResMed Core Implementation Guide
0.37.0 - ci-build
ResMed Core Implementation Guide
0.37.0 - ci-build
ResMed Core Implementation Guide - Local Development build (v0.37.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2024-01-11 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="Patient-match"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><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>Scope</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>resource</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/resource.html">Resource</a></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) consisting of name (given, family) and birthdate.</p>
</div></td></tr><tr><td>IN</td><td>onlyCertainMatches</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>If there are multiple potential matches, then the match should not return the results with this flag set to true. When false, the server may return multiple results with each result graded accordingly.</p>
</div></td></tr><tr><td>IN</td><td>count</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#integer">integer</a></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/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td><div><p>A bundle contain a set of Patient records that represent possible matches, optionally it may also contain an OperationOutcome with further information about the search results (such as warnings or information messages, such as a count of records that were close but eliminated). If the operation was unsuccessful, then an OperationOutcome may be returned along with a BadRequest status Code (e.g. security issue, or insufficient properties in patient fragment - check against profile)</p>
</div></td></tr></table></div>
</text>
<url value="http://resmed.com/fhir/core/OperationDefinition/Patient-match"/>
<version value="0.37.0"/>
<name value="Match"/>
<title value="Find patient matches using MPI based logic"/>
<status value="draft"/>
<kind value="operation"/>
<date value="2024-01-11T18:32:48+00:00"/>
<publisher value="ResMed Corp"/>
<contact>
<name value="ResMed Corp"/>
<telecom>
<system value="url"/>
<value value="https://www.resmed.com"/>
</telecom>
<telecom>
<system value="email"/>
<value value="atomteam-halifax@resmed.com"/>
</telecom>
</contact>
<description
value="To ask an Master Patient Index ([MPI](http://en.wikipedia.org/wiki/Enterprise_master_patient_index) ) to match a patient, clients use the "$match" operation, which accepts a patient resource which may be only partially complete. The data provided is interpreted as an MPI input and processed by an algorithm of some kind that uses the data to determine the most appropriate matches in the patient set."/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
</coding>
</jurisdiction>
<affectsState value="false"/>
<code value="match"/>
<base value="http://hl7.org/fhir/OperationDefinition/Patient-match"/>
<resource value="Patient"/>
<system value="false"/>
<type value="true"/>
<instance value="false"/>
<parameter>
<name value="resource"/>
<use value="in"/>
<min value="1"/>
<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) consisting of name (given, family) and birthdate."/>
<type value="Resource"/>
</parameter>
<parameter>
<name value="onlyCertainMatches"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="If there are multiple potential matches, then the match should not return the results with this flag set to true. When false, the server may return multiple results with each result graded accordingly."/>
<type value="boolean"/>
</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, optionally it may also contain an OperationOutcome with further information about the search results (such as warnings or information messages, such as a count of records that were close but eliminated). If the operation was unsuccessful, then an OperationOutcome may be returned along with a BadRequest status Code (e.g. security issue, or insufficient properties in patient fragment - check against profile)"/>
<type value="Bundle"/>
</parameter>
</OperationDefinition>