Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : Observation-flat-export - TTL Representation

Draft as of 2026-03-03

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 "Observation-flat-export"] ; #
      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 Observation-flat-export</b></p><a name=\"Observation-flat-export\"> </a><a name=\"hcObservation-flat-export\"> </a><p>URL: [base]/Observation/$flat-export</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>observationProfile</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 Observation FHIR profile to query.</p>\n</div></td></tr><tr><td>IN</td><td>subject</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 NHI that is the target of the query.</p>\n</div></td></tr><tr><td>IN</td><td>period</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Period\">Period</a></td><td/><td><div><p>The period for the query, where start and end are mandatory</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/binary.html\">Binary</a></td><td/><td><div><p>A FHIR Binary resource containing the flat file as base64 encoded data. When decoded, it will contain the patient data in a flat format with the following structure.\n<a href=\"./Binary-ObservationFlatExportResponse.html\">See response example</a>.</p>\n<pre><code class=\"language-json\">[\n  {\n    \"id\": \"1234\",\n    \"effectiveDateTime\": \"2025-04-22\",\n    \"values\": [\n      {\n        \"valueQuantity\": {\n          \"value\": 6.3,\n          \"unit\": \"mmol/l\",\n          \"system\": \"http://unitsofmeasure.org\",\n          \"code\": \"mmol/L\"\n        }\n      }\n    ]\n  },\n  {\n    \"id\": \"5678\",\n    \"effectiveDateTime\": \"2025-04-23\",\n    \"values\": [\n      {\n        \"valueQuantity\": {\n          \"value\": 2.3,\n          \"unit\": \"mmol/l\",\n          \"system\": \"http://unitsofmeasure.org\",\n          \"code\": \"mmol/L\"\n        }\n      },\n      {\n        \"valueString\": \"Normal\"\n      }\n    ]\n  }\n]\n</code></pre>\n<p>The response structure will contain an array of Observation resources, each represented in a flat format with the FHIR resource id, effective date, and value information.\nNote that the values array can contain multiple entries, including any value[x] elements, which can be possible for Observations using components for multiple Observations</p>\n</div></td></tr></table></div>"^^rdf:XMLLiteral
      ] ; #
      fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/Observation-flat-export"^^xsd:anyURI] ; #
      fhir:version [ fhir:v "0.4.5"] ; #
      fhir:name [ fhir:v "flat-export"] ; #
      fhir:status [ fhir:v "draft"] ; #
      fhir:kind [ fhir:v "operation"] ; #
      fhir:date [ fhir:v "2026-03-03T21:51:04+00: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 "url" ] ;
    fhir:value [ fhir:v "https://www.tewhatuora.govt.nz/" ]     ] )
      ] [
    fhir:name [ fhir:v "Te Whatu Ora Integration Team" ] ;
        ( fhir:telecom [
    fhir:system [ fhir:v "email" ] ;
    fhir:value [ fhir:v "integration@tewhatuora.govt.nz" ] ;
    fhir:use [ fhir:v "work" ]     ] )
      ] ) ; #
      fhir:description [ fhir:v "The Observation $flat-export operation exports Observation resources in a flat format.\nSee [request example](./Parameters-ObservationFlatExportRequest.html)."] ; #
      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:code [ fhir:v "flat-export"] ; #
      fhir:resource ( [ fhir:v "Observation"] ) ; #
      fhir:system [ fhir:v false] ; #
      fhir:type [ fhir:v true] ; #
      fhir:instance [ fhir:v false] ; #
      fhir:parameter ( [
    fhir:name [ fhir:v "observationProfile" ] ;
    fhir:use [ fhir:v "in" ] ;
    fhir:min [ fhir:v 1 ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:documentation [ fhir:v "The Observation FHIR profile to query." ] ;
    fhir:type [ fhir:v "string" ]
      ] [
    fhir:name [ fhir:v "subject" ] ;
    fhir:use [ fhir:v "in" ] ;
    fhir:min [ fhir:v 1 ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:documentation [ fhir:v "The Patient NHI that is the target of the query." ] ;
    fhir:type [ fhir:v "string" ]
      ] [
    fhir:name [ fhir:v "period" ] ;
    fhir:use [ fhir:v "in" ] ;
    fhir:min [ fhir:v 1 ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:documentation [ fhir:v "The period for the query, where start and end are mandatory" ] ;
    fhir:type [ fhir:v "Period" ]
      ] [
    fhir:name [ fhir:v "return" ] ;
    fhir:use [ fhir:v "out" ] ;
    fhir:min [ fhir:v 1 ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:documentation [ fhir:v "A FHIR Binary resource containing the flat file as base64 encoded data. When decoded, it will contain the patient data in a flat format with the following structure.\n[See response example](./Binary-ObservationFlatExportResponse.html).\n\n```json\n[\n  {\n    \"id\": \"1234\",\n    \"effectiveDateTime\": \"2025-04-22\",\n    \"values\": [\n      {\n        \"valueQuantity\": {\n          \"value\": 6.3,\n          \"unit\": \"mmol/l\",\n          \"system\": \"http://unitsofmeasure.org\",\n          \"code\": \"mmol/L\"\n        }\n      }\n    ]\n  },\n  {\n    \"id\": \"5678\",\n    \"effectiveDateTime\": \"2025-04-23\",\n    \"values\": [\n      {\n        \"valueQuantity\": {\n          \"value\": 2.3,\n          \"unit\": \"mmol/l\",\n          \"system\": \"http://unitsofmeasure.org\",\n          \"code\": \"mmol/L\"\n        }\n      },\n      {\n        \"valueString\": \"Normal\"\n      }\n    ]\n  }\n]\n```\n\nThe response structure will contain an array of Observation resources, each represented in a flat format with the FHIR resource id, effective date, and value information.\nNote that the values array can contain multiple entries, including any value[x] elements, which can be possible for Observations using components for multiple Observations" ] ;
    fhir:type [ fhir:v "Binary" ]
      ] ) . #