Interoperable Digital Identity and Patient Matching
2.0.0-ballot - STU2 Ballot United States of America flag

Interoperable Digital Identity and Patient Matching, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-identity-matching-ig/ and changes regularly. See the Directory of published versions

OperationDefinition: IDI Match Operation

Official URL: http://hl7.org/fhir/us/identity-matching/OperationDefinition/IDI-match Version: 2.0.0-ballot
Standards status: Trial-use Maturity Level: 1 Computable Name: IDIMatch

This extension of the $match operation is further constrained to meet the additional requirements found in this IG. One of the IDI Patient profiles outline in this guide (IDI-Patient, IDI-Patient-L0, IDI-Patient-L1, IDI-Patient-L2) SHALL be used as the input for the match request. An IDI-Match-Bundle will be returned to the requesting entity. This Bundle will contain the full URLs of the sourced information, an Organization resource, and any matched Patient resources.

Input parameters Profile:IDI Match Input Parameters

Output parameters Profile:IDI Match Output Parameters

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INIDIPatient1..1Patient

A Patient resource that is being requested in the match operation. The requester SHALL use one of the IDI Patient profiles for the resource in their submission.

INonlySingleMatch0..1boolean

If there are multiple potential matches, the server should identify the single most appropriate match that should be used with future interactions with the server (for example, as part of a subsequent create interaction).

INonlyCertainMatches0..1boolean

If there are multiple potential matches, the server should be certain that each of the 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.

INcount0..1integer

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.

OUTIDIMatchBundle1..1Bundle

When successful, a Bundle resource containing Patient resources of a high confidence match SHALL be returned to the requestor. In addition, an Organization resource of the responding entity SHALL be included in the Bundle for error reporting purposes. When the responding server is unable to return a match, a response of 'No Match Found' will be returned.