CH EPR FHIR (R4)
4.0.1-ballot-2 - ballot
CH EPR FHIR (R4)
4.0.1-ballot-2 - ballot
CH EPR FHIR (R4), published by eHealth Suisse. This guide is not an authorized publication; it is the continuous build for version 4.0.1-ballot-2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ehealthsuisse/ch-epr-fhir/ and changes regularly. See the Directory of published versions
| Draft as of 2024-11-19 |
{
"resourceType" : "OperationDefinition",
"id" : "CHPDQmMatch",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition CHPDQmMatch</b></p><a name=\"CHPDQmMatch\"> </a><a name=\"hcCHPDQmMatch\"> </a><a name=\"CHPDQmMatch-en-US\"> </a><p>URL: [base]/Patient/$match</p><p>Input parameters Profile:<a href=\"StructureDefinition-CHPDQmMatchParametersIn.html\">CH PDQm Match Input Parameters Profile</a></p><p>Output parameters Profile:<a href=\"StructureDefinition-ch-pdqm-matchparametersout.html\">CH PDQm Match Output Bundle 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>resource</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></td><td/><td><div><p>Use this to provide an entire set of patient details for the MPI to match against (e.g. POST a patient record to Patient/$match).</p>\n</div></td></tr><tr><td>IN</td><td>onlyCertainMatches</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>If there are multiple potential matches, then the match SHOULD not return the results with this flag set to true. When false, the server MAY return multiple results with each result graded accordingly.</p>\n</div></td></tr><tr><td>IN</td><td>count</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td><div><p>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.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>A bundle contain a set of Patient records that represent possible matches, optionally it MAY also contain an OperationOutcome with further information about the search results (such as warnings or information messages, such as a count of records that were close but eliminated) If the operation was unsuccessful, then an OperationOutcome MAY be returned along with a BadRequest status Code (e.g. security issue, or insufficient properties in patient fragment - check against profile).</p>\n<p>Note: as this is the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource</p>\n</div></td></tr></table></div>"
},
"url" : "http://fhir.ch/ig/ch-epr-fhir/OperationDefinition/CHPDQmMatch",
"version" : "4.0.1-ballot-2",
"name" : "Find_Patient_Matches_PDQm",
"title" : "CH PDQm $Match",
"status" : "draft",
"kind" : "operation",
"date" : "2024-11-19T12:10:13+00:00",
"publisher" : "eHealth Suisse",
"contact" : [
{
"name" : "eHealth Suisse",
"telecom" : [
{
"system" : "url",
"value" : "https://www.e-health-suisse.ch"
}
]
}
],
"description" : "This operation implements the [Patient Demographics Match \\[ITI-119\\]](iti-119.html) transaction.\nIt is fully compatible with the [$match Operation on Patient](http://hl7.org/fhir/R4/patient-operation-match.html).\nThe only changes are to constrain the input parameters to use the [PDQm Patient Profile for $match Input](StructureDefinition-CHPDQmMatchInput.html) profile\nand to constring the output parameters to use the [PDQm Patient Profile](StructureDefinition-ch-pdqm-patient.html) profile.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "CH"
}
]
}
],
"affectsState" : false,
"code" : "match",
"base" : "http://hl7.org/fhir/OperationDefinition/Patient-match",
"resource" : [
"Patient"
],
"system" : false,
"type" : true,
"instance" : false,
"inputProfile" : "http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/CHPDQmMatchParametersIn",
"outputProfile" : "http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-pdqm-matchparametersout",
"parameter" : [
{
"name" : "resource",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Use this to provide an entire set of patient details for the MPI to match against (e.g. POST a patient record to Patient/$match).",
"type" : "Patient"
},
{
"name" : "onlyCertainMatches",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "If there are multiple potential matches, then the match SHOULD not return the results with this flag set to true. When false, the server MAY return multiple results with each result graded accordingly.",
"type" : "boolean"
},
{
"name" : "count",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "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.",
"type" : "integer"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"documentation" : "A bundle contain a set of Patient records that represent possible matches, optionally it MAY also contain an OperationOutcome with further information about the search results (such as warnings or information messages, such as a count of records that were close but eliminated) If the operation was unsuccessful, then an OperationOutcome MAY be returned along with a BadRequest status Code (e.g. security issue, or insufficient properties in patient fragment - check against profile).\n\nNote: as this is the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource",
"type" : "Bundle"
}
]
}