HL7 Europe Imaging Study Report
0.1.0-ballot - ci-build
150
HL7 Europe Imaging Study Report
0.1.0-ballot - ci-build
150
This page is part of the HL7 Europe Imaging Study Report (v0.1.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/Report-EuMedicationAdministration | Version: 0.1.0-ballot | |||
| Draft as of 2025-05-14 | Computable Name: Report_EuMedicationAdministration | |||
Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License |
||||
Report obligations for EuMedicationAdministration
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints | |||||
|---|---|---|---|---|---|---|---|---|---|
  MedicationAdministration |
0..* | MedicationAdministration | Administration of medication to a patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | ||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | |||||
| contained |
0..* | Resource | Contained, inline Resources | ||||||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
 identifier |
O | 0..* | Identifier | External identifier ele-1: All FHIR elements must have a @value or children
| |||||
 partOf |
OΣ | 0..* | Reference(MedicationAdministration | Procedure | MedicationDispense) | Part of referenced event ele-1: All FHIR elements must have a @value or children
| |||||
| status |
?!OΣ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministrationStatusCodes (required): A set of codes indicating the current status of a MedicationAdministration. ele-1: All FHIR elements must have a @value or children
| |||||
| statusReason |
O | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated. ele-1: All FHIR elements must have a @value or children
| |||||
| medication |
OΣ | 1..1 | CodeableReference(Medication) | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. ele-1: All FHIR elements must have a @value or children
| |||||
| subject |
OΣ | 1..1 | Reference(Patient | Group) | Who received medication ele-1: All FHIR elements must have a @value or children
| |||||
  Slices for occurence[x] |
Σ | 1..1 | Specific date/time or interval of time during which the administration took place (or did not take place) Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children | ||||||
  occurenceDateTime |
dateTime | ||||||||
| occurencePeriod |
Period | ||||||||
| occurenceTiming |
Timing | ||||||||
 occurence[x]:occurenceDateTime |
OΣ | 0..1 | dateTime | Specific date/time or interval of time during which the administration took place (or did not take place) ele-1: All FHIR elements must have a @value or children
| |||||
 occurence[x]:occurencePeriod |
OΣ | 0..1 | Period | Specific date/time or interval of time during which the administration took place (or did not take place) ele-1: All FHIR elements must have a @value or children
| |||||
| reason |
O | 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Concept, condition or observation that supports why the medication was administered Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made. ele-1: All FHIR elements must have a @value or children
| |||||
| note |
O | 0..* | Annotation | Information about the administration ele-1: All FHIR elements must have a @value or children
| |||||
 dosage |
OC | 0..1 | BackboneElement | Details of how medication was taken ele-1: All FHIR elements must have a @value or children mad-1: If dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x]
| |||||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
| text |
OC | 0..1 | string | Free text dosage instructions e.g. SIG ele-1: All FHIR elements must have a @value or children
| |||||
| site |
O | 0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureAdministrationSites (example): A coded concept describing the site location the medicine enters into or onto the body. ele-1: All FHIR elements must have a @value or children
| |||||
| route |
O | 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. ele-1: All FHIR elements must have a @value or children
| |||||
| method |
O | 0..1 | CodeableConcept | How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. ele-1: All FHIR elements must have a @value or children
| |||||
| dose |
OC | 0..1 | SimpleQuantity | Amount of medication per dose ele-1: All FHIR elements must have a @value or children
| |||||
| Slices for rate[x] |
C | 0..1 | Dose quantity per unit of time Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | ||||||
| rateRatio |
Ratio | ||||||||
| rateQuantity |
Quantity(SimpleQuantity) | ||||||||
| rate[x]:rateRatio |
OC | 0..1 | Ratio | Dose quantity per unit of time ele-1: All FHIR elements must have a @value or children
| |||||
| rate[x]:rateQuantity |
OC | 0..1 | SimpleQuantity | Dose quantity per unit of time ele-1: All FHIR elements must have a @value or children
| |||||
| Documentation for this format | |||||||||
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.status | required | MedicationAdministrationStatusCodeshttp://hl7.org/fhir/ValueSet/medication-admin-status|5.0.0from the FHIR Standard | |
| MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-not-given-codesfrom the FHIR Standard | |
| MedicationAdministration.medication | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| MedicationAdministration.reason | example | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codesfrom the FHIR Standard | |
| MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureAdministrationSiteshttp://hl7.org/fhir/ValueSet/approach-site-codesfrom the FHIR Standard | |
| MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesfrom the FHIR Standard | |
| MedicationAdministration.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mad-1 | error | MedicationAdministration.dosage | If dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x] : (dose.exists() or rate.exists() or text.exists()) |
This structure is derived from MedicationAdministration
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationAdministration |
0..* | MedicationAdministration | Administration of medication to a patient | |||||
 identifier |
O | 0..* | Identifier | External identifier
| ||||
| partOf |
O | 0..* | Reference(MedicationAdministration | Procedure | MedicationDispense) | Part of referenced event
| ||||
| status |
O | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
| ||||
| statusReason |
O | 0..* | CodeableConcept | Reason administration not performed
| ||||
| medication |
O | 1..1 | CodeableReference(Medication) | What was administered
| ||||
| subject |
O | 1..1 | Reference(Patient | Group) | Who received medication
| ||||
| Slices for occurence[x] |
1..1 | dateTime, Period, Timing | Specific date/time or interval of time during which the administration took place (or did not take place) Slice: Unordered, Open by type:$this | |||||
| occurence[x]:occurenceDateTime |
O | 0..1 | dateTime | Specific date/time or interval of time during which the administration took place (or did not take place)
| ||||
| occurence[x]:occurencePeriod |
O | 0..1 | Period | Specific date/time or interval of time during which the administration took place (or did not take place)
| ||||
| reason |
O | 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Concept, condition or observation that supports why the medication was administered
| ||||
| note |
O | 0..* | Annotation | Information about the administration
| ||||
| dosage |
O | 0..1 | BackboneElement | Details of how medication was taken
| ||||
| text |
O | 0..1 | string | Free text dosage instructions e.g. SIG
| ||||
| site |
O | 0..1 | CodeableConcept | Body site administered to
| ||||
| route |
O | 0..1 | CodeableConcept | Path of substance into body
| ||||
| method |
O | 0..1 | CodeableConcept | How drug was administered
| ||||
| dose |
O | 0..1 | SimpleQuantity | Amount of medication per dose
| ||||
| Slices for rate[x] |
0..1 | Ratio, SimpleQuantity | Dose quantity per unit of time Slice: Unordered, Open by type:$this | |||||
| rate[x]:rateRatio |
O | 0..1 | Ratio | Dose quantity per unit of time
| ||||
| rate[x]:rateQuantity |
O | 0..1 | SimpleQuantity | Dose quantity per unit of time
| ||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints | |||||
|---|---|---|---|---|---|---|---|---|---|
| MedicationAdministration |
0..* | MedicationAdministration | Administration of medication to a patient | ||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | |||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| ||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | ||||||
| contained |
0..* | Resource | Contained, inline Resources | ||||||
 extension |
0..* | Extension | Additional content defined by implementations | ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
O | 0..* | Identifier | External identifier
| |||||
| basedOn |
0..* | Reference(CarePlan) | Plan this is fulfilled by this administration | ||||||
| partOf |
OΣ | 0..* | Reference(MedicationAdministration | Procedure | MedicationDispense) | Part of referenced event
| |||||
| status |
?!OΣ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministrationStatusCodes (required): A set of codes indicating the current status of a MedicationAdministration.
| |||||
| statusReason |
O | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.
| |||||
| category |
0..* | CodeableConcept | Type of medication administration Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur. | ||||||
| medication |
OΣ | 1..1 | CodeableReference(Medication) | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
| |||||
| subject |
OΣ | 1..1 | Reference(Patient | Group) | Who received medication
| |||||
| encounter |
0..1 | Reference(Encounter) | Encounter administered as part of | ||||||
| supportingInformation |
0..* | Reference(Resource) | Additional information to support administration | ||||||
| Slices for occurence[x] |
Σ | 1..1 | Specific date/time or interval of time during which the administration took place (or did not take place) Slice: Unordered, Open by type:$this | ||||||
| occurenceDateTime |
dateTime | ||||||||
| occurencePeriod |
Period | ||||||||
| occurenceTiming |
Timing | ||||||||
| occurence[x]:occurenceDateTime |
OΣ | 0..1 | dateTime | Specific date/time or interval of time during which the administration took place (or did not take place)
| |||||
| occurence[x]:occurencePeriod |
OΣ | 0..1 | Period | Specific date/time or interval of time during which the administration took place (or did not take place)
| |||||
| recorded |
Σ | 0..1 | dateTime | When the MedicationAdministration was first captured in the subject's record | |||||
| isSubPotent |
0..1 | boolean | Full dose was not administered | ||||||
| subPotentReason |
0..* | CodeableConcept | Reason full dose was not administered Binding: MedicationAdministrationSubpotentReason (example) | ||||||
| performer |
Σ | 0..* | BackboneElement | Who or what performed the medication administration and what type of performance they did | |||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| function |
0..1 | CodeableConcept | Type of performance Binding: MedicationAdministrationPerformerFunctionCodes (example): A code describing the role an individual played in administering the medication. | ||||||
 actor |
Σ | 1..1 | CodeableReference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who or what performed the medication administration | |||||
| reason |
O | 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Concept, condition or observation that supports why the medication was administered Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.
| |||||
| request |
0..1 | Reference(MedicationRequest) | Request administration performed against | ||||||
| device |
0..* | CodeableReference(Device) | Device used to administer | ||||||
| note |
O | 0..* | Annotation | Information about the administration
| |||||
| dosage |
OC | 0..1 | BackboneElement | Details of how medication was taken mad-1: If dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x]
| |||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| text |
OC | 0..1 | string | Free text dosage instructions e.g. SIG
| |||||
| site |
O | 0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureAdministrationSites (example): A coded concept describing the site location the medicine enters into or onto the body.
| |||||
| route |
O | 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 |
O | 0..1 | CodeableConcept | How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
| |||||
| dose |
OC | 0..1 | SimpleQuantity | Amount of medication per dose
| |||||
| Slices for rate[x] |
C | 0..1 | Dose quantity per unit of time Slice: Unordered, Closed by type:$this | ||||||
| rateRatio |
Ratio | ||||||||
| rateQuantity |
Quantity(SimpleQuantity) | ||||||||
| rate[x]:rateRatio |
OC | 0..1 | Ratio | Dose quantity per unit of time
| |||||
| rate[x]:rateQuantity |
OC | 0..1 | SimpleQuantity | Dose quantity per unit of time
| |||||
| eventHistory |
0..* | Reference(Provenance) | A list of events of interest in the lifecycle | ||||||
| Documentation for this format | |||||||||
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| MedicationAdministration.status | required | MedicationAdministrationStatusCodeshttp://hl7.org/fhir/ValueSet/medication-admin-status|5.0.0from the FHIR Standard | |
| MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-not-given-codesfrom the FHIR Standard | |
| MedicationAdministration.category | example | MedicationAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medication-admin-locationfrom the FHIR Standard | |
| MedicationAdministration.medication | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| MedicationAdministration.subPotentReason | example | MedicationAdministrationSubpotentReasonhttp://hl7.org/fhir/ValueSet/administration-subpotent-reasonfrom the FHIR Standard | |
| MedicationAdministration.performer.function | example | MedicationAdministrationPerformerFunctionCodeshttp://hl7.org/fhir/ValueSet/med-admin-perform-functionfrom the FHIR Standard | |
| MedicationAdministration.reason | example | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codesfrom the FHIR Standard | |
| MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureAdministrationSiteshttp://hl7.org/fhir/ValueSet/approach-site-codesfrom the FHIR Standard | |
| MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesfrom the FHIR Standard | |
| MedicationAdministration.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mad-1 | error | MedicationAdministration.dosage | If dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x] : (dose.exists() or rate.exists() or text.exists()) |
This structure is derived from MedicationAdministration
Summary
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | |||||
|---|---|---|---|---|---|---|---|---|---|
| MedicationAdministration |
0..* | MedicationAdministration | Administration of medication to a patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | ||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | |||||
| contained |
0..* | Resource | Contained, inline Resources | ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
| identifier |
O | 0..* | Identifier | External identifier ele-1: All FHIR elements must have a @value or children
| |||||
| partOf |
OΣ | 0..* | Reference(MedicationAdministration | Procedure | MedicationDispense) | Part of referenced event ele-1: All FHIR elements must have a @value or children
| |||||
| status |
?!OΣ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministrationStatusCodes (required): A set of codes indicating the current status of a MedicationAdministration. ele-1: All FHIR elements must have a @value or children
| |||||
| statusReason |
O | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated. ele-1: All FHIR elements must have a @value or children
| |||||
| medication |
OΣ | 1..1 | CodeableReference(Medication) | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. ele-1: All FHIR elements must have a @value or children
| |||||
| subject |
OΣ | 1..1 | Reference(Patient | Group) | Who received medication ele-1: All FHIR elements must have a @value or children
| |||||
| Slices for occurence[x] |
Σ | 1..1 | Specific date/time or interval of time during which the administration took place (or did not take place) Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children | ||||||
| occurenceDateTime |
dateTime | ||||||||
| occurencePeriod |
Period | ||||||||
| occurenceTiming |
Timing | ||||||||
| occurence[x]:occurenceDateTime |
OΣ | 0..1 | dateTime | Specific date/time or interval of time during which the administration took place (or did not take place) ele-1: All FHIR elements must have a @value or children
| |||||
| occurence[x]:occurencePeriod |
OΣ | 0..1 | Period | Specific date/time or interval of time during which the administration took place (or did not take place) ele-1: All FHIR elements must have a @value or children
| |||||
| reason |
O | 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Concept, condition or observation that supports why the medication was administered Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made. ele-1: All FHIR elements must have a @value or children
| |||||
| note |
O | 0..* | Annotation | Information about the administration ele-1: All FHIR elements must have a @value or children
| |||||
| dosage |
OC | 0..1 | BackboneElement | Details of how medication was taken ele-1: All FHIR elements must have a @value or children mad-1: If dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x]
| |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
| text |
OC | 0..1 | string | Free text dosage instructions e.g. SIG ele-1: All FHIR elements must have a @value or children
| |||||
| site |
O | 0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureAdministrationSites (example): A coded concept describing the site location the medicine enters into or onto the body. ele-1: All FHIR elements must have a @value or children
| |||||
| route |
O | 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. ele-1: All FHIR elements must have a @value or children
| |||||
| method |
O | 0..1 | CodeableConcept | How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. ele-1: All FHIR elements must have a @value or children
| |||||
| dose |
OC | 0..1 | SimpleQuantity | Amount of medication per dose ele-1: All FHIR elements must have a @value or children
| |||||
| Slices for rate[x] |
C | 0..1 | Dose quantity per unit of time Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | ||||||
| rateRatio |
Ratio | ||||||||
| rateQuantity |
Quantity(SimpleQuantity) | ||||||||
| rate[x]:rateRatio |
OC | 0..1 | Ratio | Dose quantity per unit of time ele-1: All FHIR elements must have a @value or children
| |||||
| rate[x]:rateQuantity |
OC | 0..1 | SimpleQuantity | Dose quantity per unit of time ele-1: All FHIR elements must have a @value or children
| |||||
| Documentation for this format | |||||||||
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.status | required | MedicationAdministrationStatusCodeshttp://hl7.org/fhir/ValueSet/medication-admin-status|5.0.0from the FHIR Standard | |
| MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-not-given-codesfrom the FHIR Standard | |
| MedicationAdministration.medication | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| MedicationAdministration.reason | example | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codesfrom the FHIR Standard | |
| MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureAdministrationSiteshttp://hl7.org/fhir/ValueSet/approach-site-codesfrom the FHIR Standard | |
| MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesfrom the FHIR Standard | |
| MedicationAdministration.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mad-1 | error | MedicationAdministration.dosage | If dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x] : (dose.exists() or rate.exists() or text.exists()) |
Differential View
This structure is derived from MedicationAdministration
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationAdministration |
0..* | MedicationAdministration | Administration of medication to a patient | |||||
| identifier |
O | 0..* | Identifier | External identifier
| ||||
| partOf |
O | 0..* | Reference(MedicationAdministration | Procedure | MedicationDispense) | Part of referenced event
| ||||
| status |
O | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
| ||||
| statusReason |
O | 0..* | CodeableConcept | Reason administration not performed
| ||||
| medication |
O | 1..1 | CodeableReference(Medication) | What was administered
| ||||
| subject |
O | 1..1 | Reference(Patient | Group) | Who received medication
| ||||
| Slices for occurence[x] |
1..1 | dateTime, Period, Timing | Specific date/time or interval of time during which the administration took place (or did not take place) Slice: Unordered, Open by type:$this | |||||
| occurence[x]:occurenceDateTime |
O | 0..1 | dateTime | Specific date/time or interval of time during which the administration took place (or did not take place)
| ||||
| occurence[x]:occurencePeriod |
O | 0..1 | Period | Specific date/time or interval of time during which the administration took place (or did not take place)
| ||||
| reason |
O | 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Concept, condition or observation that supports why the medication was administered
| ||||
| note |
O | 0..* | Annotation | Information about the administration
| ||||
| dosage |
O | 0..1 | BackboneElement | Details of how medication was taken
| ||||
| text |
O | 0..1 | string | Free text dosage instructions e.g. SIG
| ||||
| site |
O | 0..1 | CodeableConcept | Body site administered to
| ||||
| route |
O | 0..1 | CodeableConcept | Path of substance into body
| ||||
| method |
O | 0..1 | CodeableConcept | How drug was administered
| ||||
| dose |
O | 0..1 | SimpleQuantity | Amount of medication per dose
| ||||
| Slices for rate[x] |
0..1 | Ratio, SimpleQuantity | Dose quantity per unit of time Slice: Unordered, Open by type:$this | |||||
| rate[x]:rateRatio |
O | 0..1 | Ratio | Dose quantity per unit of time
| ||||
| rate[x]:rateQuantity |
O | 0..1 | SimpleQuantity | Dose quantity per unit of time
| ||||
| Documentation for this format | ||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | |||||
|---|---|---|---|---|---|---|---|---|---|
| MedicationAdministration |
0..* | MedicationAdministration | Administration of medication to a patient | ||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | |||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| ||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | ||||||
| contained |
0..* | Resource | Contained, inline Resources | ||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
O | 0..* | Identifier | External identifier
| |||||
| basedOn |
0..* | Reference(CarePlan) | Plan this is fulfilled by this administration | ||||||
| partOf |
OΣ | 0..* | Reference(MedicationAdministration | Procedure | MedicationDispense) | Part of referenced event
| |||||
| status |
?!OΣ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministrationStatusCodes (required): A set of codes indicating the current status of a MedicationAdministration.
| |||||
| statusReason |
O | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.
| |||||
| category |
0..* | CodeableConcept | Type of medication administration Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur. | ||||||
| medication |
OΣ | 1..1 | CodeableReference(Medication) | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.
| |||||
| subject |
OΣ | 1..1 | Reference(Patient | Group) | Who received medication
| |||||
| encounter |
0..1 | Reference(Encounter) | Encounter administered as part of | ||||||
| supportingInformation |
0..* | Reference(Resource) | Additional information to support administration | ||||||
| Slices for occurence[x] |
Σ | 1..1 | Specific date/time or interval of time during which the administration took place (or did not take place) Slice: Unordered, Open by type:$this | ||||||
| occurenceDateTime |
dateTime | ||||||||
| occurencePeriod |
Period | ||||||||
| occurenceTiming |
Timing | ||||||||
| occurence[x]:occurenceDateTime |
OΣ | 0..1 | dateTime | Specific date/time or interval of time during which the administration took place (or did not take place)
| |||||
| occurence[x]:occurencePeriod |
OΣ | 0..1 | Period | Specific date/time or interval of time during which the administration took place (or did not take place)
| |||||
| recorded |
Σ | 0..1 | dateTime | When the MedicationAdministration was first captured in the subject's record | |||||
| isSubPotent |
0..1 | boolean | Full dose was not administered | ||||||
| subPotentReason |
0..* | CodeableConcept | Reason full dose was not administered Binding: MedicationAdministrationSubpotentReason (example) | ||||||
| performer |
Σ | 0..* | BackboneElement | Who or what performed the medication administration and what type of performance they did | |||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| function |
0..1 | CodeableConcept | Type of performance Binding: MedicationAdministrationPerformerFunctionCodes (example): A code describing the role an individual played in administering the medication. | ||||||
| actor |
Σ | 1..1 | CodeableReference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who or what performed the medication administration | |||||
| reason |
O | 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Concept, condition or observation that supports why the medication was administered Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.
| |||||
| request |
0..1 | Reference(MedicationRequest) | Request administration performed against | ||||||
| device |
0..* | CodeableReference(Device) | Device used to administer | ||||||
| note |
O | 0..* | Annotation | Information about the administration
| |||||
| dosage |
OC | 0..1 | BackboneElement | Details of how medication was taken mad-1: If dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x]
| |||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| text |
OC | 0..1 | string | Free text dosage instructions e.g. SIG
| |||||
| site |
O | 0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureAdministrationSites (example): A coded concept describing the site location the medicine enters into or onto the body.
| |||||
| route |
O | 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 |
O | 0..1 | CodeableConcept | How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
| |||||
| dose |
OC | 0..1 | SimpleQuantity | Amount of medication per dose
| |||||
| Slices for rate[x] |
C | 0..1 | Dose quantity per unit of time Slice: Unordered, Closed by type:$this | ||||||
| rateRatio |
Ratio | ||||||||
| rateQuantity |
Quantity(SimpleQuantity) | ||||||||
| rate[x]:rateRatio |
OC | 0..1 | Ratio | Dose quantity per unit of time
| |||||
| rate[x]:rateQuantity |
OC | 0..1 | SimpleQuantity | Dose quantity per unit of time
| |||||
| eventHistory |
0..* | Reference(Provenance) | A list of events of interest in the lifecycle | ||||||
| Documentation for this format | |||||||||
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| MedicationAdministration.status | required | MedicationAdministrationStatusCodeshttp://hl7.org/fhir/ValueSet/medication-admin-status|5.0.0from the FHIR Standard | |
| MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-not-given-codesfrom the FHIR Standard | |
| MedicationAdministration.category | example | MedicationAdministrationLocationCodeshttp://hl7.org/fhir/ValueSet/medication-admin-locationfrom the FHIR Standard | |
| MedicationAdministration.medication | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| MedicationAdministration.subPotentReason | example | MedicationAdministrationSubpotentReasonhttp://hl7.org/fhir/ValueSet/administration-subpotent-reasonfrom the FHIR Standard | |
| MedicationAdministration.performer.function | example | MedicationAdministrationPerformerFunctionCodeshttp://hl7.org/fhir/ValueSet/med-admin-perform-functionfrom the FHIR Standard | |
| MedicationAdministration.reason | example | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codesfrom the FHIR Standard | |
| MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureAdministrationSiteshttp://hl7.org/fhir/ValueSet/approach-site-codesfrom the FHIR Standard | |
| MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesfrom the FHIR Standard | |
| MedicationAdministration.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mad-1 | error | MedicationAdministration.dosage | If dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x] : (dose.exists() or rate.exists() or text.exists()) |
This structure is derived from MedicationAdministration
Summary
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 Europe. Package hl7.fhir.eu.imaging-r5#0.1.0-ballot based on FHIR 5.0.0. Generated 2025-05-14
