FHIR New Zealand Patient Summary IG
0.3.0 - ci-build New Zealand flag

FHIR New Zealand Patient Summary IG, published by Health NZ | Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-nzps/ and changes regularly. See the Directory of published versions

: NZPS Summary - TTL Representation

Draft as of 2024-01-01

Raw ttl | Download


@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 "NZPSSummaryOperation"] ; # 
  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 NZPSSummaryOperation</b></p><a name=\"NZPSSummaryOperation\"> </a><a name=\"hcNZPSSummaryOperation\"> </a><a name=\"NZPSSummaryOperation-en-NZ\"> </a><p>URL: [base]/Patient/$summary</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>identifier</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>The NHI number of the patient for whom the summary is being requested. This should be provided with the NHI namespace (e.g. 'https://standards.digital.health.nz/ns/nhi-id|ZZZ0032)</p>\n</div></td></tr><tr><td>IN</td><td>profile</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>The profile for the patient summary being requested. For now, only a single profile is supported - the NZPS Bundle: https://standards.digital.health.nz/fhir/StructureDefinition/nzps-bundle</p>\n</div></td></tr><tr><td>IN</td><td>graph</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>Currently the NZPS summary operation does not require or support a graph definition. This parameter is included for future compatibility if needed.</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/bundle.html\">Bundle</a></td><td/><td><div><p>The Bundle returned is a document conforming to the specified input profile parameter or the NZPS <a href=\"./StructureDefinition-nzps-bundle.html\">Bundle profile</a> (if not otherwise specified)</p>\n</div></td></tr></table></div>"
  ] ; # 
  fhir:url [ fhir:v "https://standards.digital.health.nz/fhir/OperationDefinition/nzps-summary"^^xsd:anyURI] ; # 
  fhir:version [ fhir:v "0.3.0"] ; # 
  fhir:name [ fhir:v "NzpsSummary"] ; # 
  fhir:title [ fhir:v "NZPS Summary"] ; # 
  fhir:status [ fhir:v "draft"] ; # 
  fhir:kind [ fhir:v "operation"] ; # 
  fhir:date [ fhir:v "2024-01-01T13:15:56.964-00:00"^^xsd:dateTime] ; # 
  fhir:publisher [ fhir:v "Health NZ | Te Whatu Ora"] ; # 
  fhir:contact ( [
fhir:name [ fhir:v "Health NZ | Te Whatu Ora" ] ;
    ( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "https://github.com/tewhatuora" ]     ] )
  ] ) ; # 
  fhir:description [ fhir:v "The NZPS uses the $summary operation to allow clients to query by NHI number and be returned an NZPS compliant FHIR document. \n\nThe $summary operation is invoked by POST'ing a Parameters resource containing the NHI number of the patient to the $summary endpoint.\n\nRequest URL:\n\n`POST [base]/Patient/$summary`\n\nExample Parameters body:\n\n` \n[example Parameters resource here]\n`\n\n"] ; # 
  fhir:jurisdiction ( [
    ( fhir:coding [
fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ;
fhir:code [ fhir:v "NZ" ] ;
fhir:display [ fhir:v "New Zealand" ]     ] )
  ] ) ; # 
  fhir:affectsState [ fhir:v "false"^^xsd:boolean] ; # 
  fhir:code [ fhir:v "summary"] ; # 
  fhir:resource ( [ fhir:v "Patient"] ) ; # 
  fhir:system [ fhir:v "false"^^xsd:boolean] ; # 
  fhir:type [ fhir:v "true"^^xsd:boolean] ; # 
  fhir:instance [ fhir:v "false"^^xsd:boolean] ; # 
  fhir:parameter ( [
fhir:name [ fhir:v "identifier" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The NHI number of the patient for whom the summary is being requested. This should be provided with the NHI namespace (e.g. 'https://standards.digital.health.nz/ns/nhi-id|ZZZ0032)" ] ;
fhir:type [ fhir:v "string" ] ;
fhir:searchType [ fhir:v "token" ]
  ] [
fhir:name [ fhir:v "profile" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The profile for the patient summary being requested. For now, only a single profile is supported - the NZPS Bundle: https://standards.digital.health.nz/fhir/StructureDefinition/nzps-bundle" ] ;
fhir:type [ fhir:v "uri" ]
  ] [
fhir:name [ fhir:v "graph" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "Currently the NZPS summary operation does not require or support a graph definition. This parameter is included for future compatibility if needed." ] ;
fhir:type [ fhir:v "uri" ]
  ] [
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 Bundle returned is a document conforming to the specified input profile parameter or the NZPS [Bundle profile](./StructureDefinition-nzps-bundle.html) (if not otherwise specified)" ] ;
fhir:type [ fhir:v "Bundle" ]
  ] ) . #