Northern Region Implementation Guide
0.4.6 - CI Build

Northern Region Implementation Guide, published by healthAlliance. This guide is not an authorized publication; it is the continuous build for version 0.4.6 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/northernRegion/ and changes regularly. See the Directory of published versions

CapabilityStatement: CapabilityStatement

Official URL: http://fhir.org.nz/ig/northernregion/CapabilityStatement/NorthernRegionCapabilityStatement Version: 0.4.6
Draft as of 2020-04-01 Computable Name: NorthernRegionCapabilityStatement

Currently the subset of API's exposed by healthAlliance are read-only and confined to a small set of resource types.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement NorthernRegionCapabilityStatement

Capability Statement describing healthAlliances FHIR APIs

  • Implementation Guide Version: 0.4.6
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Supported Patch Formats:
  • Published on: 2020-04-01
  • Published by: healthAlliance

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

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 TypeProfileRSUCSearches_include_revincludeOperations
PatientSupported Profiles
  http://hl7.org.nz/healthalliance/HaPatient		yyidentifier
Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • Supports search-type
    read

    Used to retrieve a Patient resource by Id. Note that this is not the same as the NHI identifier (use the identifier search for that)

Supported Profiles

http://hl7.org.nz/healthalliance/HaPatient

Documentation

Each DHB exposes its core demographics infomation via the Patient resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Use for NHI queries and other queries related to identifiers