HL7 FHIR Implementation Guide - New Zealand Formulary/NZULM IG
1.0.0 - ci-build

HL7 FHIR Implementation Guide - New Zealand Formulary/NZULM IG, published by New Zealand Medicines Formulary LP. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7NZ/nzf/ and changes regularly. See the Directory of published versions

Extension: Cautionary and Advisory Label

Official URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-cal Version: 1.0.0
Draft as of 2024-03-18 Realm: New Zealand flag Computable Name: Cal

Cautionary and Advisory Label

Context of Use

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

  • Element ID Medication

Cautionary and Advisory labels are directly assigned to MPUUs by the New Zealand Formulary team. The CALs are then proprogated through to MPP, TPP, TPUU and CTPPs.

Note - there can be delay between a medication being available via the API and the assigning of CALs.

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: Cautionary and Advisory Label

  • id: id: An id for this CAL.
  • labelType: string: The type of label.
  • text: string: The label text.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... extension 3..*ExtensionExtension
... extension:id 1..1ExtensionAn id for this CAL.
.... extension 0..0
.... url 1..1uri"id"
.... value[x] 0..1idValue of extension
... extension:labelType 1..1ExtensionThe type of label.
.... extension 0..0
.... url 1..1uri"labelType"
.... value[x] 0..1stringValue of extension
.... extension 0..0
.... url 1..1uri"text"
.... value[x] 0..1stringValue of extension
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nzf-cal"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... id 0..1idUnique id for inter-element referencing
... Slices for extension 3..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:id 1..1ExtensionAn id for this CAL.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"id"
.... value[x] 0..1idValue of extension
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"labelType"
.... value[x] 0..1stringValue of extension
... extension:text 1..1ExtensionThe label text.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"text"
.... value[x] 0..1stringValue of extension
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nzf-cal"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Cautionary and Advisory Label

  • id: id: An id for this CAL.
  • labelType: string: The type of label.
  • text: string: The label text.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... extension 3..*ExtensionExtension
... extension:id 1..1ExtensionAn id for this CAL.
.... extension 0..0
.... url 1..1uri"id"
.... value[x] 0..1idValue of extension
... extension:labelType 1..1ExtensionThe type of label.
.... extension 0..0
.... url 1..1uri"labelType"
.... value[x] 0..1stringValue of extension
.... extension 0..0
.... url 1..1uri"text"
.... value[x] 0..1stringValue of extension
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nzf-cal"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... id 0..1idUnique id for inter-element referencing
... Slices for extension 3..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:id 1..1ExtensionAn id for this CAL.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"id"
.... value[x] 0..1idValue of extension
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"labelType"
.... value[x] 0..1stringValue of extension
... extension:text 1..1ExtensionThe label text.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"text"
.... value[x] 0..1stringValue of extension
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nzf-cal"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children unless an empty Parameters resource
: hasValue() or (children().count() > id.count()) or $this is Parameters
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()