New Zealand NES IG
1.4.7 - Release

New Zealand NES IG - Local Development build (v1.4.7) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: NESCapabilityStatement

Official URL: http://hl7.org.nz/fhir/ig/nes/CapabilityStatement/NESCapabilityStatement Version: 1.4.7
Draft as of 2023-05-24 Computable Name:

NES FHIR Capabilities

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement NESCapabilityStatement

  • Implementation Guide Version: 1.4.7
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Supported Patch Formats: json
  • Published on: 2023-05-24
  • Published by: 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
Coveragehttp://hl7.org.nz/fhir/StructureDefinition/NzCoverageyyyyidentifier, beneficiary, type, status
EpisodeOfCarehttp://hl7.org.nz/fhir/StructureDefinition/NesEnrolmentyyyypatient, status, type

Resource Conformance: supported Coverage

Base System Profile
Coverage resource for use in NZ (Trial use)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    read

    GET,[base]/Coverage/[id],Used to retrieve a Patient entitlement by id, system/Coverage.r

    create

    POST,[base]/Coverage, Create a new entitlement - Future Scope, system/Coverage.c

    update

    PUT,[base]/Coverage/[id], Update a patient's entitlement card details, system/Coverage.u

    search-type

    GET,[base]/Coverage, Search for a patient's entitlements,patient:Coverage.s system/Coverage.s

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

external entitlement id - Future scope

SHALLbeneficiarystring

NHI-Id

SHALLtypetoken

entitlement type code - Future scope

SHALLstatustoken

status code - Future scope

 

Resource Conformance: supported EpisodeOfCare

Base System Profile
NES Enrolment
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    read

    GET,[base]/EpisodeOfCare/[id],Used to retrieve a Patient enrolment by id - Future scope, system/EpisodeOfCare.r

    create

    POST,[base]/EpisodeOfCare, Create a new enrolment, system/EpisodeOfCare.c

    update

    PUT,[base]/EpisodeOfCare/[id], Update an existing enrolment, system/EpisodeOfCare.u

    search-type

    GET,[base]/EpisodeOfCare, Search for a Patient's enrolment's, system/EpisodeOfCare.s

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientstring

NHI number

SHALLstatustoken

status code

SHALLtypetoken

type code - Future scope

 

Operations

Use

FHIR Messaging Capabilities

Messaging Capability

Supported Message(s)

ModeDefinition
senderMessageDefinition[http://hl7.org.nz/fhir/MessageDefinition/EnrolmentNominationRequestMessageDefinition|1.4.7]
receiverMessageDefinition[http://hl7.org.nz/fhir/MessageDefinition/EnrolmentNominationRequestMessageDefinition|1.4.7]
receiverMessageDefinition[http://hl7.org.nz/fhir/MessageDefinition/EnrolmentNominationResponseMessageDefinition|1.4.7]