IDEA4RC FHIR Implementation Guide
0.1.0 - CI Build 150

IDEA4RC FHIR Implementation Guide, published by IDEA4RC Project. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/idea4rc/ and changes regularly. See the Directory of published versions

Resource Profile: MedicationAdministration: Chemotherapy

Official URL: http://hl7.eu/fhir/ig/idea4rc/StructureDefinition/MedicationAdministration-eu-i4rc Version: 0.1.0
Draft as of 2024-11-12 Computable Name: MedicationAdministrationI4rc

This profile defines how to represent MedicationAdministration in HL7 FHIR for describing Chemotherapy data for the purpose of the IDEA4RC project.

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 MedicationAdministration
... status S 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
... Slices for medication[x] 1..1 CodeableConcept What was administered
Slice: Unordered, Open by type:$this
.... medication[x]:medicationCodeableConcept S 1..1 CodeableConcept What was administered
Binding: Antineoplastic and immunostimulating agents (extensible)
... subject 1..1 Reference(Patient: IDEA4RC) Who received medication
.... effective[x]:effectivePeriod S 0..1 Period Start and end time of administration
... reasonReference 1..1 Reference(Condition: Primary Cancer) Condition or observation that supports why the medication was administered
... dosage
.... dose 0..1 SimpleQuantity Amount per dose
..... value S 1..1 decimal Numerical value (with implicit precision)
..... unit S 0..1 string Unit representation
..... system S 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code S 1..1 code Coded form of the unit

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationAdministration.medication[x]:medicationCodeableConceptextensibleVsI4rcAtcCodes
http://hl7.eu/fhir/ig/idea4rc/ValueSet/drugsAtc-eu-i4rc
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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.

.... medication[x]:medicationCodeableConcept SΣ 1..1 CodeableConcept What was administered
Binding: Antineoplastic and immunostimulating agents (extensible)
... subject Σ 1..1 Reference(Patient: IDEA4RC) Who received medication
... Slices for effective[x] Σ 1..1 When the chemotherapy was administered
Slice: Unordered, Open by type:$this
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectivePeriod SΣ 0..1 Period Start and end time of administration
... reasonReference 1..1 Reference(Condition: Primary Cancer) Condition or observation that supports why the medication was administered
... dosage C 0..1 BackboneElement Details of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dose 0..1 SimpleQuantity Amount per dose
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... unit SΣ 0..1 string Unit representation
..... system SΣC 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code SΣ 1..1 code Coded form of the unit

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
MedicationAdministration.medication[x]:medicationCodeableConceptextensibleVsI4rcAtcCodes
http://hl7.eu/fhir/ig/idea4rc/ValueSet/drugsAtc-eu-i4rc
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... id Σ 0..1 id 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): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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.

... Slices for medication[x] Σ 1..1 CodeableConcept What was administered
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

.... medication[x]:medicationCodeableConcept SΣ 1..1 CodeableConcept What was administered
Binding: Antineoplastic and immunostimulating agents (extensible)
... subject Σ 1..1 Reference(Patient: IDEA4RC) 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
... Slices for effective[x] Σ 1..1 When the chemotherapy was administered
Slice: Unordered, Open by type:$this
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectivePeriod SΣ 0..1 Period Start and end time of administration
... 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 0..* CodeableConcept Reason administration performed
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... reasonReference 1..1 Reference(Condition: Primary Cancer) 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 C 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 per dose
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... unit SΣ 0..1 string Unit representation
..... system SΣC 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code SΣ 1..1 code Coded form of the unit
.... 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

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.medication[x]:medicationCodeableConceptextensibleVsI4rcAtcCodes
http://hl7.eu/fhir/ig/idea4rc/ValueSet/drugsAtc-eu-i4rc
from this IG
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.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
from the FHIR Standard
MedicationAdministration.dosage.routeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
MedicationAdministration.dosage.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard

This structure is derived from MedicationAdministration

Summary

Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationAdministration.medication[x]
  • The element 1 is sliced based on the value of MedicationAdministration.effective[x]

Differential View

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration MedicationAdministration
... status S 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
... Slices for medication[x] 1..1 CodeableConcept What was administered
Slice: Unordered, Open by type:$this
.... medication[x]:medicationCodeableConcept S 1..1 CodeableConcept What was administered
Binding: Antineoplastic and immunostimulating agents (extensible)
... subject 1..1 Reference(Patient: IDEA4RC) Who received medication
.... effective[x]:effectivePeriod S 0..1 Period Start and end time of administration
... reasonReference 1..1 Reference(Condition: Primary Cancer) Condition or observation that supports why the medication was administered
... dosage
.... dose 0..1 SimpleQuantity Amount per dose
..... value S 1..1 decimal Numerical value (with implicit precision)
..... unit S 0..1 string Unit representation
..... system S 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code S 1..1 code Coded form of the unit

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationAdministration.medication[x]:medicationCodeableConceptextensibleVsI4rcAtcCodes
http://hl7.eu/fhir/ig/idea4rc/ValueSet/drugsAtc-eu-i4rc
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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.

.... medication[x]:medicationCodeableConcept SΣ 1..1 CodeableConcept What was administered
Binding: Antineoplastic and immunostimulating agents (extensible)
... subject Σ 1..1 Reference(Patient: IDEA4RC) Who received medication
... Slices for effective[x] Σ 1..1 When the chemotherapy was administered
Slice: Unordered, Open by type:$this
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectivePeriod SΣ 0..1 Period Start and end time of administration
... reasonReference 1..1 Reference(Condition: Primary Cancer) Condition or observation that supports why the medication was administered
... dosage C 0..1 BackboneElement Details of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dose 0..1 SimpleQuantity Amount per dose
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... unit SΣ 0..1 string Unit representation
..... system SΣC 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code SΣ 1..1 code Coded form of the unit

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
MedicationAdministration.medication[x]:medicationCodeableConceptextensibleVsI4rcAtcCodes
http://hl7.eu/fhir/ig/idea4rc/ValueSet/drugsAtc-eu-i4rc
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... id Σ 0..1 id 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): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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.

... Slices for medication[x] Σ 1..1 CodeableConcept What was administered
Slice: Unordered, Closed by type:$this
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

.... medication[x]:medicationCodeableConcept SΣ 1..1 CodeableConcept What was administered
Binding: Antineoplastic and immunostimulating agents (extensible)
... subject Σ 1..1 Reference(Patient: IDEA4RC) 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
... Slices for effective[x] Σ 1..1 When the chemotherapy was administered
Slice: Unordered, Open by type:$this
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectivePeriod SΣ 0..1 Period Start and end time of administration
... 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 0..* CodeableConcept Reason administration performed
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... reasonReference 1..1 Reference(Condition: Primary Cancer) 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 C 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 per dose
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... unit SΣ 0..1 string Unit representation
..... system SΣC 1..1 uri System that defines coded unit form
Required Pattern: http://unitsofmeasure.org
..... code SΣ 1..1 code Coded form of the unit
.... 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

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.medication[x]:medicationCodeableConceptextensibleVsI4rcAtcCodes
http://hl7.eu/fhir/ig/idea4rc/ValueSet/drugsAtc-eu-i4rc
from this IG
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.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
from the FHIR Standard
MedicationAdministration.dosage.routeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
MedicationAdministration.dosage.methodexampleSNOMEDCTAdministrationMethodCodes
http://hl7.org/fhir/ValueSet/administration-method-codes
from the FHIR Standard

This structure is derived from MedicationAdministration

Summary

Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationAdministration.medication[x]
  • The element 1 is sliced based on the value of MedicationAdministration.effective[x]

 

Other representations of profile: CSV, Excel, Schematron