# Patient History - Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) v1.27.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **Patient History**

## OperationDefinition: Patient History 

| | |
| :--- | :--- |
| *Official URL*:https://standards.digital.health.nz/fhir/air/OperationDefinition/patient-history | *Version*:1.27.0 |
| Active as of 2026-08-05 | *Computable Name*:patient-history |

 
Fetch all the versions of an ImmSOT Patient/Consumer. 

```
    Modification information is included in the fetched dataset. Input is a valid NHI.

```

 



## Resource Content

```json
{
  "resourceType" : "OperationDefinition",
  "id" : "Patient-History",
  "url" : "https://standards.digital.health.nz/fhir/air/OperationDefinition/patient-history",
  "version" : "1.27.0",
  "name" : "patient-history",
  "title" : "Patient History",
  "status" : "active",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2026-08-05T01:54:22+00:00",
  "publisher" : "Te Whatu Ora",
  "contact" : [{
    "name" : "Te Whatu Ora",
    "telecom" : [{
      "system" : "url",
      "value" : "https://tewhatuora.govt.nz"
    }]
  }],
  "description" : "Fetch all the versions of an ImmSOT Patient/Consumer.\n\n        Modification information is included in the fetched dataset. Input is a valid NHI.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US",
      "display" : "New Zealand"
    }]
  }],
  "affectsState" : false,
  "code" : "patient-history",
  "resource" : ["Patient"],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [{
    "name" : "NHI",
    "use" : "in",
    "min" : 1,
    "max" : "1",
    "documentation" : "The logical id to identify patient/consumer.",
    "type" : "Patient"
  },
  {
    "name" : "success",
    "use" : "out",
    "min" : 0,
    "max" : "*",
    "documentation" : "The patient/consumer version (as an Patient resource).",
    "type" : "Patient"
  },
  {
    "name" : "failure",
    "use" : "out",
    "min" : 0,
    "max" : "1",
    "documentation" : "Error response",
    "type" : "OperationOutcome"
  }]
}

```
