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-11-17 | 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:
- Use this Extension: Medication resource for NZ Formulary
- Examples for this Extension: Medication/50079341000117105, Medication/mpuu-10013271000116104 and Medication/tpuu-10013331000116105
Formal Views of Extension Content
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 | Extension | |
  extension |
3..* | Extension | Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:id |
1..1 | Extension | An id for this CAL. | |
  extension |
0..0 | |||
| url |
1..1 | uri | "id" | |
  value[x] |
0..1 | id | Value of extension | |
| extension:labelType |
1..1 | Extension | The type of label. | |
| extension |
0..0 | |||
| url |
1..1 | uri | "labelType" | |
| value[x] |
0..1 | string | Value of extension | |
 extension:text |
1..1 | Extension | The label text. | |
 extension |
0..0 | |||
| url |
1..1 | uri | "text" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nzf-cal" | |
 value[x] |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | Extension | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| Slices for extension |
3..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:id |
1..1 | Extension | An id for this CAL. | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "id" | |
| value[x] |
0..1 | id | Value of extension | |
| extension:labelType |
1..1 | Extension | The type of label. | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "labelType" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:text |
1..1 | Extension | The label text. | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "text" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nzf-cal" | |
| 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 | Extension | |
| extension |
3..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:id |
1..1 | Extension | An id for this CAL. | |
| extension |
0..0 | |||
| url |
1..1 | uri | "id" | |
| value[x] |
0..1 | id | Value of extension | |
| extension:labelType |
1..1 | Extension | The type of label. | |
| extension |
0..0 | |||
| url |
1..1 | uri | "labelType" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:text |
1..1 | Extension | The label text. | |
| extension |
0..0 | |||
| url |
1..1 | uri | "text" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nzf-cal" | |
| value[x] |
0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension |
0..* | Extension | Extension | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| Slices for extension |
3..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:id |
1..1 | Extension | An id for this CAL. | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "id" | |
| value[x] |
0..1 | id | Value of extension | |
| extension:labelType |
1..1 | Extension | The type of label. | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "labelType" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:text |
1..1 | Extension | The label text. | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "text" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nzf-cal" | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children unless an empty Parameters resource : hasValue() or (children().count() > id.count()) or $this is Parameters | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |