Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_MedicationAdministration_R3

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_R3

This cross-version profile allows R5 MedicationAdministration content to be represented via FHIR STU3 MedicationAdministration resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration C 0..* MedicationAdministration Administration of medication to a patient
Constraints: mad-2, mad-3
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR STU3(0.1.0) | CarePlan) R5: Plan this is fulfilled by this administration (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.basedOn
.... extension:statusReason 0..* CodeableConcept R5: Reason administration not performed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.statusReason
.... 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
.... 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
.... extension:isSubPotent 0..1 boolean R5: Full dose was not administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.isSubPotent
.... extension:subPotentReason 0..* CodeableConcept R5: Reason full dose was not administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.subPotentReason
Binding: R5AdministrationSubpotentReasonForR3 (0.1.0) (example)
.... extension:reason 0..* (Complex) 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code R5: in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.status
Binding: MedicationAdministrationStatus (required): A set of codes indicating the current status of a MedicationAdministration.
... medication[x] Σ 1..1 What was administered
Binding: SNOMED CT Medication Codes (example): Codes identifying substance or product that can be administered.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject Σ 1..1 Reference(Patient | Group) Who received medication
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... effective[x] Σ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... notGiven ?!Σ 0..1 boolean True if medication not administered

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationAdministration.​status Base required MedicationAdministrationStatus 📍3.0.2 FHIR Std.
MedicationAdministration.​medication[x] Base example SNOMED CT Medication Codes 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error MedicationAdministration If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
mad-2 error MedicationAdministration Reason not given is only permitted if NotGiven is true reasonNotGiven.empty() or notGiven = true
mad-3 error MedicationAdministration Reason given is only permitted if NotGiven is false reasonCode.empty() or notGiven.empty() or notGiven = 'false'

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR STU3(0.1.0) | CarePlan) R5: Plan this is fulfilled by this administration (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.basedOn
.... extension:statusReason 0..* CodeableConcept R5: Reason administration not performed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.statusReason
.... 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
.... 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
.... extension:isSubPotent 0..1 boolean R5: Full dose was not administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.isSubPotent
.... extension:subPotentReason 0..* CodeableConcept R5: Reason full dose was not administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.subPotentReason
Binding: R5AdministrationSubpotentReasonForR3 (0.1.0) (example)
.... extension:reason 0..* (Complex) 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
... partOf
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:partOf 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: partOf
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... status
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code R5: in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.status
Binding: MedicationAdministrationStatus (required): A set of codes indicating the current status of a MedicationAdministration.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... context
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Encounter administered as part of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... supportingInformation
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:supportingInformation 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: supportingInformation additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... performer
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:function 0..1 CodeableConcept R5: Type of performance (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.performer.function
Binding: R5MedAdminPerformFunctionForR3 (0.1.0) (example): A code describing the role an individual played in administering the medication.
.... actor
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:actor 0..1 (Complex) R5: Who or what performed the medication administration additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.performer.actor
... prescription
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:request 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: request additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... device
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:device 0..* CodeableConcept R5: device additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.device
... eventHistory
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:eventHistory 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: eventHistory additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration C 0..* MedicationAdministration Administration of medication to a patient
Constraints: mad-2, mad-3
... 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: Common Languages . (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR STU3(0.1.0) | CarePlan) R5: Plan this is fulfilled by this administration (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.basedOn
.... extension:statusReason 0..* CodeableConcept R5: Reason administration not performed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.statusReason
.... 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
.... 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
.... extension:isSubPotent 0..1 boolean R5: Full dose was not administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.isSubPotent
.... extension:subPotentReason 0..* CodeableConcept R5: Reason full dose was not administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.subPotentReason
Binding: R5AdministrationSubpotentReasonForR3 (0.1.0) (example)
.... extension:reason 0..* (Complex) 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... definition Σ 0..* Reference(PlanDefinition | ActivityDefinition) Instantiates protocol or definition
... partOf Σ 0..* Reference(MedicationAdministration | Procedure) Part of referenced event
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:partOf 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: partOf
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... 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 | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministrationStatus (required): A set of codes indicating the current status of a MedicationAdministration.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code R5: in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.status
Binding: MedicationAdministrationStatus (required): A set of codes indicating the current status of a MedicationAdministration.
.... value 0..1 code Primitive value for code
... category 0..1 CodeableConcept Type of medication usage
Binding: MedicationAdministrationCategory (preferred): A coded concept describing where the medication administered is expected to occur
... medication[x] Σ 1..1 What was administered
Binding: SNOMED CT Medication Codes (example): Codes identifying substance or product that can be administered.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject Σ 1..1 Reference(Patient | Group) Who received medication
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... context 0..1 Reference(Encounter | EpisodeOfCare) Encounter or Episode of Care administered as part of
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Encounter administered as part of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... supportingInformation 0..* Reference(Resource) Additional information to support administration
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:supportingInformation 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: supportingInformation additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... effective[x] Σ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer Σ 0..* BackboneElement Who administered substance
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:function 0..1 CodeableConcept R5: Type of performance (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.performer.function
Binding: R5MedAdminPerformFunctionForR3 (0.1.0) (example): A code describing the role an individual played in administering the medication.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... actor Σ 1..1 Reference(Practitioner | Patient | RelatedPerson | Device) Individual who was performing
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:actor 1..1 (Complex) R5: Who or what performed the medication administration additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.performer.actor
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... onBehalfOf 0..1 Reference(Organization) Organization organization was acting for
... notGiven ?!Σ 0..1 boolean True if medication not administered
... reasonNotGiven C 0..* CodeableConcept Reason administration not performed
Binding: SNOMED CT Reason Medication Not Given Codes (example): A set of codes indicating the reason why the MedicationAdministration is negated.
... reasonCode C 0..* CodeableConcept Reason administration performed
Binding: Reason Medication Given Codes (example): A set of codes indicating the reason why the MedicationAdministration was made.
... reasonReference 0..* Reference(Condition | Observation) Condition or Observation that supports why the medication was administered
... prescription 0..1 Reference(MedicationRequest) Request administration performed against
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:request 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: request additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... device 0..* Reference(Device) Device used to administer
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:device 0..* CodeableConcept R5: device additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.device
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... 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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... text 0..1 string Free text dosage instructions e.g. SIG
.... site 0..1 CodeableConcept Body site administered to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (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: SNOMED CT Route Codes (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: SNOMED CT Administration Method Codes (example): A coded concept describing the technique by which the medicine is administered.
.... dose 0..1 SimpleQuantity 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
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:eventHistory 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: eventHistory additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationAdministration.​language Base extensible Common Languages . 📍3.0.2 tx.fhir.org
MedicationAdministration.​status Base required MedicationAdministrationStatus 📍3.0.2 FHIR Std.
MedicationAdministration.​category Base preferred MedicationAdministrationCategory 📍3.0.2 FHIR Std.
MedicationAdministration.​medication[x] Base example SNOMED CT Medication Codes 📍3.0.2 FHIR Std.
MedicationAdministration.​reasonNotGiven Base example SNOMED CT Reason Medication Not Given Codes 📍3.0.2 FHIR Std.
MedicationAdministration.​reasonCode Base example Reason Medication Given Codes 📍3.0.2 FHIR Std.
MedicationAdministration.​dosage.site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍3.0.2 FHIR Std.
MedicationAdministration.​dosage.route Base example SNOMED CT Route Codes 📍3.0.2 FHIR Std.
MedicationAdministration.​dosage.method Base example SNOMED CT Administration Method Codes 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error MedicationAdministration If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (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 SHALL have at least one of dosage.dose or dosage.rate[x] dose.exists() or rate.exists()
mad-2 error MedicationAdministration Reason not given is only permitted if NotGiven is true reasonNotGiven.empty() or notGiven = true
mad-3 error MedicationAdministration Reason given is only permitted if NotGiven is false reasonCode.empty() or notGiven.empty() or notGiven = 'false'

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration C 0..* MedicationAdministration Administration of medication to a patient
Constraints: mad-2, mad-3
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR STU3(0.1.0) | CarePlan) R5: Plan this is fulfilled by this administration (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.basedOn
.... extension:statusReason 0..* CodeableConcept R5: Reason administration not performed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.statusReason
.... 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
.... 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
.... extension:isSubPotent 0..1 boolean R5: Full dose was not administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.isSubPotent
.... extension:subPotentReason 0..* CodeableConcept R5: Reason full dose was not administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.subPotentReason
Binding: R5AdministrationSubpotentReasonForR3 (0.1.0) (example)
.... extension:reason 0..* (Complex) 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code R5: in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.status
Binding: MedicationAdministrationStatus (required): A set of codes indicating the current status of a MedicationAdministration.
... medication[x] Σ 1..1 What was administered
Binding: SNOMED CT Medication Codes (example): Codes identifying substance or product that can be administered.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject Σ 1..1 Reference(Patient | Group) Who received medication
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... effective[x] Σ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... notGiven ?!Σ 0..1 boolean True if medication not administered

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationAdministration.​status Base required MedicationAdministrationStatus 📍3.0.2 FHIR Std.
MedicationAdministration.​medication[x] Base example SNOMED CT Medication Codes 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error MedicationAdministration If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
mad-2 error MedicationAdministration Reason not given is only permitted if NotGiven is true reasonNotGiven.empty() or notGiven = true
mad-3 error MedicationAdministration Reason given is only permitted if NotGiven is false reasonCode.empty() or notGiven.empty() or notGiven = 'false'

Differential View

This structure is derived from MedicationAdministration

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration 0..* MedicationAdministration Administration of medication to a patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR STU3(0.1.0) | CarePlan) R5: Plan this is fulfilled by this administration (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.basedOn
.... extension:statusReason 0..* CodeableConcept R5: Reason administration not performed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.statusReason
.... 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
.... 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
.... extension:isSubPotent 0..1 boolean R5: Full dose was not administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.isSubPotent
.... extension:subPotentReason 0..* CodeableConcept R5: Reason full dose was not administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.subPotentReason
Binding: R5AdministrationSubpotentReasonForR3 (0.1.0) (example)
.... extension:reason 0..* (Complex) 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
... partOf
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:partOf 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: partOf
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... status
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code R5: in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.status
Binding: MedicationAdministrationStatus (required): A set of codes indicating the current status of a MedicationAdministration.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... context
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Encounter administered as part of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... supportingInformation
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:supportingInformation 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: supportingInformation additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... performer
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:function 0..1 CodeableConcept R5: Type of performance (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.performer.function
Binding: R5MedAdminPerformFunctionForR3 (0.1.0) (example): A code describing the role an individual played in administering the medication.
.... actor
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:actor 0..1 (Complex) R5: Who or what performed the medication administration additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.performer.actor
... prescription
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:request 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: request additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... device
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:device 0..* CodeableConcept R5: device additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.device
... eventHistory
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:eventHistory 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: eventHistory additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationAdministration C 0..* MedicationAdministration Administration of medication to a patient
Constraints: mad-2, mad-3
... 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: Common Languages . (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... 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 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR STU3(0.1.0) | CarePlan) R5: Plan this is fulfilled by this administration (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.basedOn
.... extension:statusReason 0..* CodeableConcept R5: Reason administration not performed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.statusReason
.... 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
.... 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
.... extension:isSubPotent 0..1 boolean R5: Full dose was not administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.isSubPotent
.... extension:subPotentReason 0..* CodeableConcept R5: Reason full dose was not administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.subPotentReason
Binding: R5AdministrationSubpotentReasonForR3 (0.1.0) (example)
.... extension:reason 0..* (Complex) 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier External identifier
... definition Σ 0..* Reference(PlanDefinition | ActivityDefinition) Instantiates protocol or definition
... partOf Σ 0..* Reference(MedicationAdministration | Procedure) Part of referenced event
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:partOf 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: partOf
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... 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 | on-hold | completed | entered-in-error | stopped | unknown
Binding: MedicationAdministrationStatus (required): A set of codes indicating the current status of a MedicationAdministration.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code R5: in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.status
Binding: MedicationAdministrationStatus (required): A set of codes indicating the current status of a MedicationAdministration.
.... value 0..1 code Primitive value for code
... category 0..1 CodeableConcept Type of medication usage
Binding: MedicationAdministrationCategory (preferred): A coded concept describing where the medication administered is expected to occur
... medication[x] Σ 1..1 What was administered
Binding: SNOMED CT Medication Codes (example): Codes identifying substance or product that can be administered.
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication)
... subject Σ 1..1 Reference(Patient | Group) Who received medication
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... context 0..1 Reference(Encounter | EpisodeOfCare) Encounter or Episode of Care administered as part of
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Encounter administered as part of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... supportingInformation 0..* Reference(Resource) Additional information to support administration
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:supportingInformation 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: supportingInformation additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... effective[x] Σ 1..1 Start and end time of administration
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer Σ 0..* BackboneElement Who administered substance
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:function 0..1 CodeableConcept R5: Type of performance (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.performer.function
Binding: R5MedAdminPerformFunctionForR3 (0.1.0) (example): A code describing the role an individual played in administering the medication.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... actor Σ 1..1 Reference(Practitioner | Patient | RelatedPerson | Device) Individual who was performing
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:actor 1..1 (Complex) R5: Who or what performed the medication administration additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.performer.actor
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... onBehalfOf 0..1 Reference(Organization) Organization organization was acting for
... notGiven ?!Σ 0..1 boolean True if medication not administered
... reasonNotGiven C 0..* CodeableConcept Reason administration not performed
Binding: SNOMED CT Reason Medication Not Given Codes (example): A set of codes indicating the reason why the MedicationAdministration is negated.
... reasonCode C 0..* CodeableConcept Reason administration performed
Binding: Reason Medication Given Codes (example): A set of codes indicating the reason why the MedicationAdministration was made.
... reasonReference 0..* Reference(Condition | Observation) Condition or Observation that supports why the medication was administered
... prescription 0..1 Reference(MedicationRequest) Request administration performed against
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:request 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: request additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... device 0..* Reference(Device) Device used to administer
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:device 0..* CodeableConcept R5: device additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationAdministration.device
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... 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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... text 0..1 string Free text dosage instructions e.g. SIG
.... site 0..1 CodeableConcept Body site administered to
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (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: SNOMED CT Route Codes (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: SNOMED CT Administration Method Codes (example): A coded concept describing the technique by which the medicine is administered.
.... dose 0..1 SimpleQuantity 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
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:eventHistory 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: eventHistory additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationAdministration.​language Base extensible Common Languages . 📍3.0.2 tx.fhir.org
MedicationAdministration.​status Base required MedicationAdministrationStatus 📍3.0.2 FHIR Std.
MedicationAdministration.​category Base preferred MedicationAdministrationCategory 📍3.0.2 FHIR Std.
MedicationAdministration.​medication[x] Base example SNOMED CT Medication Codes 📍3.0.2 FHIR Std.
MedicationAdministration.​reasonNotGiven Base example SNOMED CT Reason Medication Not Given Codes 📍3.0.2 FHIR Std.
MedicationAdministration.​reasonCode Base example Reason Medication Given Codes 📍3.0.2 FHIR Std.
MedicationAdministration.​dosage.site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍3.0.2 FHIR Std.
MedicationAdministration.​dosage.route Base example SNOMED CT Route Codes 📍3.0.2 FHIR Std.
MedicationAdministration.​dosage.method Base example SNOMED CT Administration Method Codes 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error MedicationAdministration If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (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 SHALL have at least one of dosage.dose or dosage.rate[x] dose.exists() or rate.exists()
mad-2 error MedicationAdministration Reason not given is only permitted if NotGiven is true reasonNotGiven.empty() or notGiven = true
mad-3 error MedicationAdministration Reason given is only permitted if NotGiven is false reasonCode.empty() or notGiven.empty() or notGiven = 'false'

 

Other representations of profile: CSV, Excel, Schematron