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
| Draft as of 2020-04-01 |
{
"resourceType" : "CapabilityStatement",
"id" : "HpiCapabilityStatement",
"meta" : {
"profile" : [
🔗 "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/hnz-capability-statement"
]
},
"text" : {
"status" : "additional",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">HPI capabilities</div>"
},
"extension" : [
{
"extension" : [
{
"url" : "licenseURL",
"valueUri" : "https://www.tewhatuora.govt.nz/assets/Our-health-system/Digital-health/Digital-Service-Hub/API-Access-and-Use-Agreement.docx"
},
{
"url" : "externalDocs",
"valueUri" : "https://fhir-ig.digital.health.nz/hpi"
},
{
"url" : "licenseName",
"valueString" : "Health New Zealand Digital Services Hub API Access and Use Agreement"
},
{
"extension" : [
{
"extension" : [
{
"url" : "key",
"valueString" : "Correlation-Id"
},
{
"url" : "value",
"valueUri" : "https://raw.githubusercontent.com/tewhatuora/schemas/main/shared-care/Correlation-Id.json"
},
{
"url" : "required",
"valueBoolean" : false
}
],
"url" : "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension"
},
{
"extension" : [
{
"url" : "key",
"valueString" : "Request-Context"
},
{
"url" : "value",
"valueUri" : "https://raw.githubusercontent.com/tewhatuora/schemas/main/openapi-definitions/Request-Context.json"
},
{
"url" : "required",
"valueBoolean" : true
},
{
"url" : "documentation",
"valueString" : "A base64-encoded JSON object that defines the context of the current request.\nSee https://github.com/tewhatuora/schemas/blob/main/json-schema/Request-Context-v2.json for the schema this object must conform to."
}
],
"url" : "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension"
}
],
"url" : "globalHeaders"
}
],
"url" : "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension"
}
],
"url" : "https://fhir-ig.digital.health.nz/CapabilityStatement/HpiCapabilityStatement",
"version" : "1.5.0",
"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",
"security" : {
"extension" : [
{
"extension" : [
{
"url" : "token",
"valueUri" : "https://auth.services.health.nz/realms/hnz-integration/protocol/openid-connect/token"
}
],
"url" : "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris"
},
{
"url" : "http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities",
"valueCode" : "client-confidential-symmetric"
}
],
"cors" : true,
"service" : [
{
"coding" : [
{
"code" : "SMART-on-FHIR"
}
]
}
]
},
"resource" : [
{
"type" : "Practitioner",
"supportedProfile" : [
🔗 "http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner"
],
"documentation" : "Practitioner query\n\n",
"interaction" : [
{
"code" : "read",
"documentation" : "GET, [base]/Practitioner[cpn], Retrieves a Practitioner resource by Id, system/Practitioner.r"
},
{
"code" : "search-type",
"documentation" : "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 "
},
{
"code" : "create",
"documentation" : "POST',[base]/Practitioner, Creates a new Practitioner record , system/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" : "POST, [base]/Practitioner[cpn],An operation that updates a health providers demographic details, system/Practitioner.u"
}
]
},
{
"type" : "PractitionerRole",
"supportedProfile" : [
🔗 "http://hl7.org.nz/fhir/StructureDefinition/HPIPractitionerRole"
],
"documentation" : "PractitionerRole query\n",
"interaction" : [
{
"code" : "read",
"documentation" : "GET, [base]/PractitionerRole[id], Used to retrieve a PractitionerRole resource by Id, system/PractitionerRole.r"
},
{
"code" : "search-type",
"documentation" : "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"
},
{
"code" : "create",
"documentation" : "POST, [base]/PractitionerRole, Create a new PractitionerRole, system/PractitionerRole.c"
},
{
"code" : "update",
"documentation" : "PUT, [base]/PractitionerRole[id], Update contact details and end date on an existing PractitionerRole record, system/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/HPIOrganization"
],
"documentation" : "Organization query\n",
"interaction" : [
{
"code" : "read",
"documentation" : "GET, [base]/Organization/[hpi-org-id], Used to retrieve an Organization resource by Id, system/Organization.r"
},
{
"code" : "search-type",
"documentation" : "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"
}
],
"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/HPILocation"
],
"documentation" : "Location query",
"interaction" : [
{
"code" : "read",
"documentation" : "GET, [base]/Location/[hpi-facid], Used to retrieve an Location resource by Id, system/Location.r"
},
{
"code" : "search-type",
"documentation" : "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"
}
],
"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"
}
]
}
]
}
]
}