CHPDQmMatch
type: OperationDefinition
node role: treeRoot
id:
  v: CHPDQmMatch
text:
  status:
    v: generated
  div:
    v: Generated Narrative: OperationDefinition CHPDQmMatch URL: [base]/Patient/$match Parameters Use Name Scope Cardinality Type Binding Documentation IN resource 1..1 Patient (CH PDQm Patient) 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). IN onlyCertainMatches 0..1 boolean 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. IN count 0..1 integer 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. OUT return 1..1 Bundle (CH PDQm Match Output Bundle Profile) 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). 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
url:
  v: http://fhir.ch/ig/ch-epr-fhir/OperationDefinition/CHPDQmMatch
  l: CHPDQmMatch
version:
  v: 5.0.0
name:
  v: Find_Patient_Matches_PDQm
title:
  v: CH PDQm $Match
status:
  v: active
kind:
  v: operation
date:
  v: 2025-12-18T15:42:00+00:00
publisher:
  v: eHealth Suisse
contact:
  name:
    v: eHealth Suisse
  telecom:
    system:
      v: url
    value:
      v: https://www.e-health-suisse.ch
contact:
  name:
    v: eHealth Suisse
  telecom:
    system:
      v: url
    value:
      v: https://www.e-health-suisse.ch
    use:
      v: work
description:
  v: This operation implements the [Patient Demographics Match \[ITI-119\]](iti-119.html) transaction. It is fully compatible with the [$match Operation on Patient](http://hl7.org/fhir/R4/patient-operation-match.html). The only changes are to constrain the input parameters to use the [PDQm Patient Profile for $match Input](StructureDefinition-CHPDQmMatchInput.html) profile and to constrain the output parameters to use the [PDQm Patient Profile](StructureDefinition-ch-pdqm-patient.html) profile.
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
      l: 3166
    code:
      v: CH
affects state:
  v: false
code:
  v: match
base:
  v: http://hl7.org/fhir/OperationDefinition/Patient-match
  l: Patient-match
resource:
  v: Patient
system:
  v: false
type:
  v: true
instance:
  v: false
parameter:
  name:
    v: resource
  use:
    v: in
  min:
    v: 1
  max:
    v: 1
  documentation:
    v: 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:
    v: Patient
  target profile:
    v: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-pdqm-patient
    l: ch-pdqm-patient
parameter:
  name:
    v: onlyCertainMatches
  use:
    v: in
  min:
    v: 0
  max:
    v: 1
  documentation:
    v: 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:
    v: boolean
parameter:
  name:
    v: count
  use:
    v: in
  min:
    v: 0
  max:
    v: 1
  documentation:
    v: 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:
    v: integer
parameter:
  name:
    v: return
  use:
    v: out
  min:
    v: 1
  max:
    v: 1
  documentation:
    v: 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). 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
  type:
    v: Bundle
  target profile:
    v: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-pdqm-matchparametersout
    l: ch-pdqm-matchparametersout