OncoFAIR
0.1.0 - ci-build

OncoFAIR - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: OncoFAIR MedicationAdministration Component

Official URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-medicationadministration-component Version: 0.1.0
Draft as of 2025-05-22 Computable Name: OncoFAIRMedicationAdministrationComponent

This object corresponds to a product that belongs to the nomenclature of medicines used in the hospital.

Cet objet correspond à un produit qui appartient à la nomenclature de médicaments utilisée dans l’hôpital.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:oncofair-ma-element-traceability 0..1 (Complex) OncoFAIRMAElementTraceability
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-element-traceability
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:oncofair-ma-element-expirationdate 0..1 dateTime Expiry date of administered component
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-element-expirationdate
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:oncofair-ma-component-origin 0..1 CodeableConcept Specifies the origin of the component administered
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-component-origin
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:oncofair-ma-component-administration-status 1..1 CodeableConcept Specifies whether the component administered was actually administered to the patient or not.
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-component-administration-status
Binding: Statut composant administré Value Set (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... partOf SΣ 1..1 Reference(OncoFAIR MedicationAdministration Element) The element of administration part of the administered component
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministrationStatusCodes (required): A set of codes indicating the current status of a MedicationAdministration.


ele-1: All FHIR elements must have a @value or children
... medication SΣ 1..1 CodeableReference(OncoFAIR Medication) The medication linked to the administered component
Binding: Concepts Medication Value Set (required)
ele-1: All FHIR elements must have a @value or children
.... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: component
... subject Σ 1..1 Reference(Patient | Group) Who received medication
ele-1: All FHIR elements must have a @value or children
... occurence[x] Σ 1..1 Specific date/time or interval of time during which the administration took place (or did not take place)
ele-1: All FHIR elements must have a @value or children
.... occurenceDateTime dateTime
.... occurencePeriod Period
.... occurenceTiming Timing
... Slices for note S 0..* Annotation Information about the administration
Slice: Unordered, Open by value:id
ele-1: All FHIR elements must have a @value or children
.... note:comments 0..1 Annotation Comment relating to the administration of the administered component
ele-1: All FHIR elements must have a @value or children
..... id 1..1 id Unique id for inter-element referencing
Required Pattern: comments
..... text Σ 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children
.... note:wording 0..1 Annotation Name of administered component
ele-1: All FHIR elements must have a @value or children
..... id 1..1 id Unique id for inter-element referencing
Required Pattern: wording
..... text Σ 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children
... dosage SC 1..1 BackboneElement Details of how medication was taken
ele-1: All FHIR elements must have a @value or children
mad-1: If dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x]
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... dose C 1..1 SimpleQuantity Quantity of the component administered in the administration element that was intended to be administered to the patient
ele-1: All FHIR elements must have a @value or children
.... Slices for rate[x] C 1..1 SimpleQuantity Dose quantity per unit of time
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
..... rate[x]:rateQuantity SC 1..1 SimpleQuantity Quantity actually administered to the patient or planned to be administered
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.statusrequiredMedicationAdministrationStatusCodes
http://hl7.org/fhir/ValueSet/medication-admin-status|5.0.0
from the FHIR Standard
MedicationAdministration.medicationrequiredConceptMedicationOncoFAIRValueSet (a valid code from Concepts Medication Code System)
http://ltsi.univ-rennes.fr/ValueSet/concept-medication-oncofair-valueset
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.dosageIf dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x]
: (dose.exists() or rate.exists() or text.exists())

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:oncofair-ma-element-traceability 0..1 (Complex) OncoFAIRMAElementTraceability
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-element-traceability
.... extension:oncofair-ma-element-expirationdate 0..1 dateTime Expiry date of administered component
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-element-expirationdate
.... extension:oncofair-ma-component-origin 0..1 CodeableConcept Specifies the origin of the component administered
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-component-origin
.... extension:oncofair-ma-component-administration-status 1..1 CodeableConcept Specifies whether the component administered was actually administered to the patient or not.
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-component-administration-status
Binding: Statut composant administré Value Set (required)
... partOf S 1..1 Reference(OncoFAIR MedicationAdministration Element) The element of administration part of the administered component
... medication S 1..1 CodeableReference(OncoFAIR Medication) The medication linked to the administered component
Binding: Concepts Medication Value Set (required)
.... concept 0..1 CodeableConcept Reference to a concept (by class)
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: component
.... note:comments 0..1 Annotation Comment relating to the administration of the administered component
..... id 1..1 id Unique id for inter-element referencing
Required Pattern: comments
.... note:wording 0..1 Annotation Name of administered component
..... id 1..1 id Unique id for inter-element referencing
Required Pattern: wording
... dosage S 1..1 BackboneElement Details of how medication was taken
.... dose 1..1 SimpleQuantity Quantity of the component administered in the administration element that was intended to be administered to the patient
.... Slices for rate[x] 1..1 SimpleQuantity Dose quantity per unit of time
Slice: Unordered, Open by type:$this
..... rate[x]:rateQuantity S 1..1 SimpleQuantity Quantity actually administered to the patient or planned to be administered

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationAdministration.medicationrequiredConceptMedicationOncoFAIRValueSet (a valid code from Concepts Medication Code System)
http://ltsi.univ-rennes.fr/ValueSet/concept-medication-oncofair-valueset
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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:oncofair-ma-element-traceability 0..1 (Complex) OncoFAIRMAElementTraceability
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-element-traceability
.... extension:oncofair-ma-element-expirationdate 0..1 dateTime Expiry date of administered component
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-element-expirationdate
.... extension:oncofair-ma-component-origin 0..1 CodeableConcept Specifies the origin of the component administered
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-component-origin
.... extension:oncofair-ma-component-administration-status 1..1 CodeableConcept Specifies whether the component administered was actually administered to the patient or not.
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-component-administration-status
Binding: Statut composant administré Value Set (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... basedOn 0..* Reference(CarePlan) Plan this is fulfilled by this administration
... partOf SΣ 1..1 Reference(OncoFAIR MedicationAdministration Element) The element of administration part of the administered component
... status ?!Σ 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministrationStatusCodes (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..* CodeableConcept Type of medication administration
Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur.


... medication SΣ 1..1 CodeableReference(OncoFAIR Medication) The medication linked to the administered component
Binding: Concepts Medication Value Set (required)
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 0..1 uri Identity of the terminology system
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: component
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... reference Σ 0..1 Reference() Reference to a resource (by instance)
... subject Σ 1..1 Reference(Patient | Group) Who received medication
... encounter 0..1 Reference(Encounter) Encounter administered as part of
... supportingInformation 0..* Reference(Resource) Additional information to support administration
... occurence[x] Σ 1..1 Specific date/time or interval of time during which the administration took place (or did not take place)
.... occurenceDateTime dateTime
.... occurencePeriod Period
.... occurenceTiming Timing
... recorded Σ 0..1 dateTime When the MedicationAdministration was first captured in the subject's record
... isSubPotent 0..1 boolean Full dose was not administered
... subPotentReason 0..* CodeableConcept Reason full dose was not administered
Binding: MedicationAdministrationSubpotentReason (example)
... performer Σ 0..* BackboneElement Who or what performed the medication administration and what type of performance 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: MedicationAdministrationPerformerFunctionCodes (example): A code describing the role an individual played in administering the medication.

.... actor Σ 1..1 CodeableReference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) Who or what performed the medication administration
... reason 0..* CodeableReference(Condition | Observation | DiagnosticReport) Concept, condition or observation that supports why the medication was administered
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... request 0..1 Reference(MedicationRequest) Request administration performed against
... device 0..* CodeableReference(Device) Device used to administer
... Slices for note S 0..* Annotation Information about the administration
Slice: Unordered, Open by value:id
.... note:comments 0..1 Annotation Comment relating to the administration of the administered component
..... id 1..1 id Unique id for inter-element referencing
Required Pattern: comments
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... author[x] Σ 0..1 Individual responsible for the annotation
...... authorReference Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)
...... authorString string
..... time Σ 0..1 dateTime When the annotation was made
..... text Σ 1..1 markdown The annotation - text content (as markdown)
.... note:wording 0..1 Annotation Name of administered component
..... id 1..1 id Unique id for inter-element referencing
Required Pattern: wording
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... author[x] Σ 0..1 Individual responsible for the annotation
...... authorReference Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)
...... authorString string
..... time Σ 0..1 dateTime When the annotation was made
..... text Σ 1..1 markdown The annotation - text content (as markdown)
... dosage SC 1..1 BackboneElement Details of how medication was taken
mad-1: If dosage attribute is present then SHALL have at least one of dosage.text or 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 C 0..1 string Free text dosage instructions e.g. SIG
.... site 0..1 CodeableConcept Body site administered to
Binding: SNOMEDCTAnatomicalStructureAdministrationSites (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 C 1..1 SimpleQuantity Quantity of the component administered in the administration element that was intended to be administered to the patient
.... Slices for rate[x] C 1..1 SimpleQuantity Dose quantity per unit of time
Slice: Unordered, Closed by type:$this
..... rate[x]:rateQuantity SC 1..1 SimpleQuantity Quantity actually administered to the patient or planned to be administered
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
MedicationAdministration.statusrequiredMedicationAdministrationStatusCodes
http://hl7.org/fhir/ValueSet/medication-admin-status|5.0.0
from the FHIR Standard
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes
from the FHIR Standard
MedicationAdministration.categoryexampleMedicationAdministrationLocationCodes
http://hl7.org/fhir/ValueSet/medication-admin-location
from the FHIR Standard
MedicationAdministration.medicationrequiredConceptMedicationOncoFAIRValueSet (a valid code from Concepts Medication Code System)
http://ltsi.univ-rennes.fr/ValueSet/concept-medication-oncofair-valueset
from this IG
MedicationAdministration.subPotentReasonexampleMedicationAdministrationSubpotentReason
http://hl7.org/fhir/ValueSet/administration-subpotent-reason
from the FHIR Standard
MedicationAdministration.performer.functionexampleMedicationAdministrationPerformerFunctionCodes
http://hl7.org/fhir/ValueSet/med-admin-perform-function
from the FHIR Standard
MedicationAdministration.reasonexampleReasonMedicationGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-given-codes
from the FHIR Standard
MedicationAdministration.dosage.siteexampleSNOMEDCTAnatomicalStructureAdministrationSites
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

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.dosageIf dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x]
: (dose.exists() or rate.exists() or text.exists())

This structure is derived from MedicationAdministration

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:oncofair-ma-element-traceability 0..1 (Complex) OncoFAIRMAElementTraceability
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-element-traceability
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:oncofair-ma-element-expirationdate 0..1 dateTime Expiry date of administered component
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-element-expirationdate
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:oncofair-ma-component-origin 0..1 CodeableConcept Specifies the origin of the component administered
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-component-origin
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:oncofair-ma-component-administration-status 1..1 CodeableConcept Specifies whether the component administered was actually administered to the patient or not.
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-component-administration-status
Binding: Statut composant administré Value Set (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... partOf SΣ 1..1 Reference(OncoFAIR MedicationAdministration Element) The element of administration part of the administered component
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministrationStatusCodes (required): A set of codes indicating the current status of a MedicationAdministration.


ele-1: All FHIR elements must have a @value or children
... medication SΣ 1..1 CodeableReference(OncoFAIR Medication) The medication linked to the administered component
Binding: Concepts Medication Value Set (required)
ele-1: All FHIR elements must have a @value or children
.... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: component
... subject Σ 1..1 Reference(Patient | Group) Who received medication
ele-1: All FHIR elements must have a @value or children
... occurence[x] Σ 1..1 Specific date/time or interval of time during which the administration took place (or did not take place)
ele-1: All FHIR elements must have a @value or children
.... occurenceDateTime dateTime
.... occurencePeriod Period
.... occurenceTiming Timing
... Slices for note S 0..* Annotation Information about the administration
Slice: Unordered, Open by value:id
ele-1: All FHIR elements must have a @value or children
.... note:comments 0..1 Annotation Comment relating to the administration of the administered component
ele-1: All FHIR elements must have a @value or children
..... id 1..1 id Unique id for inter-element referencing
Required Pattern: comments
..... text Σ 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children
.... note:wording 0..1 Annotation Name of administered component
ele-1: All FHIR elements must have a @value or children
..... id 1..1 id Unique id for inter-element referencing
Required Pattern: wording
..... text Σ 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children
... dosage SC 1..1 BackboneElement Details of how medication was taken
ele-1: All FHIR elements must have a @value or children
mad-1: If dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x]
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... dose C 1..1 SimpleQuantity Quantity of the component administered in the administration element that was intended to be administered to the patient
ele-1: All FHIR elements must have a @value or children
.... Slices for rate[x] C 1..1 SimpleQuantity Dose quantity per unit of time
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
..... rate[x]:rateQuantity SC 1..1 SimpleQuantity Quantity actually administered to the patient or planned to be administered
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.statusrequiredMedicationAdministrationStatusCodes
http://hl7.org/fhir/ValueSet/medication-admin-status|5.0.0
from the FHIR Standard
MedicationAdministration.medicationrequiredConceptMedicationOncoFAIRValueSet (a valid code from Concepts Medication Code System)
http://ltsi.univ-rennes.fr/ValueSet/concept-medication-oncofair-valueset
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.dosageIf dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x]
: (dose.exists() or rate.exists() or text.exists())

Differential View

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:oncofair-ma-element-traceability 0..1 (Complex) OncoFAIRMAElementTraceability
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-element-traceability
.... extension:oncofair-ma-element-expirationdate 0..1 dateTime Expiry date of administered component
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-element-expirationdate
.... extension:oncofair-ma-component-origin 0..1 CodeableConcept Specifies the origin of the component administered
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-component-origin
.... extension:oncofair-ma-component-administration-status 1..1 CodeableConcept Specifies whether the component administered was actually administered to the patient or not.
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-component-administration-status
Binding: Statut composant administré Value Set (required)
... partOf S 1..1 Reference(OncoFAIR MedicationAdministration Element) The element of administration part of the administered component
... medication S 1..1 CodeableReference(OncoFAIR Medication) The medication linked to the administered component
Binding: Concepts Medication Value Set (required)
.... concept 0..1 CodeableConcept Reference to a concept (by class)
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: component
.... note:comments 0..1 Annotation Comment relating to the administration of the administered component
..... id 1..1 id Unique id for inter-element referencing
Required Pattern: comments
.... note:wording 0..1 Annotation Name of administered component
..... id 1..1 id Unique id for inter-element referencing
Required Pattern: wording
... dosage S 1..1 BackboneElement Details of how medication was taken
.... dose 1..1 SimpleQuantity Quantity of the component administered in the administration element that was intended to be administered to the patient
.... Slices for rate[x] 1..1 SimpleQuantity Dose quantity per unit of time
Slice: Unordered, Open by type:$this
..... rate[x]:rateQuantity S 1..1 SimpleQuantity Quantity actually administered to the patient or planned to be administered

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationAdministration.medicationrequiredConceptMedicationOncoFAIRValueSet (a valid code from Concepts Medication Code System)
http://ltsi.univ-rennes.fr/ValueSet/concept-medication-oncofair-valueset
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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:oncofair-ma-element-traceability 0..1 (Complex) OncoFAIRMAElementTraceability
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-element-traceability
.... extension:oncofair-ma-element-expirationdate 0..1 dateTime Expiry date of administered component
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-element-expirationdate
.... extension:oncofair-ma-component-origin 0..1 CodeableConcept Specifies the origin of the component administered
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-component-origin
.... extension:oncofair-ma-component-administration-status 1..1 CodeableConcept Specifies whether the component administered was actually administered to the patient or not.
URL: http://ltsi.univ-rennes.fr/StructureDefinition/oncofair-ma-component-administration-status
Binding: Statut composant administré Value Set (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... basedOn 0..* Reference(CarePlan) Plan this is fulfilled by this administration
... partOf SΣ 1..1 Reference(OncoFAIR MedicationAdministration Element) The element of administration part of the administered component
... status ?!Σ 1..1 code in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministrationStatusCodes (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..* CodeableConcept Type of medication administration
Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur.


... medication SΣ 1..1 CodeableReference(OncoFAIR Medication) The medication linked to the administered component
Binding: Concepts Medication Value Set (required)
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 0..1 uri Identity of the terminology system
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: component
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... reference Σ 0..1 Reference() Reference to a resource (by instance)
... subject Σ 1..1 Reference(Patient | Group) Who received medication
... encounter 0..1 Reference(Encounter) Encounter administered as part of
... supportingInformation 0..* Reference(Resource) Additional information to support administration
... occurence[x] Σ 1..1 Specific date/time or interval of time during which the administration took place (or did not take place)
.... occurenceDateTime dateTime
.... occurencePeriod Period
.... occurenceTiming Timing
... recorded Σ 0..1 dateTime When the MedicationAdministration was first captured in the subject's record
... isSubPotent 0..1 boolean Full dose was not administered
... subPotentReason 0..* CodeableConcept Reason full dose was not administered
Binding: MedicationAdministrationSubpotentReason (example)
... performer Σ 0..* BackboneElement Who or what performed the medication administration and what type of performance 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: MedicationAdministrationPerformerFunctionCodes (example): A code describing the role an individual played in administering the medication.

.... actor Σ 1..1 CodeableReference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) Who or what performed the medication administration
... reason 0..* CodeableReference(Condition | Observation | DiagnosticReport) Concept, condition or observation that supports why the medication was administered
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... request 0..1 Reference(MedicationRequest) Request administration performed against
... device 0..* CodeableReference(Device) Device used to administer
... Slices for note S 0..* Annotation Information about the administration
Slice: Unordered, Open by value:id
.... note:comments 0..1 Annotation Comment relating to the administration of the administered component
..... id 1..1 id Unique id for inter-element referencing
Required Pattern: comments
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... author[x] Σ 0..1 Individual responsible for the annotation
...... authorReference Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)
...... authorString string
..... time Σ 0..1 dateTime When the annotation was made
..... text Σ 1..1 markdown The annotation - text content (as markdown)
.... note:wording 0..1 Annotation Name of administered component
..... id 1..1 id Unique id for inter-element referencing
Required Pattern: wording
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... author[x] Σ 0..1 Individual responsible for the annotation
...... authorReference Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)
...... authorString string
..... time Σ 0..1 dateTime When the annotation was made
..... text Σ 1..1 markdown The annotation - text content (as markdown)
... dosage SC 1..1 BackboneElement Details of how medication was taken
mad-1: If dosage attribute is present then SHALL have at least one of dosage.text or 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 C 0..1 string Free text dosage instructions e.g. SIG
.... site 0..1 CodeableConcept Body site administered to
Binding: SNOMEDCTAnatomicalStructureAdministrationSites (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 C 1..1 SimpleQuantity Quantity of the component administered in the administration element that was intended to be administered to the patient
.... Slices for rate[x] C 1..1 SimpleQuantity Dose quantity per unit of time
Slice: Unordered, Closed by type:$this
..... rate[x]:rateQuantity SC 1..1 SimpleQuantity Quantity actually administered to the patient or planned to be administered
... eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationAdministration.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
MedicationAdministration.statusrequiredMedicationAdministrationStatusCodes
http://hl7.org/fhir/ValueSet/medication-admin-status|5.0.0
from the FHIR Standard
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes
from the FHIR Standard
MedicationAdministration.categoryexampleMedicationAdministrationLocationCodes
http://hl7.org/fhir/ValueSet/medication-admin-location
from the FHIR Standard
MedicationAdministration.medicationrequiredConceptMedicationOncoFAIRValueSet (a valid code from Concepts Medication Code System)
http://ltsi.univ-rennes.fr/ValueSet/concept-medication-oncofair-valueset
from this IG
MedicationAdministration.subPotentReasonexampleMedicationAdministrationSubpotentReason
http://hl7.org/fhir/ValueSet/administration-subpotent-reason
from the FHIR Standard
MedicationAdministration.performer.functionexampleMedicationAdministrationPerformerFunctionCodes
http://hl7.org/fhir/ValueSet/med-admin-perform-function
from the FHIR Standard
MedicationAdministration.reasonexampleReasonMedicationGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-given-codes
from the FHIR Standard
MedicationAdministration.dosage.siteexampleSNOMEDCTAnatomicalStructureAdministrationSites
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

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.dosageIf dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x]
: (dose.exists() or rate.exists() or text.exists())

This structure is derived from MedicationAdministration

 

Other representations of profile: CSV, Excel, Schematron