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