Client Registry Implementation Guide
0.1.0 - ci-build Sri Lanka flag

Client Registry Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: Operation to Merge Patient Instances - JSON Representation

Draft as of 2025-10-23

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "lk-patient-merge",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition lk-patient-merge</b></p><a name=\"lk-patient-merge\"> </a><a name=\"hclk-patient-merge\"> </a><p>URL: [base]/Patient/$merge</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>source-patient</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a> (<a href=\"StructureDefinition-LKPatient.html\" title=\"http://ig.hiu.lk/fhir/clientregistry/StructureDefinition/LKPatient\">LKPatient</a>)</td><td/><td><div><p>The source Patient.</p>\n</div></td></tr><tr><td>IN</td><td>source-patient-identifier</td><td/><td>1..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a></td><td/><td><div><p>The source Patient identifier.</p>\n</div></td></tr><tr><td>IN</td><td>target-patient</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a> (<a href=\"StructureDefinition-LKPatient.html\" title=\"http://ig.hiu.lk/fhir/clientregistry/StructureDefinition/LKPatient\">LKPatient</a>)</td><td/><td><div><p>The surviving Patient resource.</p>\n</div></td></tr><tr><td>IN</td><td>target-patient-identifier</td><td/><td>1..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a></td><td/><td><div><p>The surviving Patient identifier.</p>\n</div></td></tr><tr><td>IN</td><td>result-patient</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a> (<a href=\"StructureDefinition-LKPatient.html\" title=\"http://ig.hiu.lk/fhir/clientregistry/StructureDefinition/LKPatient\">LKPatient</a>)</td><td/><td><div><p>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.</p>\n</div></td></tr><tr><td>IN</td><td>preview</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 this is set to true then the merge will not be actually performed; an OperationOutcome will be returned in the Parameters response that will indicate that no merge has occurred and may include other diagnostic info if desired, such as the scale of the merge.</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/parameters.html\">Parameters</a></td><td/><td><div><p>The returned status and Resources, including the merged Patient resource.  See https://hl7.org/fhir/R5/patient-operation-merge.html for full details.</p>\n</div></td></tr></table></div>"
  },
  "url" : "http://ig.hiu.lk/fhir/clientregistry/OperationDefinition/lk-patient-merge",
  "version" : "0.1.0",
  "name" : "ClientMerge",
  "title" : "Operation to Merge Patient Instances",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2025-10-23T17:43:42+00:00",
  "publisher" : "Sir Lanka Ministry of Health",
  "contact" : [
    {
      "name" : "Sir Lanka Ministry of Health",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.health.gov.lk"
        }
      ]
    }
  ],
  "description" : "This operation is used to merge Patient instances.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "LKA",
          "display" : "Sri Lanka"
        }
      ]
    }
  ],
  "code" : "merge",
  "resource" : [
    "Patient"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "source-patient",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The source Patient.",
      "type" : "Reference",
      "targetProfile" : [
        🔗 "http://ig.hiu.lk/fhir/clientregistry/StructureDefinition/LKPatient"
      ]
    },
    {
      "name" : "source-patient-identifier",
      "use" : "in",
      "min" : 1,
      "max" : "*",
      "documentation" : "The source Patient identifier.",
      "type" : "Identifier"
    },
    {
      "name" : "target-patient",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The surviving Patient resource.",
      "type" : "Reference",
      "targetProfile" : [
        🔗 "http://ig.hiu.lk/fhir/clientregistry/StructureDefinition/LKPatient"
      ]
    },
    {
      "name" : "target-patient-identifier",
      "use" : "in",
      "min" : 1,
      "max" : "*",
      "documentation" : "The surviving Patient identifier.",
      "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.",
      "type" : "Patient",
      "targetProfile" : [
        🔗 "http://ig.hiu.lk/fhir/clientregistry/StructureDefinition/LKPatient"
      ]
    },
    {
      "name" : "preview",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "If this is set to true then the merge will not be actually performed; an OperationOutcome will be returned in the Parameters response that will indicate that no merge has occurred and may include other diagnostic info if desired, such as the scale of the merge.",
      "type" : "boolean"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The returned status and Resources, including the merged Patient resource.  See https://hl7.org/fhir/R5/patient-operation-merge.html for full details.",
      "type" : "Parameters"
    }
  ]
}