Da Vinci Health Record Exchange (HRex)
1.1.0 - STU 1.1 United States of America flag

Da Vinci Health Record Exchange (HRex), published by HL7 International / Clinical Interoperability Council. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-ehrx/ and changes regularly. See the Directory of published versions

: HRex Member Match Operation - JSON Representation

Page standards status: Trial-use Maturity Level: 2

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "member-match",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition member-match</b></p><a name=\"member-match\"> </a><a name=\"hcmember-match\"> </a><a name=\"member-match-en-US\"> </a><p>URL: [base]/Patient/$member-match</p><p>Input parameters Profile:<a href=\"StructureDefinition-hrex-parameters-member-match-in.html\">HRex Parameters - Member Match Request Profile</a></p><p>Output parameters Profile:<a href=\"StructureDefinition-hrex-parameters-member-match-out.html\">HRex Parameters - Member Match Response Profile</a></p><h3>Parameters</h3><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>MemberPatient</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>Parameter submitted by the new plan <strong>SHALL</strong> contain US Core Patient containing member demographics.</p>\n</div></td></tr><tr><td>IN</td><td>Consent</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>Consent held by the system seeking the match that grants permission to access the patient information information on the system for whom a patient is sought.  Downstream IGs could tighten this to 'required' if necessary.</p>\n</div></td></tr><tr><td>IN</td><td>CoverageToMatch</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>Parameter that identifies the coverage to be matched by the receiving payer.  It contains the coverage details of health plan coverage provided by the member, typically from their health plan coverage card.</p>\n</div></td></tr><tr><td>IN</td><td>CoverageToLink</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>Parameter that identifies the coverage information of the member as they are known by the requesting payer.  This information allows the matching payer to link their member coverage information to that of the requesting payer to ease subsequent exchanges, including evaluating authorization to share information in subsequent queries.  This parameter is optional as this operation might be invoked by non-payer systems.  However, it is considered 'mustSupport'.  If the client invoking the operation is a payer, they <strong>SHALL</strong> include their coverage information for the member when invoking the operation.</p>\n</div></td></tr><tr><td>OUT</td><td>MemberIdentifier</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a></td><td/><td><div><p>This is the member identifier information for the patient as known by the server that is the target of the operation.</p>\n</div></td></tr><tr><td>OUT</td><td>MemberId</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td><div><p>This is the RESTful identity for the patient as known by the server that is the target of the operation.</p>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cic"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 2,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/davinci-hrex/ImplementationGuide/davinci-hrex"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/davinci-hrex/ImplementationGuide/davinci-hrex"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/us/davinci-hrex/OperationDefinition/member-match",
  "version" : "1.1.0",
  "name" : "MemberMatch",
  "title" : "HRex Member Match Operation",
  "status" : "active",
  "kind" : "operation",
  "date" : "2024-12-10T07:03:38+00:00",
  "publisher" : "HL7 International / Clinical Interoperability Council",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cic"
        }
      ]
    }
  ],
  "description" : "The **$member-match** operation that can be invoked by either a payer or an EHR or other system, allows one health plan to retrieve a unique identifier for a member from another health plan using a member's demographic and coverage information.  This identifier can then be used to perform subsequent queries and operations. Members implementing a deterministic match will require a match on member id or subscriber id at a minimum (i.e. A pure demographic match will not be supported by such implementations.).",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "affectsState" : true,
  "code" : "member-match",
  "resource" : [
    "Patient"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "inputProfile" : "http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-parameters-member-match-in",
  "outputProfile" : "http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-parameters-member-match-out",
  "parameter" : [
    {
      "name" : "MemberPatient",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Parameter submitted by the new plan **SHALL** contain US Core Patient containing member demographics.",
      "type" : "Resource",
      "referencedFrom" : [
        {
          "source" : "CoverageToMatch",
          "sourceId" : "beneficiary"
        },
        {
          "source" : "CoverageToLink",
          "sourceId" : "beneficiary"
        }
      ]
    },
    {
      "name" : "Consent",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Consent held by the system seeking the match that grants permission to access the patient information information on the system for whom a patient is sought.  Downstream IGs could tighten this to 'required' if necessary.",
      "type" : "Resource"
    },
    {
      "name" : "CoverageToMatch",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Parameter that identifies the coverage to be matched by the receiving payer.  It contains the coverage details of health plan coverage provided by the member, typically from their health plan coverage card.",
      "type" : "Resource"
    },
    {
      "name" : "CoverageToLink",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Parameter that identifies the coverage information of the member as they are known by the requesting payer.  This information allows the matching payer to link their member coverage information to that of the requesting payer to ease subsequent exchanges, including evaluating authorization to share information in subsequent queries.  This parameter is optional as this operation might be invoked by non-payer systems.  However, it is considered 'mustSupport'.  If the client invoking the operation is a payer, they **SHALL** include their coverage information for the member when invoking the operation.",
      "type" : "Resource"
    },
    {
      "name" : "MemberIdentifier",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "This is the member identifier information for the patient as known by the server that is the target of the operation.",
      "type" : "Identifier"
    },
    {
      "name" : "MemberId",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "This is the RESTful identity for the patient as known by the server that is the target of the operation.",
      "type" : "Reference"
    }
  ]
}