New Zealand HPI Implementation Guide
1.4.9 - Release
New Zealand HPI Implementation Guide
1.4.9 - Release
New Zealand HPI Implementation Guide - Local Development build (v1.4.9) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hl7.org.nz/fhir/ig/hpi/CapabilityStatement/HpiCapabilityStatement | Version: 1.4.9 | |||
| Draft as of 2020-04-01 | Computable Name: HPI_CapabilityStatement | |||
This is the computable resource that describes the RESTful endpoint
Raw OpenAPI-Swagger Definition file | Download
Generated Narrative: CapabilityStatement HpiCapabilityStatement
jsonNote to Implementers: FHIR Capabilities
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.
serverThe summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| Practitioner | http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner Additional supported profiles: http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner | y | y | y | identifier, name, gender, birthdate | $update-core | |||
| PractitionerRole | Supported Profileshttp://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner-role | y | y | y | y | practitioner, organization, location, role, active | practitioner, organization, location | ||
| Organization | Supported Profileshttp://hl7.org.nz/fhir/StructureDefinition/hpi-organization | y | y | active, name, identifier, type, partOf | |||||
| Location | Supported Profileshttp://hl7.org.nz/fhir/StructureDefinition/hpi-location | y | y | identifier, name, type, address, organization, dhb, status, messaging-address |
http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner
readGET, [base]/Practitioner[cpn], Retrieves a Practitioner resource by Id, system/Practitioner.r
search-typeGET,[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
createPOST',[base]/Practitioner, Creates a new Practitioner record , system/Practitioner.c
Practitioner query
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | For searching a Practitioner resource using their council/board registration number |
| SHALL | name | string | Should contain the person’s full name, include all given names and family name. |
| SHALL | gender | token | Use with name and birthdate. Search by gender alone is not allowed. |
| SHALL | birthdate | date | Use with name and gender. Search by birthdate alone is not allowed. |
| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $update-core | POST, [base]/Practitioner[cpn],An operation that updates a health providers demographic details, system/Practitioner.u |
readGET, [base]/PractitionerRole[id], Used to retrieve a PractitionerRole resource by Id, system/PractitionerRole.r
search-typeGET, [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
createPOST, [base]/PractitionerRole, Create a new PractitionerRole, system/PractitionerRole.c
updatePUT, [base]/PractitionerRole[id], Update contact details and end date on an existing PractitionerRole record, system/PractitionerRole.u
http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner-role
PractitionerRole query
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | practitioner | reference | Given an hpi-person-id, returns the PractitionerRole records associated with that id |
| SHALL | organization | reference | Not yet enabled. Given an hpi-organization-id, returns the PractitionerRole records associated with that id |
| SHALL | location | token | Given an hpi-facility-id, returns the PractitionerRole records associated with that id |
| SHALL | role | token | Returns PractitionerRole records based on role code |
| SHALL | active | token | To enable exclusion of inactive PractitionerRole records |
readGET, [base]/Organization/[hpi-org-id], Used to retrieve an Organization resource by Id, system/Organization.r
search-typeGET, [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
http://hl7.org.nz/fhir/StructureDefinition/hpi-organization
Organization query
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | active | token | To enable exclusion of inactive organizations |
| SHALL | name | string | For searching using the organisation’s name or an alias name |
| SHALL | identifier | token | For searching using an organisation’s New Zealand Business Number (NZBN) or their legacy NZHIS agency code. |
| SHALL | type | token | For searching using an organisation's type E.g. DHB, RA, Educational institution |
| SHALL | partOf | reference | For retrieving organizations that are 'part of' another. |
readGET, [base]/Location/[hpi-facid], Used to retrieve an Location resource by Id, system/Location.r
search-typeGET, [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
http://hl7.org.nz/fhir/StructureDefinition/hpi-location
Location query
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | For searching using an organization’s legacy NZHIS facility code. |
| SHALL | name | string | For searching using the Locations name or alias name |
| SHALL | type | token | Retrieve Locations of the given type |
| SHALL | address | string | Retrieve the Locations by address |
| SHALL | organization | reference | Retrieve Locations with the given ManagingOrganization |
| SHALL | dhb | token | Searching for Locations that are in a DHBs catchment area. |
| SHALL | status | token | Not yet enabled. To enable exclusion of inactive locations |
| SHALL | messaging-address | string | Search by EDI address |