Digital Tooling Implementation Guide
0.0.11 - release

Digital Tooling Implementation Guide - Local Development build (v0.0.11) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: Example Capability Statement - TTL Representation

Draft as of 2024-04-18

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:CapabilityStatement ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:meta [
    ( fhir:profile [
fhir:v "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/hnz-capability-statement"^^xsd:anyURI ;
fhir:link <https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/hnz-capability-statement>     ] )
  ] ; # 
  fhir:text [
fhir:status [ fhir:v "extensions" ] ;
fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement ExampleCapabilityStatement</b></p><a name=\"ExampleCapabilityStatement\"> </a><a name=\"hcExampleCapabilityStatement\"> </a><a name=\"ExampleCapabilityStatement-en-US\"> </a><h2 id=\"title\">Example Capability Statement</h2><ul><li>Implementation Guide Version: 1.1.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-04-18 </li><li>Published by: null </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h3 id=\"shallIGs\">SHALL Support the Following Implementation Guides</h3><ul><li>https://fhir-ig.digital.health.nz/hnz-digital-tooling</li></ul><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>Details the FHIR Server API for Patients. This API allows for the creation, retrieval and searching of Patient resources.</p>\n</div><div class=\"lead\"><em>Security</em></div><div class=\"row\"><div class=\"col-lg-6\">Enable CORS: no</div><div class=\"col-lg-6\">Security services supported: <code>SMART-on-FHIR</code></div></div><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th class=\"text-center\"><b title=\"DELETE a resource (delete interaction)\">D</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Patient1-1\">Patient</a></td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">http://hl7.org/fhir/StructureDefinition/Patient</a><br/><em>Additional supported profiles:</em><br/>  <a href=\"StructureDefinition-example-patient.html\">Example Patient Profile</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td>general-practitioner</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Patient</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-example-patient.html\">Example Patient Profile</a></p></div><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>, <code>create</code>, <code>update</code>, <code>delete</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">general-practitioner</a></td><td><code>reference</code></td><td><div><p>Patient's nominated general practitioner, not the organization that manages the record</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\"> </div></div></div></div></div></div>"
  ] ; # 
  fhir:extension ( [
    ( fhir:extension [
fhir:url [ fhir:v "licenseURL"^^xsd:anyURI ] ;
fhir:value [ fhir:v "https://example.license.org"^^xsd:anyURI ]     ] [
fhir:url [ fhir:v "externalDocs"^^xsd:anyURI ] ;
fhir:value [ fhir:v "https://docs.example.com/fhir"^^xsd:anyURI ]     ] [
fhir:url [ fhir:v "licenseName"^^xsd:anyURI ] ;
fhir:value [ fhir:v "GPLv3" ]     ] [
      ( fhir:extension [
        ( fhir:extension [
fhir:url [ fhir:v "key"^^xsd:anyURI ] ;
fhir:value [ fhir:v "Correlation-Id" ]         ] [
fhir:url [ fhir:v "value"^^xsd:anyURI ] ;
fhir:value [ fhir:v "https://raw.githubusercontent.com/tewhatuora/schemas/main/fhir-definitions-oas/uuid-definition.json"^^xsd:anyURI ]         ] [
fhir:url [ fhir:v "required"^^xsd:anyURI ] ;
fhir:value [ fhir:v "true"^^xsd:boolean ]         ] ) ;
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension"^^xsd:anyURI ]       ] ) ;
fhir:url [ fhir:v "globalHeaders"^^xsd:anyURI ]     ] ) ;
fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension"^^xsd:anyURI ]
  ] ) ; # 
  fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/hnz-digital-tooling/CapabilityStatement/ExampleCapabilityStatement"^^xsd:anyURI] ; # 
  fhir:version [ fhir:v "1.1.0"] ; # 
  fhir:title [ fhir:v "Example Capability Statement"] ; # 
  fhir:status [ fhir:v "draft"] ; # 
  fhir:date [ fhir:v "2024-04-18"^^xsd:date] ; # 
  fhir:contact ( [
fhir:name [ fhir:v "Example Contact Details" ] ;
    ( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "https://example.com" ]     ] )
  ] [
fhir:name [ fhir:v "Email" ] ;
    ( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "test@example.com" ]     ] )
  ] ) ; # 
  fhir:description [ fhir:v "FHIR API for Patients"] ; # 
  fhir:kind [ fhir:v "instance"] ; # 
  fhir:implementation [
fhir:description [ fhir:v "Patient FHIR API" ] ;
fhir:url [ fhir:v "https://example.digital.health.nz/fhir/R4"^^xsd:anyURI ]
  ] ; # 
  fhir:fhirVersion [ fhir:v "4.0.1"] ; # 
  fhir:format ( [ fhir:v "json"] ) ; # 
  fhir:implementationGuide ( [
fhir:v "https://fhir-ig.digital.health.nz/hnz-digital-tooling"^^xsd:anyURI ;
fhir:link <https://fhir-ig.digital.health.nz/hnz-digital-tooling>
  ] ) ; # 
  fhir:rest ( [
fhir:mode [ fhir:v "server" ] ;
fhir:documentation [ fhir:v "Details the FHIR Server API for Patients. This API allows for the creation, retrieval and searching of Patient resources." ] ;
fhir:security [
      ( fhir:extension [
        ( fhir:extension [
fhir:url [ fhir:v "token"^^xsd:anyURI ] ;
fhir:value [ fhir:v "https://auth.example.com/oauth2/token"^^xsd:anyURI ]         ] [
fhir:url [ fhir:v "authorize"^^xsd:anyURI ] ;
fhir:value [ fhir:v "https://auth.example.com/oauth2/authorize"^^xsd:anyURI ]         ] ) ;
fhir:url [ fhir:v "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris"^^xsd:anyURI ]       ] [
fhir:url [ fhir:v "http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities"^^xsd:anyURI ] ;
fhir:value [ fhir:v "client-confidential-symmetric" ]       ] [
fhir:url [ fhir:v "http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities"^^xsd:anyURI ] ;
fhir:value [ fhir:v "permission-user" ]       ] [
fhir:url [ fhir:v "http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities"^^xsd:anyURI ] ;
fhir:value [ fhir:v "permission-patient" ]       ] ) ;
fhir:cors [ fhir:v "false"^^xsd:boolean ] ;
      ( fhir:service [
        ( fhir:coding [
fhir:code [ fhir:v "SMART-on-FHIR" ]         ] )       ] )     ] ;
    ( fhir:resource [
fhir:type [ fhir:v "Patient" ] ;
fhir:profile [
fhir:v "http://hl7.org/fhir/StructureDefinition/Patient"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/StructureDefinition/Patient>       ] ;
      ( fhir:supportedProfile [
fhir:v "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/example-patient"^^xsd:anyURI ;
fhir:link <https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/example-patient>       ] ) ;
      ( fhir:interaction [
fhir:code [ fhir:v "read" ]       ] [
fhir:code [ fhir:v "search-type" ]       ] [
fhir:code [ fhir:v "create" ]       ] [
fhir:code [ fhir:v "update" ]       ] [
fhir:code [ fhir:v "delete" ]       ] ) ;
fhir:versioning [ fhir:v "versioned" ] ;
      ( fhir:searchParam [
fhir:name [ fhir:v "general-practitioner" ] ;
fhir:definition [
fhir:v "http://hl7.org/fhir/SearchParameter/Patient-general-practitioner"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/SearchParameter/Patient-general-practitioner>         ] ;
fhir:type [ fhir:v "reference" ] ;
fhir:documentation [ fhir:v "Patient's nominated general practitioner, not the organization that manages the record" ]       ] )     ] )
  ] ) . #