CH EPR mHealth (R4)
0.1.2 - Draft Standard for Trial Use

This page is part of the CH EPR mHealth (R4) (v0.1.2: DSTU 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Find patient matches using IHE-PIXm Profile - JSON Representation

(back to description)

Raw json

Source view


{
  "resourceType" : "OperationDefinition",
  "id" : "IHE.PIXm.pix",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n            <h2> Mobile Patient Identifier Cross-Reference Query</h2>\n            <p> OPERATION: Find patient matches using IHE PIXm Profile</p>\n            <p> The official URL for this operation definition is: </p>\n            <pre> http://profiles.ihe.net/fhir/ihe.pixm.fhir/OperationDefinition/IHE_PIXm_pix</pre>\n            <div>\n                <p> A Master Patient Index (\n                    <a href=\"http://en.wikipedia.org/wiki/Enterprise_master_patient_index\">MPI</a>  ) is a service used to manage patient identification in a context where multiple patient\n           databases exist. Healthcare applications and middleware use the MPI to match patients\n           between the databases, and to store new patient details as they are encountered. MPIs\n           are highly specialized applications, often tailored extensively to the institution's particular\n           mix of patients. MPIs can also be run on a regional and national basis.\n                </p>\n\n                <p> This transaction is used by the Patient Identifier Cross-reference Consumer to solicit information about patients whose Patient Identifiers cross-match with Patient Identifiers provided in the query parameters of the request message. The request is received by the Patient Identifier Cross-reference Manager. The Patient Identifier Cross-reference Manager processes the request and returns a response in the form of zero or more Patient Identifiers for the matching patient.</p>\n\n            </div>\n            <p> URL: [base]/Patient/$ihe-pix</p>\n            <p> Parameters</p>\n            <table class=\"grid\">\n                <tr>\n                    <td>\n                        <b> Use</b>\n                    </td>\n                    <td>\n                        <b> Name</b>\n                    </td>\n                    <td>\n                        <b> Cardinality</b>\n                    </td>\n                    <td>\n                        <b> Type</b>\n                    </td>\n                    <td>\n                        <b> Binding</b>\n                    </td>\n                    <td>\n                        <b> Documentation</b>\n                    </td>\n                </tr>\n                <tr>\n                    <td> IN</td>\n                    <td> sourceIdentifier</td>\n                    <td> 1..1</td>\n                    <td>\n                        <a href=\"http://hl7.org/fhir/R4/search.html#token\">Token</a>\n                    </td>\n                    <td/>\n                    <td>\n                        <div>\n                            <p> The Patient identifier search parameter that will be used by the Patient Identifier Cross-reference Manager to find cross matching identifiers associated with the Patient Resource. See Section 3.83.4.1.2.1.</p>\n\n                        </div>\n                    </td>\n                </tr>\n                <tr>\n                    <td> IN</td>\n                    <td> targetSystem</td>\n                    <td> 0..1</td>\n                    <td>\n                        <a href=\"http://hl7.org/fhir/R4/search.html#uri\">uri</a>\n                    </td>\n                    <td/>\n                    <td>\n                        <div>\n                            <p> The target Patient Identifier Assigning Authority from which the returned identifiers should be selected. See Section 3.83.4.1.2.2.</p>\n\n                        </div>\n                    </td>\n                </tr>\n                <tr>\n                    <td> IN</td>\n                    <td> _format</td>\n                    <td> 0..1</td>\n                    <td>\n                        <a href=\"http://hl7.org/fhir/R4/http.html#mime-type\">mime-type</a>\n                    </td>\n                    <td/>\n                    <td>\n                        <div>\n                            <p> The requested format of the response. See ITI TF-2x: Appendix Z.6.</p>\n\n                        </div>\n                    </td>\n                </tr>\n                <tr>\n                    <td> OUT</td>\n                    <td> targetIdentifier</td>\n                    <td> 0..*</td>\n                    <td>\n                        <a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a>\n                    </td>\n                    <td/>\n                    <td>\n                        <div>\n                            <p> The identifier found. Constraints to include the assigning authority as specified in ITI TF-2x: Appendix E.3.</p>\n\n                        </div>\n                    </td>\n                </tr>\n                <tr>\n                    <td> OUT</td>\n                    <td> targetId</td>\n                    <td> 0..*</td>\n                    <td>\n                        <a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a>\n                    </td>\n                    <td/>\n                    <td>\n                        <div>\n                            <p>  The URL of the Patient Resource.</p>\n\n                        </div>\n                    </td>\n                </tr>\n            </table>\n            <div>\n                <p> The response is a Parameters containing matching identifier, the Parameters Resource shall include one parameter element with name=&quot;targetIdentifier&quot;. For each matching Patient Resource, the Parameters resource shall include one parameter element with name=&quot;targetId&quot;. The values may be returned in any order..\n                </p>\n\n            </div>\n        </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 5
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use"
    }
  ],
  "url" : "http://profiles.ihe.net/fhir/ihe.pixm.fhir/OperationDefinition/IHE.PIXm.pix",
  "version" : "0.1.2",
  "name" : "IHE_PIXm_pix",
  "title" : "Find patient matches using IHE-PIXm Profile",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2019-07-05",
  "publisher" : "eHealth Suisse",
  "contact" : [
    {
      "name" : "eHealth Suisse",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.e-health-suisse.ch"
        }
      ]
    }
  ],
  "description" : "A Master Patient Index ([MPI](http://en.wikipedia.org/wiki/Enterprise_master_patient_index)    ) 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 to store new patient details as they are encountered. MPIs    are highly specialized applications, often tailored extensively to the institution's particular    mix of patients. MPIs can also be run on a regional and national basis.   To 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 processed by an algorithm of some kind that uses the data    to determine the most appropriate matches in the patient set.  Note 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 an MPI match operation to be performed, but many implementations will    have a set of minimum information, which may be declared in their definition of the $match    operation by specifying a profile on the resource parameter, indicating which properties    are required in the search.  The patient resource submitted to 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, as it is used as the reference    data to match against.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "CH"
        }
      ]
    }
  ],
  "code" : "match",
  "comment" : "The response from an \"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](extension-match-grade   .html)\" that indicates the MPI's position on the match quality.",
  "resource" : [
    "Patient"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "sourceIdentifier",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The Patient identifier search parameter that will be used by the Patient Identifier Cross-reference Manager to find cross matching identifiers associated with the Patient Resource. See Section 3.83.4.1.2.1.",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "name" : "targetSystem",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The target Patient Identifier Assigning Authority from which the returned identifiers should be selected. See Section 3.83.4.1.2.2.",
      "type" : "string",
      "searchType" : "uri"
    },
    {
      "name" : "_format",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The requested format of the response. See ITI TF-2x: Appendix Z.6",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "name" : "targetIdentifier",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "The identifier found. Constraints to include the assigning authority as specified in ITI TF-2x: Appendix E.3",
      "type" : "Identifier"
    },
    {
      "name" : "targetId",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "The URL of the Patient Resource",
      "type" : "Reference"
    }
  ]
}