New Zealand HPI Implementation Guide
1.5.0 - Release

New Zealand HPI Implementation Guide - Local Development build (v1.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: CapabilityStatement - TTL Representation

Draft as of 2020-04-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:CapabilityStatement ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "HpiCapabilityStatement"] ; # 
  fhir:text [
fhir:status [ fhir:v "additional" ] ;
fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\">HPI capabilities</div>"
  ] ; # 
  fhir:url [ fhir:v "https://fhir-ig.digital.health.nz/CapabilityStatement/HpiCapabilityStatement"^^xsd:anyURI] ; # 
  fhir:version [ fhir:v "1.5.0"] ; # 
  fhir:name [ fhir:v "HPI_CapabilityStatement"] ; # 
  fhir:title [ fhir:v "Capability Statement describing HPI FHIR APIs"] ; # 
  fhir:status [ fhir:v "draft"] ; # 
  fhir:date [ fhir:v "2020-04-01"^^xsd:date] ; # 
  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 "This is the computable resource that describes the RESTful endpoint"] ; # 
  fhir:kind [ fhir:v "instance"] ; # 
  fhir:implementation [
fhir:description [ fhir:v "The HPI endpoint" ] ;
fhir:url [ fhir:v "https://api.hip.digital.health.nz/fhir/hpi/v1/"^^xsd:anyURI ]
  ] ; # 
  fhir:fhirVersion [ fhir:v "4.0.1"] ; # 
  fhir:format ( [ fhir:v "json"] ) ; # 
  fhir:rest ( [
fhir:mode [ fhir:v "server" ] ;
    ( fhir:resource [
fhir:type [ fhir:v "Practitioner" ] ;
fhir:profile [
fhir:v "http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner"^^xsd:anyURI ;
fhir:link <http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner>       ] ;
      ( fhir:supportedProfile [
fhir:v "http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner"^^xsd:anyURI ;
fhir:link <http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner>       ] ) ;
fhir:documentation [ fhir:v "Practitioner query\n\n" ] ;
      ( fhir:interaction [
fhir:code [ fhir:v "read" ] ;
fhir:documentation [ fhir:v "GET,  [base]/Practitioner[cpn],  Retrieves a Practitioner resource by Id, system/Practitioner.r" ]       ] [
fhir:code [ fhir:v "search-type" ] ;
fhir:documentation [ fhir:v "GET,[base]/Practitioner, Queries against the Practitioner using name and other search parameters. Will return a Bundle (even if there are no matching resources),system/Practitioner.s " ]       ] [
fhir:code [ fhir:v "create" ] ;
fhir:documentation [ fhir:v "POST',[base]/Practitioner, Creates a new Practitioner record , system/Practitioner.c" ]       ] ) ;
      ( fhir:searchParam [
fhir:name [ fhir:v "identifier" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "For searching a Practitioner resource using their council/board registration number" ]       ] [
fhir:name [ fhir:v "name" ] ;
fhir:type [ fhir:v "string" ] ;
fhir:documentation [ fhir:v "Should contain the person’s full name, include all given names and family name." ]       ] [
fhir:name [ fhir:v "gender" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "Use with name and birthdate. Search by gender alone is not allowed." ]       ] [
fhir:name [ fhir:v "birthdate" ] ;
fhir:type [ fhir:v "date" ] ;
fhir:documentation [ fhir:v "Use with name and gender. Search by birthdate alone is not allowed." ]       ] ) ;
      ( fhir:operation [
fhir:name [ fhir:v "update-core" ] ;
fhir:definition [
fhir:v "https://hpi-ig.hip.digital.health.nz/OperationDefinition/practitioner-update-core"^^xsd:anyURI ;
fhir:link <https://hpi-ig.hip.digital.health.nz/OperationDefinition/practitioner-update-core>         ] ;
fhir:documentation [ fhir:v "POST, [base]/Practitioner[cpn],An operation that updates a health providers demographic details,  system/Practitioner.u" ]       ] )     ] [
fhir:type [ fhir:v "PractitionerRole" ] ;
      ( fhir:supportedProfile [
fhir:v "http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner-role"^^xsd:anyURI ;
fhir:link <http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner-role>       ] ) ;
fhir:documentation [ fhir:v "PractitionerRole query\n" ] ;
      ( fhir:interaction [
fhir:code [ fhir:v "read" ] ;
fhir:documentation [ fhir:v "GET, [base]/PractitionerRole[id], Used to retrieve a PractitionerRole resource by Id, system/PractitionerRole.r" ]       ] [
fhir:code [ fhir:v "search-type" ] ;
fhir:documentation [ fhir:v "GET, [base]/PractitionerRole, Queries against PractitionerRole using hpi-person-id and other parameters. Will return a Bundle (even if there are no matching resources), system/PractitionerRole.s" ]       ] [
fhir:code [ fhir:v "create" ] ;
fhir:documentation [ fhir:v "POST, [base]/PractitionerRole, Create a new PractitionerRole, system/PractitionerRole.c" ]       ] [
fhir:code [ fhir:v "update" ] ;
fhir:documentation [ fhir:v "PUT, [base]/PractitionerRole[id], Update contact details and end date on an existing PractitionerRole record, system/PractitionerRole.u" ]       ] ) ;
      ( fhir:searchInclude [ fhir:v "practitioner" ] [ fhir:v "organization" ] [ fhir:v "location" ] ) ;
      ( fhir:searchParam [
fhir:name [ fhir:v "practitioner" ] ;
fhir:type [ fhir:v "reference" ] ;
fhir:documentation [ fhir:v "Given an hpi-person-id, returns the PractitionerRole records associated with that id" ]       ] [
fhir:name [ fhir:v "organization" ] ;
fhir:type [ fhir:v "reference" ] ;
fhir:documentation [ fhir:v "Not yet enabled. Given an hpi-organization-id, returns the PractitionerRole records associated with that id" ]       ] [
fhir:name [ fhir:v "location" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "Given an hpi-facility-id, returns the PractitionerRole records associated with that id" ]       ] [
fhir:name [ fhir:v "role" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "Returns PractitionerRole records based on role code" ]       ] [
fhir:name [ fhir:v "active" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "To enable exclusion of inactive PractitionerRole records" ]       ] )     ] [
fhir:type [ fhir:v "Organization" ] ;
      ( fhir:supportedProfile [
fhir:v "http://hl7.org.nz/fhir/StructureDefinition/hpi-organization"^^xsd:anyURI ;
fhir:link <http://hl7.org.nz/fhir/StructureDefinition/hpi-organization>       ] ) ;
fhir:documentation [ fhir:v "Organization query\n" ] ;
      ( fhir:interaction [
fhir:code [ fhir:v "read" ] ;
fhir:documentation [ fhir:v "GET, [base]/Organization/[hpi-org-id], Used to retrieve an Organization resource by Id, system/Organization.r" ]       ] [
fhir:code [ fhir:v "search-type" ] ;
fhir:documentation [ fhir:v "GET, [base]/Organization, Queries against the Organization using name or other parameters. Will return a Bundle (even if there are no matching resources), system/Organization.s" ]       ] ) ;
      ( fhir:searchParam [
fhir:name [ fhir:v "active" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "To enable exclusion of inactive organizations" ]       ] [
fhir:name [ fhir:v "name" ] ;
fhir:type [ fhir:v "string" ] ;
fhir:documentation [ fhir:v "For searching using the organisation’s name or an alias name" ]       ] [
fhir:name [ fhir:v "identifier" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "For searching using an organisation’s New Zealand Business Number (NZBN) or their legacy NZHIS agency code." ]       ] [
fhir:name [ fhir:v "type" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "For searching using an organisation's type E.g. DHB, RA, Educational institution" ]       ] [
fhir:name [ fhir:v "partOf" ] ;
fhir:type [ fhir:v "reference" ] ;
fhir:documentation [ fhir:v "For retrieving organizations that are 'part of' another. " ]       ] )     ] [
fhir:type [ fhir:v "Location" ] ;
      ( fhir:supportedProfile [
fhir:v "http://hl7.org.nz/fhir/StructureDefinition/hpi-location"^^xsd:anyURI ;
fhir:link <http://hl7.org.nz/fhir/StructureDefinition/hpi-location>       ] ) ;
fhir:documentation [ fhir:v "Location query" ] ;
      ( fhir:interaction [
fhir:code [ fhir:v "read" ] ;
fhir:documentation [ fhir:v "GET, [base]/Location/[hpi-facid], Used to retrieve an Location resource by Id, system/Location.r" ]       ] [
fhir:code [ fhir:v "search-type" ] ;
fhir:documentation [ fhir:v "GET, [base]/Location, Queries against the Location using name or other parameters. Will return a Bundle (even if there are no matching resources), system/Location.s" ]       ] ) ;
      ( fhir:searchParam [
fhir:name [ fhir:v "identifier" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "For searching using an organization’s legacy NZHIS facility code." ]       ] [
fhir:name [ fhir:v "name" ] ;
fhir:type [ fhir:v "string" ] ;
fhir:documentation [ fhir:v "For searching using the Locations name or alias name" ]       ] [
fhir:name [ fhir:v "type" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "Retrieve Locations of the given type" ]       ] [
fhir:name [ fhir:v "address" ] ;
fhir:type [ fhir:v "string" ] ;
fhir:documentation [ fhir:v "Retrieve the Locations by address" ]       ] [
fhir:name [ fhir:v "organization" ] ;
fhir:type [ fhir:v "reference" ] ;
fhir:documentation [ fhir:v "Retrieve Locations with the given ManagingOrganization" ]       ] [
fhir:name [ fhir:v "dhb" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "Searching for Locations that are in a DHBs catchment area." ]       ] [
fhir:name [ fhir:v "status" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "Not yet enabled. To enable exclusion of inactive locations" ]       ] [
fhir:name [ fhir:v "messaging-address" ] ;
fhir:type [ fhir:v "string" ] ;
fhir:documentation [ fhir:v "Search by EDI address" ]       ] )     ] )
  ] ) . #