New Zealand HPI Implementation Guide
0.2.0 - CI Build

New Zealand HPI Implementation Guide, published by David Hay. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/HL7NZ/hpi/ and changes regularly. See the Directory of published versions

Capability Statement


API summary (generated from the capabilityStatement resource)



This is the computable resource that describes the RESTful endpoint


Practitioner

Practitioner query


Interactions
CodeDocumentation
read

Used to retrieve a Practitioner resource by Id.

search-type Queries against the resource type. Will return a Bundle (even if there are no matching resources).
create undefined
update undefined
Search Parameters
NameTypeDocumentation
identifier token

Will only return active identifiers

name string

Not case sensitive

family string
given string
gender token
birthdate date
Definition: SearchParameter/HpiPractitionerBirthdate

This is a custom search

ra-identifier token
Definition: SearchParameter/HpiPractitionerRaIdentifier

This is a custom search. It queries on the identifier suplied by the Registartion Authority (Practitioner.qualification.identifier)

PractitionerRole

PractitionerRole query


Interactions
CodeDocumentation
read

Used to retrieve a PractitionerRole resource by Id.

search-type Queries against the resource type. Will return a Bundle (even if there are no matching resources).
create

Create a new PractitionerRole

update

Update an existing PractitionerRole

Search Parameters
NameTypeDocumentation
practitioner reference

Given a Practitoner id, returns the PractitonerRoles associated with that id

organization reference

Given a Organization id, returns the PractitonerRoles associated with that id

location token

Given a Location id, returns the PractitonerRoles associated with that id

identifier token

Returns PractitionerRoles based on identifier

role token

Returns PractitionerRoles based on role

active token

To enable exclusion of inactive PractitionerRoles

Search includes
Name
practitioner
organization
location
These are the _include parameters that are supported on searches

Organization

Organization query


Interactions
CodeDocumentation
read

Used to retrieve an Organization resource by Id.

search-type Queries against the resource type. Will return a Bundle (even if there are no matching resources).
Search Parameters
NameTypeDocumentation
active token

To enable exclusion of inactive organizations

name string

Will only return active organizations

identifier token

The HPI Organization id.

partOf reference

Locates Organizations that are 'part of' another. For example, [host]/Organization?partOf=cmdhb would return all Organizations like hospitals that are part of the Organization with the id 'cmdhd'

Location

Location query


Interactions
CodeDocumentation
search-type Queries against the resource type. Will return a Bundle (even if there are no matching resources).
Search Parameters
NameTypeDocumentation
identifier token

Retrieve the Location with the identifier

name string

Retrieve the Locations with the matching name or alias

type token

Retrieve Locations of the given type

address string

Retrieve the Locations by address

organization reference

Locations with the given ManagingOrganization

dhb token
Definition: http://hl7.fhir.org/fhir/SearchParameter/dhb

Locations that are in a DHBs catchment area. This is a custom search

status token

The current status of the Location