$idi-match

IDI Match Operation

activeIdentity Matching2.0.0operation4 inputs1 output

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.

Metadata

hl7.org/fhir
Canonical URL
http://hl7.org/fhir/us/identity-matching/OperationDefinition/IDI-match
Code
$idi-match
Kind
operation
Affects State
No
Publisher
HL7 International / Patient Administration

Invocation Context

Can be invoked at:
Type Level

Input Parameters (4)

NameTypeCard.Description
IDIPatient*Patient1..1A 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.
onlySingleMatchboolean0..1If 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).
onlyCertainMatchesboolean0..1If 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.
countinteger0..1The 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.

Output Parameters (1)

NameTypeCard.Description
IDIMatchBundleBundle1..1When 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.

Additional Information

Version
2.0.0
Date
2025-12-10T16:42:49+00:00
Base Definition
http://hl7.org/fhir/OperationDefinition/Patient-match