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 link one Client with another. - XML Representation

Draft as of 2025-10-23

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="lk-link-clients"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition lk-link-clients</b></p><a name="lk-link-clients"> </a><a name="hclk-link-clients"> </a><p>URL: [base]/Patient/$linkClients</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>patientOne</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>An Identifier for one Client.  As system|value.</p>
</div></td></tr><tr><td>IN</td><td>patientTwo</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>An Identifier for the other Client.  As system|value.</p>
</div></td></tr><tr><td>IN</td><td>unlink</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>Indicate that the server should 'unlink' patientTwo from patientOne.  Client one is not the same individual as Client two.  Default is false when not present.</p>
</div></td></tr><tr><td>OUT</td><td>outcome</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/operationoutcome.html">OperationOutcome</a></td><td/><td><div><p>An Operation Outcome with description of results.</p>
</div></td></tr></table></div>
  </text>
  <url
       value="http://ig.hiu.lk/fhir/clientregistry/OperationDefinition/lk-link-clients"/>
  <version value="0.1.0"/>
  <name value="LinkClients"/>
  <title value="Operation to link one Client with another."/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2025-10-23T17:43:42+00:00"/>
  <publisher value="Sir Lanka Ministry of Health"/>
  <contact>
    <name value="Sir Lanka Ministry of Health"/>
    <telecom>
      <system value="url"/>
      <value value="https://www.health.gov.lk"/>
    </telecom>
  </contact>
  <description
               value="This operation is used to link two Clients.  Linking is an internal procedure where the system applies some confirmation and 'links' resource instances with an internal mechanism.  The 'link' is not disclosed or part of any FHIR resource, but a user can confirm the linkage by searching with the identifier list operation."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="LKA"/>
      <display value="Sri Lanka"/>
    </coding>
  </jurisdiction>
  <code value="linkClients"/>
  <resource value="Patient"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="false"/>
  <parameter>
    <name value="patientOne"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="An Identifier for one Client.  As system|value."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="patientTwo"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="An Identifier for the other Client.  As system|value."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="unlink"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Indicate that the server should 'unlink' patientTwo from patientOne.  Client one is not the same individual as Client two.  Default is false when not present."/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="outcome"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="An Operation Outcome with description of results."/>
    <type value="OperationOutcome"/>
  </parameter>
</OperationDefinition>