Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release NZ

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: CMS Payload Type Extension

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension Version: 0.4.5
Active as of 2026-05-13 Computable Name: CMSPayloadTypeExtension

Identifies the logical type of the payload element.

Context of Use

    This extension may be used on the following element(s)

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension CMS Payload Type Extension
... extension 0..0
... url 1..1 uri "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
... value[x] 0..1 code Value of extension
Binding: CMS Payload Type ValueSet (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension CMS Payload Type Extension
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type code: Identifies the logical type of the payload element.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension CMS Payload Type Extension
... extension 0..0
... url 1..1 uri "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"
... value[x] 0..1 code Value of extension
Binding: CMS Payload Type ValueSet (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension CMS Payload Type Extension
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type code: Identifies the logical type of the payload element.

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.value[x]requiredCMSPayloadTypeVS(a valid code from CMS Payload Type CodeSystem)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/cms-payload-type-vs
From this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()