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

## : Patient-create - XML Representation

Draft as of 2022-05-28

Raw xml | Download

    <OperationDefinition xmlns="http://hl7.org/fhir">
      <id value="Patient-create"/>
      <text>
        <status value="generated"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition Patient-create</b></p><a name="Patient-create"> </a><a name="hcPatient-create"> </a><p>URL: [base]/Patient/$create</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>patient</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/patient.html">Patient</a> (<a href="StructureDefinition-CreateNhiPatient.html" title="http://hl7.org.nz/fhir/StructureDefinition/CreateNhiPatient">Create NHI Patient</a>)</td><td/><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 patient information is validated. If all request parameters are valid the new patient is created in the NHI</p>
    </div></div>
      </text>
      <url
           value="https://nhi-ig.hip.digital.health.nz/OperationDefinition/create-patient"/>
      <version value="1.6.5"/>
      <name value="Create Patient"/>
      <status value="draft"/>
      <kind value="operation"/>
      <date value="2022-05-28T12: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="create a patient in the NHI"/>
      <affectsState value="true"/>
      <code value="create"/>
      <comment
               value="The patient information is validated. If all request parameters are valid the new patient is created in the NHI"/>
      <resource value="Patient"/>
      <system value="false"/>
      <type value="true"/>
      <instance value="false"/>
      <parameter>
        <name value="patient"/>
        <use value="in"/>
        <min value="1"/>
        <max value="1"/>
        <type value="Patient"/>
        <targetProfile
                       value="http://hl7.org.nz/fhir/StructureDefinition/CreateNhiPatient"/>
      </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>