Qi-Core Implementation Guide (Release 2.1 Trial-Use Ballot)

This page is part of the Quality Improvement Core Framework (v2.1.0: STU 3 Ballot 1) based on FHIR R3. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: qicore-medication

Examples:

Example of an IV administration not given with a note - Alemtuzumab

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-medication

This profile builds on US Core Medication Profile.

This profile was published on Mon Aug 21 16:00:00 AEST 2017 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

Description of Profiles, Differentials, and Snapshots.

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 1 element

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*Definition of a Medication
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code SΣ1..1CodeableConceptCodes that identify this medication
Binding: Medication Clinical Drug (RxNorm) (preferred)
... status Σ0..1codeactive | inactive | entered-in-error
Binding: MedicationStatus (required)
... isBrand Σ0..1booleanTrue if a brand
... isOverTheCounter Σ0..1booleanTrue if medication does not require a prescription
... manufacturer Σ0..1Reference(QICore-Organization)Manufacturer of the item
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMED CT Form Codes (example)
... ingredient I0..*BackboneElementActive or inactive ingredient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... item[x] 1..1Reference(QICore-Substance), Reference(QICore-Medication)The product contained
.... isActive 0..1booleanActive ingredient indicator
.... amount 0..1RatioQuantity of ingredient present
... package I0..1BackboneElementDetails about packaged medications
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... container 0..1CodeableConceptE.g. box, vial, blister-pack
Binding: MedicationContainer (example)
.... content I0..*BackboneElementWhat is in the package
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... itemReference 1..1Reference(QICore-Medication)The item in the package
..... amount 0..1SimpleQuantityQuantity present in the package
.... batch I0..*BackboneElementIdentifies a single production run
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1stringIdentifier assigned to batch
..... expirationDate 0..1dateTimeWhen batch will expire
... image 0..*AttachmentPicture of the medication

doco Documentation for this format

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 1 element

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*Definition of a Medication
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code SΣ1..1CodeableConceptCodes that identify this medication
Binding: Medication Clinical Drug (RxNorm) (preferred)
... status Σ0..1codeactive | inactive | entered-in-error
Binding: MedicationStatus (required)
... isBrand Σ0..1booleanTrue if a brand
... isOverTheCounter Σ0..1booleanTrue if medication does not require a prescription
... manufacturer Σ0..1Reference(QICore-Organization)Manufacturer of the item
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMED CT Form Codes (example)
... ingredient I0..*BackboneElementActive or inactive ingredient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... item[x] 1..1Reference(QICore-Substance), Reference(QICore-Medication)The product contained
.... isActive 0..1booleanActive ingredient indicator
.... amount 0..1RatioQuantity of ingredient present
... package I0..1BackboneElementDetails about packaged medications
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... container 0..1CodeableConceptE.g. box, vial, blister-pack
Binding: MedicationContainer (example)
.... content I0..*BackboneElementWhat is in the package
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... itemReference 1..1Reference(QICore-Medication)The item in the package
..... amount 0..1SimpleQuantityQuantity present in the package
.... batch I0..*BackboneElementIdentifies a single production run
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... lotNumber 0..1stringIdentifier assigned to batch
..... expirationDate 0..1dateTimeWhen batch will expire
... image 0..*AttachmentPicture of the medication

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Medication.languageCommon LanguagesextensibleCommon Languages
Medication.codeMedication Clinical Drug (RxNorm)preferredMedication Clinical Drug (RxNorm)
Medication.statusMedicationStatusrequiredMedicationStatus
Medication.formSNOMED CT Form CodesexampleSNOMED CT Form Codes
Medication.package.containerMedicationContainerexampleMedicationContainer

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2MedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1MedicationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4MedicationIf 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-3MedicationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1Medication.ingredientAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Medication.packageAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Medication.package.contentAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Medication.package.batchAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())