MIMIC Implementation Guide
1.3.0 - Draft

MIMIC Implementation Guide - Local Development build (v1.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: MIMIC Medication Administration

Official URL: http://mimic.mit.edu/fhir/mimic/StructureDefinition/mimic-medication-administration Version: 1.3.0
Active as of 2024-02-08 Computable Name: MimicMedicationAdministration

A MIMIC medication administration profile based on the base FHIR R4 medication administration resource.

Usage:

Formal Views of Profile Content

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

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*MedicationAdministrationAdministration of medication to a patient
... medication[x] 1..1CodeableConceptWhat was administered
... subject 1..1Reference(MIMIC Patient)Who received medication
... context 0..1Reference(MIMIC Encounter)Encounter or Episode of Care administered as part of
... dosage
.... site 0..1CodeableConceptBody site administered to
Binding: MimicMedicationSite (required)
.... route 0..1CodeableConceptPath of substance into body
Binding: MimicMedicationRoute (required)
.... method 0..1CodeableConceptHow drug was administered
Binding: MimicMedicationMethod (required)
.... rateQuantity 0..1SimpleQuantityA fixed quantity (no comparator)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationAdministration.dosage.siterequiredMimicMedicationSite
http://mimic.mit.edu/fhir/mimic/ValueSet/mimic-medication-site
from this IG
MedicationAdministration.dosage.routerequiredMimicMedicationRoute
http://mimic.mit.edu/fhir/mimic/ValueSet/mimic-medication-route
from this IG
MedicationAdministration.dosage.methodrequiredMimicMedicationMethod
http://mimic.mit.edu/fhir/mimic/ValueSet/mimic-medication-method
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*MedicationAdministrationAdministration of medication to a patient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codein-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.

... subject Σ1..1Reference(MIMIC Patient)Who received medication
... context 0..1Reference(MIMIC Encounter)Encounter or Episode of Care administered as part of
... effective[x] Σ1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... request 0..1Reference(MIMIC Medication Request)Request administration performed against

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1
from the FHIR Standard
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf 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-4errorMedicationAdministrationIf 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-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*MedicationAdministrationAdministration 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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..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
... instantiates Σ0..*uriInstantiates protocol or definition
... partOf Σ0..*Reference(MedicationAdministration | Procedure)Part of referenced event
... status ?!Σ1..1codein-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.

... statusReason 0..*CodeableConceptReason administration not performed
Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.


... category 0..1CodeableConceptType of medication usage
Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur.

... medication[x] Σ1..1CodeableConceptWhat was administered
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

... subject Σ1..1Reference(MIMIC Patient)Who received medication
... context 0..1Reference(MIMIC Encounter)Encounter or Episode of Care administered as part of
... supportingInformation 0..*Reference(Resource)Additional information to support administration
... effective[x] Σ1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... performer Σ0..*BackboneElementWho performed the medication administration and what they did
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function 0..1CodeableConceptType of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.

.... actor Σ1..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device)Who performed the medication administration
... reasonCode 0..*CodeableConceptReason 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..1Reference(MIMIC Medication Request)Request administration performed against
... device 0..*Reference(Device)Device used to administer
... note 0..*AnnotationInformation about the administration
... dosage C0..1BackboneElementDetails of how medication was taken
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... text 0..1stringFree text dosage instructions e.g. SIG
.... site 0..1CodeableConceptBody site administered to
Binding: MimicMedicationSite (required)
.... route 0..1CodeableConceptPath of substance into body
Binding: MimicMedicationRoute (required)
.... method 0..1CodeableConceptHow drug was administered
Binding: MimicMedicationMethod (required)
.... dose 0..1SimpleQuantityAmount of medication per dose
.... Slices for rate[x] 0..1Dose quantity per unit of time
Slice: Unordered, Open by type:$this
..... rateRatioRatio
..... rateQuantityQuantity(SimpleQuantity)
..... rate[x]:rateQuantity C0..1SimpleQuantityA fixed quantity (no comparator)
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1
from the FHIR Standard
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes
from the FHIR Standard
MedicationAdministration.categorypreferredMedicationAdministration Category Codes
http://hl7.org/fhir/ValueSet/medication-admin-category
from the FHIR Standard
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
http://hl7.org/fhir/ValueSet/med-admin-perform-function
from the FHIR Standard
MedicationAdministration.reasonCodeexampleReasonMedicationGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-given-codes
from the FHIR Standard
MedicationAdministration.dosage.siterequiredMimicMedicationSite
http://mimic.mit.edu/fhir/mimic/ValueSet/mimic-medication-site
from this IG
MedicationAdministration.dosage.routerequiredMimicMedicationRoute
http://mimic.mit.edu/fhir/mimic/ValueSet/mimic-medication-route
from this IG
MedicationAdministration.dosage.methodrequiredMimicMedicationMethod
http://mimic.mit.edu/fhir/mimic/ValueSet/mimic-medication-method
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf 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-4errorMedicationAdministrationIf 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-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()
qty-3errorMedicationAdministration.dosage.rate[x]:rateQuantityIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
sqty-1errorMedicationAdministration.dosage.rate[x]:rateQuantityThe comparator is not used on a SimpleQuantity
: comparator.empty()

Differential View

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*MedicationAdministrationAdministration of medication to a patient
... medication[x] 1..1CodeableConceptWhat was administered
... subject 1..1Reference(MIMIC Patient)Who received medication
... context 0..1Reference(MIMIC Encounter)Encounter or Episode of Care administered as part of
... dosage
.... site 0..1CodeableConceptBody site administered to
Binding: MimicMedicationSite (required)
.... route 0..1CodeableConceptPath of substance into body
Binding: MimicMedicationRoute (required)
.... method 0..1CodeableConceptHow drug was administered
Binding: MimicMedicationMethod (required)
.... rateQuantity 0..1SimpleQuantityA fixed quantity (no comparator)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationAdministration.dosage.siterequiredMimicMedicationSite
http://mimic.mit.edu/fhir/mimic/ValueSet/mimic-medication-site
from this IG
MedicationAdministration.dosage.routerequiredMimicMedicationRoute
http://mimic.mit.edu/fhir/mimic/ValueSet/mimic-medication-route
from this IG
MedicationAdministration.dosage.methodrequiredMimicMedicationMethod
http://mimic.mit.edu/fhir/mimic/ValueSet/mimic-medication-method
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*MedicationAdministrationAdministration of medication to a patient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codein-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.

... subject Σ1..1Reference(MIMIC Patient)Who received medication
... context 0..1Reference(MIMIC Encounter)Encounter or Episode of Care administered as part of
... effective[x] Σ1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... request 0..1Reference(MIMIC Medication Request)Request administration performed against

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1
from the FHIR Standard
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf 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-4errorMedicationAdministrationIf 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-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*MedicationAdministrationAdministration 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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..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
... instantiates Σ0..*uriInstantiates protocol or definition
... partOf Σ0..*Reference(MedicationAdministration | Procedure)Part of referenced event
... status ?!Σ1..1codein-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.

... statusReason 0..*CodeableConceptReason administration not performed
Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.


... category 0..1CodeableConceptType of medication usage
Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur.

... medication[x] Σ1..1CodeableConceptWhat was administered
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

... subject Σ1..1Reference(MIMIC Patient)Who received medication
... context 0..1Reference(MIMIC Encounter)Encounter or Episode of Care administered as part of
... supportingInformation 0..*Reference(Resource)Additional information to support administration
... effective[x] Σ1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... performer Σ0..*BackboneElementWho performed the medication administration and what they did
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function 0..1CodeableConceptType of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.

.... actor Σ1..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device)Who performed the medication administration
... reasonCode 0..*CodeableConceptReason 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..1Reference(MIMIC Medication Request)Request administration performed against
... device 0..*Reference(Device)Device used to administer
... note 0..*AnnotationInformation about the administration
... dosage C0..1BackboneElementDetails of how medication was taken
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... text 0..1stringFree text dosage instructions e.g. SIG
.... site 0..1CodeableConceptBody site administered to
Binding: MimicMedicationSite (required)
.... route 0..1CodeableConceptPath of substance into body
Binding: MimicMedicationRoute (required)
.... method 0..1CodeableConceptHow drug was administered
Binding: MimicMedicationMethod (required)
.... dose 0..1SimpleQuantityAmount of medication per dose
.... Slices for rate[x] 0..1Dose quantity per unit of time
Slice: Unordered, Open by type:$this
..... rateRatioRatio
..... rateQuantityQuantity(SimpleQuantity)
..... rate[x]:rateQuantity C0..1SimpleQuantityA fixed quantity (no comparator)
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1
from the FHIR Standard
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes
from the FHIR Standard
MedicationAdministration.categorypreferredMedicationAdministration Category Codes
http://hl7.org/fhir/ValueSet/medication-admin-category
from the FHIR Standard
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
http://hl7.org/fhir/ValueSet/med-admin-perform-function
from the FHIR Standard
MedicationAdministration.reasonCodeexampleReasonMedicationGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-given-codes
from the FHIR Standard
MedicationAdministration.dosage.siterequiredMimicMedicationSite
http://mimic.mit.edu/fhir/mimic/ValueSet/mimic-medication-site
from this IG
MedicationAdministration.dosage.routerequiredMimicMedicationRoute
http://mimic.mit.edu/fhir/mimic/ValueSet/mimic-medication-route
from this IG
MedicationAdministration.dosage.methodrequiredMimicMedicationMethod
http://mimic.mit.edu/fhir/mimic/ValueSet/mimic-medication-method
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf 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-4errorMedicationAdministrationIf 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-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()
qty-3errorMedicationAdministration.dosage.rate[x]:rateQuantityIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
sqty-1errorMedicationAdministration.dosage.rate[x]:rateQuantityThe comparator is not used on a SimpleQuantity
: comparator.empty()

 

Other representations of profile: CSV, Excel, Schematron