New Zealand HPI Implementation Guide
1.3.1 - Release
New Zealand HPI Implementation Guide - Local Development build (v1.3.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2020-04-01 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="HpiCapabilityStatement"/>
<text>
<status value="additional"/>
<div xmlns="http://www.w3.org/1999/xhtml">HPI capabilities</div>
</text>
<url
value="http://hl7.org.nz/fhir/ig/hpi/CapabilityStatement/HpiCapabilityStatement"/>
<version value="1.3.1"/>
<name value="HPI_CapabilityStatement"/>
<title value="Capability Statement describing HPI FHIR APIs"/>
<status value="draft"/>
<date value="2020-04-01"/>
<publisher value="Te Whatu Ora"/>
<contact>
<name value="Te Whatu Ora"/>
<telecom>
<system value="email"/>
<value value="mailto:integration@health.govt.nz"/>
</telecom>
</contact>
<description
value="This is the computable resource that describes the RESTful endpoint"/>
<kind value="instance"/>
<implementation>
<description value="The HPI endpoint"/>
<url value="https://api.hip.digital.health.nz/fhir/hpi/v1/"/>
</implementation>
<fhirVersion value="4.0.1"/>
<format value="json"/>
<rest>
<mode value="server"/>
<resource>
<type value="Practitioner"/>
<profile
value="http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner"/>
<supportedProfile
value="http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner"/>
<documentation value="Practitioner query
"/>
<interaction>
<code value="read"/>
<documentation
value="Used to retrieve a Practitioner resource by Id **HTTP Request** 'GET' **Scope required:** practitioner:read / Practitioner.r"/>
</interaction>
<interaction>
<code value="search-type"/>
<documentation
value="Queries against the Practitioner using name and other search parameters. Will return a Bundle (even if there are no matching resources) **HTTP Request**: 'GET' **Scope required:** practitioner:search / Practitioner.s"/>
</interaction>
<interaction>
<code value="create"/>
<documentation
value="Creates a new Practitioner record **HTTP Request** 'POST' **Scope required:** practitioner:write / Practitioner.c"/>
</interaction>
<searchParam>
<name value="identifier"/>
<type value="token"/>
<documentation
value="For searching a Practitioner resource using their council/board registration number"/>
</searchParam>
<searchParam>
<name value="name"/>
<type value="string"/>
<documentation
value="Should contain the person’s full name, include all given names and family name."/>
</searchParam>
<searchParam>
<name value="gender"/>
<type value="token"/>
<documentation
value="Use with name and birthdate. Search by gender alone is not allowed."/>
</searchParam>
<searchParam>
<name value="birthdate"/>
<type value="date"/>
<documentation
value="Use with name and gender. Search by birthdate alone is not allowed."/>
</searchParam>
<operation>
<name value="update-core"/>
<definition
value="https:/hpi-ig.hip.digital.health.nz/OperationDefinition/practitioner-update-core"/>
<documentation
value="An operation that updates a health providers name, birthdate, death-date **HTTP Request** 'POST' **Scope required:** practitioner:write / Practitioner.u"/>
</operation>
</resource>
<resource>
<type value="PractitionerRole"/>
<supportedProfile
value="http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner-role"/>
<documentation value="PractitionerRole query
"/>
<interaction>
<code value="read"/>
<documentation
value="Used to retrieve a PractitionerRole resource by Id. **HTTP Request** 'GET' **Scope required:** pracrole:read / PractitionerRole.r"/>
</interaction>
<interaction>
<code value="search-type"/>
<documentation
value="Queries against PractitionerRole using hpi-person-id and other parameters. Will return a Bundle (even if there are no matching resources) **HTTP Request** 'GET' **Scope required:** pracrole:search / PractitionerRole.s"/>
</interaction>
<interaction>
<code value="create"/>
<documentation
value="Create a new PractitionerRole **HTTP Request** 'POST' **Scope required:** pracrole:create / PractitionerRole.c"/>
</interaction>
<interaction>
<code value="update"/>
<documentation
value="Update contact details and end date on an existing PractitionerRole record. **HTTP Request** 'PUT' **Scope required:** pracrole:write / PractitionerRole.u"/>
</interaction>
<searchInclude value="practitioner"/>
<searchInclude value="organization"/>
<searchInclude value="location"/>
<searchParam>
<name value="practitioner"/>
<type value="reference"/>
<documentation
value="Given an hpi-person-id, returns the PractitionerRole records associated with that id"/>
</searchParam>
<searchParam>
<name value="organization"/>
<type value="reference"/>
<documentation
value="Not yet enabled. Given an hpi-organization-id, returns the PractitionerRole records associated with that id"/>
</searchParam>
<searchParam>
<name value="location"/>
<type value="token"/>
<documentation
value="Given an hpi-facility-id, returns the PractitionerRole records associated with that id"/>
</searchParam>
<searchParam>
<name value="role"/>
<type value="token"/>
<documentation
value="Returns PractitionerRole records based on role code"/>
</searchParam>
<searchParam>
<name value="active"/>
<type value="token"/>
<documentation
value="To enable exclusion of inactive PractitionerRole records"/>
</searchParam>
</resource>
<resource>
<type value="Organization"/>
<supportedProfile
value="http://hl7.org.nz/fhir/StructureDefinition/hpi-organization"/>
<documentation value="Organization query
"/>
<interaction>
<code value="read"/>
<documentation
value="Used to retrieve an Organization resource by Id. **HTTP Request** 'GET' **Scope required:** organization:read / Organization.r"/>
</interaction>
<interaction>
<code value="search-type"/>
<documentation
value="Queries against the Organization using name or other parameters. Will return a Bundle (even if there are no matching resources). **HTTP Request** 'GET' **Scope required:** organization:search / Organization.s"/>
</interaction>
<searchParam>
<name value="active"/>
<type value="token"/>
<documentation value="To enable exclusion of inactive organizations"/>
</searchParam>
<searchParam>
<name value="name"/>
<type value="string"/>
<documentation
value="For searching using the organisation’s name or an alias name"/>
</searchParam>
<searchParam>
<name value="identifier"/>
<type value="token"/>
<documentation
value="For searching using an organisation’s New Zealand Business Number (NZBN) or their legacy NZHIS agency code."/>
</searchParam>
<searchParam>
<name value="type"/>
<type value="token"/>
<documentation
value="For searching using an organisation's type E.g. DHB, RA, Educational institution"/>
</searchParam>
<searchParam>
<name value="partOf"/>
<type value="reference"/>
<documentation
value="For retrieving organizations that are 'part of' another. "/>
</searchParam>
</resource>
<resource>
<type value="Location"/>
<supportedProfile
value="http://hl7.org.nz/fhir/StructureDefinition/hpi-location"/>
<documentation value="Location query"/>
<interaction>
<code value="read"/>
<documentation
value="Used to retrieve an Location resource by Id. **HTTP Request** 'GET' **Scope required:** location:read / Location.r"/>
</interaction>
<interaction>
<code value="search-type"/>
<documentation
value="Queries against the Location using name or other parameters. Will return a Bundle (even if there are no matching resources). **HTTP Request** 'GET' **Scope required:** location:search / Location.s"/>
</interaction>
<searchParam>
<name value="identifier"/>
<type value="token"/>
<documentation
value="For searching using an organization’s legacy NZHIS facility code."/>
</searchParam>
<searchParam>
<name value="name"/>
<type value="string"/>
<documentation
value="For searching using the Locations name or alias name"/>
</searchParam>
<searchParam>
<name value="type"/>
<type value="token"/>
<documentation value="Retrieve Locations of the given type"/>
</searchParam>
<searchParam>
<name value="address"/>
<type value="string"/>
<documentation value="Retrieve the Locations by address"/>
</searchParam>
<searchParam>
<name value="organization"/>
<type value="reference"/>
<documentation
value="Retrieve Locations with the given ManagingOrganization"/>
</searchParam>
<searchParam>
<name value="dhb"/>
<type value="token"/>
<documentation
value="Searching for Locations that are in a DHBs catchment area."/>
</searchParam>
<searchParam>
<name value="status"/>
<type value="token"/>
<documentation
value="Not yet enabled. To enable exclusion of inactive locations"/>
</searchParam>
<searchParam>
<name value="messaging-address"/>
<type value="string"/>
<documentation value="Search by EDI address"/>
</searchParam>
</resource>
</rest>
</CapabilityStatement>