New Zealand HPI Implementation Guide
1.5.0 - Release
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
This is the computable resource that describes the RESTful endpoint
Practitioner query
| Name | Verb | URL | Documentation | Scope |
|---|---|---|---|---|
| read | GET | [base]/Practitioner[cpn] | Retrieves a Practitioner resource by Id | system/Practitioner.r |
| search-type | 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 |
| create | POST' | [base]/Practitioner | Creates a new Practitioner record | system/Practitioner.c |
| Name | Definition | Verb | URL | Documentation | Scope |
|---|---|---|---|---|---|
| update-core | https://hpi-ig.hip.digital.health.nz/OperationDefinition/practitioner-update-core | POST | [base]/Practitioner[cpn] | An operation that updates a health providers demographic details | system/Practitioner.u |
| Name | Type | Documentation |
|---|---|---|
| identifier | token | For searching a Practitioner resource using their council/board registration number |
| name | string | Should contain the person’s full name, include all given names and family name. |
| gender | token | Use with name and birthdate. Search by gender alone is not allowed. |
| birthdate | date | Use with name and gender. Search by birthdate alone is not allowed. |
PractitionerRole query
| Name | Verb | URL | Documentation | Scope |
|---|---|---|---|---|
| read | GET | [base]/PractitionerRole[id] | Used to retrieve a PractitionerRole resource by Id | system/PractitionerRole.r |
| search-type | 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 |
| create | POST | [base]/PractitionerRole | Create a new PractitionerRole | system/PractitionerRole.c |
| update | PUT | [base]/PractitionerRole[id] | Update contact details and end date on an existing PractitionerRole record | system/PractitionerRole.u |
| Name | Type | Documentation |
|---|---|---|
| practitioner | reference | Given an hpi-person-id, returns the PractitionerRole records associated with that id |
| organization | reference | Not yet enabled. Given an hpi-organization-id, returns the PractitionerRole records associated with that id |
| location | token | Given an hpi-facility-id, returns the PractitionerRole records associated with that id |
| role | token | Returns PractitionerRole records based on role code |
| active | token | To enable exclusion of inactive PractitionerRole records |
| Name |
|---|
| practitioner |
| organization |
| location |
Organization query
| Name | Verb | URL | Documentation | Scope |
|---|---|---|---|---|
| read | GET | [base]/Organization/[hpi-org-id] | Used to retrieve an Organization resource by Id | system/Organization.r |
| search-type | 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 |
| Name | Type | Documentation |
|---|---|---|
| active | token | To enable exclusion of inactive organizations |
| name | string | For searching using the organisation’s name or an alias name |
| identifier | token | For searching using an organisation’s New Zealand Business Number (NZBN) or their legacy NZHIS agency code. |
| type | token | For searching using an organisation's type E.g. DHB, RA, Educational institution |
| partOf | reference | For retrieving organizations that are 'part of' another. |
Location query
| Name | Verb | URL | Documentation | Scope |
|---|---|---|---|---|
| read | GET | [base]/Location/[hpi-facid] | Used to retrieve an Location resource by Id | system/Location.r |
| search-type | 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 |
| Name | Type | Documentation |
|---|---|---|
| identifier | token | For searching using an organization’s legacy NZHIS facility code. |
| name | string | For searching using the Locations name or alias name |
| type | token | Retrieve Locations of the given type |
| address | string | Retrieve the Locations by address |
| organization | reference | Retrieve Locations with the given ManagingOrganization |
| dhb | token | Searching for Locations that are in a DHBs catchment area. |
| status | token | Not yet enabled. To enable exclusion of inactive locations |
| messaging-address | string | Search by EDI address |