German Oncological Data Standard (GOLD)
0.1.0 - CI Build
German Oncological Data Standard (GOLD) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://www.vision-zero-oncology.de/fhir/StructureDefinition/medication-administration | Version: 0.1.0 | |||
Draft as of 2023-12-13 | Computable Name: PR_MedicationAdministration | |||
Copyright/Legal: CC-BY-SA-4.0 |
Profile to describe the event of a patient consuming or otherwise being administered a medication.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationAdministration
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | MedicationAdministration | Administration of medication to a patient | |
id | S | 0..1 | id | Logical id of this artifact |
meta | S | 0..1 | Meta | Metadata about the resource |
source | S | 0..1 | uri | Identifies where the resource comes from |
profile | S | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
identifier | S | 0..* | Identifier | External identifier |
partOf | S | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event |
status | S | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown |
category | S | 0..1 | CodeableConcept | Type of medication usage |
Slices for medication[x] | S | 1..1 | CodeableConcept, Reference(Medication) | What was administered Slice: Unordered, Open by type:$this |
medication[x]:medicationReference | S | 0..1 | Reference(Medication) | What was administered |
medication[x]:medicationCodeableConcept | S | 0..1 | CodeableConcept | What was administered |
Slices for coding | S | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
coding:Pharmazentralnummer | S | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/ifa/pzn | |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
coding:atcClassDe | S | 0..* | Coding | ATC Klassifikation deutsche Version Binding: ATC (required) Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/bfarm/atc | |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
coding:atcClassEn | S | 0..* | Coding | Anatomical Therapeutic Chemical Classification System Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.whocc.no/atc | |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
text | S | 0..1 | string | Plain text representation of the concept |
subject | S | 1..1 | Reference(Patient | Group) | Who received medication |
context | S | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of |
supportingInformation | 0..* | Reference(Profile Tumor) | Additional information to support administration | |
Slices for effective[x] | S | 1..1 | dateTime, Period | Start and end time of administration Slice: Unordered, Open by type:$this |
effective[x]:effectiveDateTime | S | 0..1 | dateTime | Start and end time of administration |
effective[x]:effectivePeriod | S | 0..1 | Period | Start and end time of administration |
performer | S | 0..* | BackboneElement | Who performed the medication administration and what they did |
reasonCode | S | 0..* | CodeableConcept | Reason administration performed |
reasonReference | S | 0..* | Reference(Profile Tumor Disorder) | Condition or observation that supports why the medication was administered |
request | S | 0..1 | Reference(MedicationRequest) | Request administration performed against |
note | S | 0..* | Annotation | Information about the administration |
dosage | S | 0..1 | BackboneElement | Details of how medication was taken |
text | S | 0..1 | string | Free text dosage instructions e.g. SIG |
site | S | 0..1 | CodeableConcept | Body site administered to |
Slices for coding | S | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
coding:SNOMED | S | 0..* | Coding | Code defined by a terminology system Binding: Target Site - IPS (example): target site IPS Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
route | S | 0..1 | CodeableConcept | Path of substance into body |
Slices for coding | S | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this Binding: Medicine Route of Administration - IPS (preferred): EDQM Standards Terms |
coding:EDQM | S | 0..1 | Coding | Code defined by a terminology system Binding: Medicine Route of Administration - IPS (preferred): EDQM Standard Terms Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://standardterms.edqm.eu | |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
coding:SNOMED | S | 0..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
dose | S | 0..1 | SimpleQuantity | Amount of medication per dose Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
Slices for rate[x] | S | 0..1 | Ratio, SimpleQuantity | Dose quantity per unit of time Slice: Unordered, Open by type:$this |
rate[x]:rateRatio | S | 0..1 | Ratio | Dose quantity per unit of time |
numerator | S | 0..1 | Quantity | Numerator value Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
denominator | S | 0..1 | Quantity | Denominator value Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
rate[x]:rateQuantity | S | 0..1 | SimpleQuantity | A fixed quantity (no comparator) Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
Documentation for this format |
Path | Conformance | ValueSet / Code |
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:atcClassDe | required | Pattern: null |
MedicationAdministration.dosage.site.coding:SNOMED | example | Pattern: SNOMED CT code null |
MedicationAdministration.dosage.route.coding | preferred | RouteOfAdminUvIps |
MedicationAdministration.dosage.route.coding:EDQM | preferred | Pattern: null |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | MedicationAdministration | Administration of medication to a patient | |
id | SΣ | 0..1 | id | Logical id of this artifact |
meta | SΣ | 0..1 | Meta | Metadata about the resource |
source | SΣ | 0..1 | uri | Identifies where the resource comes from |
profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 0..* | Identifier | External identifier |
partOf | SΣ | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event |
status | ?!SΣ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. |
category | S | 0..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur. |
Slices for medication[x] | SΣ | 1..1 | What was administered Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. | |
medicationCodeableConcept | CodeableConcept | |||
medicationReference | Reference(Medication) | |||
medication[x]:medicationReference | SΣ | 0..1 | Reference(Medication) | What was administered |
medication[x]:medicationCodeableConcept | SΣ | 0..1 | CodeableConcept | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. |
Slices for coding | SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
coding:Pharmazentralnummer | SΣ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/ifa/pzn | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
coding:atcClassDe | SΣ | 0..* | Coding | ATC Klassifikation deutsche Version Binding: ATC (required) Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/bfarm/atc | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
coding:atcClassEn | SΣ | 0..* | Coding | Anatomical Therapeutic Chemical Classification System Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.whocc.no/atc | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
text | SΣ | 0..1 | string | Plain text representation of the concept |
subject | SΣ | 1..1 | Reference(Patient | Group) | Who received medication |
context | S | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of |
supportingInformation | 0..* | Reference(Profile Tumor) | Additional information to support administration | |
Slices for effective[x] | SΣ | 1..1 | Start and end time of administration Slice: Unordered, Closed by type:$this | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effective[x]:effectiveDateTime | SΣ | 0..1 | dateTime | Start and end time of administration |
effective[x]:effectivePeriod | SΣ | 0..1 | Period | Start and end time of administration |
performer | SΣ | 0..* | BackboneElement | Who performed the medication administration and what they did |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who performed the medication administration |
reasonCode | S | 0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made. |
reasonReference | S | 0..* | Reference(Profile Tumor Disorder) | Condition or observation that supports why the medication was administered |
request | S | 0..1 | Reference(MedicationRequest) | Request administration performed against |
note | S | 0..* | Annotation | Information about the administration |
dosage | SC | 0..1 | BackboneElement | Details of how medication was taken |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
text | S | 0..1 | string | Free text dosage instructions e.g. SIG |
site | S | 0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. |
Slices for coding | SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
coding:SNOMED | SΣ | 0..* | Coding | Code defined by a terminology system Binding: Target Site - IPS (example): target site IPS Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
route | S | 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. |
Slices for coding | SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this Binding: Medicine Route of Administration - IPS (preferred): EDQM Standards Terms |
coding:EDQM | SΣ | 0..1 | Coding | Code defined by a terminology system Binding: Medicine Route of Administration - IPS (preferred): EDQM Standard Terms Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://standardterms.edqm.eu | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
coding:SNOMED | SΣ | 0..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
dose | S | 0..1 | SimpleQuantity | Amount of medication per dose Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
Slices for rate[x] | S | 0..1 | Dose quantity per unit of time Slice: Unordered, Closed by type:$this | |
rateRatio | Ratio | |||
rateQuantity | Quantity(SimpleQuantity) | |||
rate[x]:rateRatio | S | 0..1 | Ratio | Dose quantity per unit of time |
numerator | SΣ | 0..1 | Quantity | Numerator value Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
denominator | SΣ | 0..1 | Quantity | Denominator value Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
rate[x]:rateQuantity | SC | 0..1 | SimpleQuantity | A fixed quantity (no comparator) Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
Documentation for this format |
Path | Conformance | ValueSet / Code |
MedicationAdministration.status | required | MedicationAdministration Status Codes |
MedicationAdministration.category | preferred | MedicationAdministration Category Codes |
MedicationAdministration.medication[x] | example | SNOMEDCTMedicationCodes |
MedicationAdministration.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodes |
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:atcClassDe | required | Pattern: null |
MedicationAdministration.reasonCode | example | ReasonMedicationGivenCodes |
MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodes |
MedicationAdministration.dosage.site.coding:SNOMED | example | Pattern: SNOMED CT code null |
MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodes |
MedicationAdministration.dosage.route.coding | preferred | RouteOfAdminUvIps |
MedicationAdministration.dosage.route.coding:EDQM | preferred | Pattern: null |
MedicationAdministration.dosage.rate[x]:rateRatio.numerator.comparator | required | QuantityComparator |
MedicationAdministration.dosage.rate[x]:rateRatio.denominator.comparator | required | QuantityComparator |
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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 | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() | |
qty-3 | error | MedicationAdministration.dosage.rate[x]:rateQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | MedicationAdministration.dosage.rate[x]:rateQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationAdministration | 0..* | MedicationAdministration | Administration of medication to a patient | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | SΣ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | SΣ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | S | 0..* | Identifier | External identifier | ||||
instantiates | Σ | 0..* | uri | Instantiates protocol or definition | ||||
partOf | SΣ | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. | ||||
statusReason | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated. | |||||
category | S | 0..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur. | ||||
Slices for medication[x] | SΣ | 1..1 | What was administered Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(Medication) | |||||||
medication[x]:medicationReference | SΣ | 0..1 | Reference(Medication) | What was administered | ||||
medication[x]:medicationCodeableConcept | SΣ | 0..1 | CodeableConcept | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||
coding:Pharmazentralnummer | SΣ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/ifa/pzn | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 0..1 | code | Symbol in syntax defined by the system | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:atcClassDe | SΣ | 0..* | Coding | ATC Klassifikation deutsche Version Binding: ATC (required) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/bfarm/atc | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 0..1 | code | Symbol in syntax defined by the system | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:atcClassEn | SΣ | 0..* | Coding | Anatomical Therapeutic Chemical Classification System Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.whocc.no/atc | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 0..1 | code | Symbol in syntax defined by the system | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
subject | SΣ | 1..1 | Reference(Patient | Group) | Who received medication | ||||
context | S | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of | ||||
supportingInformation | 0..* | Reference(Profile Tumor) | Additional information to support administration | |||||
Slices for effective[x] | SΣ | 1..1 | Start and end time of administration Slice: Unordered, Closed by type:$this | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
effective[x]:effectiveDateTime | SΣ | 0..1 | dateTime | Start and end time of administration | ||||
effective[x]:effectivePeriod | SΣ | 0..1 | Period | Start and end time of administration | ||||
performer | SΣ | 0..* | BackboneElement | Who performed the medication administration and what they did | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | 0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication. | |||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who performed the medication administration | ||||
reasonCode | S | 0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made. | ||||
reasonReference | S | 0..* | Reference(Profile Tumor Disorder) | Condition or observation that supports why the medication was administered | ||||
request | S | 0..1 | Reference(MedicationRequest) | Request administration performed against | ||||
device | 0..* | Reference(Device) | Device used to administer | |||||
note | S | 0..* | Annotation | Information about the administration | ||||
dosage | SC | 0..1 | BackboneElement | Details of how medication was taken | ||||
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 | S | 0..1 | string | Free text dosage instructions e.g. SIG | ||||
site | S | 0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||
coding:SNOMED | SΣ | 0..* | Coding | Code defined by a terminology system Binding: Target Site - IPS (example): target site IPS Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 0..1 | code | Symbol in syntax defined by the system | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
route | S | 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. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this Binding: Medicine Route of Administration - IPS (preferred): EDQM Standards Terms | ||||
coding:EDQM | SΣ | 0..1 | Coding | Code defined by a terminology system Binding: Medicine Route of Administration - IPS (preferred): EDQM Standard Terms Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://standardterms.edqm.eu | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 0..1 | code | Symbol in syntax defined by the system | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:SNOMED | SΣ | 0..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 0..1 | code | Symbol in syntax defined by the system | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
method | 0..1 | CodeableConcept | How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | |||||
dose | S | 0..1 | SimpleQuantity | Amount of medication per dose Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |||||
comparator | 0..1 | code | < | <= | >= | > - how to understand the value | |||||
unit | 0..1 | string | Unit representation | |||||
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |||||
code | 0..1 | code | Coded form of the unit | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
unit | SΣ | 0..1 | string | Unit representation | ||||
system | SΣC | 1..1 | uri | System that defines coded unit form | ||||
code | SΣ | 1..1 | code | Coded form of the unit | ||||
Slices for rate[x] | S | 0..1 | Dose quantity per unit of time Slice: Unordered, Closed by type:$this | |||||
rateRatio | Ratio | |||||||
rateQuantity | Quantity(SimpleQuantity) | |||||||
rate[x]:rateRatio | S | 0..1 | Ratio | Dose quantity per unit of time | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
numerator | SΣ | 0..1 | Quantity | Numerator value Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |||||
comparator | 0..1 | code | < | <= | >= | > - how to understand the value | |||||
unit | 0..1 | string | Unit representation | |||||
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |||||
code | 0..1 | code | Coded form of the unit | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | SΣ | 0..1 | string | Unit representation | ||||
system | SΣC | 1..1 | uri | System that defines coded unit form | ||||
code | SΣ | 1..1 | code | Coded form of the unit | ||||
denominator | SΣ | 0..1 | Quantity | Denominator value Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |||||
comparator | 0..1 | code | < | <= | >= | > - how to understand the value | |||||
unit | 0..1 | string | Unit representation | |||||
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |||||
code | 0..1 | code | Coded form of the unit | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | SΣ | 0..1 | string | Unit representation | ||||
system | SΣC | 1..1 | uri | System that defines coded unit form | ||||
code | SΣ | 1..1 | code | Coded form of the unit | ||||
rate[x]:rateQuantity | SC | 0..1 | SimpleQuantity | A fixed quantity (no comparator) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |||||
comparator | 0..1 | code | < | <= | >= | > - how to understand the value | |||||
unit | 0..1 | string | Unit representation | |||||
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |||||
code | 0..1 | code | Coded form of the unit | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
unit | SΣ | 0..1 | string | Unit representation | ||||
system | SΣC | 1..1 | uri | System that defines coded unit form | ||||
code | SΣ | 1..1 | code | Coded form of the unit | ||||
eventHistory | 0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
MedicationAdministration.meta.security | extensible | All Security Labels | ||||
MedicationAdministration.meta.tag | example | CommonTags | ||||
MedicationAdministration.language | preferred | CommonLanguages
| ||||
MedicationAdministration.status | required | MedicationAdministration Status Codes | ||||
MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodes | ||||
MedicationAdministration.category | preferred | MedicationAdministration Category Codes | ||||
MedicationAdministration.medication[x] | example | SNOMEDCTMedicationCodes | ||||
MedicationAdministration.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodes | ||||
MedicationAdministration.medication[x]:medicationCodeableConcept.coding:atcClassDe | required | Pattern: null | ||||
MedicationAdministration.performer.function | example | MedicationAdministration Performer Function Codes | ||||
MedicationAdministration.reasonCode | example | ReasonMedicationGivenCodes | ||||
MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodes | ||||
MedicationAdministration.dosage.site.coding:SNOMED | example | Pattern: SNOMED CT code null | ||||
MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodes | ||||
MedicationAdministration.dosage.route.coding | preferred | RouteOfAdminUvIps | ||||
MedicationAdministration.dosage.route.coding:EDQM | preferred | Pattern: null | ||||
MedicationAdministration.dosage.method | example | SNOMEDCTAdministrationMethodCodes | ||||
MedicationAdministration.dosage.rate[x]:rateRatio.numerator.comparator | required | QuantityComparator | ||||
MedicationAdministration.dosage.rate[x]:rateRatio.denominator.comparator | required | QuantityComparator |
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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 | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() | |
qty-3 | error | MedicationAdministration.dosage.rate[x]:rateQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | MedicationAdministration.dosage.rate[x]:rateQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() |
This structure is derived from MedicationAdministration
Summary
Mandatory: 0 element (24 nested mandatory elements)
Must-Support: 69 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from MedicationAdministration
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | MedicationAdministration | Administration of medication to a patient | |
id | S | 0..1 | id | Logical id of this artifact |
meta | S | 0..1 | Meta | Metadata about the resource |
source | S | 0..1 | uri | Identifies where the resource comes from |
profile | S | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
identifier | S | 0..* | Identifier | External identifier |
partOf | S | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event |
status | S | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown |
category | S | 0..1 | CodeableConcept | Type of medication usage |
Slices for medication[x] | S | 1..1 | CodeableConcept, Reference(Medication) | What was administered Slice: Unordered, Open by type:$this |
medication[x]:medicationReference | S | 0..1 | Reference(Medication) | What was administered |
medication[x]:medicationCodeableConcept | S | 0..1 | CodeableConcept | What was administered |
Slices for coding | S | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
coding:Pharmazentralnummer | S | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/ifa/pzn | |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
coding:atcClassDe | S | 0..* | Coding | ATC Klassifikation deutsche Version Binding: ATC (required) Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/bfarm/atc | |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
coding:atcClassEn | S | 0..* | Coding | Anatomical Therapeutic Chemical Classification System Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.whocc.no/atc | |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
text | S | 0..1 | string | Plain text representation of the concept |
subject | S | 1..1 | Reference(Patient | Group) | Who received medication |
context | S | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of |
supportingInformation | 0..* | Reference(Profile Tumor) | Additional information to support administration | |
Slices for effective[x] | S | 1..1 | dateTime, Period | Start and end time of administration Slice: Unordered, Open by type:$this |
effective[x]:effectiveDateTime | S | 0..1 | dateTime | Start and end time of administration |
effective[x]:effectivePeriod | S | 0..1 | Period | Start and end time of administration |
performer | S | 0..* | BackboneElement | Who performed the medication administration and what they did |
reasonCode | S | 0..* | CodeableConcept | Reason administration performed |
reasonReference | S | 0..* | Reference(Profile Tumor Disorder) | Condition or observation that supports why the medication was administered |
request | S | 0..1 | Reference(MedicationRequest) | Request administration performed against |
note | S | 0..* | Annotation | Information about the administration |
dosage | S | 0..1 | BackboneElement | Details of how medication was taken |
text | S | 0..1 | string | Free text dosage instructions e.g. SIG |
site | S | 0..1 | CodeableConcept | Body site administered to |
Slices for |