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 |
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:OperationDefinition ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "Patient-update-birth"] ; #
fhir:text [
fhir:status [ fhir:v "generated" ] ;
fhir: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><a name=\"Patient-update-birth-en-US\"> </a><p>URL: [base]/Patient/[id]/$update-birth</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>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>"
] ; #
fhir:url [ fhir:v "https://nhi-ig.hip.digital.health.nz/OperationDefinition/update-birth"^^xsd:anyURI] ; #
fhir:version [ fhir:v "1.6.1"] ; #
fhir:name [ fhir:v "Update Birth Details"] ; #
fhir:title [ fhir:v "Update patient's birth details"] ; #
fhir:status [ fhir:v "draft"] ; #
fhir:kind [ fhir:v "operation"] ; #
fhir:experimental [ fhir:v "false"^^xsd:boolean] ; #
fhir:date [ fhir:v "2023-06-12T12:47:40+10:00"^^xsd:dateTime] ; #
fhir:publisher [ fhir:v "Te Whatu Ora"] ; #
fhir:contact ( [
fhir:name [ fhir:v "Te Whatu Ora" ] ;
( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "mailto:integration@health.govt.nz" ] ] )
] ) ; #
fhir:description [ fhir:v "Update patient's birth details."] ; #
fhir:affectsState [ fhir:v "true"^^xsd:boolean] ; #
fhir:code [ fhir:v "update-birth"] ; #
fhir:comment [ fhir:v "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."] ; #
fhir:resource ( [ fhir:v "Patient"] ) ; #
fhir:system [ fhir:v "false"^^xsd:boolean] ; #
fhir:type [ fhir:v "false"^^xsd:boolean] ; #
fhir:instance [ fhir:v "true"^^xsd:boolean] ; #
fhir:parameter ( [
fhir:name [ fhir:v "nhi" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The Patient's nhi number" ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "version-id" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The current value of the patient resources meta.versionId" ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "birthdate" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The patient's date of birth" ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "birthdate-information-source" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The information source for the patient's date of birth" ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "country-of-birth" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The patient's country of birth" ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "country-of-birth-information-source" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The information source for the patient's country of birth" ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "place-of-birth" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The place where the person as born, E.g. Whangārei. Only populate if country-of-birth is populated" ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "return" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The updated patient resource" ] ;
fhir:type [ fhir:v "Patient" ]
] [
fhir:name [ fhir:v "failure" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Error response" ] ;
fhir:type [ fhir:v "OperationOutcome" ]
] ) . #
IG © 2020+ Te Whatu Ora. Package hl7.org.nz.fhir.ig.nhi#1.6.1 based on FHIR 4.0.1. Generated 2024-09-04
Links: Table of Contents |
QA Report