New Zealand NHI IG - Local Development build (v1.5.4) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Replace a name on a patient's NHI record. - XML Representation

Draft as of 2023-06-12

Raw xml | Download

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Patient-replace-name"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/Patient/[id]/$replace-name</p><p>Parameters</p><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>nhi</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The Patient's nhi number</p>
</div></td></tr><tr><td>IN</td><td>version-id</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The current value of the patient resources meta.versionId</p>
</div></td></tr><tr><td>IN</td><td>replace-id</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#integer">integer</a></td><td/><td><div><p>The id for the name on the nhi to be replaced</p>
</div></td></tr><tr><td>IN</td><td>use</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>the name use qualifier for a name</p>
</div></td></tr><tr><td>IN</td><td>prefix</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>the name prefix</p>
</div></td></tr><tr><td>IN</td><td>given-1</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>the first or given name</p>
</div></td></tr><tr><td>IN</td><td>given-2</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>the middle or other given name(s)</p>
</div></td></tr><tr><td>IN</td><td>family</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>the family name</p>
</div></td></tr><tr><td>IN</td><td>preferred</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>attribute used to indicate whether the name is preferred or not</p>
</div></td></tr><tr><td>IN</td><td>information-source</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The information source for the patient's name</p>
</div></td></tr><tr><td>IN</td><td>nhi-name-use-extra</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>an attribute used to qualify pre-allocated and babyof names</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/patient.html">Patient</a></td><td/><td><div><p>The updated patient resource</p>
</div></td></tr><tr><td>OUT</td><td>failure</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/operationoutcome.html">OperationOutcome</a></td><td/><td><div><p>Error response</p>
</div></td></tr></table><div><p>The NHI is validated, the versionId is validated, the parameters validated. If all request parameters are valid the new name is added to the nhi record, and the old one is removed.</p>
</div></div>
  </text>
  <url
       value="https://nhi-ig.hip.digital.health.nz/OperationDefinition/replace-name"/>
  <version value="1.5.4"/>
  <name value="Replace Name"/>
  <title value="Replace a name on a patient's NHI record."/>
  <status value="draft"/>
  <kind value="operation"/>
  <experimental value="false"/>
  <date value="2023-06-12T12:47:40+10:00"/>
  <publisher value="Te Whatu Ora"/>
  <contact>
    <name value="Te Whatu Ora"/>
    <telecom>
      <system value="email"/>
      <value value="mailto:integration@health.govt.nz"/>
    </telecom>
  </contact>
  <description
               value="An operation to to replace a name on a patient's record."/>
  <affectsState value="true"/>
  <code value="replace-name"/>
  <comment
           value="The NHI is validated, the versionId is validated, the parameters validated. If all request parameters are valid the new name is added to the nhi record, and the old one is removed."/>
  <resource value="Patient"/>
  <system value="false"/>
  <type value="false"/>
  <instance value="true"/>
  <parameter>
    <name value="nhi"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The Patient's nhi number"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="version-id"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The current value of the patient resources meta.versionId"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="replace-id"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The id for the name on the nhi to be replaced"/>
    <type value="integer"/>
  </parameter>
  <parameter>
    <name value="use"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="the name use qualifier for a name"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="prefix"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="the name prefix"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="given-1"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="the first or given name"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="given-2"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="the middle or other given name(s)"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="family"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="the family name"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="preferred"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="attribute used to indicate whether the name is preferred or not"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="information-source"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The information source for the patient's name"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="nhi-name-use-extra"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="an attribute used to qualify pre-allocated and babyof names"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The updated patient resource"/>
    <type value="Patient"/>
  </parameter>
  <parameter>
    <name value="failure"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Error response"/>
    <type value="OperationOutcome"/>
  </parameter>
</OperationDefinition>