QI-Core Implementation Guide
6.0.0 - STU6
QI-Core Implementation Guide
6.0.0 - STU6
This page is part of the Quality Improvement Core Framework (v6.0.0: STU6 (v6.0.0)) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-medication | Version: 6.0.0 | |||
| 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.
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
| Example of an IV medication - Alemtuzumab |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreMedicationProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Medication | USCoreMedicationProfile | |||
  manufacturer | 0..1 | Reference(QICore Organization) | Manufacturer of the item | |
  ingredient | ||||
   item[x] | 1..1 | The actual ingredient or content | ||
  itemCodeableConcept | CodeableConcept | |||
 itemReference | Reference(QICore Substance | QICore Medication) | |||
 isActive | 0..1 | boolean | Active ingredient indicator | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | 0..* | USCoreMedicationProfile | Definition of a Medication | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| code | SΣ | 1..1 | CodeableConcept | (USCDI) Codes that identify this medication Binding: Medication Clinical Drug  (extensible) |
| status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. |
| manufacturer | Σ | 0..1 | Reference(QICore Organization) | Manufacturer of the item |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Medication.code | extensible | Medication Clinical Drug http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 | |
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1from the FHIR Standard |
| 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 | ||||
|---|---|---|---|---|---|---|---|---|
| Medication | 0..* | USCoreMedicationProfile | Definition of a Medication | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business identifier for this medication | ||||
| code | SΣ | 1..1 | CodeableConcept | (USCDI) Codes that identify this medication Binding: Medication Clinical Drug (extensible) | ||||
| status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||
| manufacturer | Σ | 0..1 | Reference(QICore Organization) | Manufacturer of the item | ||||
| form | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
| amount | Σ | 0..1 | Ratio | Amount of drug in package | ||||
| ingredient | 0..* | BackboneElement | Active or inactive ingredient | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| item[x] | 1..1 | The actual ingredient or content | ||||||
| itemCodeableConcept | CodeableConcept | |||||||
| itemReference | Reference(QICore Substance | QICore Medication) | |||||||
| isActive | 0..1 | boolean | Active ingredient indicator | |||||
| strength | 0..1 | Ratio | Quantity of ingredient present | |||||
| batch | 0..1 | BackboneElement | Details about packaged medications | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| lotNumber | 0..1 | string | Identifier assigned to batch | |||||
| expirationDate | 0..1 | dateTime | When batch will expire | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Medication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Medication.code | extensible | Medication Clinical Drug http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 | ||||
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1from the FHIR Standard | ||||
| Medication.form | example | SNOMEDCTFormCodeshttp://hl7.org/fhir/ValueSet/medication-form-codesfrom the FHIR Standard |
| 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() |
This structure is derived from USCoreMedicationProfile
Differential View
This structure is derived from USCoreMedicationProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | USCoreMedicationProfile | |||
| manufacturer | 0..1 | Reference(QICore Organization) | Manufacturer of the item | |
| ingredient | ||||
| item[x] | 1..1 | The actual ingredient or content | ||
| itemCodeableConcept | CodeableConcept | |||
| itemReference | Reference(QICore Substance | QICore Medication) | |||
| isActive | 0..1 | boolean | Active ingredient indicator | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | 0..* | USCoreMedicationProfile | Definition of a Medication | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| code | SΣ | 1..1 | CodeableConcept | (USCDI) Codes that identify this medication Binding: Medication Clinical Drug (extensible) |
| status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. |
| manufacturer | Σ | 0..1 | Reference(QICore Organization) | Manufacturer of the item |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Medication.code | extensible | Medication Clinical Drug http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 | |
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1from the FHIR Standard |
| 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 | ||||
|---|---|---|---|---|---|---|---|---|
| Medication | 0..* | USCoreMedicationProfile | Definition of a Medication | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business identifier for this medication | ||||
| code | SΣ | 1..1 | CodeableConcept | (USCDI) Codes that identify this medication Binding: Medication Clinical Drug (extensible) | ||||
| status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||
| manufacturer | Σ | 0..1 | Reference(QICore Organization) | Manufacturer of the item | ||||
| form | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication. | |||||
| amount | Σ | 0..1 | Ratio | Amount of drug in package | ||||
| ingredient | 0..* | BackboneElement | Active or inactive ingredient | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| item[x] | 1..1 | The actual ingredient or content | ||||||
| itemCodeableConcept | CodeableConcept | |||||||
| itemReference | Reference(QICore Substance | QICore Medication) | |||||||
| isActive | 0..1 | boolean | Active ingredient indicator | |||||
| strength | 0..1 | Ratio | Quantity of ingredient present | |||||
| batch | 0..1 | BackboneElement | Details about packaged medications | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| lotNumber | 0..1 | string | Identifier assigned to batch | |||||
| expirationDate | 0..1 | dateTime | When batch will expire | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Medication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Medication.code | extensible | Medication Clinical Drug http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 | ||||
| Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1from the FHIR Standard | ||||
| Medication.form | example | SNOMEDCTFormCodeshttp://hl7.org/fhir/ValueSet/medication-form-codesfrom the FHIR Standard |
| 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() |
This structure is derived from USCoreMedicationProfile
Other representations of profile: CSV, Excel, Schematron
IG © 2019+ HL7 International / Clinical Quality Information. Package hl7.fhir.us.qicore#6.0.0 based on FHIR 4.0.1. Generated 2024-03-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change