CIBMTR Reporting Implementation Guide
0.1.6 - Trial Use 1

CIBMTR Reporting Implementation Guide - Local Development build (v0.1.6). See the Directory of published versions

Resource Profile: CIBMTR Medication Administration (mcode)

Official URL: http://fhir.nmdp.org/ig/cibmtr-reporting/StructureDefinition/cibmtr-medication-administration Version: 0.1.6
Active as of 2023-05-05 Computable Name: CIBMTR_MedicationAdministration

CIBMTR Medication Administration (mcode)

Usage:

Formal Views of Profile Content

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

This structure is derived from CancerRelatedMedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*CancerRelatedMedicationAdministrationAdministration of medication to a patient
... meta
.... Slices for security 1..*CodingSecurity Labels applied to this resource
Slice: Unordered, Open by pattern:system
..... security:TransplantCenter S1..1CodingSecurity Labels applied to this resource
...... system 1..1uriIdentity of the terminology system
Required Pattern: http://terminology.cibmtr.org/codesystem/transplant-center
...... code C1..1codeSymbol in syntax defined by the system
sec-rc: Use transplant center identifier for security tag

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
sec-rcerrorMedicationAdministration.meta.security:TransplantCenter.codeUse transplant center identifier for security tag
: matches('^rc_[0-9]{5}$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration C0..*CancerRelatedMedicationAdministrationAdministration of medication to a patient
... meta Σ0..1MetaMetadata about the resource
.... Slices for security Σ1..*CodingSecurity Labels applied to this resource
Slice: Unordered, Open by pattern:system
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:TransplantCenter SΣ1..1CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://terminology.cibmtr.org/codesystem/transplant-center
...... code ΣC1..1codeSymbol in syntax defined by the system
sec-rc: Use transplant center identifier for security tag
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... terminationReason S0..*CodeableConceptTreatment Termination Reason Extension
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-treatment-termination-reason
Binding: Treatment Termination Reason Value Set (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ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.

... medication[x] SΣ1..1What was administered
Binding: Medication Clinical Drug (extensible)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
... subject SΣ1..1Reference(Cancer Patient Profile)Who received medication
... effective[x] SΣ1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... reasonCode S0..*CodeableConceptReason administration performed
Binding: Cancer Disorder Value Set (extensible)
... reasonReference S0..*Reference(Primary Cancer Condition Profile | Secondary Cancer Condition Profile)Condition or observation that supports why the medication was administered

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationAdministration.meta.securityextensibleAll Security Labels
MedicationAdministration.meta.security:TransplantCenterextensibleAll Security Labels
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
MedicationAdministration.medication[x]extensibleMedication Clinical Drug
MedicationAdministration.reasonCodeextensibleCancerDisorderVS

Constraints

IdGradePath(s)DetailsRequirements
sec-rcerrorMedicationAdministration.meta.security:TransplantCenter.codeUse transplant center identifier for security tag
: matches('^rc_[0-9]{5}$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration C0..*CancerRelatedMedicationAdministrationAdministration of medication to a patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... Slices for security Σ1..*CodingSecurity Labels applied to this resource
Slice: Unordered, Open by pattern:system
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:TransplantCenter SΣ1..1CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://terminology.cibmtr.org/codesystem/transplant-center
...... version Σ0..1stringVersion of the system - if relevant
...... code ΣC1..1codeSymbol in syntax defined by the system
sec-rc: Use transplant center identifier for security tag
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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
... Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... treatmentIntent S0..1CodeableConceptProcedure Intent Extension
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-procedure-intent
Binding: Procedure Intent Value Set (required)
... terminationReason S0..*CodeableConceptTreatment Termination Reason Extension
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-treatment-termination-reason
Binding: Treatment Termination Reason Value Set (required)
... 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 ?!SΣ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] SΣ1..1What was administered
Binding: Medication Clinical Drug (extensible)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
... subject SΣ1..1Reference(Cancer Patient Profile)Who received medication
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode of Care administered as part of
... supportingInformation 0..*Reference(Resource)Additional information to support administration
... effective[x] SΣ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 S0..*CodeableConceptReason administration performed
Binding: Cancer Disorder Value Set (extensible)
... reasonReference S0..*Reference(Primary Cancer Condition Profile | Secondary Cancer Condition Profile)Condition or observation that supports why the medication was administered
... request 0..1Reference(MedicationRequest)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: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.

.... route 0..1CodeableConceptPath 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..1CodeableConceptHow drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.

.... dose 0..1SimpleQuantityAmount of medication per dose
.... rate[x] 0..1Dose quantity per unit of time
..... rateRatioRatio
..... rateQuantityQuantity(SimpleQuantity)
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationAdministration.meta.securityextensibleAll Security Labels
MedicationAdministration.meta.security:TransplantCenterextensibleAll Security Labels
MedicationAdministration.meta.tagexampleCommonTags
MedicationAdministration.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
MedicationAdministration.categorypreferredMedicationAdministration Category Codes
MedicationAdministration.medication[x]extensibleMedication Clinical Drug
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
MedicationAdministration.reasonCodeextensibleCancerDisorderVS
MedicationAdministration.dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
MedicationAdministration.dosage.routeexampleSNOMEDCTRouteCodes
MedicationAdministration.dosage.methodexampleSNOMEDCTAdministrationMethodCodes

Constraints

IdGradePath(s)DetailsRequirements
sec-rcerrorMedicationAdministration.meta.security:TransplantCenter.codeUse transplant center identifier for security tag
: matches('^rc_[0-9]{5}$')

This structure is derived from CancerRelatedMedicationAdministration

Summary

Mandatory: 0 element (4 nested mandatory elements)
Must-Support: 1 element

Slices

This structure defines the following Slices:

  • The element MedicationAdministration.meta.security is sliced based on the value of pattern:system

Differential View

This structure is derived from CancerRelatedMedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*CancerRelatedMedicationAdministrationAdministration of medication to a patient
... meta
.... Slices for security 1..*CodingSecurity Labels applied to this resource
Slice: Unordered, Open by pattern:system
..... security:TransplantCenter S1..1CodingSecurity Labels applied to this resource
...... system 1..1uriIdentity of the terminology system
Required Pattern: http://terminology.cibmtr.org/codesystem/transplant-center
...... code C1..1codeSymbol in syntax defined by the system
sec-rc: Use transplant center identifier for security tag

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
sec-rcerrorMedicationAdministration.meta.security:TransplantCenter.codeUse transplant center identifier for security tag
: matches('^rc_[0-9]{5}$')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration C0..*CancerRelatedMedicationAdministrationAdministration of medication to a patient
... meta Σ0..1MetaMetadata about the resource
.... Slices for security Σ1..*CodingSecurity Labels applied to this resource
Slice: Unordered, Open by pattern:system
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:TransplantCenter SΣ1..1CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://terminology.cibmtr.org/codesystem/transplant-center
...... code ΣC1..1codeSymbol in syntax defined by the system
sec-rc: Use transplant center identifier for security tag
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... terminationReason S0..*CodeableConceptTreatment Termination Reason Extension
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-treatment-termination-reason
Binding: Treatment Termination Reason Value Set (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ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.

... medication[x] SΣ1..1What was administered
Binding: Medication Clinical Drug (extensible)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
... subject SΣ1..1Reference(Cancer Patient Profile)Who received medication
... effective[x] SΣ1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... reasonCode S0..*CodeableConceptReason administration performed
Binding: Cancer Disorder Value Set (extensible)
... reasonReference S0..*Reference(Primary Cancer Condition Profile | Secondary Cancer Condition Profile)Condition or observation that supports why the medication was administered

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationAdministration.meta.securityextensibleAll Security Labels
MedicationAdministration.meta.security:TransplantCenterextensibleAll Security Labels
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
MedicationAdministration.medication[x]extensibleMedication Clinical Drug
MedicationAdministration.reasonCodeextensibleCancerDisorderVS

Constraints

IdGradePath(s)DetailsRequirements
sec-rcerrorMedicationAdministration.meta.security:TransplantCenter.codeUse transplant center identifier for security tag
: matches('^rc_[0-9]{5}$')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration C0..*CancerRelatedMedicationAdministrationAdministration of medication to a patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... Slices for security Σ1..*CodingSecurity Labels applied to this resource
Slice: Unordered, Open by pattern:system
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:TransplantCenter SΣ1..1CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://terminology.cibmtr.org/codesystem/transplant-center
...... version Σ0..1stringVersion of the system - if relevant
...... code ΣC1..1codeSymbol in syntax defined by the system
sec-rc: Use transplant center identifier for security tag
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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
... Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... treatmentIntent S0..1CodeableConceptProcedure Intent Extension
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-procedure-intent
Binding: Procedure Intent Value Set (required)
... terminationReason S0..*CodeableConceptTreatment Termination Reason Extension
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-treatment-termination-reason
Binding: Treatment Termination Reason Value Set (required)
... 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 ?!SΣ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] SΣ1..1What was administered
Binding: Medication Clinical Drug (extensible)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(Medication)
... subject SΣ1..1Reference(Cancer Patient Profile)Who received medication
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode of Care administered as part of
... supportingInformation 0..*Reference(Resource)Additional information to support administration
... effective[x] SΣ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 S0..*CodeableConceptReason administration performed
Binding: Cancer Disorder Value Set (extensible)
... reasonReference S0..*Reference(Primary Cancer Condition Profile | Secondary Cancer Condition Profile)Condition or observation that supports why the medication was administered
... request 0..1Reference(MedicationRequest)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: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.

.... route 0..1CodeableConceptPath 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..1CodeableConceptHow drug was administered
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.

.... dose 0..1SimpleQuantityAmount of medication per dose
.... rate[x] 0..1Dose quantity per unit of time
..... rateRatioRatio
..... rateQuantityQuantity(SimpleQuantity)
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MedicationAdministration.meta.securityextensibleAll Security Labels
MedicationAdministration.meta.security:TransplantCenterextensibleAll Security Labels
MedicationAdministration.meta.tagexampleCommonTags
MedicationAdministration.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MedicationAdministration.statusrequiredMedicationAdministration Status Codes
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
MedicationAdministration.categorypreferredMedicationAdministration Category Codes
MedicationAdministration.medication[x]extensibleMedication Clinical Drug
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
MedicationAdministration.reasonCodeextensibleCancerDisorderVS
MedicationAdministration.dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
MedicationAdministration.dosage.routeexampleSNOMEDCTRouteCodes
MedicationAdministration.dosage.methodexampleSNOMEDCTAdministrationMethodCodes

Constraints

IdGradePath(s)DetailsRequirements
sec-rcerrorMedicationAdministration.meta.security:TransplantCenter.codeUse transplant center identifier for security tag
: matches('^rc_[0-9]{5}$')

This structure is derived from CancerRelatedMedicationAdministration

Summary

Mandatory: 0 element (4 nested mandatory elements)
Must-Support: 1 element

Slices

This structure defines the following Slices:

  • The element MedicationAdministration.meta.security is sliced based on the value of pattern:system

 

Other representations of profile: CSV, Excel, Schematron