New Zealand NHI IG
1.6.1 - Release
New Zealand NHI IG
1.6.1 - Release
New Zealand NHI IG - Local Development build (v1.6.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2023-06-12 |
{
"resourceType" : "OperationDefinition",
"id" : "Patient-replace-name",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition Patient-replace-name</b></p><a name=\"Patient-replace-name\"> </a><a name=\"hcPatient-replace-name\"> </a><a name=\"Patient-replace-name-en-US\"> </a><p>URL: [base]/Patient/[id]/$replace-name</p><p>Parameters</p><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>replace-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 for the name on the nhi to be replaced</p>\n</div></td></tr><tr><td>IN</td><td>use</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 name use qualifier for a name</p>\n</div></td></tr><tr><td>IN</td><td>prefix</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 name prefix</p>\n</div></td></tr><tr><td>IN</td><td>given-1</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 first or given name</p>\n</div></td></tr><tr><td>IN</td><td>given-2</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 middle or other given name(s)</p>\n</div></td></tr><tr><td>IN</td><td>family</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 family name</p>\n</div></td></tr><tr><td>IN</td><td>preferred</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>attribute used to indicate whether the name is preferred or not</p>\n</div></td></tr><tr><td>IN</td><td>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 name</p>\n</div></td></tr><tr><td>IN</td><td>nhi-name-use-extra</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>an attribute used to qualify pre-allocated and babyof names</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 new name is added to the nhi record, and the old one is removed.</p>\n</div></div>"
},
"url" : "https://nhi-ig.hip.digital.health.nz/OperationDefinition/replace-name",
"version" : "1.6.1",
"name" : "Replace Name",
"title" : "Replace a name on a patient's NHI record.",
"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" : "replace-name",
"comment" : "The NHI is validated, the versionId is validated, the parameters validated. If all request parameters are valid the new name is added to the nhi record, and the old one is removed.",
"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" : "replace-id",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "The id for the name on the nhi to be replaced",
"type" : "integer"
},
{
"name" : "use",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "the name use qualifier for a name",
"type" : "string"
},
{
"name" : "prefix",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "the name prefix",
"type" : "string"
},
{
"name" : "given-1",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "the first or given name",
"type" : "string"
},
{
"name" : "given-2",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "the middle or other given name(s)",
"type" : "string"
},
{
"name" : "family",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "the family name",
"type" : "string"
},
{
"name" : "preferred",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "attribute used to indicate whether the name is preferred or not",
"type" : "string"
},
{
"name" : "information-source",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The information source for the patient's name",
"type" : "string"
},
{
"name" : "nhi-name-use-extra",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "an attribute used to qualify pre-allocated and babyof names",
"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"
}
]
}