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 a patient's address. - JSON Representation

Draft as of 2023-06-12

Raw json | Download

    {
      "resourceType" : "OperationDefinition",
      "id" : "Patient-set-address",
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition Patient-set-address</b></p><a name=\"Patient-set-address\"> </a><a name=\"hcPatient-set-address\"> </a><p>URL: [base]/Patient/[id]/$set-address</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>address-type</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Must be physical or postal</p>\n</div></td></tr><tr><td>IN</td><td>nz-address-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 id of the validated address as returned by the eSAM address service</p>\n</div></td></tr><tr><td>IN</td><td>address-line</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 first line of the validated address as returned by eSAM</p>\n</div></td></tr><tr><td>IN</td><td>address-building-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>Building name if required as additional address information, not returned by eSAM</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 address is validated and the patient address is updated.</p>\n</div></div>"
      },
      "url" : "https://nhi-ig.hip.digital.health.nz/OperationDefinition/set-address",
      "version" : "1.6.5",
      "name" : "Set Address",
      "title" : "Update a patient's address.",
      "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" : "An operation to to replace a name on a patient's record.",
      "affectsState" : true,
      "code" : "set-address",
      "comment" : "The address is validated and the patient address is updated.",
      "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" : "address-type",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "Must be physical or postal",
          "type" : "string"
        },
        {
          "name" : "nz-address-id",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "The id of the validated address as returned by the eSAM address service",
          "type" : "string"
        },
        {
          "name" : "address-line",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "The first line of the validated address as returned by eSAM",
          "type" : "string"
        },
        {
          "name" : "address-building-name",
          "use" : "in",
          "min" : 0,
          "max" : "1",
          "documentation" : "Building name if required as additional address information, not returned by eSAM",
          "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"
        }
      ]
    }