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

## : Update a patient address using an unvalidated address. - TTL Representation

Draft as of 2023-06-12

Raw ttl | Download

    @prefix fhir: <http://hl7.org/fhir/> .
    @prefix owl: <http://www.w3.org/2002/07/owl#> .
    @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
    @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-set-unvalidated-address"] ; #
      fhir:text [
    fhir:status [ fhir:v "generated" ] ;
    fhir:div [ fhir:v "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition Patient-set-unvalidated-address</b></p><a name=\"Patient-set-unvalidated-address\"> </a><a name=\"hcPatient-set-unvalidated-address\"> </a><p>URL: [base]/Patient/[id]/$set-unvalidated-address</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>not-validated-address-reason</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 reason the address could not be validated</p>\n</div></td></tr><tr><td>IN</td><td>address-type</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Must be physical or postal</p>\n</div></td></tr><tr><td>IN</td><td>address-line-1</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 first line of the address</p>\n</div></td></tr><tr><td>IN</td><td>address-line-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 first line of the address</p>\n</div></td></tr><tr><td>IN</td><td>address-building-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>Building name if required as additional address information, not returned by eSAM</p>\n</div></td></tr><tr><td>IN</td><td>address-suburb</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td/></tr><tr><td>IN</td><td>address-city</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td/></tr><tr><td>IN</td><td>address-postal-code</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td/></tr><tr><td>IN</td><td>address-country-code</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Must be supplied when not-validated-address-reason = OSEA and must not be ‘NZ’. When not-validated-address-reason not = OSEA and country-code is supplied it must be ‘NZ’</p>\n</div></td></tr><tr><td>IN</td><td>address-domicile-code</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>When supplied it must be a valid code in domicile-code valueset. When not supplied, the suburb and city are used to derive a domicile code from the streets file. If a suburb/city combination is not found in the streets file an error is returned  (note the client end-user can then enter a domicile code or client system can supply a default district domicile code)</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 patient address is updated with an unvalidated address.</p>\n</div></div>"^^rdf:XMLLiteral ]
      ] ; #
      fhir:url [
    fhir:v "https://nhi-ig.hip.digital.health.nz/OperationDefinition/set-unvalidated-address"^^xsd:anyURI ;
    fhir:l <https://nhi-ig.hip.digital.health.nz/OperationDefinition/set-unvalidated-address>
      ] ; #
      fhir:version [ fhir:v "1.6.5"] ; #
      fhir:name [ fhir:v "Set Unvalidated Address"] ; #
      fhir:title [ fhir:v "Update a patient address using an unvalidated address."] ; #
      fhir:status [ fhir:v "draft"] ; #
      fhir:kind [ fhir:v "operation"] ; #
      fhir:experimental [ fhir:v false] ; #
      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 a patient address using an unvalidated address."] ; #
      fhir:affectsState [ fhir:v true] ; #
      fhir:code [ fhir:v "set-unvalidated-address"] ; #
      fhir:comment [ fhir:v "The patient address is updated with an unvalidated address."] ; #
      fhir:resource ( [ fhir:v "Patient"] ) ; #
      fhir:system [ fhir:v false] ; #
      fhir:type [ fhir:v false] ; #
      fhir:instance [ fhir:v true] ; #
      fhir:parameter ( [
    fhir:name [ fhir:v "nhi" ] ;
    fhir:use [ fhir:v "in" ] ;
    fhir:min [ fhir:v 1 ] ;
    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 ] ;
    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 "not-validated-address-reason" ] ;
    fhir:use [ fhir:v "in" ] ;
    fhir:min [ fhir:v 1 ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:documentation [ fhir:v "The reason the address could not be validated" ] ;
    fhir:type [ fhir:v "string" ]
      ] [
    fhir:name [ fhir:v "address-type" ] ;
    fhir:use [ fhir:v "in" ] ;
    fhir:min [ fhir:v 1 ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:documentation [ fhir:v "Must be physical or postal" ] ;
    fhir:type [ fhir:v "string" ]
      ] [
    fhir:name [ fhir:v "address-line-1" ] ;
    fhir:use [ fhir:v "in" ] ;
    fhir:min [ fhir:v 1 ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:documentation [ fhir:v "The first line of the address" ] ;
    fhir:type [ fhir:v "string" ]
      ] [
    fhir:name [ fhir:v "address-line-2" ] ;
    fhir:use [ fhir:v "in" ] ;
    fhir:min [ fhir:v 0 ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:documentation [ fhir:v "The first line of the address" ] ;
    fhir:type [ fhir:v "string" ]
      ] [
    fhir:name [ fhir:v "address-building-name" ] ;
    fhir:use [ fhir:v "in" ] ;
    fhir:min [ fhir:v 0 ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:documentation [ fhir:v "Building name if required as additional address information, not returned by eSAM" ] ;
    fhir:type [ fhir:v "string" ]
      ] [
    fhir:name [ fhir:v "address-suburb" ] ;
    fhir:use [ fhir:v "in" ] ;
    fhir:min [ fhir:v 0 ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:type [ fhir:v "string" ]
      ] [
    fhir:name [ fhir:v "address-city" ] ;
    fhir:use [ fhir:v "in" ] ;
    fhir:min [ fhir:v 0 ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:type [ fhir:v "string" ]
      ] [
    fhir:name [ fhir:v "address-postal-code" ] ;
    fhir:use [ fhir:v "in" ] ;
    fhir:min [ fhir:v 0 ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:type [ fhir:v "string" ]
      ] [
    fhir:name [ fhir:v "address-country-code" ] ;
    fhir:use [ fhir:v "in" ] ;
    fhir:min [ fhir:v 0 ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:documentation [ fhir:v "Must be supplied when not-validated-address-reason = OSEA and must not be ‘NZ’. When not-validated-address-reason not = OSEA and country-code is supplied it must be ‘NZ’ " ] ;
    fhir:type [ fhir:v "string" ]
      ] [
    fhir:name [ fhir:v "address-domicile-code" ] ;
    fhir:use [ fhir:v "in" ] ;
    fhir:min [ fhir:v 0 ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:documentation [ fhir:v "When supplied it must be a valid code in domicile-code valueset. When not supplied, the suburb and city are used to derive a domicile code from the streets file. If a suburb/city combination is not found in the streets file an error is returned  (note the client end-user can then enter a domicile code or client system can supply a default district domicile code)" ] ;
    fhir:type [ fhir:v "string" ]
      ] [
    fhir:name [ fhir:v "return" ] ;
    fhir:use [ fhir:v "out" ] ;
    fhir:min [ fhir:v 0 ] ;
    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 ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:documentation [ fhir:v "Error response" ] ;
    fhir:type [ fhir:v "OperationOutcome" ]
      ] ) . #