FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: OperationDefinition/bc-patient-merge

Packagefhir.ca-bc.client
Resource TypeOperationDefinition
Idbc-patient-merge
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=fhir.ca-bc.client@1.0.1&canonical=http://hlth.gov.bc.ca/fhir/client/OperationDefinition/bc-patient-merge
URLhttp://hlth.gov.bc.ca/fhir/client/OperationDefinition/bc-patient-merge
Version1.0.0
Statusdraft
Date2025-02-07T23:01:35+00:00
NameMergePatient
TitleMerge Patient
Realmus
Authorityhl7
DescriptionThis operation is used to merge patients.
Typetrue
Kindoperation

Resources that use this resource

CapabilityStatement
bc-hcim-capability-statement-serverBC HCIM Server Capability Statement

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition bc-patient-merge

URL: [base]/Patient/$Merge

Input parameters Profile:Parameters

Output parameters Profile:Parameters

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INsource-patient0..1Patient

A direct resource reference to the source patient resource (this may include an identifier).

INsource-patient-identifier0..*Identifier

When source-patient-identifiers are provided, the server is expected to perform an internal lookup to identify the source patient record. The server SHALL reject the request if the provided identifiers do not resolve to a single patient record. This resolution MAY occur asynchronously, for example, as a part of a review by a user.

INtarget-patient0..1Patient

A direct resource reference to the target patient resource. This is the surviving patient resource, the target for the merge.

INtarget-patient-identifier0..*Identifier

When target-patient-identifiers are provided, the server is expected to perform an internal lookup to identify the target patient record. The server SHALL reject the request if the provided identifiers do not resolve to a single patient record. This resolution MAY occur asynchronously, for example, as a part of a review by a user.

INresult-patient0..1Patient

The details of the Patient resource that is expected to be updated to complete with and must have the same patient.id and provided identifiers included. This resource MUST have the link property included referencing the source patient resource. It will be used to perform an update on the target patient resource. In the absence of this parameter the servers should copy all identifiers from the source patient into the target patient, and include the link property. This is often used when properties from the source patient are desired to be included in the target resource. The receiving system may also apply other internal business rules onto the merge which may make the resource different from what is provided here.

OUTreturn1..1Parameters

The Parameters resource will include: The Input parameters to the operation, An OperationOutcome containing errors, warnings, and information messages, The resulting merged Patient resource (or a patient reference if the patient is not committed), Optionally a Task resource to track any additional processing that was required.


Source

{
  "resourceType": "OperationDefinition",
  "id": "bc-patient-merge",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hlth.gov.bc.ca/fhir/client/OperationDefinition/bc-patient-merge",
  "version": "1.0.0",
  "name": "MergePatient",
  "title": "Merge Patient",
  "status": "draft",
  "kind": "operation",
  "date": "2025-02-07T23:01:35+00:00",
  "publisher": "BC Ministry of Health",
  "contact": [
    {
      "name": "BC Ministry of Health",
      "telecom": [
        {
          "system": "url",
          "value": "https://www2.gov.bc.ca/gov/content/governments/organizational-structure/ministries-organizations/ministries/health"
        }
      ]
    }
  ],
  "description": "This operation is used to merge patients.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "CA",
          "display": "Canada"
        }
      ]
    }
  ],
  "code": "Merge",
  "resource": [
    "Patient"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "inputProfile": "http://hl7.org/fhir/StructureDefinition/Parameters",
  "outputProfile": "http://hl7.org/fhir/StructureDefinition/Parameters",
  "parameter": [
    {
      "name": "source-patient",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A direct resource reference to the source patient resource (this may include an identifier).",
      "type": "Patient"
    },
    {
      "name": "source-patient-identifier",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "When source-patient-identifiers are provided, the server is expected to perform an internal lookup to identify the source patient record. The server SHALL reject the request if the provided identifiers do not resolve to a single patient record. This resolution MAY occur asynchronously, for example, as a part of a review by a user.",
      "type": "Identifier"
    },
    {
      "name": "target-patient",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A direct resource reference to the target patient resource. This is the surviving patient resource, the target for the merge.",
      "type": "Patient"
    },
    {
      "name": "target-patient-identifier",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "When target-patient-identifiers are provided, the server is expected to perform an internal lookup to identify the target patient record. The server SHALL reject the request if the provided identifiers do not resolve to a single patient record. This resolution MAY occur asynchronously, for example, as a part of a review by a user.",
      "type": "Identifier"
    },
    {
      "name": "result-patient",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The details of the Patient resource that is expected to be updated to complete with and must have the same patient.id and provided identifiers included. This resource MUST have the link property included referencing the source patient resource. It will be used to perform an update on the target patient resource. In the absence of this parameter the servers should copy all identifiers from the source patient into the target patient, and include the link property. This is often used when properties from the source patient are desired to be included in the target resource. The receiving system may also apply other internal business rules onto the merge which may make the resource different from what is provided here.",
      "type": "Patient"
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The Parameters resource will include: The Input parameters to the operation, An OperationOutcome containing errors, warnings, and information messages, The resulting merged Patient resource (or a patient reference if the patient is not committed), Optionally a Task resource to track any additional processing that was required.",
      "type": "Parameters"
    }
  ]
}