New Zealand HPI Implementation Guide
1.4.7 - Release
New Zealand HPI Implementation Guide
1.4.7 - Release
New Zealand HPI Implementation Guide - Local Development build (v1.4.7) 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" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement HpiCapabilityStatement</b></p><a name=\"HpiCapabilityStatement\"> </a><a name=\"hcHpiCapabilityStatement\"> </a><a name=\"HpiCapabilityStatement-en-US\"> </a><h2 id=\"title\">Capability Statement describing HPI FHIR APIs</h2><ul><li>Implementation Guide Version: 1.4.7 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2020-04-01 </li><li>Published by: Te Whatu Ora </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>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.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Practitioner1-1\">Practitioner</a></td><td><a href=\"StructureDefinition-HPIPractitioner.html\">http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner</a><br/><em>Additional supported profiles:</em><br/>\u00a0\u00a0<code>http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner</code></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td>identifier, name, gender, birthdate</td><td/><td/><td/></tr><tr><td><a href=\"#PractitionerRole1-2\">PractitionerRole</a></td><td>Supported Profiles<br/>\u00a0\u00a0<code>http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner-role</code></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td>practitioner, organization, location, role, active</td><td><code>practitioner</code>, <code>organization</code>, <code>location</code></td><td/><td/></tr><tr><td><a href=\"#Organization1-3\">Organization</a></td><td>Supported Profiles<br/>\u00a0\u00a0<code>http://hl7.org.nz/fhir/StructureDefinition/hpi-organization</code></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>active, name, identifier, type, partOf</td><td/><td/><td/></tr><tr><td><a href=\"#Location1-4\">Location</a></td><td>Supported Profiles<br/>\u00a0\u00a0<code>http://hl7.org.nz/fhir/StructureDefinition/hpi-location</code></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>identifier, name, type, address, organization, dhb, status, messaging-address</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Practitioner1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Practitioner</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-HPIPractitioner.html\">http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p>http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner</p></div><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>, <code>create</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Practitioner query</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>For searching a Practitioner resource using their council/board registration number</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div><p>Should contain the person’s full name, include all given names and family name.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>gender</td><td><code>token</code></td><td><div><p>Use with name and birthdate. Search by gender alone is not allowed.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>birthdate</td><td><code>date</code></td><td><div><p>Use with name and gender. Search by birthdate alone is not allowed.</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-Practitioner-update-core.html\">$update-core</a></td><td><div><p>POST, [base]/Practitioner[cpn],An operation that updates a health providers demographic details, system/Practitioner.u</p>\n</div></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"PractitionerRole1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>PractitionerRole</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/practitionerrole.html\">PractitionerRole</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>, <code>create</code>, <code>update</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p>http://hl7.org.nz/fhir/StructureDefinition/hpi-practitioner-role</p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>PractitionerRole query</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>practitioner</td><td><code>reference</code></td><td><div><p>Given an hpi-person-id, returns the PractitionerRole records associated with that id</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>organization</td><td><code>reference</code></td><td><div><p>Not yet enabled. Given an hpi-organization-id, returns the PractitionerRole records associated with that id</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>location</td><td><code>token</code></td><td><div><p>Given an hpi-facility-id, returns the PractitionerRole records associated with that id</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>role</td><td><code>token</code></td><td><div><p>Returns PractitionerRole records based on role code</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>active</td><td><code>token</code></td><td><div><p>To enable exclusion of inactive PractitionerRole records</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Organization1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Organization</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/organization.html\">Organization</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p>http://hl7.org.nz/fhir/StructureDefinition/hpi-organization</p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Organization query</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>active</td><td><code>token</code></td><td><div><p>To enable exclusion of inactive organizations</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div><p>For searching using the organisation’s name or an alias name</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>For searching using an organisation’s New Zealand Business Number (NZBN) or their legacy NZHIS agency code.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>type</td><td><code>token</code></td><td><div><p>For searching using an organisation's type E.g. DHB, RA, Educational institution</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>partOf</td><td><code>reference</code></td><td><div><p>For retrieving organizations that are 'part of' another.</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Location1-4\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Location</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/location.html\">Location</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p>http://hl7.org.nz/fhir/StructureDefinition/hpi-location</p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Location query</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>For searching using an organization’s legacy NZHIS facility code.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div><p>For searching using the Locations name or alias name</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>type</td><td><code>token</code></td><td><div><p>Retrieve Locations of the given type</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>address</td><td><code>string</code></td><td><div><p>Retrieve the Locations by address</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>organization</td><td><code>reference</code></td><td><div><p>Retrieve Locations with the given ManagingOrganization</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>dhb</td><td><code>token</code></td><td><div><p>Searching for Locations that are in a DHBs catchment area.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>Not yet enabled. To enable exclusion of inactive locations</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>messaging-address</td><td><code>string</code></td><td><div><p>Search by EDI address</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div></div>"
},
"url" : "http://hl7.org.nz/fhir/ig/hpi/CapabilityStatement/HpiCapabilityStatement",
"version" : "1.4.7",
"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\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/hpi-practitioner-role"
],
"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/hpi-organization"
],
"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/hpi-location"
],
"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"
}
]
}
]
}
]
}