HNZ Custom Headers Extension - Definitions - Digital Tooling Implementation Guide v0.0.6

Digital Tooling Implementation Guide - Local Development build (v0.0.6) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: HnzCustomHeadersExtension - Detailed Descriptions

Active as of 2024-06-24

Definitions for the custom-headers-extension extension.

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	An extension to represent custom headers to be applied globally in an OpenAPI specification.
Short	HNZ Custom Headers Extension
2. Extension.extension
Control	3..?
4. Extension.extension:key
Slice Name	key
Short	The header name. E.g. Request-Context
Control	1..1
6. Extension.extension:key.extension
Control	0..0
8. Extension.extension:key.url
Fixed Value	`key`
10. Extension.extension:key.value[x]
Type	string
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
12. Extension.extension:value
Slice Name	value
Short	The uri to an OAS schema to apply for the header value
Control	1..1
14. Extension.extension:value.extension
Control	0..0
16. Extension.extension:value.url
Fixed Value	`value`
18. Extension.extension:value.value[x]
Type	uri
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
20. Extension.extension:required
Slice Name	required
Short	Whether the header is required or optional.
Control	1..1
22. Extension.extension:required.extension
Control	0..0
24. Extension.extension:required.url
Fixed Value	`required`
26. Extension.extension:required.value[x]
Type	boolean
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
28. Extension.url
Fixed Value	`https://fhir-ig-uat.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension`
30. Extension.value[x]
Control	0..0

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	An extension to represent custom headers to be applied globally in an OpenAPI specification. Optional Extension Element - found in all resources.
Short	HNZ Custom Headers ExtensionOptional Extensions Element
Control	0..* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	ExtensionAdditional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	30..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
4. Extension.extension:key
Slice Name	key
Definition	An Extension
Short	The header name. E.g. Request-ContextAdditional content defined by implementations
Control	10..1*
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. Extension.extension:key.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	ExtensionAdditional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..0*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
8. Extension.extension:key.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`key`
10. Extension.extension:key.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	0..1
Type	string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Extension.extension:value
Slice Name	value
Definition	An Extension
Short	The uri to an OAS schema to apply for the header valueAdditional content defined by implementations
Control	10..1*
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. Extension.extension:value.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	ExtensionAdditional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..0*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
16. Extension.extension:value.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`value`
18. Extension.extension:value.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	0..1
Type	uri, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Extension.extension:required
Slice Name	required
Definition	An Extension
Short	Whether the header is required or optional.Additional content defined by implementations
Control	10..1*
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. Extension.extension:required.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	ExtensionAdditional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..0*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
24. Extension.extension:required.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`required`
26. Extension.extension:required.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	0..1
Type	boolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`https://fhir-ig-uat.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension`
30. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	0..01
Type	Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	An extension to represent custom headers to be applied globally in an OpenAPI specification.
Short	HNZ Custom Headers Extension
Control	0..* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
2. Extension.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
4. Extension.extension
Definition	An Extension
Short	Extension
Control	3..*
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Extension.extension:key
Slice Name	key
Definition	An Extension
Short	The header name. E.g. Request-Context
Control	1..1
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
8. Extension.extension:key.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
10. Extension.extension:key.extension
Definition	An Extension
Short	Extension
Control	0..0
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
12. Extension.extension:key.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`key`
14. Extension.extension:key.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	0..1
Type	string
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
16. Extension.extension:value
Slice Name	value
Definition	An Extension
Short	The uri to an OAS schema to apply for the header value
Control	1..1
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. Extension.extension:value.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
20. Extension.extension:value.extension
Definition	An Extension
Short	Extension
Control	0..0
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
22. Extension.extension:value.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`value`
24. Extension.extension:value.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	0..1
Type	uri
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Extension.extension:required
Slice Name	required
Definition	An Extension
Short	Whether the header is required or optional.
Control	1..1
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
28. Extension.extension:required.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
30. Extension.extension:required.extension
Definition	An Extension
Short	Extension
Control	0..0
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
32. Extension.extension:required.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`required`
34. Extension.extension:required.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	0..1
Type	boolean
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`https://fhir-ig-uat.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension`
38. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	0..0
Type	Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)