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

## : Set patient's preferred name - JSON Representation

Draft as of 2023-06-12

Raw json | Download

    {
      "resourceType" : "OperationDefinition",
      "id" : "Patient-set-preferred-name",
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition Patient-set-preferred-name</b></p><a name=\"Patient-set-preferred-name\"> </a><a name=\"hcPatient-set-preferred-name\"> </a><p>URL: [base]/Patient/[id]/$set-preferred-name</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>preferred-id</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td><div><p>The id of the name element to be set to be the preferred name (patient.name.id)</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 name.id is validated. If all request parameters are valid the name.preferred boolean is set to TRUE on the requested name and FALSE on the current preferred name.</p>\n</div></div>"
      },
      "url" : "https://nhi-ig.hip.digital.health.nz/OperationDefinition/set-preferred-name",
      "version" : "1.6.5",
      "name" : "Set Preferred Nam",
      "title" : "Set patient's preferred name",
      "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" : "Inactivate name",
      "affectsState" : true,
      "code" : "set-preferred-name",
      "comment" : "The NHI is validated, the versionId is validated, the name.id is validated. If all request parameters are valid the name.preferred boolean is set to TRUE on the requested name and FALSE on the current preferred name.",
      "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" : "preferred-id",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "The id of the name element to be set to be the preferred name (patient.name.id)",
          "type" : "integer"
        },
        {
          "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"
        }
      ]
    }