New Zealand NES IG
1.4.6 - Release
New Zealand NES IG
1.4.6 - Release
New Zealand NES IG - Local Development build (v1.4.6) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2023-05-24 |
{
"resourceType" : "CapabilityStatement",
"id" : "NESCapabilityStatement",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement NESCapabilityStatement</b></p><a name=\"NESCapabilityStatement\"> </a><a name=\"hcNESCapabilityStatement\"> </a><a name=\"NESCapabilityStatement-en-US\"> </a><h2 id=\"title\"/><ul><li>Implementation Guide Version: 1.4.6 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Supported Patch Formats: <code>json</code></li><li>Published on: 2023-05-24 </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=\"#Coverage1-1\">Coverage</a></td><td><a href=\"https://fhir.org.nz/ig/base/StructureDefinition-NzCoverage.html\">http://hl7.org.nz/fhir/StructureDefinition/NzCoverage</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td>identifier, beneficiary, type, status</td><td/><td/><td/></tr><tr><td><a href=\"#EpisodeOfCare1-2\">EpisodeOfCare</a></td><td><a href=\"StructureDefinition-NesEnrolment.html\">http://hl7.org.nz/fhir/StructureDefinition/NesEnrolment</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td>patient, status, type</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Coverage1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Coverage</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=\"https://fhir.org.nz/ig/base/StructureDefinition-NzCoverage.html\">http://hl7.org.nz/fhir/StructureDefinition/NzCoverage</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-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>.</li></ul></div></div><p/><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>external entitlement id - Future scope</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>beneficiary</td><td><code>string</code></td><td><div><p>NHI-Id</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>type</td><td><code>token</code></td><td><div><p>entitlement type code - Future scope</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>status code - Future scope</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=\"EpisodeOfCare1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>EpisodeOfCare</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-NesEnrolment.html\">http://hl7.org.nz/fhir/StructureDefinition/NesEnrolment</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-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>.</li></ul></div></div><p/><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>patient</td><td><code>string</code></td><td><div><p>NHI number</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>status code</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>type</td><td><code>token</code></td><td><div><p>type code - Future scope</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/nes/CapabilityStatement/NESCapabilityStatement",
"version" : "1.4.6",
"status" : "draft",
"date" : "2023-05-24",
"publisher" : "Te Whatu Ora",
"contact" : [
{
"name" : "Te Whatu Ora",
"telecom" : [
{
"system" : "email",
"value" : "mailto:integration@health.govt.nz"
}
]
}
],
"description" : "NES FHIR Capabilities",
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"json"
],
"patchFormat" : [
"json"
],
"rest" : [
{
"mode" : "server",
"resource" : [
{
"type" : "Coverage",
"profile" : "http://hl7.org.nz/fhir/StructureDefinition/NzCoverage",
"interaction" : [
{
"code" : "read",
"documentation" : "GET,[base]/Coverage/[id],Used to retrieve a Patient entitlement by id, system/Coverage.r"
},
{
"code" : "create",
"documentation" : "POST,[base]/Coverage, Create a new entitlement - Future Scope, system/Coverage.c"
},
{
"code" : "update",
"documentation" : "PUT,[base]/Coverage/[id], Update a patient's entitlement card details, system/Coverage.u"
},
{
"code" : "search-type",
"documentation" : "GET,[base]/Coverage, Search for a patient's entitlements,patient:Coverage.s system/Coverage.s"
}
],
"searchParam" : [
{
"name" : "identifier",
"type" : "token",
"documentation" : "external entitlement id - Future scope"
},
{
"name" : "beneficiary",
"type" : "string",
"documentation" : "NHI-Id"
},
{
"name" : "type",
"type" : "token",
"documentation" : "entitlement type code - Future scope"
},
{
"name" : "status",
"type" : "token",
"documentation" : "status code - Future scope"
}
]
},
{
"type" : "EpisodeOfCare",
"profile" : "http://hl7.org.nz/fhir/StructureDefinition/NesEnrolment",
"interaction" : [
{
"code" : "read",
"documentation" : "GET,[base]/EpisodeOfCare/[id],Used to retrieve a Patient enrolment by id - Future scope, system/EpisodeOfCare.r"
},
{
"code" : "create",
"documentation" : "POST,[base]/EpisodeOfCare, Create a new enrolment, system/EpisodeOfCare.c"
},
{
"code" : "update",
"documentation" : "PUT,[base]/EpisodeOfCare/[id], Update an existing enrolment, system/EpisodeOfCare.u"
},
{
"code" : "search-type",
"documentation" : "GET,[base]/EpisodeOfCare, Search for a Patient's enrolment's, system/EpisodeOfCare.s"
}
],
"searchParam" : [
{
"name" : "patient",
"type" : "string",
"documentation" : "NHI number"
},
{
"name" : "status",
"type" : "token",
"documentation" : "status code"
},
{
"name" : "type",
"type" : "token",
"documentation" : "type code - Future scope"
}
]
}
],
"operation" : [
{
"name" : "process-message",
"definition" : "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message",
"documentation" : "POST, [base]/$process-message, http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message, system/MessageHeader.c"
}
]
}
],
"messaging" : [
{
"supportedMessage" : [
{
"mode" : "sender",
"definition" : "http://hl7.org.nz/fhir/MessageDefinition/EnrolmentNominationRequestMessageDefinition"
},
{
"mode" : "receiver",
"definition" : "http://hl7.org.nz/fhir/MessageDefinition/EnrolmentNominationRequestMessageDefinition"
},
{
"mode" : "receiver",
"definition" : "http://hl7.org.nz/fhir/MessageDefinition/EnrolmentNominationResponseMessageDefinition"
}
]
}
]
}