Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release New Zealand flag

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

Extension: For sms reply

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension Version: 0.4.1
Active as of 2025-08-31 Computable Name: SystemReplyExtension

Specifies whether a reply is expected and provides a webhook URL for the reply.

Context of Use

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 For sms reply
... Slices for extension Content/Rules for all slices
.... extension:replyUrl 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "replyUrl"
..... value[x] 0..1 url Value of extension
.... extension:replyBoolean 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "replyBoolean"
..... value[x] 0..1 boolean Value of extension
... url 1..1 uri "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension For sms reply
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:replyUrl 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "replyUrl"
..... value[x] 0..1 url Value of extension
.... extension:replyBoolean 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "replyBoolean"
..... value[x] 0..1 boolean Value of extension
... url 1..1 uri "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Specifies whether a reply is expected and provides a webhook URL for the reply.

  • replyUrl: url: An Extension
  • replyBoolean: boolean: An Extension

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension For sms reply
... Slices for extension Content/Rules for all slices
.... extension:replyUrl 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "replyUrl"
..... value[x] 0..1 url Value of extension
.... extension:replyBoolean 0..1 Extension Extension
..... extension 0..0
..... url 1..1 uri "replyBoolean"
..... value[x] 0..1 boolean Value of extension
... url 1..1 uri "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension For sms reply
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:replyUrl 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "replyUrl"
..... value[x] 0..1 url Value of extension
.... extension:replyBoolean 0..1 Extension Extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "replyBoolean"
..... value[x] 0..1 boolean Value of extension
... url 1..1 uri "https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Specifies whether a reply is expected and provides a webhook URL for the reply.

  • replyUrl: url: An Extension
  • replyBoolean: boolean: An Extension

 

Other representations of profile: CSV, Excel, Schematron

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()