QI-Core Implementation Guide
5.0.0-ballot - STU Ballot US

This page is part of the Quality Improvement Core Framework (v5.0.0-ballot: STU 5 Ballot 1) based on FHIR R4. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions

Resource Profile: QICore Medication

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-medication Version: 5.0.0-ballot
Active as of 2018-08-22 Computable Name: QICoreMedication

Profile of Medication for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

Usage

See the patterns page for implementation and usage patterns. 

define function "GetMedicationCode"(request MedicationRequest):
  if request.medication is CodeableConcept then
    request.medication as CodeableConcept
  else
    (singleton from ([Medication] M where M.id = GetId((request.medication as Reference).reference))).code

Examples

Example of an IV medication - Alemtuzumab

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from USCoreMedicationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*USCoreMedicationProfileDefinition of a Medication
... code S1..1CodeableConceptCodes that identify this medication
Binding: Medication Clinical Drug (extensible)
... manufacturer 0..1Reference(QICoreOrganization)Manufacturer of the item
... ingredient 0..*BackboneElementActive or inactive ingredient
.... item[x] 1..1The actual ingredient or content
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(QICoreSubstance | QICore Medication)
.... isActive 0..1booleanActive ingredient indicator

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*USCoreMedicationProfileDefinition of a Medication
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..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
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code SΣ1..1CodeableConceptCodes that identify this medication
Binding: Medication Clinical Drug (extensible)
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(QICoreOrganization)Manufacturer of the item
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

... amount Σ0..1RatioAmount of drug in package
... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] 1..1The actual ingredient or content
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(QICoreSubstance | QICore Medication)
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity of ingredient present
... batch 0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format

Differential View

This structure is derived from USCoreMedicationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*USCoreMedicationProfileDefinition of a Medication
... code S1..1CodeableConceptCodes that identify this medication
Binding: Medication Clinical Drug (extensible)
... manufacturer 0..1Reference(QICoreOrganization)Manufacturer of the item
... ingredient 0..*BackboneElementActive or inactive ingredient
.... item[x] 1..1The actual ingredient or content
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(QICoreSubstance | QICore Medication)
.... isActive 0..1booleanActive ingredient indicator

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*USCoreMedicationProfileDefinition of a Medication
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..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
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code SΣ1..1CodeableConceptCodes that identify this medication
Binding: Medication Clinical Drug (extensible)
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(QICoreOrganization)Manufacturer of the item
... form 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

... amount Σ0..1RatioAmount of drug in package
... ingredient 0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] 1..1The actual ingredient or content
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(QICoreSubstance | QICore Medication)
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity of ingredient present
... batch 0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Medication.languagepreferredCommonLanguages
Max Binding: AllLanguages
Medication.codeextensibleMedication Clinical Drug
Medication.statusrequiredMedication Status Codes
Medication.formexampleSNOMEDCTFormCodes

Constraints

IdGradePathDetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1errorMedication.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMedication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMedication.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMedication.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMedication.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.manufacturerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.formAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.amountAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.ingredientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.ingredient.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMedication.ingredient.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMedication.ingredient.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMedication.ingredient.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMedication.ingredient.item[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.ingredient.isActiveAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.ingredient.strengthAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.batchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.batch.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMedication.batch.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMedication.batch.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMedication.batch.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMedication.batch.lotNumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMedication.batch.expirationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())