Health NZ | Te Whatu Ora FHIR Assistance Needs Questionnaires Implementation Guide
0.0.1 - draft
Health NZ | Te Whatu Ora FHIR Assistance Needs Questionnaires Implementation Guide
0.0.1 - draft
Health NZ | Te Whatu Ora FHIR Assistance Needs Questionnaires Implementation Guide - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2024-05-03 |
{
"resourceType" : "CapabilityStatement",
"id" : "AssistanceNeedsCapabilityStatement",
"meta" : {
"profile" : [
🔗 "https://fhir-ig-uat.digital.health.nz/hnz-digital-tooling/StructureDefinition/hnz-capability-statement"
]
},
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement AssistanceNeedsCapabilityStatement</b></p><a name=\"AssistanceNeedsCapabilityStatement\"> </a><a name=\"hcAssistanceNeedsCapabilityStatement\"> </a><a name=\"AssistanceNeedsCapabilityStatement-en-US\"> </a><h2 id=\"title\">Assistance Needs API</h2><ul><li>Implementation Guide Version: 1.1.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-05-03 </li><li>Published by: null </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>Security</em></div><div class=\"row\"><div class=\"col-lg-6\">Enable CORS: yes</div><div class=\"col-lg-6\">Security services supported: <code>OAuth</code></div></div><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 past versions of resources (vread interaction)\">V-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=\"#Condition1-1\">Condition</a></td><td><a href=\"StructureDefinition-assistance-needs-profile.html\">https://fhir-ig.digital.health.nz/fhir-patient-questionnaires/StructureDefinition/assistance-needs-profile|0.0.1</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>patient, category, code</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Condition1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Condition</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-assistance-needs-profile.html\">https://fhir-ig.digital.health.nz/fhir-patient-questionnaires/StructureDefinition/assistance-needs-profile|0.0.1</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>vread</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>This server profiles FHIR Condition to support NZ Disabled Patient Assistance Requirements</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><a href=\"http://hl7.org/fhir/R4/condition.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Who has the assistance need?</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">category</a></td><td><code>token</code></td><td><div><p>Search by condition category</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">code</a></td><td><code>token</code></td><td><div><p>Search by condition code</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div></div>"
},
"extension" : [
{
"extension" : [
{
"url" : "licenseURL",
"valueUri" : "https://example.license.org"
},
{
"url" : "externalDocs",
"valueUri" : "https://docs.example.com/fhir"
},
{
"url" : "licenseName",
"valueString" : "GPLv3"
},
{
"extension" : [
{
"extension" : [
{
"url" : "key",
"valueString" : "Correlation-Id"
},
{
"url" : "value",
"valueUri" : "https://raw.githubusercontent.com/tewhatuora/schemas/main/fhir-definitions-oas/uuid-definition.json"
},
{
"url" : "required",
"valueBoolean" : true
}
],
"url" : "https://fhir-ig-uat.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension"
}
],
"url" : "globalHeaders"
}
],
"url" : "https://fhir-ig-uat.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension"
}
],
"url" : "https://fhir-ig.digital.health.nz/fhir-patient-questionnaires/CapabilityStatement/AssistanceNeedsCapabilityStatement",
"version" : "1.1.0",
"name" : "AssistanceNeedsCapabilityStatement",
"title" : "Assistance Needs API",
"status" : "draft",
"date" : "2024-05-03",
"contact" : [
{
"name" : "Example Contact Details",
"telecom" : [
{
"system" : "url",
"value" : "https://example.com"
}
]
}
],
"description" : "Assistance Requirements and Summary",
"kind" : "instance",
"implementation" : {
"description" : "Assistance Requirements and Summary",
"url" : "https://fhir.api.digital.health.nz/R4"
},
"fhirVersion" : "4.0.1",
"format" : [
"json"
],
"rest" : [
{
"mode" : "server",
"security" : {
"extension" : [
{
"extension" : [
{
"url" : "token",
"valueUri" : "https://auth.integration.covid19.health.nz/oauth2/token"
},
{
"url" : "authorize",
"valueUri" : "https://auth.integration.covid19.health.nz/oauth2/authorize"
}
],
"url" : "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris"
}
],
"cors" : true,
"service" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code" : "OAuth"
}
]
}
]
},
"resource" : [
{
"type" : "Condition",
"profile" : "https://fhir-ig.digital.health.nz/fhir-patient-questionnaires/StructureDefinition/assistance-needs-profile|0.0.1",
"documentation" : "This server profiles FHIR Condition to support NZ Disabled Patient Assistance Requirements",
"interaction" : [
{
"code" : "read"
},
{
"code" : "vread"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchParam" : [
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who has the assistance need?"
},
{
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-category",
"type" : "token",
"documentation" : "Search by condition category"
},
{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Search by condition code"
}
]
}
]
}
]
}