CH EMED (R4)
5.0.0-ci-build - trial-use Switzerland flag

CH EMED (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 5.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-emed/ and changes regularly. See the Directory of published versions

Resource Profile: CH EMED MedicationAdministration (DIS)

Official URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-medicationadministration Version: 5.0.0-ci-build
Active as of 2024-03-28 Computable Name: CHEMEDMedicationAdministration

Copyright/Legal: CC0-1.0

Definition of the medication administration for the medication dispense document

Usage:

Formal Views of Profile Content

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

This structure is derived from CHCoreMedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*CHCoreMedicationAdministrationCH EMED MedicationAdministration (DIS)
... contained 1..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... prescription 0..1(Complex)Reference to the medication prescription
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-prescription
... treatmentPlan 0..1(Complex)Reference to the medication treatment plan
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-treatmentplan
... identifier 1..1IdentifierMedicationAdministration Identifier
.... system 1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value 1..1stringIdentifier value as UUID
Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
... status 1..1codein-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Fixed Value: completed
... Slices for medication[x] 1..1CodeableConcept, Reference(CH Core Medication)What was administered
Slice: Unordered, Open by type:$this
.... medication[x]:medicationReference 0..1Reference(CH EMED Medication (MedicationDispense)) {c}Reference to the contained medication
... subject 1..1Reference(CH Core Patient)Patient
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... performer 1..1BackboneElementWho performed the medication administration and what they did
.... actor 1..1Reference(CH EMED PractitionerRole)The author of the medical decision, see also 'Guidance - Authorship'
..... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... reasonCode 0..1CodeableConceptTreatment reason
... dosage 1..1BackboneElementDetails of how medication was taken
.... route 0..1CodeableConceptRoute of administration
Binding: EDQM - RouteOfAdministration (required)
..... coding S1..*CodingCode defined by a terminology system
...... system 1..1uriIdentity of the terminology system
...... code 1..1codeSymbol in syntax defined by the system
.... method 0..1CodeableConceptAdministration method
Binding: EDQM - Administration Method (required)
..... coding 1..*CodingCode defined by a terminology system
...... system 1..1uriIdentity of the terminology system
...... code 1..1codeSymbol in syntax defined by the system
.... dose S0..1CHCoreQuantityWithEmedUnitsAmount of medication administered

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationAdministration.dosage.routerequiredRouteOfAdministrationEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration
MedicationAdministration.dosage.methodrequiredAdministrationMethodEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*CHCoreMedicationAdministrationCH EMED MedicationAdministration (DIS)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 1..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pharmaceuticalAdvice 0..1(Complex)Reference to the pharmaceutical advice
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-pharmaceuticaladvice
... treatmentPlan 0..1(Complex)Reference to the medication treatment plan
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-treatmentplan
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 1..1IdentifierMedicationAdministration Identifier
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value Σ1..1stringIdentifier value as UUID
Example General: 123456
Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
... status ?!Σ1..1codein-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.


Fixed Value: completed
... Slices for medication[x] Σ1..1What was administered
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(CH Core Medication)
.... medication[x]:medicationReference Σ0..1Reference(CH EMED Medication (MedicationDispense)) {c}Reference to the contained medication
... subject Σ1..1Reference(CH Core Patient)Patient
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... effective[x] Σ1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... performer Σ1..1BackboneElementWho performed the medication administration and what they did
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... actor Σ1..1Reference(CH EMED PractitionerRole)The author of the medical decision, see also 'Guidance - Authorship'
..... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... reasonCode 0..1CodeableConceptTreatment reason
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... dosage C1..1BackboneElementDetails of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... route 0..1CodeableConceptRoute of administration
Binding: EDQM - RouteOfAdministration (required)
..... coding SΣ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
...... code Σ1..1codeSymbol in syntax defined by the system
.... method 0..1CodeableConceptAdministration method
Binding: EDQM - Administration Method (required)
..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
...... code Σ1..1codeSymbol in syntax defined by the system
.... dose SC0..1CHCoreQuantityWithEmedUnitsAmount of medication administered
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationAdministration.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationAdministration.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1
from the FHIR Standard
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.reasonCodeexampleReasonMedicationGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-given-codes
from the FHIR Standard
MedicationAdministration.dosage.routerequiredRouteOfAdministrationEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration
MedicationAdministration.dosage.methodrequiredAdministrationMethodEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf 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-4errorMedicationAdministrationIf 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-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()
qty-3errorMedicationAdministration.dosage.doseIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
sqty-1errorMedicationAdministration.dosage.doseThe comparator is not used on a SimpleQuantity
: comparator.empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*CHCoreMedicationAdministrationCH EMED MedicationAdministration (DIS)
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 1..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... prescription 0..1(Complex)Reference to the medication prescription
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-prescription
... pharmaceuticalAdvice 0..1(Complex)Reference to the pharmaceutical advice
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-pharmaceuticaladvice
... treatmentPlan 0..1(Complex)Reference to the medication treatment plan
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-treatmentplan
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 1..1IdentifierMedicationAdministration Identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value Σ1..1stringIdentifier value as UUID
Example General: 123456
Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... instantiates Σ0..*uriInstantiates protocol or definition
... partOf Σ0..*Reference(MedicationAdministration | Procedure)Part of referenced event
... status ?!Σ1..1codein-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.


Fixed Value: completed
... statusReason 0..*CodeableConceptReason administration not performed
Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.


... category 0..1CodeableConceptType of medication usage
Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur.

... Slices for medication[x] Σ1..1What was administered
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(CH Core Medication)
.... medication[x]:medicationReference Σ0..1Reference(CH EMED Medication (MedicationDispense)) {c}Reference to the contained medication
... subject Σ1..1Reference(CH Core Patient)Patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode of Care administered as part of
... supportingInformation 0..*Reference(Resource)Additional information to support administration
... effective[x] Σ1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... performer Σ1..1BackboneElementWho performed the medication administration and what they did
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function 0..1CodeableConceptType of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.

.... actor Σ1..1Reference(CH EMED PractitionerRole)The author of the medical decision, see also 'Guidance - Authorship'
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... reasonCode 0..1CodeableConceptTreatment reason
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Condition or observation that supports why the medication was administered
... request 0..1Reference(MedicationRequest)Request administration performed against
... device 0..*Reference(Device)Device used to administer
... note 0..*AnnotationInformation about the administration
... dosage C1..1BackboneElementDetails of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... text 0..1stringFree text dosage instructions e.g. SIG
.... site 0..1CodeableConceptBody site administered to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.

.... route 0..1CodeableConceptRoute of administration
Binding: EDQM - RouteOfAdministration (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... method 0..1CodeableConceptAdministration method
Binding: EDQM - Administration Method (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... dose SC0..1CHCoreQuantityWithEmedUnitsAmount of medication administered
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
.... rate[x] 0..1Dose quantity per unit of time
..... rateRatioRatio(CHCoreRatioWithEmedUnits)
..... rateQuantityQuantity(CHCoreQuantityWithEmedUnits)
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationAdministration.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationAdministration.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationAdministration.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
MedicationAdministration.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1
from the FHIR Standard
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes
from the FHIR Standard
MedicationAdministration.categorypreferredMedicationAdministration Category Codes
http://hl7.org/fhir/ValueSet/medication-admin-category
from the FHIR Standard
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
http://hl7.org/fhir/ValueSet/med-admin-perform-function
from the FHIR Standard
MedicationAdministration.performer.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationAdministration.reasonCodeexampleReasonMedicationGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-given-codes
from the FHIR Standard
MedicationAdministration.dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
from the FHIR Standard
MedicationAdministration.dosage.routerequiredRouteOfAdministrationEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration
MedicationAdministration.dosage.methodrequiredAdministrationMethodEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf 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-4errorMedicationAdministrationIf 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-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()
qty-3errorMedicationAdministration.dosage.doseIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
sqty-1errorMedicationAdministration.dosage.doseThe comparator is not used on a SimpleQuantity
: comparator.empty()

This structure is derived from CHCoreMedicationAdministration

Summary

Mandatory: 8 elements (6 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationAdministration.medication[x] is sliced based on the value of type:$this

Differential View

This structure is derived from CHCoreMedicationAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*CHCoreMedicationAdministrationCH EMED MedicationAdministration (DIS)
... contained 1..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... prescription 0..1(Complex)Reference to the medication prescription
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-prescription
... treatmentPlan 0..1(Complex)Reference to the medication treatment plan
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-treatmentplan
... identifier 1..1IdentifierMedicationAdministration Identifier
.... system 1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value 1..1stringIdentifier value as UUID
Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
... status 1..1codein-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Fixed Value: completed
... Slices for medication[x] 1..1CodeableConcept, Reference(CH Core Medication)What was administered
Slice: Unordered, Open by type:$this
.... medication[x]:medicationReference 0..1Reference(CH EMED Medication (MedicationDispense)) {c}Reference to the contained medication
... subject 1..1Reference(CH Core Patient)Patient
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... performer 1..1BackboneElementWho performed the medication administration and what they did
.... actor 1..1Reference(CH EMED PractitionerRole)The author of the medical decision, see also 'Guidance - Authorship'
..... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... reasonCode 0..1CodeableConceptTreatment reason
... dosage 1..1BackboneElementDetails of how medication was taken
.... route 0..1CodeableConceptRoute of administration
Binding: EDQM - RouteOfAdministration (required)
..... coding S1..*CodingCode defined by a terminology system
...... system 1..1uriIdentity of the terminology system
...... code 1..1codeSymbol in syntax defined by the system
.... method 0..1CodeableConceptAdministration method
Binding: EDQM - Administration Method (required)
..... coding 1..*CodingCode defined by a terminology system
...... system 1..1uriIdentity of the terminology system
...... code 1..1codeSymbol in syntax defined by the system
.... dose S0..1CHCoreQuantityWithEmedUnitsAmount of medication administered

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationAdministration.dosage.routerequiredRouteOfAdministrationEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration
MedicationAdministration.dosage.methodrequiredAdministrationMethodEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*CHCoreMedicationAdministrationCH EMED MedicationAdministration (DIS)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 1..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pharmaceuticalAdvice 0..1(Complex)Reference to the pharmaceutical advice
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-pharmaceuticaladvice
... treatmentPlan 0..1(Complex)Reference to the medication treatment plan
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-treatmentplan
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 1..1IdentifierMedicationAdministration Identifier
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value Σ1..1stringIdentifier value as UUID
Example General: 123456
Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
... status ?!Σ1..1codein-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.


Fixed Value: completed
... Slices for medication[x] Σ1..1What was administered
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(CH Core Medication)
.... medication[x]:medicationReference Σ0..1Reference(CH EMED Medication (MedicationDispense)) {c}Reference to the contained medication
... subject Σ1..1Reference(CH Core Patient)Patient
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... effective[x] Σ1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... performer Σ1..1BackboneElementWho performed the medication administration and what they did
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... actor Σ1..1Reference(CH EMED PractitionerRole)The author of the medical decision, see also 'Guidance - Authorship'
..... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... reasonCode 0..1CodeableConceptTreatment reason
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... dosage C1..1BackboneElementDetails of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... route 0..1CodeableConceptRoute of administration
Binding: EDQM - RouteOfAdministration (required)
..... coding SΣ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
...... code Σ1..1codeSymbol in syntax defined by the system
.... method 0..1CodeableConceptAdministration method
Binding: EDQM - Administration Method (required)
..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
...... code Σ1..1codeSymbol in syntax defined by the system
.... dose SC0..1CHCoreQuantityWithEmedUnitsAmount of medication administered
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationAdministration.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationAdministration.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1
from the FHIR Standard
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.reasonCodeexampleReasonMedicationGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-given-codes
from the FHIR Standard
MedicationAdministration.dosage.routerequiredRouteOfAdministrationEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration
MedicationAdministration.dosage.methodrequiredAdministrationMethodEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf 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-4errorMedicationAdministrationIf 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-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()
qty-3errorMedicationAdministration.dosage.doseIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
sqty-1errorMedicationAdministration.dosage.doseThe comparator is not used on a SimpleQuantity
: comparator.empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 0..*CHCoreMedicationAdministrationCH EMED MedicationAdministration (DIS)
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 1..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... prescription 0..1(Complex)Reference to the medication prescription
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-prescription
... pharmaceuticalAdvice 0..1(Complex)Reference to the pharmaceutical advice
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-pharmaceuticaladvice
... treatmentPlan 0..1(Complex)Reference to the medication treatment plan
URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-treatmentplan
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 1..1IdentifierMedicationAdministration Identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
.... value Σ1..1stringIdentifier value as UUID
Example General: 123456
Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... instantiates Σ0..*uriInstantiates protocol or definition
... partOf Σ0..*Reference(MedicationAdministration | Procedure)Part of referenced event
... status ?!Σ1..1codein-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.


Fixed Value: completed
... statusReason 0..*CodeableConceptReason administration not performed
Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated.


... category 0..1CodeableConceptType of medication usage
Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur.

... Slices for medication[x] Σ1..1What was administered
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered.

.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(CH Core Medication)
.... medication[x]:medicationReference Σ0..1Reference(CH EMED Medication (MedicationDispense)) {c}Reference to the contained medication
... subject Σ1..1Reference(CH Core Patient)Patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode of Care administered as part of
... supportingInformation 0..*Reference(Resource)Additional information to support administration
... effective[x] Σ1..1Start and end time of administration
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... performer Σ1..1BackboneElementWho performed the medication administration and what they did
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function 0..1CodeableConceptType of performance
Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication.

.... actor Σ1..1Reference(CH EMED PractitionerRole)The author of the medical decision, see also 'Guidance - Authorship'
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... reasonCode 0..1CodeableConceptTreatment reason
Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made.


... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Condition or observation that supports why the medication was administered
... request 0..1Reference(MedicationRequest)Request administration performed against
... device 0..*Reference(Device)Device used to administer
... note 0..*AnnotationInformation about the administration
... dosage C1..1BackboneElementDetails of how medication was taken
mad-1: SHALL have at least one of dosage.dose or dosage.rate[x]
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... text 0..1stringFree text dosage instructions e.g. SIG
.... site 0..1CodeableConceptBody site administered to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body.

.... route 0..1CodeableConceptRoute of administration
Binding: EDQM - RouteOfAdministration (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... method 0..1CodeableConceptAdministration method
Binding: EDQM - Administration Method (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... dose SC0..1CHCoreQuantityWithEmedUnitsAmount of medication administered
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
.... rate[x] 0..1Dose quantity per unit of time
..... rateRatioRatio(CHCoreRatioWithEmedUnits)
..... rateQuantityQuantity(CHCoreQuantityWithEmedUnits)
... eventHistory 0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MedicationAdministration.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MedicationAdministration.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
MedicationAdministration.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
MedicationAdministration.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1
from the FHIR Standard
MedicationAdministration.statusReasonexampleSNOMEDCTReasonMedicationNotGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes
from the FHIR Standard
MedicationAdministration.categorypreferredMedicationAdministration Category Codes
http://hl7.org/fhir/ValueSet/medication-admin-category
from the FHIR Standard
MedicationAdministration.medication[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationAdministration.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationAdministration.performer.functionexampleMedicationAdministration Performer Function Codes
http://hl7.org/fhir/ValueSet/med-admin-perform-function
from the FHIR Standard
MedicationAdministration.performer.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
MedicationAdministration.reasonCodeexampleReasonMedicationGivenCodes
http://hl7.org/fhir/ValueSet/reason-medication-given-codes
from the FHIR Standard
MedicationAdministration.dosage.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
http://hl7.org/fhir/ValueSet/approach-site-codes
from the FHIR Standard
MedicationAdministration.dosage.routerequiredRouteOfAdministrationEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration
MedicationAdministration.dosage.methodrequiredAdministrationMethodEDQM
http://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationAdministrationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationAdministrationIf 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-4errorMedicationAdministrationIf 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-5errorMedicationAdministrationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationAdministrationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mad-1errorMedicationAdministration.dosageSHALL have at least one of dosage.dose or dosage.rate[x]
: dose.exists() or rate.exists()
qty-3errorMedicationAdministration.dosage.doseIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
sqty-1errorMedicationAdministration.dosage.doseThe comparator is not used on a SimpleQuantity
: comparator.empty()

This structure is derived from CHCoreMedicationAdministration

Summary

Mandatory: 8 elements (6 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationAdministration.medication[x] is sliced based on the value of type:$this

 

Other representations of profile: CSV, Excel, Schematron