New Zealand NHI IG
1.6.5 - Release

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

## : Set patient's preferred name - XML Representation

Draft as of 2023-06-12

Raw xml | Download

    <OperationDefinition xmlns="http://hl7.org/fhir">
      <id value="Patient-set-preferred-name"/>
      <text>
        <status value="generated"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition Patient-set-preferred-name</b></p><a name="Patient-set-preferred-name"> </a><a name="hcPatient-set-preferred-name"> </a><p>URL: [base]/Patient/[id]/$set-preferred-name</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>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>preferred-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 of the name element to be set to be the preferred name (patient.name.id)</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 name.id is validated. If all request parameters are valid the name.preferred boolean is set to TRUE on the requested name and FALSE on the current preferred name.</p>
    </div></div>
      </text>
      <url
           value="https://nhi-ig.hip.digital.health.nz/OperationDefinition/set-preferred-name"/>
      <version value="1.6.5"/>
      <name value="Set Preferred Nam"/>
      <title value="Set patient's preferred name"/>
      <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="Inactivate name"/>
      <affectsState value="true"/>
      <code value="set-preferred-name"/>
      <comment
               value="The NHI is validated, the versionId is validated, the name.id is validated. If all request parameters are valid the name.preferred boolean is set to TRUE on the requested name and FALSE on the current preferred name."/>
      <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="preferred-id"/>
        <use value="in"/>
        <min value="1"/>
        <max value="1"/>
        <documentation
                       value="The id of the name element to be set to be the preferred name (patient.name.id)"/>
        <type value="integer"/>
      </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>