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: LegalClass
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass | Version: 1.0.0 | |||
| Draft as of 2024-12-12 | Computable Name: LegalClass | |||
Legal classification
Context of Use
This extension may be used on the following element(s):
- Element ID Medication
Usage info
Usage:
- Use this Extension: Medication resource for NZ Formulary
- Examples for this Extension: Medication/50000391000117104, Medication/50079341000117105 and Medication/mp-10013251000116106
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 |
1..* | Extension | Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:code |
1..1 | Extension | Medsafe legal classification code | |
  extension |
0..0 | |||
| url |
1..1 | uri | "code" | |
  value[x] |
0..1 | CodeableConcept | Value of extension Binding: Legal Medication status (required) | |
 extension:conditions |
0..1 | Extension | Classification conditions | |
 extension |
0..0 | |||
| url |
1..1 | uri | "conditions" | |
 value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass" | |
 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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:code |
1..1 | Extension | Medsafe legal classification code | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "code" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: Legal Medication status (required) | |
| extension:conditions |
0..1 | Extension | Classification conditions | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "conditions" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass" | |
| 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 |
1..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
1..1 | Extension | Medsafe legal classification code | |
| extension |
0..0 | |||
| url |
1..1 | uri | "code" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: Legal Medication status (required) | |
| extension:conditions |
0..1 | Extension | Classification conditions | |
| extension |
0..0 | |||
| url |
1..1 | uri | "conditions" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass" | |
| 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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:code |
1..1 | Extension | Medsafe legal classification code | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "code" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: Legal Medication status (required) | |
| extension:conditions |
0..1 | Extension | Classification conditions | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "conditions" | |
| value[x] |
0..1 | string | Value of extension | |
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass" | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Extension.extension:code.value[x] | required | MedicineClassificationCodeHB (a valid code from Possible values for Medication Legal Classification)https://nzhts.digital.health.nz/fhir/ValueSet/medicine-classification-codefrom this IG |
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() |