Digital Tooling Implementation Guide
0.0.6 - release

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: HnzApiSpecBuilderExtension - Detailed Descriptions

Active as of 2024-06-24

Definitions for the resource-metadata-extension extension.

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

0. Extension
Definition

An extension to hold additional metadata for resources such as global headers and license URL.

ShortResource Metadata Extension
2. Extension.extension
Control3..?
4. Extension.extension:globalHeaders
Slice NameglobalHeaders
ShortGlobal HTTP headers to be added to all operations as request parameters within the OpenAPI specification
Control0..*
6. Extension.extension:globalHeaders.extension
TypeExtension(HNZ Custom Headers Extension) (Complex Extension)
8. Extension.extension:globalHeaders.url
Fixed ValueglobalHeaders
10. Extension.extension:globalHeaders.value[x]
Control0..0
12. Extension.extension:licenseURL
Slice NamelicenseURL
ShortA URL to the license under which the FHIR API is provided.
Control1..1
14. Extension.extension:licenseURL.extension
Control0..0
16. Extension.extension:licenseURL.url
Fixed ValuelicenseURL
18. Extension.extension:licenseURL.value[x]
Typeuri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. Extension.extension:externalDocs
Slice NameexternalDocs
ShortA URL to the external documentation for this FHIR API.
Control1..1
22. Extension.extension:externalDocs.extension
Control0..0
24. Extension.extension:externalDocs.url
Fixed ValueexternalDocs
26. Extension.extension:externalDocs.value[x]
Typeuri
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. Extension.extension:licenseName
Slice NamelicenseName
ShortA name for the license under which the FHIR API is provided.
Control1..1
30. Extension.extension:licenseName.extension
Control0..0
32. Extension.extension:licenseName.url
Fixed ValuelicenseName
34. Extension.extension:licenseName.value[x]
Typestring
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. Extension.url
Fixed Valuehttps://fhir-ig-uat.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension
38. Extension.value[x]
Control0..0