minimal Common Oncology Data Elements (mCODE) Implementation Guide
2.0.0 - STU 2
minimal Common Oncology Data Elements (mCODE) Implementation Guide
2.0.0 - STU 2
This page is part of the HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1 (v2.0.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-related-medication-administration |
| Version: | 2.0.0 |
| Name: | CancerRelatedMedicationAdministration |
| Title: | Cancer-Related Medication Administration Profile |
| Status: | Active as of 1/18/22 3:17 AM |
| Definition: | An episode of medication administration for a patient whose condition is related to a primary or secondary cancer condition. In the context of chemotherapy drugs, the medication administration in most cases is performed and documented by the provider. |
| Publisher: | HL7 International Clinical Interoperability Council |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-related-medication-administration
MedicationAdministration resources associated with an in-scope patient MUST conform to this profile. Beyond this requirement, a producer of resources SHOULD ensure that any resource instance associated with an in-scope patient that would reasonably be expected to conform to this profile SHOULD be published in this form.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationAdministration
Summary
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from MedicationAdministration
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MedicationAdministration | I | 0..* | MedicationAdministration | Administration of medication to a patient mcode-reason-required: One of reasonCode or reasonReference SHALL be present |
  id | Σ | 0..1 | string | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
 mcode-procedure-intent | S | 0..1 | CodeableConcept | Procedure Intent Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-procedure-intent Binding: Procedure Intent Value Set (required) |
| mcode-treatment-termination-reason | S | 0..* | CodeableConcept | Treatment Termination Reason Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-treatment-termination-reason Binding: Treatment Termination Reason Value Set (required) |
 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 | ?!SΣ | 1..1 | code | 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. |
| statusReason | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated. | |
| 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] | SΣ | 1..1 | What was administered Binding: Medication Clinical Drug (extensible) | |
 medicationCodeableConcept | CodeableConcept | |||
 medicationReference | Reference(Medication) | |||
| subject | SΣ | 1..1 | Reference(Cancer Patient Profile) | Who received medication |
| context | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of | |
| supportingInformation | 0..* | Reference(Resource) | Additional information to support administration | |
| effective[x] | SΣ | 1..1 | 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 | S | 0..* | CodeableConcept | Reason administration performed Binding: Cancer Disorder Value Set (extensible) |
| reasonReference | S | 0..* | Reference(Primary Cancer Condition Profile | Secondary Cancer Condition Profile) | Condition or observation that supports why the medication was administered |
| request | 0..1 | Reference(MedicationRequest) | Request administration performed against | |
| device | 0..* | Reference(Device) | Device used to administer | |
| note | 0..* | Annotation | Information about the administration | |
| dosage | I | 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 | ||||
This structure is derived from MedicationAdministration
Summary
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from MedicationAdministration
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationAdministration | I | 0..* | MedicationAdministration | Administration of medication to a patient mcode-reason-required: One of reasonCode or reasonReference SHALL be present |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| mcode-procedure-intent | S | 0..1 | CodeableConcept | Procedure Intent Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-procedure-intent Binding: Procedure Intent Value Set (required) |
| mcode-treatment-termination-reason | S | 0..* | CodeableConcept | Treatment Termination Reason Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-treatment-termination-reason Binding: Treatment Termination Reason Value Set (required) |
| 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 | ?!SΣ | 1..1 | code | 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. |
| statusReason | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated. | |
| 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] | SΣ | 1..1 | What was administered Binding: Medication Clinical Drug (extensible) | |
| medicationCodeableConcept | CodeableConcept | |||
| medicationReference | Reference(Medication) | |||
| subject | SΣ | 1..1 | Reference(Cancer Patient Profile) | Who received medication |
| context | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of | |
| supportingInformation | 0..* | Reference(Resource) | Additional information to support administration | |
| effective[x] | SΣ | 1..1 | 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 | S | 0..* | CodeableConcept | Reason administration performed Binding: Cancer Disorder Value Set (extensible) |
| reasonReference | S | 0..* | Reference(Primary Cancer Condition Profile | Secondary Cancer Condition Profile) | Condition or observation that supports why the medication was administered |
| request | 0..1 | Reference(MedicationRequest) | Request administration performed against | |
| device | 0..* | Reference(Device) | Device used to administer | |
| note | 0..* | Annotation | Information about the administration | |
| dosage | I | 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 | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| MedicationAdministration.language | preferred | CommonLanguages Max Binding: AllLanguages |
| MedicationAdministration.status | required | MedicationAdministration Status Codes |
| MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodes |
| MedicationAdministration.category | preferred | MedicationAdministration Category Codes |
| MedicationAdministration.medication[x] | extensible | Medication Clinical Drug |
| MedicationAdministration.performer.function | example | MedicationAdministration Performer Function Codes |
| MedicationAdministration.reasonCode | extensible | CancerDisorderVS |
| MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodes |
| MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodes |
| MedicationAdministration.dosage.method | example | SNOMEDCTAdministrationMethodCodes |
| Id | Grade | Path | Details | Requirements |
| mcode-reason-required | warning | MedicationAdministration | One of reasonCode or reasonReference SHALL be present : reasonCode.exists() or reasonReference.exists() | |
| mad-1 | error | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() |
IG © 2019+ HL7 International Clinical Interoperability Council. Package hl7.fhir.us.mcode#2.0.0 based on FHIR 4.0.1. Generated 2022-01-18
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change
