Digital Tooling Implementation Guide
0.0.10 - release
Digital Tooling Implementation Guide
0.0.10 - release
Digital Tooling Implementation Guide - Local Development build (v0.0.10) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension | Version: 0.0.10 | |||
| Active as of 2024-08-22 | Computable Name: HnzCustomHeadersExtension | |||
An extension to represent custom headers to be applied globally in an OpenAPI specification.
Context of Use
This extension may be used on the following element(s):
Usage info
Usage:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension |
0..* | Extension | HNZ Custom Headers Extension | |
  extension |
3..* | Extension | Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:key |
1..1 | Extension | The header name. E.g. Request-Context | |
  extension |
0..0 | |||
| url |
1..1 | uri | "key" | |
  value[x] |
0..1 | string | Value of extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:value |
1..1 | Extension | The uri to an OAS schema to apply for the header value | |
| extension |
0..0 | |||
| url |
1..1 | uri | "value" | |
| value[x] |
0..1 | uri | Value of extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:required |
1..1 | Extension | Whether the header is required or optional. | |
| extension |
0..0 | |||
| url |
1..1 | uri | "required" | |
| value[x] |
0..1 | boolean | Value of extension | |
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension" | |
 value[x] |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | HNZ Custom Headers Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
3..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:key |
1..1 | Extension | The header name. E.g. Request-Context | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "key" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:value |
1..1 | Extension | The uri to an OAS schema to apply for the header value | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "value" | |
| value[x] |
0..1 | uri | Value of extension | |
| extension:required |
1..1 | Extension | Whether the header is required or optional. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "required" | |
| value[x] |
0..1 | boolean | Value of extension | |
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension" | |
| Documentation for this format | ||||
This structure is derived from Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | HNZ Custom Headers Extension | |
| extension |
3..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:key |
1..1 | Extension | The header name. E.g. Request-Context | |
| extension |
0..0 | |||
| url |
1..1 | uri | "key" | |
| value[x] |
0..1 | string | Value of extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:value |
1..1 | Extension | The uri to an OAS schema to apply for the header value | |
| extension |
0..0 | |||
| url |
1..1 | uri | "value" | |
| value[x] |
0..1 | uri | Value of extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:required |
1..1 | Extension | Whether the header is required or optional. | |
| extension |
0..0 | |||
| url |
1..1 | uri | "required" | |
| value[x] |
0..1 | boolean | Value of extension | |
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension" | |
| value[x] |
0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | HNZ Custom Headers Extension | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
3..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:key |
1..1 | Extension | The header name. E.g. Request-Context | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "key" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:value |
1..1 | Extension | The uri to an OAS schema to apply for the header value | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "value" | |
| value[x] |
0..1 | uri | Value of extension | |
| extension:required |
1..1 | Extension | Whether the header is required or optional. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "required" | |
| value[x] |
0..1 | boolean | Value of extension | |
| url |
1..1 | uri | "https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension" | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron