This page is part of the Interoperable Digital Identity and Patient Matching (v2.0.0-ballot: STU2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

• Narrative Content
• XML
• JSON

: IDI Match Operation - JSON Representation

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "IDI-match",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition IDI-match</b></p><a name=\"IDI-match\"> </a><a name=\"hcIDI-match\"> </a><a name=\"IDI-match-en-US\"> </a><p>URL: [base]/Patient/$idi-match</p><p>Input parameters Profile:<a href=\"StructureDefinition-idi-match-input-parameters.html\">IDI Match Input Parameters</a></p><p>Output parameters Profile:<a href=\"StructureDefinition-idi-match-output-parameters.html\">IDI Match Output Parameters</a></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>IDIPatient</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></td><td/><td><div><p>A Patient resource that is being requested in the match operation. The requester must use one of the IDI Patient profiles for the resource in their submission.</p>\n</div></td></tr><tr><td>OUT</td><td>IDIMatchBundle</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>When successful, a Bundle resource containing Patient resources of a high confidence match is returned to the requestor. In addition, an Organization resource of the responding entity will 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.</p>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "pa"
    }
  ],
  "url" : "http://hl7.org/fhir/us/identity-matching/OperationDefinition/IDI-match",
  "version" : "2.0.0-ballot",
  "name" : "IDIMatch",
  "title" : "IDI Match Operation",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2024-08-12T18:37:27+00:00",
  "publisher" : "HL7 International / Patient Administration",
  "contact" : [
    {
      "name" : "HL7 International / Patient Administration",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/pafm"
        }
      ]
    }
  ],
  "description" : "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) 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.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "code" : "idi-match",
  "base" : "http://hl7.org/fhir/us/identity-matching/OperationDefinition/IDI-match",
  "resource" : [
    "Patient"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "inputProfile" : "http://hl7.org/fhir/us/identity-matching/StructureDefinition/idi-match-input-parameters",
  "outputProfile" : "http://hl7.org/fhir/us/identity-matching/StructureDefinition/idi-match-output-parameters",
  "parameter" : [
    {
      "name" : "IDIPatient",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "A Patient resource that is being requested in the match operation. The requester must use one of the IDI Patient profiles for the resource in their submission.",
      "type" : "Patient"
    },
    {
      "name" : "IDIMatchBundle",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "When successful, a Bundle resource containing Patient resources of a high confidence match is returned to the requestor. In addition, an Organization resource of the responding entity will 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.",
      "type" : "Bundle"
    }
  ]
}