New Zealand HPI Implementation Guide
1.5.0 - Release
New Zealand HPI Implementation Guide, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 1.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions
Draft as of 2023-06-12 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="Practitioner-update-core"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition Practitioner-update-core</b></p><a name="Practitioner-update-core"> </a><a name="hcPractitioner-update-core"> </a><a name="Practitioner-update-core-en-US"> </a><p>URL: [base]/Practitioner/[id]/$practitioner-update-core</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>cpn</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 hpi-person-id (cpn)</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 Practitioner record version number</p>
</div></td></tr><tr><td>IN</td><td>ra-identifier</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 RA identifier</p>
</div></td></tr><tr><td>IN</td><td>name</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 update replaces the full set of name attributes (use, prefix, given, family)</p>
</div></td></tr><tr><td>IN</td><td>death-date</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 Provider's date of death, can only be set by an admin user</p>
</div></td></tr><tr><td>IN</td><td>birth-date</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 Provider's birthdate, can only be set by an admin user</p>
</div></td></tr><tr><td>OUT</td><td>Practitioner</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/practitioner.html">Practitioner</a></td><td/><td><div><p>The updated Practitioner 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 cpn is validated, the versionId is validated. If all request parameters are valid If all request parameters are valid, then the parameter is replaced on the record</p>
</div></div>
</text>
<url
value="https://hpi-ig.hip.digital.health.nz/OperationDefinition/practitioner-update-core"/>
<version value="1.0.0"/>
<name value="Update Core "/>
<title value="Updates a health provider's name, birthdate and death-date."/>
<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="Updates a health provider's name, birthdate, death-date"/>
<affectsState value="true"/>
<code value="practitioner-update-core"/>
<comment
value="The cpn is validated, the versionId is validated. If all request parameters are valid If all request parameters are valid, then the parameter is replaced on the record"/>
<resource value="Practitioner"/>
<system value="false"/>
<type value="false"/>
<instance value="true"/>
<parameter>
<name value="cpn"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="The hpi-person-id (cpn)"/>
<type value="string"/>
</parameter>
<parameter>
<name value="version-id"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="The current Practitioner record version number"/>
<type value="string"/>
</parameter>
<parameter>
<name value="ra-identifier"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="The RA identifier"/>
<type value="string"/>
</parameter>
<parameter>
<name value="name"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="An update replaces the full set of name attributes (use, prefix, given, family)"/>
<type value="string"/>
</parameter>
<parameter>
<name value="death-date"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The Provider's date of death, can only be set by an admin user"/>
<type value="string"/>
</parameter>
<parameter>
<name value="birth-date"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The Provider's birthdate, can only be set by an admin user"/>
<type value="string"/>
</parameter>
<parameter>
<name value="Practitioner"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation value="The updated Practitioner resource"/>
<type value="Practitioner"/>
</parameter>
<parameter>
<name value="failure"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<documentation value="Error response"/>
<type value="OperationOutcome"/>
</parameter>
</OperationDefinition>