This page is part of the ONCOFAIR FHIR Implementation Guide (v0.1.0: Release) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions
Resource Profile: OncoFAIR MedicationAdministration Element
| Official URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-medicationadministration-element | Version: 0.1.0 | |||
| Active as of 2025-11-17 | Computable Name: OncoFAIRMedicationAdministrationElement | |||
Corresponds to the activity induced by a prescription item and its dosage (structured or unstructured), and carried out at a given moment.
Correspond à l’activité induite par un élément de prescription et sa posologie (structurée ou non), et réalisée à un instant donné.
Usages:
- Refer to this Profile: OncoFAIR MedicationAdministration Component
- Examples for this Profile: MedicationAdministration/ExampleOncoFAIRMedicationAdministrationElement
- CapabilityStatements using this Profile: OncoFAIR Consumer secondary chemotherapy data, OncoFAIR Health Data Warehouse and OncoFAIR Producer Chemotherapy Data
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  MedicationAdministration |
0..* | MedicationAdministration | Administration of medication to a patient | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:oncofair-ma-element-urgent |
S | 0..1 | boolean | Boolean attribute indicating the notion of urgency in creating the administration element URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-urgent |
| extension:oncofair-ma-element-expirationdate |
0..1 | dateTime | Expiry date of administered component URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-expirationdate | |
| extension:oncofair-ma-element-traceability |
0..1 | (Complex) | OncoFAIRMAElementTraceability URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-traceability | |
| extension:oncofair-ma-plannedperiod |
1..1 | Period | OncoFAIRMAElementPlannedPeriod URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-plannedperiod | |
 extension:oncofair-element-form |
0..1 | CodeableConcept | Pharmaceutical form of the prescription/administration item URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-element-form | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
S | 1..1 | Identifier | Unique identifier of the administration element in the HIS. |
 partOf |
SΣ | 1..1 | Reference(OncoFAIR MedicationAdministration Report) | The medication administration report linked to the element of administration |
| 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. |
 Slices for category |
S | 0..* | CodeableConcept | Type of medication administration Slice: Unordered, Open by value:coding.system Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur. |
| category:code |
0..1 | CodeableConcept | Type of medication administration Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur. | |
| category:nature |
0..1 | CodeableConcept | Type of medication administration Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur. | |
| medication |
Σ | 1..1 | CodeableReference(Medication) | What was administered Binding: Concepts Medication Value Set (required) |
 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: element | |
| 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 | |
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who received medication |
| Slices for occurence[x] |
Σ | 1..1 | Specific date/time or interval of time during which the administration took place (or did not take place) Slice: Unordered, Open by type:$this | |
| occurenceDateTime |
dateTime | |||
| occurencePeriod |
Period | |||
| occurenceTiming |
Timing | |||
 occurence[x]:occurencePeriod |
SΣ | 0..1 | Period | Specific date/time or interval of time during which the administration took place (or did not take place) |
 start |
ΣC | 1..1 | dateTime | Effective date and time for startinf administration of the administration element |
 end |
ΣC | 0..1 | dateTime | Effective date and time for ending administration of the administration element |
| request |
S | 0..1 | Reference(MedicationRequest) | Request administration performed against |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier |
ΣC | 0..1 | Identifier | Unique identifier of the prescription element to which this administration element responds |
| device |
S | 0..* | CodeableReference(Device) | Specifies, where applicable, the medical devices or equipment to be used to administer the product. By default, the associated devices are those listed in the prescription element associated with the administration element |
| Slices for note |
S | 1..* | Annotation | Information about the administration Slice: Unordered, Open by value:id |
 note:wording |
1..1 | Annotation | Wording of the administration element | |
 id |
1..1 | id | Unique id for inter-element referencing Required Pattern: wording | |
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) |
| note:comments |
0..1 | Annotation | Comment attached to the administration element | |
| id |
1..1 | id | Unique id for inter-element referencing Required Pattern: comments | |
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) |
| dosage |
SC | 0..1 | BackboneElement | Details of how medication was taken Constraints: mad-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| site |
0..1 | CodeableConcept | Specifies, where applicable, the exact point on the body where the product is to be applied to the patient. By default, the place of administration is that shown in the prescription element associated with the administration element Binding: SNOMEDCTAnatomicalStructureAdministrationSites (example): A coded concept describing the site location the medicine enters into or onto the body. | |
| route |
0..1 | CodeableConcept | Specifies the route of administration of the product. By default, it is the one shown in the prescription element associated with the administration element. 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 | Type of administration element. Must be used to differentiate between management processes adapted to different types of drug treatment. Binding: Type de l'élément d'administration Value Set (required) | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.status | required | MedicationAdministrationStatusCodeshttp://hl7.org/fhir/ValueSet/medication-admin-status|5.0.0From the FHIR Standard | |
| MedicationAdministration.category | example | MedicationAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medication-admin-locationFrom the FHIR Standard | |
| MedicationAdministration.category:code | example | MedicationAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medication-admin-locationFrom the FHIR Standard | |
| MedicationAdministration.category:nature | example | MedicationAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medication-admin-locationFrom the FHIR Standard | |
| MedicationAdministration.medication | required | ConceptMedicationOncoFAIRValueSet(a valid code from Concepts Medication Code System)http://oncofair-ig.kereval.cloud/ValueSet/concept-medication-oncofair-valuesetFrom this IG | |
| MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureAdministrationSiteshttp://hl7.org/fhir/ValueSet/approach-site-codesFrom the FHIR Standard | |
| MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesFrom the FHIR Standard | |
| MedicationAdministration.dosage.method | required | SIPhTypeEltPLAOncoFAIRValueSet(a valid code from Type de l'élément d'administration Code System)http://oncofair-ig.kereval.cloud/ValueSet/siph-typeeltpla-oncofair-valuesetFrom this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | 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 : 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-4 | error | MedicationAdministration | If 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-5 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mad-1 | error | MedicationAdministration.dosage | If 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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-urgent |
S | 0..1 | boolean | Boolean attribute indicating the notion of urgency in creating the administration element URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-urgent |
| extension:oncofair-ma-element-expirationdate |
0..1 | dateTime | Expiry date of administered component URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-expirationdate | |
| extension:oncofair-ma-element-traceability |
0..1 | (Complex) | OncoFAIRMAElementTraceability URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-traceability | |
| extension:oncofair-ma-plannedperiod |
1..1 | Period | OncoFAIRMAElementPlannedPeriod URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-plannedperiod | |
| extension:oncofair-element-form |
0..1 | CodeableConcept | Pharmaceutical form of the prescription/administration item URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-element-form | |
 identifier |
S | 1..1 | Identifier | Unique identifier of the administration element in the HIS. |
| partOf |
S | 1..1 | Reference(OncoFAIR MedicationAdministration Report) | The medication administration report linked to the element of administration |
| Slices for category |
S | 0..* | CodeableConcept | Type of medication administration Slice: Unordered, Open by value:coding.system |
| category:code |
0..1 | CodeableConcept | Type of medication administration | |
| category:nature |
0..1 | CodeableConcept | Type of medication administration | |
| medication |
1..1 | CodeableReference(Medication) | What was administered 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: element | |
| Slices for occurence[x] |
1..1 | dateTime, Period, Timing | Specific date/time or interval of time during which the administration took place (or did not take place) Slice: Unordered, Open by type:$this | |
| occurence[x]:occurencePeriod |
S | 0..1 | Period | Specific date/time or interval of time during which the administration took place (or did not take place) |
| start |
1..1 | dateTime | Effective date and time for startinf administration of the administration element | |
| end |
0..1 | dateTime | Effective date and time for ending administration of the administration element | |
| request |
S | 0..1 | Reference(MedicationRequest) | Request administration performed against |
| identifier |
0..1 | Identifier | Unique identifier of the prescription element to which this administration element responds | |
| device |
S | 0..* | CodeableReference(Device) | Specifies, where applicable, the medical devices or equipment to be used to administer the product. By default, the associated devices are those listed in the prescription element associated with the administration element |
| Slices for note |
S | 1..* | Annotation | Information about the administration Slice: Unordered, Open by value:id |
| note:wording |
1..1 | Annotation | Wording of the administration element | |
| id |
1..1 | id | Unique id for inter-element referencing Required Pattern: wording | |
| note:comments |
0..1 | Annotation | Comment attached to the administration element | |
| id |
1..1 | id | Unique id for inter-element referencing Required Pattern: comments | |
| dosage |
S | 0..1 | BackboneElement | Details of how medication was taken |
| site |
0..1 | CodeableConcept | Specifies, where applicable, the exact point on the body where the product is to be applied to the patient. By default, the place of administration is that shown in the prescription element associated with the administration element | |
| route |
0..1 | CodeableConcept | Specifies the route of administration of the product. By default, it is the one shown in the prescription element associated with the administration element. | |
| method |
0..1 | CodeableConcept | Type of administration element. Must be used to differentiate between management processes adapted to different types of drug treatment. Binding: Type de l'élément d'administration Value Set (required) | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.medication | required | ConceptMedicationOncoFAIRValueSet(a valid code from Concepts Medication Code System)http://oncofair-ig.kereval.cloud/ValueSet/concept-medication-oncofair-valuesetFrom this IG | |
| MedicationAdministration.dosage.method | required | SIPhTypeEltPLAOncoFAIRValueSet(a valid code from Type de l'élément d'administration Code System)http://oncofair-ig.kereval.cloud/ValueSet/siph-typeeltpla-oncofair-valuesetFrom this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:oncofair-ma-element-urgent |
S | 0..1 | boolean | Boolean attribute indicating the notion of urgency in creating the administration element URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-urgent | ||||
| extension:oncofair-ma-element-expirationdate |
0..1 | dateTime | Expiry date of administered component URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-expirationdate | |||||
| extension:oncofair-ma-element-traceability |
0..1 | (Complex) | OncoFAIRMAElementTraceability URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-traceability | |||||
| extension:oncofair-ma-plannedperiod |
1..1 | Period | OncoFAIRMAElementPlannedPeriod URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-plannedperiod | |||||
| extension:oncofair-element-form |
0..1 | CodeableConcept | Pharmaceutical form of the prescription/administration item URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-element-form | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
S | 1..1 | Identifier | Unique identifier of the administration element in the HIS. | ||||
| basedOn |
0..* | Reference(CarePlan) | Plan this is fulfilled by this administration | |||||
| partOf |
SΣ | 1..1 | Reference(OncoFAIR MedicationAdministration Report) | The medication administration report linked to the element of administration | ||||
| 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. | |||||
| Slices for category |
S | 0..* | CodeableConcept | Type of medication administration Slice: Unordered, Open by value:coding.system Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur. | ||||
| category:code |
0..1 | CodeableConcept | Type of medication administration Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur. | |||||
| category:nature |
0..1 | CodeableConcept | Type of medication administration Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur. | |||||
| medication |
Σ | 1..1 | CodeableReference(Medication) | What was administered 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: element | |||||
| 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 | |||||
| Slices for occurence[x] |
Σ | 1..1 | Specific date/time or interval of time during which the administration took place (or did not take place) Slice: Unordered, Open by type:$this | |||||
| occurenceDateTime |
dateTime | |||||||
| occurencePeriod |
Period | |||||||
| occurenceTiming |
Timing | |||||||
| occurence[x]:occurencePeriod |
SΣ | 0..1 | Period | Specific date/time or interval of time during which the administration took place (or did not take place) | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
ΣC | 1..1 | dateTime | Effective date and time for startinf administration of the administration element | ||||
| end |
ΣC | 0..1 | dateTime | Effective date and time for ending administration of the administration element | ||||
| 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 |
S | 0..1 | Reference(MedicationRequest) | Request administration performed against | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Unique identifier of the prescription element to which this administration element responds | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| device |
S | 0..* | CodeableReference(Device) | Specifies, where applicable, the medical devices or equipment to be used to administer the product. By default, the associated devices are those listed in the prescription element associated with the administration element | ||||
| Slices for note |
S | 1..* | Annotation | Information about the administration Slice: Unordered, Open by value:id | ||||
| note:wording |
1..1 | Annotation | Wording of the administration element | |||||
| 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) | ||||
| note:comments |
0..1 | Annotation | Comment attached to the administration element | |||||
| 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) | ||||
| dosage |
SC | 0..1 | BackboneElement | Details of how medication was taken Constraints: mad-1 | ||||
| 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 | Specifies, where applicable, the exact point on the body where the product is to be applied to the patient. By default, the place of administration is that shown in the prescription element associated with the administration element Binding: SNOMEDCTAnatomicalStructureAdministrationSites (example): A coded concept describing the site location the medicine enters into or onto the body. | |||||
| route |
0..1 | CodeableConcept | Specifies the route of administration of the product. By default, it is the one shown in the prescription element associated with the administration element. 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 | Type of administration element. Must be used to differentiate between management processes adapted to different types of drug treatment. Binding: Type de l'élément d'administration Value Set (required) | |||||
| dose |
C | 0..1 | SimpleQuantity | Amount of medication per dose | ||||
| rate[x] |
C | 0..1 | Dose quantity per unit of time | |||||
| rateRatio |
Ratio | |||||||
| rateQuantity |
Quantity(SimpleQuantity) | |||||||
| eventHistory |
0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.language | required | AllLanguages(a valid code from urn:ietf:bcp:47)http://hl7.org/fhir/ValueSet/all-languages|5.0.0From the FHIR Standard | |
| MedicationAdministration.status | required | MedicationAdministrationStatusCodeshttp://hl7.org/fhir/ValueSet/medication-admin-status|5.0.0From the FHIR Standard | |
| MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-not-given-codesFrom the FHIR Standard | |
| MedicationAdministration.category | example | MedicationAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medication-admin-locationFrom the FHIR Standard | |
| MedicationAdministration.category:code | example | MedicationAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medication-admin-locationFrom the FHIR Standard | |
| MedicationAdministration.category:nature | example | MedicationAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medication-admin-locationFrom the FHIR Standard | |
| MedicationAdministration.medication | required | ConceptMedicationOncoFAIRValueSet(a valid code from Concepts Medication Code System)http://oncofair-ig.kereval.cloud/ValueSet/concept-medication-oncofair-valuesetFrom this IG | |
| MedicationAdministration.subPotentReason | example | MedicationAdministrationSubpotentReasonhttp://hl7.org/fhir/ValueSet/administration-subpotent-reasonFrom the FHIR Standard | |
| MedicationAdministration.performer.function | example | MedicationAdministrationPerformerFunctionCodeshttp://hl7.org/fhir/ValueSet/med-admin-perform-functionFrom the FHIR Standard | |
| MedicationAdministration.reason | example | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codesFrom the FHIR Standard | |
| MedicationAdministration.request.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureAdministrationSiteshttp://hl7.org/fhir/ValueSet/approach-site-codesFrom the FHIR Standard | |
| MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesFrom the FHIR Standard | |
| MedicationAdministration.dosage.method | required | SIPhTypeEltPLAOncoFAIRValueSet(a valid code from Type de l'élément d'administration Code System)http://oncofair-ig.kereval.cloud/ValueSet/siph-typeeltpla-oncofair-valuesetFrom this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | 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 : 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-4 | error | MedicationAdministration | If 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-5 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mad-1 | error | MedicationAdministration.dosage | If 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
Summary
Mandatory: 7 elements(2 nested mandatory elements)
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
- http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-urgent
- http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-expirationdate
- http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-traceability
- http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-plannedperiod
- http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-element-form
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of MedicationAdministration.category
- The element 1 is sliced based on the value of MedicationAdministration.occurence[x]
- The element 1 is sliced based on the value of MedicationAdministration.note
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MedicationAdministration |
0..* | MedicationAdministration | Administration of medication to a patient | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:oncofair-ma-element-urgent |
S | 0..1 | boolean | Boolean attribute indicating the notion of urgency in creating the administration element URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-urgent |
| extension:oncofair-ma-element-expirationdate |
0..1 | dateTime | Expiry date of administered component URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-expirationdate | |
| extension:oncofair-ma-element-traceability |
0..1 | (Complex) | OncoFAIRMAElementTraceability URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-traceability | |
| extension:oncofair-ma-plannedperiod |
1..1 | Period | OncoFAIRMAElementPlannedPeriod URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-plannedperiod | |
| extension:oncofair-element-form |
0..1 | CodeableConcept | Pharmaceutical form of the prescription/administration item URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-element-form | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
S | 1..1 | Identifier | Unique identifier of the administration element in the HIS. |
| partOf |
SΣ | 1..1 | Reference(OncoFAIR MedicationAdministration Report) | The medication administration report linked to the element of administration |
| 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. |
| Slices for category |
S | 0..* | CodeableConcept | Type of medication administration Slice: Unordered, Open by value:coding.system Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur. |
| category:code |
0..1 | CodeableConcept | Type of medication administration Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur. | |
| category:nature |
0..1 | CodeableConcept | Type of medication administration Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur. | |
| medication |
Σ | 1..1 | CodeableReference(Medication) | What was administered Binding: Concepts Medication Value Set (required) |
| 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: element | |
| 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 | |
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who received medication |
| Slices for occurence[x] |
Σ | 1..1 | Specific date/time or interval of time during which the administration took place (or did not take place) Slice: Unordered, Open by type:$this | |
| occurenceDateTime |
dateTime | |||
| occurencePeriod |
Period | |||
| occurenceTiming |
Timing | |||
| occurence[x]:occurencePeriod |
SΣ | 0..1 | Period | Specific date/time or interval of time during which the administration took place (or did not take place) |
| start |
ΣC | 1..1 | dateTime | Effective date and time for startinf administration of the administration element |
| end |
ΣC | 0..1 | dateTime | Effective date and time for ending administration of the administration element |
| request |
S | 0..1 | Reference(MedicationRequest) | Request administration performed against |
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier |
ΣC | 0..1 | Identifier | Unique identifier of the prescription element to which this administration element responds |
| device |
S | 0..* | CodeableReference(Device) | Specifies, where applicable, the medical devices or equipment to be used to administer the product. By default, the associated devices are those listed in the prescription element associated with the administration element |
| Slices for note |
S | 1..* | Annotation | Information about the administration Slice: Unordered, Open by value:id |
| note:wording |
1..1 | Annotation | Wording of the administration element | |
| id |
1..1 | id | Unique id for inter-element referencing Required Pattern: wording | |
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) |
| note:comments |
0..1 | Annotation | Comment attached to the administration element | |
| id |
1..1 | id | Unique id for inter-element referencing Required Pattern: comments | |
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) |
| dosage |
SC | 0..1 | BackboneElement | Details of how medication was taken Constraints: mad-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| site |
0..1 | CodeableConcept | Specifies, where applicable, the exact point on the body where the product is to be applied to the patient. By default, the place of administration is that shown in the prescription element associated with the administration element Binding: SNOMEDCTAnatomicalStructureAdministrationSites (example): A coded concept describing the site location the medicine enters into or onto the body. | |
| route |
0..1 | CodeableConcept | Specifies the route of administration of the product. By default, it is the one shown in the prescription element associated with the administration element. 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 | Type of administration element. Must be used to differentiate between management processes adapted to different types of drug treatment. Binding: Type de l'élément d'administration Value Set (required) | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.status | required | MedicationAdministrationStatusCodeshttp://hl7.org/fhir/ValueSet/medication-admin-status|5.0.0From the FHIR Standard | |
| MedicationAdministration.category | example | MedicationAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medication-admin-locationFrom the FHIR Standard | |
| MedicationAdministration.category:code | example | MedicationAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medication-admin-locationFrom the FHIR Standard | |
| MedicationAdministration.category:nature | example | MedicationAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medication-admin-locationFrom the FHIR Standard | |
| MedicationAdministration.medication | required | ConceptMedicationOncoFAIRValueSet(a valid code from Concepts Medication Code System)http://oncofair-ig.kereval.cloud/ValueSet/concept-medication-oncofair-valuesetFrom this IG | |
| MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureAdministrationSiteshttp://hl7.org/fhir/ValueSet/approach-site-codesFrom the FHIR Standard | |
| MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesFrom the FHIR Standard | |
| MedicationAdministration.dosage.method | required | SIPhTypeEltPLAOncoFAIRValueSet(a valid code from Type de l'élément d'administration Code System)http://oncofair-ig.kereval.cloud/ValueSet/siph-typeeltpla-oncofair-valuesetFrom this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | 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 : 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-4 | error | MedicationAdministration | If 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-5 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mad-1 | error | MedicationAdministration.dosage | If 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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-urgent |
S | 0..1 | boolean | Boolean attribute indicating the notion of urgency in creating the administration element URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-urgent |
| extension:oncofair-ma-element-expirationdate |
0..1 | dateTime | Expiry date of administered component URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-expirationdate | |
| extension:oncofair-ma-element-traceability |
0..1 | (Complex) | OncoFAIRMAElementTraceability URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-traceability | |
| extension:oncofair-ma-plannedperiod |
1..1 | Period | OncoFAIRMAElementPlannedPeriod URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-plannedperiod | |
| extension:oncofair-element-form |
0..1 | CodeableConcept | Pharmaceutical form of the prescription/administration item URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-element-form | |
| identifier |
S | 1..1 | Identifier | Unique identifier of the administration element in the HIS. |
| partOf |
S | 1..1 | Reference(OncoFAIR MedicationAdministration Report) | The medication administration report linked to the element of administration |
| Slices for category |
S | 0..* | CodeableConcept | Type of medication administration Slice: Unordered, Open by value:coding.system |
| category:code |
0..1 | CodeableConcept | Type of medication administration | |
| category:nature |
0..1 | CodeableConcept | Type of medication administration | |
| medication |
1..1 | CodeableReference(Medication) | What was administered 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: element | |
| Slices for occurence[x] |
1..1 | dateTime, Period, Timing | Specific date/time or interval of time during which the administration took place (or did not take place) Slice: Unordered, Open by type:$this | |
| occurence[x]:occurencePeriod |
S | 0..1 | Period | Specific date/time or interval of time during which the administration took place (or did not take place) |
| start |
1..1 | dateTime | Effective date and time for startinf administration of the administration element | |
| end |
0..1 | dateTime | Effective date and time for ending administration of the administration element | |
| request |
S | 0..1 | Reference(MedicationRequest) | Request administration performed against |
| identifier |
0..1 | Identifier | Unique identifier of the prescription element to which this administration element responds | |
| device |
S | 0..* | CodeableReference(Device) | Specifies, where applicable, the medical devices or equipment to be used to administer the product. By default, the associated devices are those listed in the prescription element associated with the administration element |
| Slices for note |
S | 1..* | Annotation | Information about the administration Slice: Unordered, Open by value:id |
| note:wording |
1..1 | Annotation | Wording of the administration element | |
| id |
1..1 | id | Unique id for inter-element referencing Required Pattern: wording | |
| note:comments |
0..1 | Annotation | Comment attached to the administration element | |
| id |
1..1 | id | Unique id for inter-element referencing Required Pattern: comments | |
| dosage |
S | 0..1 | BackboneElement | Details of how medication was taken |
| site |
0..1 | CodeableConcept | Specifies, where applicable, the exact point on the body where the product is to be applied to the patient. By default, the place of administration is that shown in the prescription element associated with the administration element | |
| route |
0..1 | CodeableConcept | Specifies the route of administration of the product. By default, it is the one shown in the prescription element associated with the administration element. | |
| method |
0..1 | CodeableConcept | Type of administration element. Must be used to differentiate between management processes adapted to different types of drug treatment. Binding: Type de l'élément d'administration Value Set (required) | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.medication | required | ConceptMedicationOncoFAIRValueSet(a valid code from Concepts Medication Code System)http://oncofair-ig.kereval.cloud/ValueSet/concept-medication-oncofair-valuesetFrom this IG | |
| MedicationAdministration.dosage.method | required | SIPhTypeEltPLAOncoFAIRValueSet(a valid code from Type de l'élément d'administration Code System)http://oncofair-ig.kereval.cloud/ValueSet/siph-typeeltpla-oncofair-valuesetFrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:oncofair-ma-element-urgent |
S | 0..1 | boolean | Boolean attribute indicating the notion of urgency in creating the administration element URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-urgent | ||||
| extension:oncofair-ma-element-expirationdate |
0..1 | dateTime | Expiry date of administered component URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-expirationdate | |||||
| extension:oncofair-ma-element-traceability |
0..1 | (Complex) | OncoFAIRMAElementTraceability URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-traceability | |||||
| extension:oncofair-ma-plannedperiod |
1..1 | Period | OncoFAIRMAElementPlannedPeriod URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-plannedperiod | |||||
| extension:oncofair-element-form |
0..1 | CodeableConcept | Pharmaceutical form of the prescription/administration item URL: http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-element-form | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
S | 1..1 | Identifier | Unique identifier of the administration element in the HIS. | ||||
| basedOn |
0..* | Reference(CarePlan) | Plan this is fulfilled by this administration | |||||
| partOf |
SΣ | 1..1 | Reference(OncoFAIR MedicationAdministration Report) | The medication administration report linked to the element of administration | ||||
| 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. | |||||
| Slices for category |
S | 0..* | CodeableConcept | Type of medication administration Slice: Unordered, Open by value:coding.system Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur. | ||||
| category:code |
0..1 | CodeableConcept | Type of medication administration Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur. | |||||
| category:nature |
0..1 | CodeableConcept | Type of medication administration Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur. | |||||
| medication |
Σ | 1..1 | CodeableReference(Medication) | What was administered 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: element | |||||
| 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 | |||||
| Slices for occurence[x] |
Σ | 1..1 | Specific date/time or interval of time during which the administration took place (or did not take place) Slice: Unordered, Open by type:$this | |||||
| occurenceDateTime |
dateTime | |||||||
| occurencePeriod |
Period | |||||||
| occurenceTiming |
Timing | |||||||
| occurence[x]:occurencePeriod |
SΣ | 0..1 | Period | Specific date/time or interval of time during which the administration took place (or did not take place) | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
ΣC | 1..1 | dateTime | Effective date and time for startinf administration of the administration element | ||||
| end |
ΣC | 0..1 | dateTime | Effective date and time for ending administration of the administration element | ||||
| 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 |
S | 0..1 | Reference(MedicationRequest) | Request administration performed against | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Unique identifier of the prescription element to which this administration element responds | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| device |
S | 0..* | CodeableReference(Device) | Specifies, where applicable, the medical devices or equipment to be used to administer the product. By default, the associated devices are those listed in the prescription element associated with the administration element | ||||
| Slices for note |
S | 1..* | Annotation | Information about the administration Slice: Unordered, Open by value:id | ||||
| note:wording |
1..1 | Annotation | Wording of the administration element | |||||
| 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) | ||||
| note:comments |
0..1 | Annotation | Comment attached to the administration element | |||||
| 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) | ||||
| dosage |
SC | 0..1 | BackboneElement | Details of how medication was taken Constraints: mad-1 | ||||
| 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 | Specifies, where applicable, the exact point on the body where the product is to be applied to the patient. By default, the place of administration is that shown in the prescription element associated with the administration element Binding: SNOMEDCTAnatomicalStructureAdministrationSites (example): A coded concept describing the site location the medicine enters into or onto the body. | |||||
| route |
0..1 | CodeableConcept | Specifies the route of administration of the product. By default, it is the one shown in the prescription element associated with the administration element. 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 | Type of administration element. Must be used to differentiate between management processes adapted to different types of drug treatment. Binding: Type de l'élément d'administration Value Set (required) | |||||
| dose |
C | 0..1 | SimpleQuantity | Amount of medication per dose | ||||
| rate[x] |
C | 0..1 | Dose quantity per unit of time | |||||
| rateRatio |
Ratio | |||||||
| rateQuantity |
Quantity(SimpleQuantity) | |||||||
| eventHistory |
0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.language | required | AllLanguages(a valid code from urn:ietf:bcp:47)http://hl7.org/fhir/ValueSet/all-languages|5.0.0From the FHIR Standard | |
| MedicationAdministration.status | required | MedicationAdministrationStatusCodeshttp://hl7.org/fhir/ValueSet/medication-admin-status|5.0.0From the FHIR Standard | |
| MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-not-given-codesFrom the FHIR Standard | |
| MedicationAdministration.category | example | MedicationAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medication-admin-locationFrom the FHIR Standard | |
| MedicationAdministration.category:code | example | MedicationAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medication-admin-locationFrom the FHIR Standard | |
| MedicationAdministration.category:nature | example | MedicationAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medication-admin-locationFrom the FHIR Standard | |
| MedicationAdministration.medication | required | ConceptMedicationOncoFAIRValueSet(a valid code from Concepts Medication Code System)http://oncofair-ig.kereval.cloud/ValueSet/concept-medication-oncofair-valuesetFrom this IG | |
| MedicationAdministration.subPotentReason | example | MedicationAdministrationSubpotentReasonhttp://hl7.org/fhir/ValueSet/administration-subpotent-reasonFrom the FHIR Standard | |
| MedicationAdministration.performer.function | example | MedicationAdministrationPerformerFunctionCodeshttp://hl7.org/fhir/ValueSet/med-admin-perform-functionFrom the FHIR Standard | |
| MedicationAdministration.reason | example | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codesFrom the FHIR Standard | |
| MedicationAdministration.request.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureAdministrationSiteshttp://hl7.org/fhir/ValueSet/approach-site-codesFrom the FHIR Standard | |
| MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesFrom the FHIR Standard | |
| MedicationAdministration.dosage.method | required | SIPhTypeEltPLAOncoFAIRValueSet(a valid code from Type de l'élément d'administration Code System)http://oncofair-ig.kereval.cloud/ValueSet/siph-typeeltpla-oncofair-valuesetFrom this IG |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | 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 : 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-4 | error | MedicationAdministration | If 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-5 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mad-1 | error | MedicationAdministration.dosage | If 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
Summary
Mandatory: 7 elements(2 nested mandatory elements)
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
- http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-urgent
- http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-expirationdate
- http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-traceability
- http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-ma-element-plannedperiod
- http://oncofair-ig.kereval.cloud/StructureDefinition/oncofair-element-form
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of MedicationAdministration.category
- The element 1 is sliced based on the value of MedicationAdministration.occurence[x]
- The element 1 is sliced based on the value of MedicationAdministration.note
Other representations of profile: CSV, Excel, Schematron