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

## : Update patient's birth details - JSON Representation

Draft as of 2023-06-12

Raw json | Download

    {
      "resourceType" : "OperationDefinition",
      "id" : "Patient-update-birth",
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition Patient-update-birth</b></p><a name=\"Patient-update-birth\"> </a><a name=\"hcPatient-update-birth\"> </a><p>URL: [base]/Patient/[id]/$update-birth</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>\n</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>\n</div></td></tr><tr><td>IN</td><td>birthdate</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 patient's date of birth</p>\n</div></td></tr><tr><td>IN</td><td>birthdate-information-source</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 information source for the patient's date of birth</p>\n</div></td></tr><tr><td>IN</td><td>country-of-birth</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 patient's country of birth</p>\n</div></td></tr><tr><td>IN</td><td>country-of-birth-information-source</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 information source for the patient's country of birth</p>\n</div></td></tr><tr><td>IN</td><td>place-of-birth</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 place where the person as born, E.g. Whangārei. Only populate if country-of-birth is populated</p>\n</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>\n</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>\n</div></td></tr></table><div><p>The NHI is validated, the versionId is validated, the parameters validated. If all request parameters are valid the included items are updated on the Patients NHI record.</p>\n</div></div>"
      },
      "url" : "https://nhi-ig.hip.digital.health.nz/OperationDefinition/update-birth",
      "version" : "1.6.5",
      "name" : "Update Birth Details",
      "title" : "Update patient's birth details",
      "status" : "draft",
      "kind" : "operation",
      "experimental" : false,
      "date" : "2023-06-12T12:47:40+10:00",
      "publisher" : "Te Whatu Ora",
      "contact" : [
        {
          "name" : "Te Whatu Ora",
          "telecom" : [
            {
              "system" : "email",
              "value" : "mailto:integration@health.govt.nz"
            }
          ]
        }
      ],
      "description" : "Update patient's birth details.",
      "affectsState" : true,
      "code" : "update-birth",
      "comment" : "The NHI is validated, the versionId is validated, the parameters validated. If all request parameters are valid the included items are updated on the Patients NHI record.",
      "resource" : [
        "Patient"
      ],
      "system" : false,
      "type" : false,
      "instance" : true,
      "parameter" : [
        {
          "name" : "nhi",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "The Patient's nhi number",
          "type" : "string"
        },
        {
          "name" : "version-id",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "The current value of the patient resources meta.versionId",
          "type" : "string"
        },
        {
          "name" : "birthdate",
          "use" : "in",
          "min" : 0,
          "max" : "1",
          "documentation" : "The patient's date of birth",
          "type" : "string"
        },
        {
          "name" : "birthdate-information-source",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "The information source for the patient's date of birth",
          "type" : "string"
        },
        {
          "name" : "country-of-birth",
          "use" : "in",
          "min" : 0,
          "max" : "1",
          "documentation" : "The patient's country of birth",
          "type" : "string"
        },
        {
          "name" : "country-of-birth-information-source",
          "use" : "in",
          "min" : 0,
          "max" : "1",
          "documentation" : "The information source for the patient's country of birth",
          "type" : "string"
        },
        {
          "name" : "place-of-birth",
          "use" : "in",
          "min" : 0,
          "max" : "1",
          "documentation" : "The place where the person as born, E.g. Whangārei. Only populate if country-of-birth is populated",
          "type" : "string"
        },
        {
          "name" : "return",
          "use" : "out",
          "min" : 0,
          "max" : "1",
          "documentation" : "The updated patient resource",
          "type" : "Patient"
        },
        {
          "name" : "failure",
          "use" : "out",
          "min" : 0,
          "max" : "1",
          "documentation" : "Error response",
          "type" : "OperationOutcome"
        }
      ]
    }