STU 2 Ballot

This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. 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

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

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

This profile was published on Fri Feb 27 00:00:00 AEDT 2015 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration I0..*Administration of medication to a patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
mad-2: Reason not given is only permitted if wasNotGiven is true
mad-3: Reason given is only permitted if wasNotGiven is false
... 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
... status ?!S1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
... medication[x] S1..1CodeableConcept, Reference(Profile qicore-medication)What was administered
Binding: 7.org/fhir/daf/ValueSet/daf-medication-codes (preferred)
... patient S1..1Reference(Profile qicore-patient)Who received medication
... encounter S0..1Reference(Profile qicore-encounter)An interaction during which services are provided to the patient
... effectiveTime[x] S1..1dateTime, PeriodStart and end time of administration
... performer 0..1Reference(Profile qicore-practitioner | Profile qicore-patient | Profile qicore-relatedperson)Who administered substance
... prescription 0..1Reference(Profile qicore-medicationorder)Order administration performed against
... wasNotGiven ?!S0..1booleanTrue if medication not administered
... reasonNotGiven SI0..*CodeableConceptReason administration not performed
Binding: SNOMED CT Reason Medication Not Given Codes (example)
... reasonGiven SI0..*CodeableConceptReason administration performed
Binding: Reason Medication Given Codes (example)
... device 0..*Reference(Profile qicore-device)Item used in healthcare
... note 0..*AnnotationInformation about the administration
... dosage I0..1BackboneElementDetails of how medication was taken
mad-1: SHALL have at least one of dosage.dose and dosage.rate[x]
.... 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[x] 0..1CodeableConcept, Reference(BodySite)Body 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..*BackboneElementA list of events of interest in the lifecycle
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... status 1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
.... action 0..1CodeableConceptAction taken (e.g. verify)
Binding: (unbound) (example)
.... dateTime 1..1dateTimeThe date at which the event happened
.... actor 0..1Reference(Practitioner)Who took the action
.... reason 0..1CodeableConceptReason the action was taken
Binding: (unbound) (example)

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration I0..*Administration of medication to a patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
mad-2: Reason not given is only permitted if wasNotGiven is true
mad-3: Reason given is only permitted if wasNotGiven is false
... 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
... status ?!S1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
... medication[x] S1..1CodeableConcept, Reference(Profile qicore-medication)What was administered
Binding: 7.org/fhir/daf/ValueSet/daf-medication-codes (preferred)
... patient S1..1Reference(Profile qicore-patient)Who received medication
... encounter S0..1Reference(Profile qicore-encounter)An interaction during which services are provided to the patient
... effectiveTime[x] S1..1dateTime, PeriodStart and end time of administration
... performer 0..1Reference(Profile qicore-practitioner | Profile qicore-patient | Profile qicore-relatedperson)Who administered substance
... prescription 0..1Reference(Profile qicore-medicationorder)Order administration performed against
... wasNotGiven ?!S0..1booleanTrue if medication not administered
... reasonNotGiven SI0..*CodeableConceptReason administration not performed
Binding: SNOMED CT Reason Medication Not Given Codes (example)
... reasonGiven SI0..*CodeableConceptReason administration performed
Binding: Reason Medication Given Codes (example)
... device 0..*Reference(Profile qicore-device)Item used in healthcare
... note 0..*AnnotationInformation about the administration
... dosage I0..1BackboneElementDetails of how medication was taken
mad-1: SHALL have at least one of dosage.dose and dosage.rate[x]
.... 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[x] 0..1CodeableConcept, Reference(BodySite)Body 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..*BackboneElementA list of events of interest in the lifecycle
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... status 1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
.... action 0..1CodeableConceptAction taken (e.g. verify)
Binding: (unbound) (example)
.... dateTime 1..1dateTimeThe date at which the event happened
.... actor 0..1Reference(Practitioner)Who took the action
.... reason 0..1CodeableConceptReason the action was taken
Binding: (unbound) (example)

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
MedicationAdministration.languageCommon LanguagesextensibleCommon Languages
MedicationAdministration.statusMedicationAdministrationStatusrequiredMedicationAdministrationStatus
MedicationAdministration.medication[x]?extpreferredhttp://hl7.org/fhir/daf/ValueSet/daf-medication-codes
MedicationAdministration.reasonNotGivenSNOMED CT Reason Medication Not Given CodesexampleSNOMED CT Reason Medication Not Given Codes
MedicationAdministration.reasonGivenReason Medication Given CodesexampleReason Medication Given Codes
MedicationAdministration.dosage.site[x]SNOMED 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
MedicationAdministration.eventHistory.statusMedicationAdministrationStatusrequiredMedicationAdministrationStatus
MedicationAdministration.eventHistory.action?extexample
MedicationAdministration.eventHistory.reason?extexample

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2MedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1MedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4MedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3MedicationAdministrationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
mad-2MedicationAdministrationReason not given is only permitted if wasNotGiven is true
XPath: not(exists(f:reasonNotGiven) and f:wasNotGiven/@value=false())
mad-3MedicationAdministrationReason given is only permitted if wasNotGiven is false
XPath: not(exists(f:reasonGiven) and f:wasNotGiven/@value=true())
mad-1MedicationAdministration.dosageSHALL have at least one of dosage.dose and dosage.rate[x]
XPath: exists(f:dose) or exists(f:rateRatio) or exists(f:rateRange)
.