Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1)
1.28.0-SNAPSHOT - ci-build New Zealand

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) - Local Development build (v1.28.0-SNAPSHOT) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : Patient History - XML Representation

Active as of 2026-08-04

Raw xml | Download

    <OperationDefinition xmlns="http://hl7.org/fhir">
      <id value="Patient-History"/>
      <text>
        <status value="generated"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition Patient-History</b></p><a name="Patient-History"> </a><a name="hcPatient-History"> </a><p>URL: [base]/Patient/$patient-history</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/patient.html">Patient</a></td><td/><td><div><p>The logical id to identify patient/consumer.</p>
    </div></td></tr><tr><td>OUT</td><td>success</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/patient.html">Patient</a></td><td/><td><div><p>The patient/consumer version (as an 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>
      </text>
      <url
           value="https://standards.digital.health.nz/fhir/air/OperationDefinition/patient-history"/>
      <version value="1.28.0-SNAPSHOT"/>
      <name value="patient-history"/>
      <title value="Patient History"/>
      <status value="active"/>
      <kind value="operation"/>
      <experimental value="false"/>
      <date value="2026-08-04T03:40:16+00:00"/>
      <publisher value="Te Whatu Ora"/>
      <contact>
        <name value="Te Whatu Ora"/>
        <telecom>
          <system value="url"/>
          <value value="https://tewhatuora.govt.nz"/>
        </telecom>
      </contact>
      <description
                   value="Fetch all the versions of an ImmSOT Patient/Consumer.

            Modification information is included in the fetched dataset. Input is a valid NHI."/>
      <jurisdiction>
        <coding>
          <system value="urn:iso:std:iso:3166"/>
          <code value="US"/>
          <display value="New Zealand"/>
        </coding>
      </jurisdiction>
      <affectsState value="false"/>
      <code value="patient-history"/>
      <resource value="Patient"/>
      <system value="false"/>
      <type value="true"/>
      <instance value="false"/>
      <parameter>
        <name value="NHI"/>
        <use value="in"/>
        <min value="1"/>
        <max value="1"/>
        <documentation value="The logical id to identify patient/consumer."/>
        <type value="Patient"/>
      </parameter>
      <parameter>
        <name value="success"/>
        <use value="out"/>
        <min value="0"/>
        <max value="*"/>
        <documentation
                       value="The patient/consumer version (as an 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>