FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions . Page versions: R5 R4B R4 R3

Operation-patient-match

Example OperationDefinition/Patient-match (Narrative)

Maturity Level : N/A
Responsible Owner: Patient Administration Work Group Ballot Standards Status : Informative Compartments : Patient , Practitioner , RelatedPerson

This is the narrative for the resource. See also the XML or , JSON or Turtle format.

Find patient matches using MPI based logic OPERATION: Find patient matches using MPI based logic The official URL for

Note that this operation definition is: http://hl7.org/fhir/OperationDefinition/Patient-match A Master Patient Index ( MPI ) 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 formal definition for the institution's particular mix of patients. MPIs can also be run on a regional and national basis.\n\nTo ask an MPI 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 passed processed by an algorithm of some kind that uses the data to determine the most appropriate matches in the patient set. \n\nNote 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 as 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 by specifying a profile OperationDefinition on Patient. See the resource parameter, indicating which properties are required in the search.\n\nThe patient resource coming into the operation does not have to be complete, nor does it need to pass validation (i.e. Mandatory fields don't need to be populated), but it does have to be a valid instance. This is due to the resource being used for reference data to match from, and not being stored. Operation documentation

Generated Narrative: OperationDefinition Patient-match

URL: [base]/Patient/$match

Parameters

Use Name Scope Cardinality Type Binding Documentation
IN resource 1..1 Resource

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).

IN onlySingleMatch 0..1 boolean

If a patient record is not provided, then one or more of there are multiple potential matches, the other parameters must server should identify the single most appropriate match that should be provided used with future interactions with the server (for example, as part of a subsequent create interaction).

IN onlyCertainMatches 0..1 boolean

If there are multiple potential matches, then the match server should not return be certain that each of the results with this flag set to true. records are for the same patients. This could happen if the records are duplicates, are the same person for the purpose of data segregation, or other reasons. When false, the server may return multiple results with each result graded accordingly.

IN count 0..1 integer

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

OUT return 1..1 Bundle

The bundle type is "searchset"

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)

The response from an "mpi" "mpi" 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 " match-grade " http://hl7.org/fhir/StructureDefinition/match-grade " " that indicates the MPI's position on the match quality.

 

 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.