New Zealand NHI IG
1.6.5 - Release
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
| Draft as of 2023-06-12 |
{
"resourceType" : "OperationDefinition",
"id" : "Patient-add-contact",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition Patient-add-contact</b></p><a name=\"Patient-add-contact\"> </a><a name=\"hcPatient-add-contact\"> </a><p>URL: [base]/Patient/[id]/$add-contact</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>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>home or mobile</p>\n</div></td></tr><tr><td>IN</td><td>system</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>phone or email</p>\n</div></td></tr><tr><td>IN</td><td>value</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 phone number or email address</p>\n</div></td></tr><tr><td>IN</td><td>isValidFormat</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>The format of the email address or phone number is valid (true or false)</p>\n</div></td></tr><tr><td>IN</td><td>isValidDomain</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 domain of the email address is valid (true or false)</p>\n</div></td></tr><tr><td>IN</td><td>isVerified</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Verification has been performed to determine that the email or phone number can be used to communicate with the patient (true or false)</p>\n</div></td></tr><tr><td>IN</td><td>isShared</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 email address or phone number is shared with other people (true or false)</p>\n</div></td></tr><tr><td>IN</td><td>isPrivate</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 email address or phone number may be used to communicate private health information about the individual identified by the NHI</p>\n</div></td></tr><tr><td>IN</td><td>isPrivate</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Additional information about the context of use of this contact</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 contact is added to the nhi record.</p>\n</div></div>"
},
"url" : "https://nhi-ig.hip.digital.health.nz/OperationDefinition/add-contact",
"version" : "1.6.5",
"name" : "Add Contact",
"title" : "Add a contact to 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 add a contact to a patient's NHI record",
"affectsState" : true,
"code" : "add-contact",
"comment" : "The NHI is validated, the versionId is validated, the parameters validated. If all request parameters are valid the new contact is added to the 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" : "use",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "home or mobile",
"type" : "string"
},
{
"name" : "system",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "phone or email",
"type" : "string"
},
{
"name" : "value",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "the phone number or email address",
"type" : "string"
},
{
"name" : "isValidFormat",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The format of the email address or phone number is valid (true or false)",
"type" : "boolean"
},
{
"name" : "isValidDomain",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The domain of the email address is valid (true or false)",
"type" : "string"
},
{
"name" : "isVerified",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Verification has been performed to determine that the email or phone number can be used to communicate with the patient (true or false)",
"type" : "string"
},
{
"name" : "isShared",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The email address or phone number is shared with other people (true or false)",
"type" : "string"
},
{
"name" : "isPrivate",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "The email address or phone number may be used to communicate private health information about the individual identified by the NHI",
"type" : "string"
},
{
"name" : "isPrivate",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "Additional information about the context of use of this contact",
"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"
}
]
}