Health New Zealand Te Whatu Ora Digital Tooling Implementation Guide
0.0.5 - release

Health New Zealand Te Whatu Ora Digital Tooling Implementation Guide - Local Development build (v0.0.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: Resource Metadata Extension

Official URL: https://fhir-ig-uat.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension Version: 0.0.5
Active as of 2024-06-15 Computable Name: HnzApiSpecBuilderExtension

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

Context of Use

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

  • Element ID Element

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

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

  • globalHeaders: 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: An Extension
  • licenseURL: uri: An Extension
  • externalDocs: uri: An Extension
  • licenseName: string: An Extension

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Resource Metadata Extension
... extension 3..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:globalHeaders 0..* Extension Global HTTP headers to be added to all operations as request parameters within the OpenAPI specification
..... custom-headers-extension 0..* (Complex) HNZ Custom Headers Extension
URL: https://fhir-ig-uat.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension
..... url 1..1 uri "globalHeaders"
..... value[x] 0..0
.... extension:licenseURL 1..1 Extension A URL to the license under which the FHIR API is provided.
..... extension 0..0
..... url 1..1 uri "licenseURL"
..... value[x] 0..1 uri Value of extension
.... extension:externalDocs 1..1 Extension A URL to the external documentation for this FHIR API.
..... extension 0..0
..... url 1..1 uri "externalDocs"
..... value[x] 0..1 uri Value of extension
.... extension:licenseName 1..1 Extension A name for the license under which the FHIR API is provided.
..... extension 0..0
..... url 1..1 uri "licenseName"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "https://fhir-ig-uat.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Resource Metadata Extension
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:globalHeaders 0..* Extension Global HTTP headers to be added to all operations as request parameters within the OpenAPI specification
..... id 0..1 string Unique id for inter-element referencing
..... custom-headers-extension 0..* (Complex) HNZ Custom Headers Extension
URL: https://fhir-ig-uat.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "globalHeaders"
.... extension:licenseURL 1..1 Extension A URL to the license under which the FHIR API is provided.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "licenseURL"
..... value[x] 0..1 uri Value of extension
.... extension:externalDocs 1..1 Extension A URL to the external documentation for this FHIR API.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "externalDocs"
..... value[x] 0..1 uri Value of extension
.... extension:licenseName 1..1 Extension A name for the license under which the FHIR API is provided.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "licenseName"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "https://fhir-ig-uat.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension"

doco Documentation for this format

This structure is derived from Extension

Summary

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

  • globalHeaders: 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: An Extension
  • licenseURL: uri: An Extension
  • externalDocs: uri: An Extension
  • licenseName: string: An Extension

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Resource Metadata Extension
... extension 3..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:globalHeaders 0..* Extension Global HTTP headers to be added to all operations as request parameters within the OpenAPI specification
..... custom-headers-extension 0..* (Complex) HNZ Custom Headers Extension
URL: https://fhir-ig-uat.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension
..... url 1..1 uri "globalHeaders"
..... value[x] 0..0
.... extension:licenseURL 1..1 Extension A URL to the license under which the FHIR API is provided.
..... extension 0..0
..... url 1..1 uri "licenseURL"
..... value[x] 0..1 uri Value of extension
.... extension:externalDocs 1..1 Extension A URL to the external documentation for this FHIR API.
..... extension 0..0
..... url 1..1 uri "externalDocs"
..... value[x] 0..1 uri Value of extension
.... extension:licenseName 1..1 Extension A name for the license under which the FHIR API is provided.
..... extension 0..0
..... url 1..1 uri "licenseName"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "https://fhir-ig-uat.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Resource Metadata Extension
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:globalHeaders 0..* Extension Global HTTP headers to be added to all operations as request parameters within the OpenAPI specification
..... id 0..1 string Unique id for inter-element referencing
..... custom-headers-extension 0..* (Complex) HNZ Custom Headers Extension
URL: https://fhir-ig-uat.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "globalHeaders"
.... extension:licenseURL 1..1 Extension A URL to the license under which the FHIR API is provided.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "licenseURL"
..... value[x] 0..1 uri Value of extension
.... extension:externalDocs 1..1 Extension A URL to the external documentation for this FHIR API.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "externalDocs"
..... value[x] 0..1 uri Value of extension
.... extension:licenseName 1..1 Extension A name for the license under which the FHIR API is provided.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "licenseName"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "https://fhir-ig-uat.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron