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: LegalClass

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

Legal classification

Context of Use

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

  • Element ID Medication

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: Legal classification

  • code: CodeableConcept: Medsafe legal classification code
  • conditions: string: Classification conditions

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... extension 1..*ExtensionExtension
... extension:code 1..1ExtensionMedsafe legal classification code
.... extension 0..0
.... url 1..1uri"code"
.... value[x] 0..1CodeableConceptValue of extension
Binding: Legal Medication status (required)
... extension:conditions 0..1ExtensionClassification conditions
.... extension 0..0
.... url 1..1uri"conditions"
.... value[x] 0..1stringValue of extension
... 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 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:code 1..1ExtensionMedsafe legal classification code
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"code"
.... value[x] 0..1CodeableConceptValue of extension
Binding: Legal Medication status (required)
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"conditions"
.... value[x] 0..1stringValue of extension
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Legal classification

  • code: CodeableConcept: Medsafe legal classification code
  • conditions: string: Classification conditions

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionExtension
... extension 1..*ExtensionExtension
... extension:code 1..1ExtensionMedsafe legal classification code
.... extension 0..0
.... url 1..1uri"code"
.... value[x] 0..1CodeableConceptValue of extension
Binding: Legal Medication status (required)
... extension:conditions 0..1ExtensionClassification conditions
.... extension 0..0
.... url 1..1uri"conditions"
.... value[x] 0..1stringValue of extension
... 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 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:code 1..1ExtensionMedsafe legal classification code
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"code"
.... value[x] 0..1CodeableConceptValue of extension
Binding: Legal Medication status (required)
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"conditions"
.... value[x] 0..1stringValue of extension
... url 1..1uri"http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:code.value[x]requiredMedicineClassificationCodeHB (a valid code from Possible values for Medication Legal Classification)
https://nzhts.digital.health.nz/fhir/ValueSet/medicine-classification-code
from this IG

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()