QI-Core Implementation Guide
6.0.0 - STU6
QI-Core Implementation Guide
6.0.0 - STU6
QI-Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 6.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-qi-core/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-medicationadministrationnotdone | Version: 6.0.0 | |||
| Active as of 2018-08-22 | Computable Name: QICoreMedicationAdministrationNotDone | |||
Negation profile of MedicationAdministration for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
| Negation example using a valueset | Medication not administered using a value set to indicate what was not administered; indicates that none of the medications in the given value set were administered |
| Negation example using a code | Medication not administered using a code to indicate that a particular medication was not administered; indicates that a specific medication, by code, was not administered |
Both of these example instances meet measure intent for exclusion as defined in the following example CQL:
define "Low Dose Unfractionated Heparin for VTE Prophylaxis Not Administered":
["MedicationAdministrationNotDone": "Low Dose Unfractionated Heparin for VTE Prophylaxis"] VTEMedication
where VTEMedication.category ~ QICoreCommon."Inpatient"
and (VTEMedication.reasonCode in "Medical Reason" or VTEMedication.reasonCode in "Patient Refusal")For a more complete discussion of representation of negation within QI-Core and quality improvement artifacts, see the Negation in QI-Core topic.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationAdministration
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MedicationAdministration | C | 0..* | MedicationAdministration | Administration of medication to a patient mna-1: To indicate what medication was not administered, either at least one coding in the medication or a notDoneValueSet extension shall be provided |
  implicitRules | 0..1 | uri | (QI-Core) A set of rules under which this content was created | |
 recorded | 1..1 | dateTime | (QI-Core) Extension URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded | |
 status | 1..1 | code | (QI-Core) in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Fixed Value: not-done | |
| statusReason | 1..* | CodeableConcept | (QI-Core) Reason administration not performed Binding: QICore Negation Reason Codes (extensible): The reason the event did not occur or was not performed | |
  medication[x] | C | 1..1 | CodeableConcept | (QI-Core) What was administered Binding: Medication Clinical Drug  (preferred): The set of RxNorm codes to represent medications |
  notDoneValueSet | C | 0..1 | canonical(ValueSet) | (QI-Core) Url of a value set of activities not requested or performed URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet |
 subject | 1..1 | Reference(QICore Patient) | (QI-Core) Who received medication | |
| context | 0..1 | Reference(QICore Encounter | EpisodeOfCare) | (QI-Core) Encounter or Episode of Care administered as part of | |
| effective[x] | 1..1 | dateTime, Period | (QI-Core) Start and end time of administration | |
| request | 0..1 | Reference(QICore MedicationRequest) | (QI-Core) Request administration performed against | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.statusReason | extensible | NegationReasonCodeshttp://hl7.org/fhir/us/qicore/ValueSet/qicore-negation-reasonfrom this IG | |
| MedicationAdministration.medication[x] | preferred | MedicationClinicalDrug http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 |
| Id | Grade | Path(s) | Details | Requirements |
| mna-1 | error | MedicationAdministration | To indicate what medication was not administered, either at least one coding in the medication or a notDoneValueSet extension shall be provided : medication.extension('http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet').exists() xor medication.coding.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationAdministration | C | 0..* | MedicationAdministration | Administration of medication to a patient mna-1: To indicate what medication was not administered, either at least one coding in the medication or a notDoneValueSet extension shall be provided |
| implicitRules | ?!Σ | 0..1 | uri | (QI-Core) A set of rules under which this content was created |
 Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| recorded | 1..1 | dateTime | (QI-Core) Extension URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | (QI-Core) in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. Fixed Value: not-done |
| statusReason | 1..* | CodeableConcept | (QI-Core) Reason administration not performed Binding: QICore Negation Reason Codes (extensible): The reason the event did not occur or was not performed | |
| medication[x] | ΣC | 1..1 | CodeableConcept | (QI-Core) What was administered Binding: Medication Clinical Drug (preferred): The set of RxNorm codes to represent medications |
| notDoneValueSet | C | 0..1 | canonical(ValueSet) | (QI-Core) Url of a value set of activities not requested or performed URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet |
| subject | Σ | 1..1 | Reference(QICore Patient) | (QI-Core) Who received medication |
| context | 0..1 | Reference(QICore Encounter | EpisodeOfCare) | (QI-Core) Encounter or Episode of Care administered as part of | |
 effective[x] | Σ | 1..1 | (QI-Core) Start and end time of administration | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| request | 0..1 | Reference(QICore MedicationRequest) | (QI-Core) Request administration performed against | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MedicationAdministration.status | required | Fixed Value: not-donehttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1from the FHIR Standard | |
| MedicationAdministration.statusReason | extensible | NegationReasonCodeshttp://hl7.org/fhir/us/qicore/ValueSet/qicore-negation-reasonfrom this IG | |
| MedicationAdministration.medication[x] | preferred | MedicationClinicalDrug http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | 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() | |
| mna-1 | error | MedicationAdministration | To indicate what medication was not administered, either at least one coding in the medication or a notDoneValueSet extension shall be provided : medication.extension('http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet').exists() xor medication.coding.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationAdministration | C | 0..* | MedicationAdministration | Administration of medication to a patient mna-1: To indicate what medication was not administered, either at least one coding in the medication or a notDoneValueSet extension shall be provided | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | (QI-Core) 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 | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| recorded | 1..1 | dateTime | (QI-Core) Extension URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier | External identifier | |||||
| instantiates | Σ | 0..* | uri | Instantiates protocol or definition | ||||
| partOf | Σ | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event | ||||
| status | ?!Σ | 1..1 | code | (QI-Core) in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. Fixed Value: not-done | ||||
| statusReason | 1..* | CodeableConcept | (QI-Core) Reason administration not performed Binding: QICore Negation Reason Codes (extensible): The reason the event did not occur or was not performed | |||||
| category | 0..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur. | |||||
| medication[x] | ΣC | 1..1 | CodeableConcept | (QI-Core) What was administered Binding: Medication Clinical Drug (preferred): The set of RxNorm codes to represent medications | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| notDoneValueSet | C | 0..1 | canonical(ValueSet) | (QI-Core) Url of a value set of activities not requested or performed URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet | ||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| subject | Σ | 1..1 | Reference(QICore Patient) | (QI-Core) Who received medication | ||||
| context | 0..1 | Reference(QICore Encounter | EpisodeOfCare) | (QI-Core) Encounter or Episode of Care administered as part of | |||||
| supportingInformation | 0..* | Reference(Resource) | Additional information to support administration | |||||
| effective[x] | Σ | 1..1 | (QI-Core) Start and end time of administration | |||||
| effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| performer | Σ | 0..* | BackboneElement | Who performed the medication administration and what they did | ||||
| 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 | ||||
| function | 0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication. | |||||
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who performed the medication administration | ||||
| reasonCode | 0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made. | |||||
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication was administered | |||||
| request | 0..1 | Reference(QICore MedicationRequest) | (QI-Core) Request administration performed against | |||||
| device | 0..* | Reference(Device) | Device used to administer | |||||
| note | 0..* | Annotation | Information about the administration | |||||
| dosage | C | 0..1 | BackboneElement | Details of how medication was taken mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] | ||||
| 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 | ||||
| text | 0..1 | string | Free text dosage instructions e.g. SIG | |||||
| site | 0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | |||||
| route | 0..1 | CodeableConcept | Path of substance into body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||
| method | 0..1 | CodeableConcept | How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | |||||
| dose | 0..1 | SimpleQuantity | Amount of medication per dose | |||||
 rate[x] | 0..1 | Dose quantity per unit of time | ||||||
 rateRatio | Ratio | |||||||
| rateQuantity | Quantity(SimpleQuantity) | |||||||
| eventHistory | 0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MedicationAdministration.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| MedicationAdministration.status | required | Fixed Value: not-donehttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1from the FHIR Standard | ||||
| MedicationAdministration.statusReason | extensible | NegationReasonCodeshttp://hl7.org/fhir/us/qicore/ValueSet/qicore-negation-reasonfrom this IG | ||||
| MedicationAdministration.category | preferred | MedicationAdministration Category Codeshttp://hl7.org/fhir/ValueSet/medication-admin-categoryfrom the FHIR Standard | ||||
| MedicationAdministration.medication[x] | preferred | MedicationClinicalDrug http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 | ||||
| MedicationAdministration.performer.function | example | MedicationAdministration Performer Function Codeshttp://hl7.org/fhir/ValueSet/med-admin-perform-functionfrom the FHIR Standard | ||||
| MedicationAdministration.reasonCode | example | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codesfrom the FHIR Standard | ||||
| MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codesfrom the FHIR Standard | ||||
| MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesfrom the FHIR Standard | ||||
| MedicationAdministration.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | 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() | |
| mad-1 | error | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() | |
| mna-1 | error | MedicationAdministration | To indicate what medication was not administered, either at least one coding in the medication or a notDoneValueSet extension shall be provided : medication.extension('http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet').exists() xor medication.coding.exists() |
This structure is derived from MedicationAdministration
Summary
Mandatory: 2 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from MedicationAdministration
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationAdministration | C | 0..* | MedicationAdministration | Administration of medication to a patient mna-1: To indicate what medication was not administered, either at least one coding in the medication or a notDoneValueSet extension shall be provided |
| implicitRules | 0..1 | uri | (QI-Core) A set of rules under which this content was created | |
| recorded | 1..1 | dateTime | (QI-Core) Extension URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded | |
| status | 1..1 | code | (QI-Core) in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Fixed Value: not-done | |
| statusReason | 1..* | CodeableConcept | (QI-Core) Reason administration not performed Binding: QICore Negation Reason Codes (extensible): The reason the event did not occur or was not performed | |
| medication[x] | C | 1..1 | CodeableConcept | (QI-Core) What was administered Binding: Medication Clinical Drug (preferred): The set of RxNorm codes to represent medications |
| notDoneValueSet | C | 0..1 | canonical(ValueSet) | (QI-Core) Url of a value set of activities not requested or performed URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet |
| subject | 1..1 | Reference(QICore Patient) | (QI-Core) Who received medication | |
| context | 0..1 | Reference(QICore Encounter | EpisodeOfCare) | (QI-Core) Encounter or Episode of Care administered as part of | |
| effective[x] | 1..1 | dateTime, Period | (QI-Core) Start and end time of administration | |
| request | 0..1 | Reference(QICore MedicationRequest) | (QI-Core) Request administration performed against | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.statusReason | extensible | NegationReasonCodeshttp://hl7.org/fhir/us/qicore/ValueSet/qicore-negation-reasonfrom this IG | |
| MedicationAdministration.medication[x] | preferred | MedicationClinicalDrug http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 |
| Id | Grade | Path(s) | Details | Requirements |
| mna-1 | error | MedicationAdministration | To indicate what medication was not administered, either at least one coding in the medication or a notDoneValueSet extension shall be provided : medication.extension('http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet').exists() xor medication.coding.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationAdministration | C | 0..* | MedicationAdministration | Administration of medication to a patient mna-1: To indicate what medication was not administered, either at least one coding in the medication or a notDoneValueSet extension shall be provided |
| implicitRules | ?!Σ | 0..1 | uri | (QI-Core) A set of rules under which this content was created |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| recorded | 1..1 | dateTime | (QI-Core) Extension URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | (QI-Core) in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. Fixed Value: not-done |
| statusReason | 1..* | CodeableConcept | (QI-Core) Reason administration not performed Binding: QICore Negation Reason Codes (extensible): The reason the event did not occur or was not performed | |
| medication[x] | ΣC | 1..1 | CodeableConcept | (QI-Core) What was administered Binding: Medication Clinical Drug (preferred): The set of RxNorm codes to represent medications |
| notDoneValueSet | C | 0..1 | canonical(ValueSet) | (QI-Core) Url of a value set of activities not requested or performed URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet |
| subject | Σ | 1..1 | Reference(QICore Patient) | (QI-Core) Who received medication |
| context | 0..1 | Reference(QICore Encounter | EpisodeOfCare) | (QI-Core) Encounter or Episode of Care administered as part of | |
| effective[x] | Σ | 1..1 | (QI-Core) Start and end time of administration | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| request | 0..1 | Reference(QICore MedicationRequest) | (QI-Core) Request administration performed against | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MedicationAdministration.status | required | Fixed Value: not-donehttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1from the FHIR Standard | |
| MedicationAdministration.statusReason | extensible | NegationReasonCodeshttp://hl7.org/fhir/us/qicore/ValueSet/qicore-negation-reasonfrom this IG | |
| MedicationAdministration.medication[x] | preferred | MedicationClinicalDrug http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | 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() | |
| mna-1 | error | MedicationAdministration | To indicate what medication was not administered, either at least one coding in the medication or a notDoneValueSet extension shall be provided : medication.extension('http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet').exists() xor medication.coding.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationAdministration | C | 0..* | MedicationAdministration | Administration of medication to a patient mna-1: To indicate what medication was not administered, either at least one coding in the medication or a notDoneValueSet extension shall be provided | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | (QI-Core) 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 | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| recorded | 1..1 | dateTime | (QI-Core) Extension URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-recorded | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier | External identifier | |||||
| instantiates | Σ | 0..* | uri | Instantiates protocol or definition | ||||
| partOf | Σ | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event | ||||
| status | ?!Σ | 1..1 | code | (QI-Core) in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. Fixed Value: not-done | ||||
| statusReason | 1..* | CodeableConcept | (QI-Core) Reason administration not performed Binding: QICore Negation Reason Codes (extensible): The reason the event did not occur or was not performed | |||||
| category | 0..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur. | |||||
| medication[x] | ΣC | 1..1 | CodeableConcept | (QI-Core) What was administered Binding: Medication Clinical Drug (preferred): The set of RxNorm codes to represent medications | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| notDoneValueSet | C | 0..1 | canonical(ValueSet) | (QI-Core) Url of a value set of activities not requested or performed URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet | ||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| subject | Σ | 1..1 | Reference(QICore Patient) | (QI-Core) Who received medication | ||||
| context | 0..1 | Reference(QICore Encounter | EpisodeOfCare) | (QI-Core) Encounter or Episode of Care administered as part of | |||||
| supportingInformation | 0..* | Reference(Resource) | Additional information to support administration | |||||
| effective[x] | Σ | 1..1 | (QI-Core) Start and end time of administration | |||||
| effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| performer | Σ | 0..* | BackboneElement | Who performed the medication administration and what they did | ||||
| 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 | ||||
| function | 0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication. | |||||
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who performed the medication administration | ||||
| reasonCode | 0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made. | |||||
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication was administered | |||||
| request | 0..1 | Reference(QICore MedicationRequest) | (QI-Core) Request administration performed against | |||||
| device | 0..* | Reference(Device) | Device used to administer | |||||
| note | 0..* | Annotation | Information about the administration | |||||
| dosage | C | 0..1 | BackboneElement | Details of how medication was taken mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] | ||||
| 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 | ||||
| text | 0..1 | string | Free text dosage instructions e.g. SIG | |||||
| site | 0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | |||||
| route | 0..1 | CodeableConcept | Path of substance into body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||
| method | 0..1 | CodeableConcept | How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | |||||
| dose | 0..1 | SimpleQuantity | Amount of medication per dose | |||||
| rate[x] | 0..1 | Dose quantity per unit of time | ||||||
| rateRatio | Ratio | |||||||
| rateQuantity | Quantity(SimpleQuantity) | |||||||
| eventHistory | 0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MedicationAdministration.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| MedicationAdministration.status | required | Fixed Value: not-donehttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1from the FHIR Standard | ||||
| MedicationAdministration.statusReason | extensible | NegationReasonCodeshttp://hl7.org/fhir/us/qicore/ValueSet/qicore-negation-reasonfrom this IG | ||||
| MedicationAdministration.category | preferred | MedicationAdministration Category Codeshttp://hl7.org/fhir/ValueSet/medication-admin-categoryfrom the FHIR Standard | ||||
| MedicationAdministration.medication[x] | preferred | MedicationClinicalDrug http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 | ||||
| MedicationAdministration.performer.function | example | MedicationAdministration Performer Function Codeshttp://hl7.org/fhir/ValueSet/med-admin-perform-functionfrom the FHIR Standard | ||||
| MedicationAdministration.reasonCode | example | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codesfrom the FHIR Standard | ||||
| MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codesfrom the FHIR Standard | ||||
| MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesfrom the FHIR Standard | ||||
| MedicationAdministration.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | 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() | |
| mad-1 | error | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() | |
| mna-1 | error | MedicationAdministration | To indicate what medication was not administered, either at least one coding in the medication or a notDoneValueSet extension shall be provided : medication.extension('http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-notDoneValueSet').exists() xor medication.coding.exists() |
This structure is derived from MedicationAdministration
Summary
Mandatory: 2 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
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-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change