New Zealand HPI Implementation Guide
0.9.0 - CI Build
New Zealand HPI Implementation Guide, published by Ministry of Health. This is not an authorized publication; it is the continuous build for version 0.9.0). This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions
@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:Resource.id [ fhir:value "HpiCapabilityStatement"];
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "additional" ];
fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\">HPI capabilities</div>"
];
fhir:CapabilityStatement.url [ fhir:value "http://hl7.org.nz/fhir/ig/hpi/CapabilityStatement/HpiCapabilityStatement"];
fhir:CapabilityStatement.version [ fhir:value "0.9.0"];
fhir:CapabilityStatement.name [ fhir:value "HPI_CapabilityStatement"];
fhir:CapabilityStatement.title [ fhir:value "Capability Statement describing HPI FHIR APIs"];
fhir:CapabilityStatement.status [ fhir:value "draft"];
fhir:CapabilityStatement.date [ fhir:value "2020-04-01"^^xsd:date];
fhir:CapabilityStatement.publisher [ fhir:value "Ministry of Health"];
fhir:CapabilityStatement.contact [
fhir:index 0;
fhir:ContactDetail.name [ fhir:value "Ministry of Health" ];
fhir:ContactDetail.telecom [
fhir:index 0;
fhir:ContactPoint.system [ fhir:value "email" ];
fhir:ContactPoint.value [ fhir:value "mailto:integration@health.govt.nz" ] ]
];
fhir:CapabilityStatement.description [ fhir:value "This is the computable resource that describes the RESTful endpoint"];
fhir:CapabilityStatement.jurisdiction [
fhir:index 0;
fhir:CodeableConcept.coding [
fhir:index 0;
fhir:Coding.system [ fhir:value "urn:iso:std:iso:3166" ];
fhir:Coding.code [ fhir:value "NZ" ] ]
];
fhir:CapabilityStatement.kind [ fhir:value "instance"];
fhir:CapabilityStatement.implementation [
fhir:CapabilityStatement.implementation.description [ fhir:value "The HPI endpoint" ];
fhir:CapabilityStatement.implementation.url [ fhir:value "https://api.hip.digital.health.nz/fhir/hpi/v1/" ]
];
fhir:CapabilityStatement.fhirVersion [ fhir:value "4.0.1"];
fhir:CapabilityStatement.format [
fhir:value "json";
fhir:index 0
];
fhir:CapabilityStatement.rest [
fhir:index 0;
fhir:CapabilityStatement.rest.mode [ fhir:value "server" ];
fhir:CapabilityStatement.rest.resource [
fhir:index 0;
fhir:CapabilityStatement.rest.resource.type [ fhir:value "Practitioner" ];
fhir:CapabilityStatement.rest.resource.supportedProfile [
fhir:value "http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner";
fhir:index 0;
fhir:link <http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner> ];
fhir:CapabilityStatement.rest.resource.documentation [ fhir:value "Practitioner query\n" ];
fhir:CapabilityStatement.rest.resource.interaction [
fhir:index 0;
fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ];
fhir:CapabilityStatement.rest.resource.interaction.documentation [ fhir:value "Used to retrieve a Practitioner resource by Id." ] ], [
fhir:index 1;
fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ] ];
fhir:CapabilityStatement.rest.resource.searchParam [
fhir:index 0;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "identifier" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ] ], [
fhir:index 1;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "name" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "string" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Not case sensitive" ] ], [
fhir:index 2;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "family" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "string" ] ], [
fhir:index 3;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "given" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "string" ] ], [
fhir:index 4;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "gender" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ] ], [
fhir:index 5;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "birthdate" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "date" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Supports a search on practitioner birthdate" ] ] ], [
fhir:index 1;
fhir:CapabilityStatement.rest.resource.type [ fhir:value "PractitionerRole" ];
fhir:CapabilityStatement.rest.resource.supportedProfile [
fhir:value "http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner-role";
fhir:index 0;
fhir:link <http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner-role> ];
fhir:CapabilityStatement.rest.resource.documentation [ fhir:value "PractitionerRole query\n" ];
fhir:CapabilityStatement.rest.resource.interaction [
fhir:index 0;
fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ];
fhir:CapabilityStatement.rest.resource.interaction.documentation [ fhir:value "Used to retrieve a PractitionerRole resource by Id." ] ], [
fhir:index 1;
fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ] ], [
fhir:index 2;
fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "create" ];
fhir:CapabilityStatement.rest.resource.interaction.documentation [ fhir:value "Create a new PractitionerRole" ] ], [
fhir:index 3;
fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "update" ];
fhir:CapabilityStatement.rest.resource.interaction.documentation [ fhir:value "Update an existing PractitionerRole" ] ];
fhir:CapabilityStatement.rest.resource.searchInclude [
fhir:value "practitioner";
fhir:index 0 ], [
fhir:value "organization";
fhir:index 1 ], [
fhir:value "location";
fhir:index 2 ];
fhir:CapabilityStatement.rest.resource.searchParam [
fhir:index 0;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "practitioner" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "reference" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Given a Practitioner id, returns the PractitionerRoles associated with that id" ] ], [
fhir:index 1;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "organization" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "reference" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Given a Organization id, returns the PractitionerRoles associated with that id" ] ], [
fhir:index 2;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "location" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Given a Location id, returns the PractitionerRoles associated with that id" ] ], [
fhir:index 3;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "identifier" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Returns PractitionerRoles based on identifier" ] ], [
fhir:index 4;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "role" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Returns PractitionerRoles based on role" ] ], [
fhir:index 5;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "active" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "To enable exclusion of inactive PractitionerRoles" ] ] ], [
fhir:index 2;
fhir:CapabilityStatement.rest.resource.type [ fhir:value "Organization" ];
fhir:CapabilityStatement.rest.resource.supportedProfile [
fhir:value "http://hl7.org.nz/fhir/StructureDefinition/hpi-organization";
fhir:index 0;
fhir:link <http://hl7.org.nz/fhir/StructureDefinition/hpi-organization> ];
fhir:CapabilityStatement.rest.resource.documentation [ fhir:value "Organization query\n" ];
fhir:CapabilityStatement.rest.resource.interaction [
fhir:index 0;
fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "read" ];
fhir:CapabilityStatement.rest.resource.interaction.documentation [ fhir:value "Used to retrieve an Organization resource by Id." ] ], [
fhir:index 1;
fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ] ];
fhir:CapabilityStatement.rest.resource.searchParam [
fhir:index 0;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "active" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "To enable exclusion of inactive organizations" ] ], [
fhir:index 1;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "name" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "string" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Will only return active organizations" ] ], [
fhir:index 2;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "identifier" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "The HPI Organization id or the New Zealand Business Number (NZBN)." ] ], [
fhir:index 3;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "partOf" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "reference" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Locates Organizations that are 'part of' another. " ] ] ], [
fhir:index 3;
fhir:CapabilityStatement.rest.resource.type [ fhir:value "Location" ];
fhir:CapabilityStatement.rest.resource.supportedProfile [
fhir:value "http://hl7.org.nz/fhir/StructureDefinition/hpi-location";
fhir:index 0;
fhir:link <http://hl7.org.nz/fhir/StructureDefinition/hpi-location> ];
fhir:CapabilityStatement.rest.resource.documentation [ fhir:value "Location query\n" ];
fhir:CapabilityStatement.rest.resource.interaction [
fhir:index 0;
fhir:CapabilityStatement.rest.resource.interaction.code [ fhir:value "search-type" ] ];
fhir:CapabilityStatement.rest.resource.searchParam [
fhir:index 0;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "identifier" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Retrieve the Location with the identifier" ] ], [
fhir:index 1;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "name" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "string" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Retrieve the Locations with the matching name or alias" ] ], [
fhir:index 2;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "type" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Retrieve Locations of the given type" ] ], [
fhir:index 3;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "address" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "string" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Retrieve the Locations by address" ] ], [
fhir:index 4;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "organization" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "reference" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Locations with the given ManagingOrganization" ] ], [
fhir:index 5;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "dhb" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "Locations that are in a DHBs catchment area. This is a custom search" ] ], [
fhir:index 6;
fhir:CapabilityStatement.rest.resource.searchParam.name [ fhir:value "status" ];
fhir:CapabilityStatement.rest.resource.searchParam.type [ fhir:value "token" ];
fhir:CapabilityStatement.rest.resource.searchParam.documentation [ fhir:value "The current status of the Location" ] ] ]
].
# - ontology header ------------------------------------------------------------
a owl:Ontology;
owl:imports fhir:fhir.ttl.