New Zealand HPI Implementation Guide
1.5.0 - Release
New Zealand HPI Implementation Guide, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 1.5.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. 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 "Practitioner-update-core"] ; #
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 Practitioner-update-core</b></p><a name=\"Practitioner-update-core\"> </a><a name=\"hcPractitioner-update-core\"> </a><a name=\"Practitioner-update-core-en-US\"> </a><p>URL: [base]/Practitioner/[id]/$practitioner-update-core</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>cpn</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 hpi-person-id (cpn)</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 Practitioner record version number</p>\n</div></td></tr><tr><td>IN</td><td>ra-identifier</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 RA identifier</p>\n</div></td></tr><tr><td>IN</td><td>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>An update replaces the full set of name attributes (use, prefix, given, family)</p>\n</div></td></tr><tr><td>IN</td><td>death-date</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 Provider's date of death, can only be set by an admin user</p>\n</div></td></tr><tr><td>IN</td><td>birth-date</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 Provider's birthdate, can only be set by an admin user</p>\n</div></td></tr><tr><td>OUT</td><td>Practitioner</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/practitioner.html\">Practitioner</a></td><td/><td><div><p>The updated Practitioner 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 cpn is validated, the versionId is validated. If all request parameters are valid If all request parameters are valid, then the parameter is replaced on the record</p>\n</div></div>"
] ; #
fhir:url [ fhir:v "https://hpi-ig.hip.digital.health.nz/OperationDefinition/practitioner-update-core"^^xsd:anyURI] ; #
fhir:version [ fhir:v "1.0.0"] ; #
fhir:name [ fhir:v "Update Core "] ; #
fhir:title [ fhir:v "Updates a health provider's name, birthdate and death-date."] ; #
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 "Updates a health provider's name, birthdate, death-date"] ; #
fhir:affectsState [ fhir:v "true"^^xsd:boolean] ; #
fhir:code [ fhir:v "practitioner-update-core"] ; #
fhir:comment [ fhir:v "The cpn is validated, the versionId is validated. If all request parameters are valid If all request parameters are valid, then the parameter is replaced on the record"] ; #
fhir:resource ( [ fhir:v "Practitioner"] ) ; #
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 "cpn" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The hpi-person-id (cpn)" ] ;
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 Practitioner record version number" ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "ra-identifier" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The RA identifier" ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "name" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "An update replaces the full set of name attributes (use, prefix, given, family)" ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "death-date" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The Provider's date of death, can only be set by an admin user" ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "birth-date" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The Provider's birthdate, can only be set by an admin user" ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "Practitioner" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The updated Practitioner resource" ] ;
fhir:type [ fhir:v "Practitioner" ]
] [
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 tewhatuora.hpi#1.5.0 based on FHIR 4.0.1. Generated 2024-12-17
Links: Table of Contents |
QA Report