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-medicationadministration

Examples:

Inhalant Example

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

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

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

This profile builds on MedicationAdministration.

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

Description of Profiles, Differentials, and Snapshots.

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration I0..*Administration of medication to a patient
... 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
... identifier 0..*IdentifierExternal identifier
... definition Σ0..*Reference(PlanDefinition), Reference(ActivityDefinition)Instantiates protocol or definition
... partOf Σ0..*Reference(MedicationAdministration), Reference(Procedure)Part of referenced event
... status ?!SΣ1..1codein-progress | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministrationStatus (required)
... category 0..1CodeableConceptType of medication usage
Binding: MedicationAdministrationCategory (preferred)
... medication[x] SΣ1..1CodeableConcept, Reference(QICore-Medication)What was administered
Binding: Medication Clinical Drug (RxNorm) (preferred)
... subject SΣ1..1Reference(QICore-Patient), Reference(Group)Who received medication
... context S0..1Reference(QICore-Encounter), Reference(EpisodeOfCare)Encounter or Episode of Care administered as part of
... supportingInformation 0..*Reference(Resource)Additional information to support administration
... effective[x] SΣ1..1dateTime, PeriodStart and end time of administration
... performer ΣI0..*BackboneElementWho administered substance
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... actor Σ1..1Reference(QICore-Practitioner), Reference(QICore-Patient), Reference(QICore-RelatedPerson), Reference(QICore-Device)Individual who was performing
.... onBehalfOf 0..1Reference(Organization)Organization organization was acting for
... notGiven ?!SΣ0..1booleanTrue if medication not administered
... reasonNotGiven SI0..*CodeableConceptReason administration not performed
Binding: SNOMED CT Reason Medication Not Given Codes (example)
... reasonCode SI0..*CodeableConceptReason administration performed
Binding: Reason Medication Given Codes (example)
... reasonReference 0..*Reference(Condition), Reference(Observation)Condition or Observation that supports why the medication was administered
... prescription 0..1Reference(QICore-MedicationRequest)Request administration performed against
... device 0..*Reference(QICore-Device)Device used to administer
... note 0..*AnnotationInformation about the administration
... dosage I0..1BackboneElementDetails of how medication was taken
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... text 0..1stringFree text dosage instructions e.g. SIG
.... site 0..1CodeableConceptBody site administered to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example)
.... route S0..1CodeableConceptPath of substance into body
Binding: SNOMED CT Route Codes (example)
.... method 0..1CodeableConceptHow drug was administered
Binding: SNOMED CT Administration Method Codes (example)
.... dose S0..1SimpleQuantityAmount of medication per dose
.... rate[x] 0..1Ratio, SimpleQuantityDose quantity per unit of time
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration I0..*Administration of medication to a patient
... 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
... identifier 0..*IdentifierExternal identifier
... definition Σ0..*Reference(PlanDefinition), Reference(ActivityDefinition)Instantiates protocol or definition
... partOf Σ0..*Reference(MedicationAdministration), Reference(Procedure)Part of referenced event
... status ?!SΣ1..1codein-progress | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministrationStatus (required)
... category 0..1CodeableConceptType of medication usage
Binding: MedicationAdministrationCategory (preferred)
... medication[x] SΣ1..1CodeableConcept, Reference(QICore-Medication)What was administered
Binding: Medication Clinical Drug (RxNorm) (preferred)
... subject SΣ1..1Reference(QICore-Patient), Reference(Group)Who received medication
... context S0..1Reference(QICore-Encounter), Reference(EpisodeOfCare)Encounter or Episode of Care administered as part of
... supportingInformation 0..*Reference(Resource)Additional information to support administration
... effective[x] SΣ1..1dateTime, PeriodStart and end time of administration
... performer ΣI0..*BackboneElementWho administered substance
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... actor Σ1..1Reference(QICore-Practitioner), Reference(QICore-Patient), Reference(QICore-RelatedPerson), Reference(QICore-Device)Individual who was performing
.... onBehalfOf 0..1Reference(Organization)Organization organization was acting for
... notGiven ?!SΣ0..1booleanTrue if medication not administered
... reasonNotGiven SI0..*CodeableConceptReason administration not performed
Binding: SNOMED CT Reason Medication Not Given Codes (example)
... reasonCode SI0..*CodeableConceptReason administration performed
Binding: Reason Medication Given Codes (example)
... reasonReference 0..*Reference(Condition), Reference(Observation)Condition or Observation that supports why the medication was administered
... prescription 0..1Reference(QICore-MedicationRequest)Request administration performed against
... device 0..*Reference(QICore-Device)Device used to administer
... note 0..*AnnotationInformation about the administration
... dosage I0..1BackboneElementDetails of how medication was taken
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... text 0..1stringFree text dosage instructions e.g. SIG
.... site 0..1CodeableConceptBody site administered to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example)
.... route S0..1CodeableConceptPath of substance into body
Binding: SNOMED CT Route Codes (example)
.... method 0..1CodeableConceptHow drug was administered
Binding: SNOMED CT Administration Method Codes (example)
.... dose S0..1SimpleQuantityAmount of medication per dose
.... rate[x] 0..1Ratio, SimpleQuantityDose quantity per unit of time
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
MedicationAdministration.languageCommon LanguagesextensibleCommon Languages
MedicationAdministration.statusMedicationAdministrationStatusrequiredMedicationAdministrationStatus
MedicationAdministration.categoryMedicationAdministrationCategorypreferredMedicationAdministrationCategory
MedicationAdministration.medication[x]Medication Clinical Drug (RxNorm)preferredMedication Clinical Drug (RxNorm)
MedicationAdministration.reasonNotGivenSNOMED CT Reason Medication Not Given CodesexampleSNOMED CT Reason Medication Not Given Codes
MedicationAdministration.reasonCodeReason Medication Given CodesexampleReason Medication Given Codes
MedicationAdministration.dosage.siteSNOMED CT Anatomical Structure for Administration Site CodesexampleSNOMED CT Anatomical Structure for Administration Site Codes
MedicationAdministration.dosage.routeSNOMED CT Route CodesexampleSNOMED CT Route Codes
MedicationAdministration.dosage.methodSNOMED CT Administration Method CodesexampleSNOMED CT Administration Method Codes

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2MedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1MedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4MedicationAdministrationIf 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-3MedicationAdministrationIf 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()
mad-2MedicationAdministrationReason not given is only permitted if NotGiven is true
: reasonNotGiven.empty() or notGiven = true
mad-3MedicationAdministrationReason given is only permitted if NotGiven is false
: reasonCode.empty() or notGiven.empty() or notGiven = 'false'
ele-1MedicationAdministration.performerAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1MedicationAdministration.dosageAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
mad-1MedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()