QI-Core Implementation Guide: STU 4 (v4.0.0 for FHIR 4.0.1)
QI-Core Implementation Guide - This is the current published version.. See the Directory of published versions
To create an expression specifically requesting information that a MedicationAdministration intentionally did not occur for a medical, patient or system reason, use the profile QICore-mednotadministered.
The following example illustrates the use of a MedicationAdministration resource:
// connectathon/fhir4/cql/EXM108_FHIR4-8.2.000.cql
define "Low Dose Unfractionated Heparin Administration":
["MedicationAdministration": medication in "Low Dose Unfractionated Heparin for VTE Prophylaxis"] VTEMedication
where VTEMedication.status = 'completed'
and VTEMedication.category ~ "Inpatient"
See the patterns page for implementation and usage patterns.
| Inhalant Example |
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 Wed Aug 22 00:00:00 UTC 2018 as a draft by Health Level Seven, Inc. - CQI WG.
Description of Profiles, Differentials, and Snapshots.
Summary
Must-Support: 9 elements
Structures
This structure refers to these other structures:
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MedicationAdministration | 0..* | MedicationAdministration | ||
  id | 0..1 | string | ||
| status | S | 1..1 | code | |
| statusReason | S | 0..* | CodeableConcept | |
 medication[x] | S | 1..1 | Binding: US Core Medication Codes (RxNorm) (preferred) | |
  medicationCodeableConcept | CodeableConcept | |||
  medicationReference | Reference(QICoreMedication) | |||
| subject | S | 1..1 | Reference(QICorePatient) | |
| context | S | 0..1 | Reference(QICoreEncounter | EpisodeOfCare) | |
| effective[x] | S | 1..1 | dateTime, Period | |
| performer | 0..* | BackboneElement | ||
| actor | 1..1 | Reference(QICorePractitioner | QICorePatient | QICoreRelatedPerson | QICoreDevice) | ||
| reasonCode | S | 0..* | CodeableConcept | |
| request | 0..1 | Reference(QICoreMedicationRequest) | ||
| device | 0..* | Reference(QICoreDevice) | ||
| dosage | 0..1 | BackboneElement | ||
 route | S | 0..1 | CodeableConcept | |
| dose | S | 0..1 | SimpleQuantity | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationAdministration | I | 0..* | MedicationAdministration | Administration of medication to a patient |
 id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | I | 0..* | Identifier | External identifier |
| instantiates | ΣI | 0..* | uri | Instantiates protocol or definition |
| partOf | ΣI | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event |
| status | ?!SΣI | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required) |
| statusReason | SI | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example) |
| category | I | 0..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministration Category Codes (preferred) |
| medication[x] | SΣI | 1..1 | What was administered Binding: US Core Medication Codes (RxNorm) (preferred) | |
| medicationCodeableConcept | CodeableConcept | |||
| medicationReference | Reference(QICoreMedication) | |||
| subject | SΣI | 1..1 | Reference(QICorePatient) | Who received medication |
| context | SI | 0..1 | Reference(QICoreEncounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of |
| supportingInformation | I | 0..* | Reference(Resource) | Additional information to support administration |
| effective[x] | SΣI | 1..1 | Start and end time of administration | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| performer | ΣI | 0..* | BackboneElement | Who performed the medication administration and what they did |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | I | 0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (example) |
| actor | ΣI | 1..1 | Reference(QICorePractitioner | QICorePatient | QICoreRelatedPerson | QICoreDevice) | Who performed the medication administration |
| reasonCode | SI | 0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (example) |
| reasonReference | I | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication was administered |
| request | I | 0..1 | Reference(QICoreMedicationRequest) | Request administration performed against |
| device | I | 0..* | Reference(QICoreDevice) | Device used to administer |
| note | I | 0..* | Annotation | Information about the administration |
| dosage | I | 0..1 | BackboneElement | Details of how medication was taken |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| text | I | 0..1 | string | Free text dosage instructions e.g. SIG |
| site | I | 0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example) |
| route | SI | 0..1 | CodeableConcept | Path of substance into body Binding: SNOMEDCTRouteCodes (example) |
| method | I | 0..1 | CodeableConcept | How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example) |
| dose | SI | 0..1 | SimpleQuantity | Amount of medication per dose |
| rate[x] | I | 0..1 | Dose quantity per unit of time | |
| rateRatio | Ratio | |||
| rateQuantity | Quantity(SimpleQuantity) | |||
| eventHistory | I | 0..* | Reference(Provenance) | A list of events of interest in the lifecycle |
| Documentation for this format | ||||
Summary
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationAdministration | 0..* | MedicationAdministration | ||
| id | 0..1 | string | ||
| status | S | 1..1 | code | |
| statusReason | S | 0..* | CodeableConcept | |
| medication[x] | S | 1..1 | Binding: US Core Medication Codes (RxNorm) (preferred) | |
| medicationCodeableConcept | CodeableConcept | |||
| medicationReference | Reference(QICoreMedication) | |||
| subject | S | 1..1 | Reference(QICorePatient) | |
| context | S | 0..1 | Reference(QICoreEncounter | EpisodeOfCare) | |
| effective[x] | S | 1..1 | dateTime, Period | |
| performer | 0..* | BackboneElement | ||
| actor | 1..1 | Reference(QICorePractitioner | QICorePatient | QICoreRelatedPerson | QICoreDevice) | ||
| reasonCode | S | 0..* | CodeableConcept | |
| request | 0..1 | Reference(QICoreMedicationRequest) | ||
| device | 0..* | Reference(QICoreDevice) | ||
| dosage | 0..1 | BackboneElement | ||
| route | S | 0..1 | CodeableConcept | |
| dose | S | 0..1 | SimpleQuantity | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationAdministration | I | 0..* | MedicationAdministration | Administration of medication to a patient |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | I | 0..* | Identifier | External identifier |
| instantiates | ΣI | 0..* | uri | Instantiates protocol or definition |
| partOf | ΣI | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event |
| status | ?!SΣI | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required) |
| statusReason | SI | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example) |
| category | I | 0..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministration Category Codes (preferred) |
| medication[x] | SΣI | 1..1 | What was administered Binding: US Core Medication Codes (RxNorm) (preferred) | |
| medicationCodeableConcept | CodeableConcept | |||
| medicationReference | Reference(QICoreMedication) | |||
| subject | SΣI | 1..1 | Reference(QICorePatient) | Who received medication |
| context | SI | 0..1 | Reference(QICoreEncounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of |
| supportingInformation | I | 0..* | Reference(Resource) | Additional information to support administration |
| effective[x] | SΣI | 1..1 | Start and end time of administration | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| performer | ΣI | 0..* | BackboneElement | Who performed the medication administration and what they did |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | I | 0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (example) |
| actor | ΣI | 1..1 | Reference(QICorePractitioner | QICorePatient | QICoreRelatedPerson | QICoreDevice) | Who performed the medication administration |
| reasonCode | SI | 0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (example) |
| reasonReference | I | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication was administered |
| request | I | 0..1 | Reference(QICoreMedicationRequest) | Request administration performed against |
| device | I | 0..* | Reference(QICoreDevice) | Device used to administer |
| note | I | 0..* | Annotation | Information about the administration |
| dosage | I | 0..1 | BackboneElement | Details of how medication was taken |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| text | I | 0..1 | string | Free text dosage instructions e.g. SIG |
| site | I | 0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example) |
| route | SI | 0..1 | CodeableConcept | Path of substance into body Binding: SNOMEDCTRouteCodes (example) |
| method | I | 0..1 | CodeableConcept | How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example) |
| dose | SI | 0..1 | SimpleQuantity | Amount of medication per dose |
| rate[x] | I | 0..1 | Dose quantity per unit of time | |
| rateRatio | Ratio | |||
| rateQuantity | Quantity(SimpleQuantity) | |||
| eventHistory | I | 0..* | Reference(Provenance) | A list of events of interest in the lifecycle |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationAdministration.language | preferred | CommonLanguages Max Binding: AllLanguages |
| MedicationAdministration.status | required | MedicationAdministration Status Codes |
| MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodes |
| MedicationAdministration.category | preferred | MedicationAdministration Category Codes |
| MedicationAdministration.medication[x] | preferred | USCoreMedicationCodes |
| MedicationAdministration.performer.function | example | MedicationAdministration Performer Function Codes |
| MedicationAdministration.reasonCode | example | ReasonMedicationGivenCodes |
| MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodes |
| MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodes |
| MedicationAdministration.dosage.method | example | SNOMEDCTAdministrationMethodCodes |
| Id | Path | Details | Requirements |
| dom-2 | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | MedicationAdministration | 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 | MedicationAdministration | 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 | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | MedicationAdministration | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | MedicationAdministration.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MedicationAdministration.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MedicationAdministration.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MedicationAdministration.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MedicationAdministration.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.instantiates | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.medication[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.context | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.supportingInformation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.effective[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.performer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.performer.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MedicationAdministration.performer.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MedicationAdministration.performer.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MedicationAdministration.performer.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MedicationAdministration.performer.function | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.performer.actor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.request | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.device | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.dosage | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| mad-1 | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() | |
| ele-1 | MedicationAdministration.dosage.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MedicationAdministration.dosage.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MedicationAdministration.dosage.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MedicationAdministration.dosage.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MedicationAdministration.dosage.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.dosage.site | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.dosage.route | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.dosage.method | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.dosage.dose | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.dosage.rate[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MedicationAdministration.eventHistory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
© HL7.org 2011+. (Clinical Quality Improvement WG). hl7.fhir.us.qicore#4.0.0 based on FHIR v4.0.1 Generated 2020-03-24.
Links: Home
| QA Report | Search
| Version History
| 
| Propose a change 