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

CapabilityStatement: Assistance Needs API

Official URL: https://fhir-ig.digital.health.nz/fhir-patient-questionnaires/CapabilityStatement/AssistanceNeedsCapabilityStatement Version: 1.1.0
Draft as of 2024-05-03 Computable Name: AssistanceNeedsCapabilityStatement

Assistance Requirements and Summary

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement AssistanceNeedsCapabilityStatement

Assistance Needs API

  • Implementation Guide Version: 1.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Supported Patch Formats:
  • Published on: 2024-05-03
  • Published by: null

Note to Implementers: FHIR Capabilities

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.

FHIR RESTful Capabilities

Mode: server

Security
Enable CORS: yes
Security services supported: OAuth
Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRV-RSUCSearches_include_revincludeOperations
Conditionhttps://fhir-ig.digital.health.nz/fhir-patient-questionnaires/StructureDefinition/assistance-needs-profile|0.0.1yyypatient, category, code

Resource Conformance: supported Condition

Base System Profile
https://fhir-ig.digital.health.nz/fhir-patient-questionnaires/StructureDefinition/assistance-needs-profile|0.0.1
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, vread, search-type.

Documentation

This server profiles FHIR Condition to support NZ Disabled Patient Assistance Requirements

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Who has the assistance need?

SHALLcategorytoken

Search by condition category

SHALLcodetoken

Search by condition code