FHIR New Zealand Patient Summary IG
0.3.0 - ci-build New Zealand flag

FHIR New Zealand Patient Summary IG, published by Health NZ | Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-nzps/ and changes regularly. See the Directory of published versions

CapabilityStatement: HNZ Patient Summary CapabilityStatement

Official URL: https://standards.digital.health.nz/CapabilityStatement/HNZPatientSummaryCapabilityStatement Version: 0.3.0
Active as of 2024-05-22 Computable Name: HNZPatientSummaryCapabilityStatement

HNZ Patient Summary API capability statement. This API supports the $summary operation to return an NZPS compliant FHIR document containing a summary of a patient based on infomration held by Health New Zealand collated from multiple systems of record and sources of truth systems.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement HNZPatientSummaryCapabilityStatement

HNZ Patient Summary CapabilityStatement

  • Implementation Guide Version: 0.3.0
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Supported Patch Formats:
  • Published on: 2024-05-22
  • Published by: Health NZ | Te Whatu Ora

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
Patient $summary

Resource Conformance: supported Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary

    Extended Operations
    ConformanceOperationDocumentation
    SHALL$summary