HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE), v0.9.1

HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE), v0.9.1 FHIR Profiles - Local Development build (v0.9.1). See the Directory of published versions

MedicationAdministration

 

The official URL for this profile is: 

http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-MedicationAdministration

A record of the use of a medication. If the medication is given as part of a course of treatment, the PartOf attribute should refer to the CourseOfTreatment. Although FHIR MedicationAdministration supports date of administration, information source, performer, it lacks common provenance elements, statement creation date, author, and recorder. These are supported as optional extensions. FHIR DSTU2 lacks a category attribute, which is provided as an extension in that version. SHR does not allow the 'not given' attributes from DSTU2 and STU3, since they are dropped in R4. The status element is used to document medications not given.

This profile builds on MedicationAdministration.

This profile was published on Wed Oct 23 00:00:00 EDT 2019 as a draft by The MITRE Corporation.

Summary

Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

obf.MedicationAdministration maps to MedicationAdministration:
  Language maps to language
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.SourceSystem maps to meta.extension
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Narrative maps to text
  Identifier maps to identifier
  Status maps to status
  MedicationAdministrationPartOf maps to extension
  StatusReason maps to extension
  Category maps to extension
  SubjectOfRecord maps to patient
  Participation.Participant maps to practitioner
  CareContext maps to encounter
  MedicationAdministrationBasedOn maps to prescription
  constrain wasNotGiven to 0..0
  constrain reasonNotGiven to 0..0
  ReasonCode maps to reasonGiven
  MedicationReasonReference maps to extension
  OccurrenceTimeOrPeriod maps to effectiveTime[x]  // different name
  MedicationCodeOrReference maps to medication[x]
  Device maps to device
  Annotation maps to extension
  Dosage.InstructionText maps to dosage.text
  Dosage.AdministrationSite maps to dosage.site[x]
  Dosage.RouteIntoBody maps to dosage.route
  Dosage.Method maps to dosage.method
  Dosage.DoseAndRate.DoseAmount maps to dosage.quantity
  Dosage.DoseAndRate.DoseRate maps to dosage.rate[x]
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration Σobf-MedicationAdministration
... meta
.... extension Slice: Unordered, Open by value:url
.... obf-SourceSystem-extension 0..1uriSourceSystem
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-SourceSystem-extension
... extension Slice: Unordered, Open by value:url
... obf-MedicationAdministrationPartOf-extension 0..*Reference(obf-MedicationAdministration | obf-Procedure)MedicationAdministrationPartOf
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-MedicationAdministrationPartOf-extension
... obf-StatusReason-extension 0..*CodeableConceptStatusReason
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-StatusReason-extension
... obf-datatype-Category-extension 0..1CodeableConceptCategory
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-datatype-Category-extension
.... valueCodeableConcept ​Binding: medication-admin-category (preferred)
... obf-MedicationReasonReference-extension 0..*Reference(obf-Condition | obf-Observation | obf-DiagnosticReport)MedicationReasonReference
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-MedicationReasonReference-extension
... obf-Annotation-extension 0..*AnnotationAnnotation
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-Annotation-extension
... obf-StatementDateTime-extension 0..1dateTimeStatementDateTime
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-StatementDateTime-extension
... obf-SupportingInformation-extension 0..*Reference(obf-Resource)SupportingInformation
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-SupportingInformation-extension
... patient Reference(obf-Patient)
... practitioner Reference(Practitioner | obf-Patient | RelatedPerson)A choice of Patient, Practitioner and RelatedPerson as participant
... prescription Reference(obf-MedicationRequest)
... wasNotGiven 0..0
... reasonNotGiven 0..0
... medication[x]
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(http://fhir.org/guides/argonaut/StructureDefinition/argo-medication)
... device Reference(http://fhir.org/guides/argonaut/StructureDefinition/argo-device)
... dosage
.... siteCodeableConcept CodeableConceptBinding: SNOMED CT Body Structures (example)
.... route Binding: SNOMED CT Route Codes (required)
.... method ​Binding: administration-method-codes (preferred)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration ΣI0..*obf-MedicationAdministration
mad-3: Reason given is only permitted if wasNotGiven is false
mad-2: Reason not given is only permitted if wasNotGiven is true
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... obf-SourceSystem-extension 0..1uriSourceSystem
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-SourceSystem-extension
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ0..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: (unbound) (example)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... obf-MedicationAdministrationPartOf-extension 0..*Reference(obf-MedicationAdministration | obf-Procedure)MedicationAdministrationPartOf
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-MedicationAdministrationPartOf-extension
... obf-StatusReason-extension 0..*CodeableConceptStatusReason
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-StatusReason-extension
... obf-datatype-Category-extension 0..1CodeableConceptCategory
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-datatype-Category-extension
.... id 0..1idxml:id (or equivalent in JSON)
.... url 1..1uri"http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-datatype-Category-extension"
.... valueCodeableConcept 1..1CodeableConcept​Value of extension
Binding: medication-admin-category (preferred)
... obf-MedicationReasonReference-extension 0..*Reference(obf-Condition | obf-Observation | obf-DiagnosticReport)MedicationReasonReference
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-MedicationReasonReference-extension
... obf-Annotation-extension 0..*AnnotationAnnotation
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-Annotation-extension
... obf-StatementDateTime-extension 0..1dateTimeStatementDateTime
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-StatementDateTime-extension
... obf-SupportingInformation-extension 0..*Reference(obf-Resource)SupportingInformation
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-SupportingInformation-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifier
... status ?!Σ1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
... patient Σ1..1Reference(obf-Patient)Who received medication
... practitioner Σ0..1Reference(Practitioner | obf-Patient | RelatedPerson)A choice of Patient, Practitioner and RelatedPerson as participant
... encounter Σ0..1Reference(Encounter)Encounter administered as part of
... prescription Σ0..1Reference(obf-MedicationRequest)Order administration performed against
... reasonGiven ΣI0..*CodeableConceptReason administration performed
Binding: Reason Medication Given Codes (example)
... effectiveTime[x] Σ1..1Start and end time of administration
.... effectiveTimeDateTimedateTime
.... effectiveTimePeriodPeriod
... medication[x] Σ1..1What was administered
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(http://fhir.org/guides/argonaut/StructureDefinition/argo-medication)
... device Σ0..*Reference(http://fhir.org/guides/argonaut/StructureDefinition/argo-device)Device used to administer
... note Σ0..1stringInformation about the administration
... dosage ΣI0..1BackboneElementDetails of how medication was taken
mad-1: SHALL have at least one of dosage.quantity and dosage.rate[x]
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... text Σ0..1stringDosage Instructions
.... siteCodeableConcept Σ0..1CodeableConceptBody site administered to
Binding: SNOMED CT Body Structures (example)
.... route Σ0..1CodeableConceptPath of substance into body
Binding: SNOMED CT Route Codes (required)
.... method Σ0..1CodeableConcept​How drug was administered
Binding: administration-method-codes (preferred)
.... quantity Σ0..1SimpleQuantityAmount administered in one dose
.... rate[x] Σ0..1Dose quantity per unit of time
..... rateRatioRatio
..... rateRangeRange

doco Documentation for this format

Summary

Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

obf.MedicationAdministration maps to MedicationAdministration:
  Language maps to language
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.SourceSystem maps to meta.extension
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Narrative maps to text
  Identifier maps to identifier
  Status maps to status
  MedicationAdministrationPartOf maps to extension
  StatusReason maps to extension
  Category maps to extension
  SubjectOfRecord maps to patient
  Participation.Participant maps to practitioner
  CareContext maps to encounter
  MedicationAdministrationBasedOn maps to prescription
  constrain wasNotGiven to 0..0
  constrain reasonNotGiven to 0..0
  ReasonCode maps to reasonGiven
  MedicationReasonReference maps to extension
  OccurrenceTimeOrPeriod maps to effectiveTime[x]  // different name
  MedicationCodeOrReference maps to medication[x]
  Device maps to device
  Annotation maps to extension
  Dosage.InstructionText maps to dosage.text
  Dosage.AdministrationSite maps to dosage.site[x]
  Dosage.RouteIntoBody maps to dosage.route
  Dosage.Method maps to dosage.method
  Dosage.DoseAndRate.DoseAmount maps to dosage.quantity
  Dosage.DoseAndRate.DoseRate maps to dosage.rate[x]

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration Σobf-MedicationAdministration
... meta
.... extension Slice: Unordered, Open by value:url
.... obf-SourceSystem-extension 0..1uriSourceSystem
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-SourceSystem-extension
... extension Slice: Unordered, Open by value:url
... obf-MedicationAdministrationPartOf-extension 0..*Reference(obf-MedicationAdministration | obf-Procedure)MedicationAdministrationPartOf
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-MedicationAdministrationPartOf-extension
... obf-StatusReason-extension 0..*CodeableConceptStatusReason
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-StatusReason-extension
... obf-datatype-Category-extension 0..1CodeableConceptCategory
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-datatype-Category-extension
.... valueCodeableConcept ​Binding: medication-admin-category (preferred)
... obf-MedicationReasonReference-extension 0..*Reference(obf-Condition | obf-Observation | obf-DiagnosticReport)MedicationReasonReference
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-MedicationReasonReference-extension
... obf-Annotation-extension 0..*AnnotationAnnotation
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-Annotation-extension
... obf-StatementDateTime-extension 0..1dateTimeStatementDateTime
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-StatementDateTime-extension
... obf-SupportingInformation-extension 0..*Reference(obf-Resource)SupportingInformation
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-SupportingInformation-extension
... patient Reference(obf-Patient)
... practitioner Reference(Practitioner | obf-Patient | RelatedPerson)A choice of Patient, Practitioner and RelatedPerson as participant
... prescription Reference(obf-MedicationRequest)
... wasNotGiven 0..0
... reasonNotGiven 0..0
... medication[x]
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(http://fhir.org/guides/argonaut/StructureDefinition/argo-medication)
... device Reference(http://fhir.org/guides/argonaut/StructureDefinition/argo-device)
... dosage
.... siteCodeableConcept CodeableConceptBinding: SNOMED CT Body Structures (example)
.... route Binding: SNOMED CT Route Codes (required)
.... method ​Binding: administration-method-codes (preferred)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration ΣI0..*obf-MedicationAdministration
mad-3: Reason given is only permitted if wasNotGiven is false
mad-2: Reason not given is only permitted if wasNotGiven is true
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... obf-SourceSystem-extension 0..1uriSourceSystem
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-SourceSystem-extension
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ0..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: (unbound) (example)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... obf-MedicationAdministrationPartOf-extension 0..*Reference(obf-MedicationAdministration | obf-Procedure)MedicationAdministrationPartOf
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-MedicationAdministrationPartOf-extension
... obf-StatusReason-extension 0..*CodeableConceptStatusReason
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-StatusReason-extension
... obf-datatype-Category-extension 0..1CodeableConceptCategory
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-datatype-Category-extension
.... id 0..1idxml:id (or equivalent in JSON)
.... url 1..1uri"http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-datatype-Category-extension"
.... valueCodeableConcept 1..1CodeableConcept​Value of extension
Binding: medication-admin-category (preferred)
... obf-MedicationReasonReference-extension 0..*Reference(obf-Condition | obf-Observation | obf-DiagnosticReport)MedicationReasonReference
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-MedicationReasonReference-extension
... obf-Annotation-extension 0..*AnnotationAnnotation
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-Annotation-extension
... obf-StatementDateTime-extension 0..1dateTimeStatementDateTime
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-StatementDateTime-extension
... obf-SupportingInformation-extension 0..*Reference(obf-Resource)SupportingInformation
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-SupportingInformation-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifier
... status ?!Σ1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
... patient Σ1..1Reference(obf-Patient)Who received medication
... practitioner Σ0..1Reference(Practitioner | obf-Patient | RelatedPerson)A choice of Patient, Practitioner and RelatedPerson as participant
... encounter Σ0..1Reference(Encounter)Encounter administered as part of
... prescription Σ0..1Reference(obf-MedicationRequest)Order administration performed against
... reasonGiven ΣI0..*CodeableConceptReason administration performed
Binding: Reason Medication Given Codes (example)
... effectiveTime[x] Σ1..1Start and end time of administration
.... effectiveTimeDateTimedateTime
.... effectiveTimePeriodPeriod
... medication[x] Σ1..1What was administered
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(http://fhir.org/guides/argonaut/StructureDefinition/argo-medication)
... device Σ0..*Reference(http://fhir.org/guides/argonaut/StructureDefinition/argo-device)Device used to administer
... note Σ0..1stringInformation about the administration
... dosage ΣI0..1BackboneElementDetails of how medication was taken
mad-1: SHALL have at least one of dosage.quantity and dosage.rate[x]
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... text Σ0..1stringDosage Instructions
.... siteCodeableConcept Σ0..1CodeableConceptBody site administered to
Binding: SNOMED CT Body Structures (example)
.... route Σ0..1CodeableConceptPath of substance into body
Binding: SNOMED CT Route Codes (required)
.... method Σ0..1CodeableConcept​How drug was administered
Binding: administration-method-codes (preferred)
.... quantity Σ0..1SimpleQuantityAmount administered in one dose
.... rate[x] Σ0..1Dose quantity per unit of time
..... rateRatioRatio
..... rateRangeRange

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathConformanceValueSet
MedicationAdministration.meta.securityextensibleAll Security Labels
MedicationAdministration.meta.tagexample
MedicationAdministration.languagerequiredhttp://tools.ietf.org/html/bcp47
MedicationAdministration.extension-category.valueCodeableConceptpreferredhttp://hl7.org/fhir/ValueSet/medication-admin-category
MedicationAdministration.statusrequiredMedicationAdministrationStatus
MedicationAdministration.reasonGivenexampleReason Medication Given Codes
MedicationAdministration.dosage.siteCodeableConceptexampleSNOMED CT Body Structures
MedicationAdministration.dosage.routerequiredSNOMED CT Route Codes
MedicationAdministration.dosage.methodpreferredhttp://hl7.org/fhir/ValueSet/administration-method-codes

 

Constraints

IdPathDetailsRequirements
mad-3MedicationAdministrationReason given is only permitted if wasNotGiven is false
:
mad-2MedicationAdministrationReason not given is only permitted if wasNotGiven is true
:
mad-1MedicationAdministration.dosageSHALL have at least one of dosage.quantity and dosage.rate[x]
: