Extensions for Using Data Elements from FHIR R5 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-MedicationAdministration | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_MedicationAdministration_R4B | ||
This cross-version profile allows R5 MedicationAdministration content to be represented via FHIR R4B MedicationAdministration resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationAdministration.status | Base | required | MedicationAdministration Status Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.medication[x] | Base | example | SNOMED CT Medication Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').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 | MedicationAdministration.implicitRules, MedicationAdministration.extension, MedicationAdministration.extension:basedOn, MedicationAdministration.extension:occurence, MedicationAdministration.extension:recorded, MedicationAdministration.extension:isSubPotent, MedicationAdministration.extension:subPotentReason, MedicationAdministration.extension:reason, MedicationAdministration.modifierExtension, MedicationAdministration.status, MedicationAdministration.medication[x], MedicationAdministration.subject, MedicationAdministration.effective[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | MedicationAdministration.extension, MedicationAdministration.extension:basedOn, MedicationAdministration.extension:occurence, MedicationAdministration.extension:recorded, MedicationAdministration.extension:isSubPotent, MedicationAdministration.extension:subPotentReason, MedicationAdministration.extension:reason, MedicationAdministration.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from MedicationAdministration
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
  MedicationAdministration |
0..* | MedicationAdministration(4.3.0) | Administration of medication to a patient | |||||
  id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| 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 Constraints: dom-r4b | |||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
   extension:basedOn |
0..* | Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4B(0.1.0) | CarePlan) | R5: Plan this is fulfilled by this administration (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.basedOn Constraints: ext-1 | |||||
| extension:occurence |
0..1 | Timing | R5: Specific date/time or interval of time during which the administration took place (or did not take place) additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.occurence Constraints: ext-1 | |||||
| extension:recorded |
0..1 | dateTime | R5: When the MedicationAdministration was first captured in the subject's record (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.recorded Constraints: ext-1 | |||||
| extension:isSubPotent |
0..1 | boolean | R5: Full dose was not administered (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.isSubPotent Constraints: ext-1 | |||||
| extension:subPotentReason |
0..* | CodeableConcept | R5: Reason full dose was not administered (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.subPotentReason Binding: R5AdministrationSubpotentReasonForR4B (0.1.0) (example) Constraints: ext-1 | |||||
 extension:reason |
0..* | CodeableReference(Cross-version Profile for R5.Condition for use in FHIR R4B(0.1.0) | Condition | Cross-version Profile for R5.Observation for use in FHIR R4B(0.1.0) | Observation | Cross-version Profile for R5.DiagnosticReport for use in FHIR R4B(0.1.0) | DiagnosticReport) | R5: Concept, condition or observation that supports why the medication was administered additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.reason Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made. Constraints: ext-1 | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
0..* | Identifier | External identifier | |||||
| instantiates |
Σ | 0..* | uri | Instantiates protocol or definition | ||||
 partOf |
Σ | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:partOf |
0..1 | Reference(Resource) | R5: partOf URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
 display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| status |
?!Σ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. | ||||
| statusReason |
0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated. | |||||
| category |
0..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur. | |||||
 medication[x] |
Σ | 1..1 | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. | |||||
| medicationCodeableConcept |
CodeableConcept | |||||||
| medicationReference |
Reference(Medication) | |||||||
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who received medication | ||||
| context |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of | |||||
| supportingInformation |
0..* | Reference(Resource) | Additional information to support administration | |||||
| effective[x] |
Σ | 1..1 | Start and end time of administration | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| performer |
Σ | 0..* | BackboneElement | Who performed the medication administration and what they did | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| function |
0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication. | |||||
 actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who performed the medication administration | ||||
 id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:actor |
1..1 | CodeableReference(Cross-version Profile for R5.Practitioner for use in FHIR R4B(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4B(0.1.0) | PractitionerRole | Cross-version Profile for R5.Patient for use in FHIR R4B(0.1.0) | Patient | Cross-version Profile for R5.RelatedPerson for use in FHIR R4B(0.1.0) | RelatedPerson | Cross-version Profile for R5.Device for use in FHIR R4B(0.1.0) | Device) | R5: Who or what performed the medication administration additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.performer.actor Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| reasonCode |
0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication was administered | |||||
| request |
0..1 | Reference(MedicationRequest) | Request administration performed against | |||||
| device |
0..* | Reference(Device) | Device used to administer | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:device |
0..* | CodeableConcept | R5: device additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.device Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| note |
0..* | Annotation | Information about the administration | |||||
| dosage |
C | 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| text |
0..1 | string | Free text dosage instructions e.g. SIG | |||||
| site |
0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | |||||
| route |
0..1 | CodeableConcept | Path of substance into body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||
| method |
0..1 | CodeableConcept | How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | |||||
| dose |
0..1 | SimpleQuantity(4.3.0) | Amount of medication per dose | |||||
| rate[x] |
0..1 | Dose quantity per unit of time | ||||||
| rateRatio |
Ratio | |||||||
| rateQuantity |
Quantity(SimpleQuantity) | |||||||
| eventHistory |
0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationAdministration.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.partOf.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.status | Base | required | MedicationAdministration Status Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.statusReason | Base | example | SNOMED CT Reason Medication Not Given Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.category | Base | preferred | MedicationAdministration Category Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.medication[x] | Base | example | SNOMED CT Medication Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.performer.function | Base | example | MedicationAdministration Performer Function Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.performer.actor.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.reasonCode | Base | example | Reason Medication Given Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.device.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.dosage.site | Base | example | SNOMED CT Anatomical Structure for Administration Site Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.dosage.route | Base | example | SNOMED CT Route Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.dosage.method | Base | example | SNOMED CT Administration Method Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').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()
|
| dom-r4b | warning | MedicationAdministration.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | MedicationAdministration.meta, MedicationAdministration.implicitRules, MedicationAdministration.language, MedicationAdministration.text, MedicationAdministration.extension, MedicationAdministration.extension:basedOn, MedicationAdministration.extension:occurence, MedicationAdministration.extension:recorded, MedicationAdministration.extension:isSubPotent, MedicationAdministration.extension:subPotentReason, MedicationAdministration.extension:reason, MedicationAdministration.modifierExtension, MedicationAdministration.identifier, MedicationAdministration.instantiates, MedicationAdministration.partOf, MedicationAdministration.partOf.extension, MedicationAdministration.partOf.extension:partOf, MedicationAdministration.partOf.reference, MedicationAdministration.partOf.type, MedicationAdministration.partOf.identifier, MedicationAdministration.partOf.display, MedicationAdministration.status, MedicationAdministration.statusReason, MedicationAdministration.category, MedicationAdministration.medication[x], MedicationAdministration.subject, MedicationAdministration.context, MedicationAdministration.supportingInformation, MedicationAdministration.effective[x], MedicationAdministration.performer, MedicationAdministration.performer.extension, MedicationAdministration.performer.modifierExtension, MedicationAdministration.performer.function, MedicationAdministration.performer.actor, MedicationAdministration.performer.actor.extension, MedicationAdministration.performer.actor.extension:actor, MedicationAdministration.performer.actor.reference, MedicationAdministration.performer.actor.type, MedicationAdministration.performer.actor.identifier, MedicationAdministration.performer.actor.display, MedicationAdministration.reasonCode, MedicationAdministration.reasonReference, MedicationAdministration.request, MedicationAdministration.device, MedicationAdministration.device.extension, MedicationAdministration.device.extension:device, MedicationAdministration.device.reference, MedicationAdministration.device.type, MedicationAdministration.device.identifier, MedicationAdministration.device.display, MedicationAdministration.note, MedicationAdministration.dosage, MedicationAdministration.dosage.extension, MedicationAdministration.dosage.modifierExtension, MedicationAdministration.dosage.text, MedicationAdministration.dosage.site, MedicationAdministration.dosage.route, MedicationAdministration.dosage.method, MedicationAdministration.dosage.dose, MedicationAdministration.dosage.rate[x], MedicationAdministration.eventHistory | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | MedicationAdministration.extension, MedicationAdministration.extension:basedOn, MedicationAdministration.extension:occurence, MedicationAdministration.extension:recorded, MedicationAdministration.extension:isSubPotent, MedicationAdministration.extension:subPotentReason, MedicationAdministration.extension:reason, MedicationAdministration.modifierExtension, MedicationAdministration.partOf.extension, MedicationAdministration.partOf.extension:partOf, MedicationAdministration.performer.extension, MedicationAdministration.performer.modifierExtension, MedicationAdministration.performer.actor.extension, MedicationAdministration.performer.actor.extension:actor, MedicationAdministration.device.extension, MedicationAdministration.device.extension:device, MedicationAdministration.dosage.extension, MedicationAdministration.dosage.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mad-1 | error | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] |
dose.exists() or rate.exists()
|
This structure is derived from MedicationAdministration
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationAdministration.status | Base | required | MedicationAdministration Status Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.medication[x] | Base | example | SNOMED CT Medication Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').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 | MedicationAdministration.implicitRules, MedicationAdministration.extension, MedicationAdministration.extension:basedOn, MedicationAdministration.extension:occurence, MedicationAdministration.extension:recorded, MedicationAdministration.extension:isSubPotent, MedicationAdministration.extension:subPotentReason, MedicationAdministration.extension:reason, MedicationAdministration.modifierExtension, MedicationAdministration.status, MedicationAdministration.medication[x], MedicationAdministration.subject, MedicationAdministration.effective[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | MedicationAdministration.extension, MedicationAdministration.extension:basedOn, MedicationAdministration.extension:occurence, MedicationAdministration.extension:recorded, MedicationAdministration.extension:isSubPotent, MedicationAdministration.extension:subPotentReason, MedicationAdministration.extension:reason, MedicationAdministration.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from MedicationAdministration
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationAdministration |
0..* | MedicationAdministration(4.3.0) | Administration of medication to a patient | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| 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 Constraints: dom-r4b | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:basedOn |
0..* | Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4B(0.1.0) | CarePlan) | R5: Plan this is fulfilled by this administration (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.basedOn Constraints: ext-1 | |||||
| extension:occurence |
0..1 | Timing | R5: Specific date/time or interval of time during which the administration took place (or did not take place) additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.occurence Constraints: ext-1 | |||||
| extension:recorded |
0..1 | dateTime | R5: When the MedicationAdministration was first captured in the subject's record (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.recorded Constraints: ext-1 | |||||
| extension:isSubPotent |
0..1 | boolean | R5: Full dose was not administered (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.isSubPotent Constraints: ext-1 | |||||
| extension:subPotentReason |
0..* | CodeableConcept | R5: Reason full dose was not administered (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.subPotentReason Binding: R5AdministrationSubpotentReasonForR4B (0.1.0) (example) Constraints: ext-1 | |||||
| extension:reason |
0..* | CodeableReference(Cross-version Profile for R5.Condition for use in FHIR R4B(0.1.0) | Condition | Cross-version Profile for R5.Observation for use in FHIR R4B(0.1.0) | Observation | Cross-version Profile for R5.DiagnosticReport for use in FHIR R4B(0.1.0) | DiagnosticReport) | R5: Concept, condition or observation that supports why the medication was administered additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.reason Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made. Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
0..* | Identifier | External identifier | |||||
| instantiates |
Σ | 0..* | uri | Instantiates protocol or definition | ||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:partOf |
0..1 | Reference(Resource) | R5: partOf URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| status |
?!Σ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. | ||||
| statusReason |
0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated. | |||||
| category |
0..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur. | |||||
| medication[x] |
Σ | 1..1 | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. | |||||
| medicationCodeableConcept |
CodeableConcept | |||||||
| medicationReference |
Reference(Medication) | |||||||
| subject |
Σ | 1..1 | Reference(Patient | Group) | Who received medication | ||||
| context |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of | |||||
| supportingInformation |
0..* | Reference(Resource) | Additional information to support administration | |||||
| effective[x] |
Σ | 1..1 | Start and end time of administration | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| performer |
Σ | 0..* | BackboneElement | Who performed the medication administration and what they did | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| function |
0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication. | |||||
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who performed the medication administration | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:actor |
1..1 | CodeableReference(Cross-version Profile for R5.Practitioner for use in FHIR R4B(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR R4B(0.1.0) | PractitionerRole | Cross-version Profile for R5.Patient for use in FHIR R4B(0.1.0) | Patient | Cross-version Profile for R5.RelatedPerson for use in FHIR R4B(0.1.0) | RelatedPerson | Cross-version Profile for R5.Device for use in FHIR R4B(0.1.0) | Device) | R5: Who or what performed the medication administration additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.performer.actor Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| reasonCode |
0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication was administered | |||||
| request |
0..1 | Reference(MedicationRequest) | Request administration performed against | |||||
| device |
0..* | Reference(Device) | Device used to administer | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:device |
0..* | CodeableConcept | R5: device additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.device Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| note |
0..* | Annotation | Information about the administration | |||||
| dosage |
C | 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| text |
0..1 | string | Free text dosage instructions e.g. SIG | |||||
| site |
0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | |||||
| route |
0..1 | CodeableConcept | Path of substance into body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||
| method |
0..1 | CodeableConcept | How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | |||||
| dose |
0..1 | SimpleQuantity(4.3.0) | Amount of medication per dose | |||||
| rate[x] |
0..1 | Dose quantity per unit of time | ||||||
| rateRatio |
Ratio | |||||||
| rateQuantity |
Quantity(SimpleQuantity) | |||||||
| eventHistory |
0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MedicationAdministration.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.partOf.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.status | Base | required | MedicationAdministration Status Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.statusReason | Base | example | SNOMED CT Reason Medication Not Given Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.category | Base | preferred | MedicationAdministration Category Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.medication[x] | Base | example | SNOMED CT Medication Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.performer.function | Base | example | MedicationAdministration Performer Function Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.performer.actor.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.reasonCode | Base | example | Reason Medication Given Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.device.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.dosage.site | Base | example | SNOMED CT Anatomical Structure for Administration Site Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.dosage.route | Base | example | SNOMED CT Route Codes | 📍4.3.0 | FHIR Std. |
| MedicationAdministration.dosage.method | Base | example | SNOMED CT Administration Method Codes | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').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()
|
| dom-r4b | warning | MedicationAdministration.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | MedicationAdministration.meta, MedicationAdministration.implicitRules, MedicationAdministration.language, MedicationAdministration.text, MedicationAdministration.extension, MedicationAdministration.extension:basedOn, MedicationAdministration.extension:occurence, MedicationAdministration.extension:recorded, MedicationAdministration.extension:isSubPotent, MedicationAdministration.extension:subPotentReason, MedicationAdministration.extension:reason, MedicationAdministration.modifierExtension, MedicationAdministration.identifier, MedicationAdministration.instantiates, MedicationAdministration.partOf, MedicationAdministration.partOf.extension, MedicationAdministration.partOf.extension:partOf, MedicationAdministration.partOf.reference, MedicationAdministration.partOf.type, MedicationAdministration.partOf.identifier, MedicationAdministration.partOf.display, MedicationAdministration.status, MedicationAdministration.statusReason, MedicationAdministration.category, MedicationAdministration.medication[x], MedicationAdministration.subject, MedicationAdministration.context, MedicationAdministration.supportingInformation, MedicationAdministration.effective[x], MedicationAdministration.performer, MedicationAdministration.performer.extension, MedicationAdministration.performer.modifierExtension, MedicationAdministration.performer.function, MedicationAdministration.performer.actor, MedicationAdministration.performer.actor.extension, MedicationAdministration.performer.actor.extension:actor, MedicationAdministration.performer.actor.reference, MedicationAdministration.performer.actor.type, MedicationAdministration.performer.actor.identifier, MedicationAdministration.performer.actor.display, MedicationAdministration.reasonCode, MedicationAdministration.reasonReference, MedicationAdministration.request, MedicationAdministration.device, MedicationAdministration.device.extension, MedicationAdministration.device.extension:device, MedicationAdministration.device.reference, MedicationAdministration.device.type, MedicationAdministration.device.identifier, MedicationAdministration.device.display, MedicationAdministration.note, MedicationAdministration.dosage, MedicationAdministration.dosage.extension, MedicationAdministration.dosage.modifierExtension, MedicationAdministration.dosage.text, MedicationAdministration.dosage.site, MedicationAdministration.dosage.route, MedicationAdministration.dosage.method, MedicationAdministration.dosage.dose, MedicationAdministration.dosage.rate[x], MedicationAdministration.eventHistory | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | MedicationAdministration.extension, MedicationAdministration.extension:basedOn, MedicationAdministration.extension:occurence, MedicationAdministration.extension:recorded, MedicationAdministration.extension:isSubPotent, MedicationAdministration.extension:subPotentReason, MedicationAdministration.extension:reason, MedicationAdministration.modifierExtension, MedicationAdministration.partOf.extension, MedicationAdministration.partOf.extension:partOf, MedicationAdministration.performer.extension, MedicationAdministration.performer.modifierExtension, MedicationAdministration.performer.actor.extension, MedicationAdministration.performer.actor.extension:actor, MedicationAdministration.device.extension, MedicationAdministration.device.extension:device, MedicationAdministration.dosage.extension, MedicationAdministration.dosage.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mad-1 | error | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] |
dose.exists() or rate.exists()
|
This structure is derived from MedicationAdministration
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r4b#0.1.0 based on FHIR 4.3.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
