HL7 FHIR Implementation Guide - New Zealand Formulary/NZULM IG
0.1.0 - ci-build
HL7 FHIR Implementation Guide - New Zealand Formulary/NZULM IG, published by New Zealand Medicines Formulary LP. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7NZ/nzf/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-medication | Version: 0.1.0 | |||
Active as of 2022-12-02 |
Realm: |
Computable Name: NzfMedication |
Medication resource for NZ Formulary
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Medication
Path | Conformance | ValueSet |
Medication.code | preferred | http://nzmt.org.nz/vs |
Path | Conformance | ValueSet |
Medication.code | preferred | http://nzmt.org.nz/vs |
Medication.status | required | Medication Status Codes |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Medication | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Medication | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Medication | Definition of a Medication | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Type of NZMT record (e.g. MP, MPUU) URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type Binding: Nzmt type (required) | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | Anatomical Therapeutic Chemical (ATC) Classification URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc Binding: ATC codes (required) | |||||
![]() ![]() ![]() | 0..* | Reference(DocumentReference) | Links to other information about this medication URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-link | |||||
![]() ![]() ![]() | 0..* | (Complex) | Cautionary and Advisory Label URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-cal | |||||
![]() ![]() ![]() | 0..* | (Complex) | General Funding details URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding | |||||
![]() ![]() ![]() | 0..* | (Complex) | Funding constraints and requirements URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding-rule | |||||
![]() ![]() ![]() | 0..* | (Complex) | NZMT descriptions for the medicine URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-description | |||||
![]() ![]() ![]() | 0..1 | boolean | Whether the medication can be used under section29 URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-unapproved | |||||
![]() ![]() ![]() | 0..1 | (Complex) | Legal classification of the medication URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass | |||||
![]() ![]() ![]() | 0..1 | (Complex) | Medsafe details of the medication URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-medsafe | |||||
![]() ![]() ![]() | 0..1 | boolean | True if can be prescribed by brand URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-prescribe-by-brand | |||||
![]() ![]() ![]() | 0..* | (Complex) | Supply information URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information | |||||
![]() ![]() ![]() | 0..* | (Complex) | Related medication URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-related-medication | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 0..* | Identifier | Business identifier for this medication | ||||
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Codes that identify this medication Binding: http://nzmt.org.nz/vs (preferred) | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
![]() ![]() ![]() | 0..* | BackboneElement | Active or inactive ingredient | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 1..1 | The actual ingredient or content | ||||||
![]() ![]() ![]() ![]() ![]() | CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() | Reference(Substance | Medication) | |||||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Active ingredient indicator | |||||
![]() |
Path | Conformance | ValueSet | ||||
Medication.language | preferred | CommonLanguages
| ||||
Medication.code | preferred | http://nzmt.org.nz/vs | ||||
Medication.status | required | Medication Status Codes | ||||
Medication.form | example | SNOMEDCTFormCodes |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Medication
Summary
Prohibited: 4 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Medication
Path | Conformance | ValueSet |
Medication.code | preferred | http://nzmt.org.nz/vs |
Key Elements View
Path | Conformance | ValueSet |
Medication.code | preferred | http://nzmt.org.nz/vs |
Medication.status | required | Medication Status Codes |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Medication | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Medication | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Medication | Definition of a Medication | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Type of NZMT record (e.g. MP, MPUU) URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-nzmt-type Binding: Nzmt type (required) | |||||
![]() ![]() ![]() | 0..* | CodeableConcept | Anatomical Therapeutic Chemical (ATC) Classification URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-atc Binding: ATC codes (required) | |||||
![]() ![]() ![]() | 0..* | Reference(DocumentReference) | Links to other information about this medication URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-link | |||||
![]() ![]() ![]() | 0..* | (Complex) | Cautionary and Advisory Label URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-cal | |||||
![]() ![]() ![]() | 0..* | (Complex) | General Funding details URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding | |||||
![]() ![]() ![]() | 0..* | (Complex) | Funding constraints and requirements URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-funding-rule | |||||
![]() ![]() ![]() | 0..* | (Complex) | NZMT descriptions for the medicine URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-description | |||||
![]() ![]() ![]() | 0..1 | boolean | Whether the medication can be used under section29 URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-unapproved | |||||
![]() ![]() ![]() | 0..1 | (Complex) | Legal classification of the medication URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-legalclass | |||||
![]() ![]() ![]() | 0..1 | (Complex) | Medsafe details of the medication URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-medsafe | |||||
![]() ![]() ![]() | 0..1 | boolean | True if can be prescribed by brand URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-prescribe-by-brand | |||||
![]() ![]() ![]() | 0..* | (Complex) | Supply information URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-supply-information | |||||
![]() ![]() ![]() | 0..* | (Complex) | Related medication URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-related-medication | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 0..* | Identifier | Business identifier for this medication | ||||
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Codes that identify this medication Binding: http://nzmt.org.nz/vs (preferred) | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
![]() ![]() ![]() | 0..* | BackboneElement | Active or inactive ingredient | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 1..1 | The actual ingredient or content | ||||||
![]() ![]() ![]() ![]() ![]() | CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() | Reference(Substance | Medication) | |||||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Active ingredient indicator | |||||
![]() |
Path | Conformance | ValueSet | ||||
Medication.language | preferred | CommonLanguages
| ||||
Medication.code | preferred | http://nzmt.org.nz/vs | ||||
Medication.status | required | Medication Status Codes | ||||
Medication.form | example | SNOMEDCTFormCodes |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Medication
Summary
Prohibited: 4 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron