CH EMED (R4)
5.0.0-ci-build - ci-build
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
Official URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-medicationadministration-list | Version: 5.0.0-ci-build | |||
Active as of 2024-10-04 | Computable Name: CHEMEDMedicationAdministrationList | |||
Copyright/Legal: CC0-1.0 |
Definition of the medication administration for the medication list document
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CHEMEDMedicationAdministration
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | CHEMEDMedicationAdministration | CH EMED MedicationAdministration (LIST) | |
Slices for extension | Content/Rules for all slices | |||
parentDocument | 0..1 | (Complex) | Reference to the parent document URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-dispense | |
authorDocument | 0..1 | Reference(CH Core Patient | CH Core PractitionerRole | RelatedPerson) | Author of the original document if different from the author of the medical decision (MedicationAdministration.performer.actor), see also 'Guidance - Authorship' URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | CHEMEDMedicationAdministration | CH EMED MedicationAdministration (LIST) | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 1..* | Resource | Contained, inline Resources | |
Slices for extension | Content/Rules for all slices | |||
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 | |
parentDocument | 0..1 | (Complex) | Reference to the parent document URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-dispense | |
authorDocument | 0..1 | Reference(CH Core Patient | CH Core PractitionerRole | RelatedPerson) | Author of the original document if different from the author of the medical decision (MedicationAdministration.performer.actor), see also 'Guidance - Authorship' URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 1..1 | Identifier | MedicationAdministration Identifier | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 |
value | Σ | 1..1 | string | Identifier value as UUID Example General: 123456 Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9 |
status | ?!Σ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. Fixed Value: completed |
Slices for medication[x] | Σ | 1..1 | What was administered Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. | |
medicationCodeableConcept | CodeableConcept | |||
medicationReference | Reference(CH Core Medication) | |||
medication[x]:medicationReference | Σ | 0..1 | Reference(CH EMED Medication (MedicationDispense)) {c} | Reference to the contained medication |
subject | Σ | 1..1 | Reference(CH Core Patient) | Patient |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
effective[x] | Σ | 1..1 | Start and end time of administration | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
performer | Σ | 1..1 | 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(CH EMED PractitionerRole) | The author of the medical decision, see also 'Guidance - Authorship' |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
dosage | C | 1..1 | BackboneElement | Details of how medication was taken mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
route | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) | |
coding | SΣ | 1..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
dose | SC | 0..1 | CHCoreQuantityWithEmedUnits | Amount 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 |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
MedicationAdministration.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
MedicationAdministration.status | required | Fixed Value: completedhttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1 from the FHIR Standard | |
MedicationAdministration.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
MedicationAdministration.dosage.route | required | RouteOfAdministrationEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration |
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.dose | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | MedicationAdministration.dosage.dose | The comparator is not used on a SimpleQuantity : comparator.empty() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationAdministration | 0..* | CHEMEDMedicationAdministration | CH EMED MedicationAdministration (LIST) | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 1..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension 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 | |||||
parentDocument | 0..1 | (Complex) | Reference to the parent document URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-dispense | |||||
authorDocument | 0..1 | Reference(CH Core Patient | CH Core PractitionerRole | RelatedPerson) | Author of the original document if different from the author of the medical decision (MedicationAdministration.performer.actor), see also 'Guidance - Authorship' URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 1..1 | Identifier | MedicationAdministration Identifier | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | ||||
value | Σ | 1..1 | string | Identifier value as UUID Example General: 123456 Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
instantiates | Σ | 0..* | uri | Instantiates protocol or definition | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event | ||||
status | ?!Σ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. Fixed Value: completed | ||||
statusReason | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated. | |||||
category | 0..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur. | |||||
Slices for medication[x] | Σ | 1..1 | What was administered Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(CH Core Medication) | |||||||
medication[x]:medicationReference | Σ | 0..1 | Reference(CH EMED Medication (MedicationDispense)) {c} | Reference to the contained medication | ||||
subject | Σ | 1..1 | Reference(CH Core Patient) | Patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
context | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of | |||||
supportingInformation | 0..* | Reference(Resource) | Additional information to support administration | |||||
effective[x] | Σ | 1..1 | Start and end time of administration | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
performer | Σ | 1..1 | 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(CH EMED PractitionerRole) | The author of the medical decision, see also 'Guidance - Authorship' | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
reasonCode | 0..* | CodeableConcept | Treatment 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..1 | Reference(MedicationRequest) | Request administration performed against | |||||
device | 0..* | Reference(Device) | Device used to administer | |||||
note | 0..* | Annotation | Information about the administration | |||||
dosage | C | 1..1 | BackboneElement | Details of how medication was taken mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
text | 0..1 | string | Free text dosage instructions e.g. SIG | |||||
site | 0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | |||||
route | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..* | Coding | Code defined by a terminology system | ||||
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 | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 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 | Administration method Binding: EDQM - Administration Method (required) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..* | Coding | Code defined by a terminology system | ||||
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 | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 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 | ||||
dose | SC | 0..1 | CHCoreQuantityWithEmedUnits | Amount 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..1 | Dose quantity per unit of time | ||||||
rateRatio | Ratio(CHCoreRatioWithEmedUnits) | |||||||
rateQuantity | Quantity(CHCoreQuantityWithEmedUnits) | |||||||
eventHistory | 0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
MedicationAdministration.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationAdministration.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
MedicationAdministration.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
MedicationAdministration.status | required | Fixed Value: completedhttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1 from the FHIR Standard | ||||
MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-not-given-codes from the FHIR Standard | ||||
MedicationAdministration.category | preferred | MedicationAdministration Category Codeshttp://hl7.org/fhir/ValueSet/medication-admin-category from the FHIR Standard | ||||
MedicationAdministration.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
MedicationAdministration.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationAdministration.performer.function | example | MedicationAdministration Performer Function Codeshttp://hl7.org/fhir/ValueSet/med-admin-perform-function from the FHIR Standard | ||||
MedicationAdministration.performer.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationAdministration.reasonCode | example | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codes from the FHIR Standard | ||||
MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationAdministration.dosage.route | required | RouteOfAdministrationEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration | ||||
MedicationAdministration.dosage.method | required | AdministrationMethodEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod |
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.dose | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | MedicationAdministration.dosage.dose | The comparator is not used on a SimpleQuantity : comparator.empty() |
This structure is derived from CHEMEDMedicationAdministration
Differential View
This structure is derived from CHEMEDMedicationAdministration
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | CHEMEDMedicationAdministration | CH EMED MedicationAdministration (LIST) | |
Slices for extension | Content/Rules for all slices | |||
parentDocument | 0..1 | (Complex) | Reference to the parent document URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-dispense | |
authorDocument | 0..1 | Reference(CH Core Patient | CH Core PractitionerRole | RelatedPerson) | Author of the original document if different from the author of the medical decision (MedicationAdministration.performer.actor), see also 'Guidance - Authorship' URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | CHEMEDMedicationAdministration | CH EMED MedicationAdministration (LIST) | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 1..* | Resource | Contained, inline Resources | |
Slices for extension | Content/Rules for all slices | |||
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 | |
parentDocument | 0..1 | (Complex) | Reference to the parent document URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-dispense | |
authorDocument | 0..1 | Reference(CH Core Patient | CH Core PractitionerRole | RelatedPerson) | Author of the original document if different from the author of the medical decision (MedicationAdministration.performer.actor), see also 'Guidance - Authorship' URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 1..1 | Identifier | MedicationAdministration Identifier | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 |
value | Σ | 1..1 | string | Identifier value as UUID Example General: 123456 Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9 |
status | ?!Σ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. Fixed Value: completed |
Slices for medication[x] | Σ | 1..1 | What was administered Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. | |
medicationCodeableConcept | CodeableConcept | |||
medicationReference | Reference(CH Core Medication) | |||
medication[x]:medicationReference | Σ | 0..1 | Reference(CH EMED Medication (MedicationDispense)) {c} | Reference to the contained medication |
subject | Σ | 1..1 | Reference(CH Core Patient) | Patient |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
effective[x] | Σ | 1..1 | Start and end time of administration | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
performer | Σ | 1..1 | 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(CH EMED PractitionerRole) | The author of the medical decision, see also 'Guidance - Authorship' |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
dosage | C | 1..1 | BackboneElement | Details of how medication was taken mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
route | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) | |
coding | SΣ | 1..* | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
dose | SC | 0..1 | CHCoreQuantityWithEmedUnits | Amount 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 |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
MedicationAdministration.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
MedicationAdministration.status | required | Fixed Value: completedhttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1 from the FHIR Standard | |
MedicationAdministration.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
MedicationAdministration.dosage.route | required | RouteOfAdministrationEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration |
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.dose | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | MedicationAdministration.dosage.dose | The comparator is not used on a SimpleQuantity : comparator.empty() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationAdministration | 0..* | CHEMEDMedicationAdministration | CH EMED MedicationAdministration (LIST) | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 1..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension 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 | |||||
parentDocument | 0..1 | (Complex) | Reference to the parent document URL: http://fhir.ch/ig/ch-emed/StructureDefinition/ch-emed-ext-dispense | |||||
authorDocument | 0..1 | Reference(CH Core Patient | CH Core PractitionerRole | RelatedPerson) | Author of the original document if different from the author of the medical decision (MedicationAdministration.performer.actor), see also 'Guidance - Authorship' URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 1..1 | Identifier | MedicationAdministration Identifier | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | ||||
value | Σ | 1..1 | string | Identifier value as UUID Example General: 123456 Example CH EMED: urn:uuid:daa8cd41-34a1-4a9c-9a6d-cd3f850142e9 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
instantiates | Σ | 0..* | uri | Instantiates protocol or definition | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event | ||||
status | ?!Σ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. Fixed Value: completed | ||||
statusReason | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated. | |||||
category | 0..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur. | |||||
Slices for medication[x] | Σ | 1..1 | What was administered Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(CH Core Medication) | |||||||
medication[x]:medicationReference | Σ | 0..1 | Reference(CH EMED Medication (MedicationDispense)) {c} | Reference to the contained medication | ||||
subject | Σ | 1..1 | Reference(CH Core Patient) | Patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
context | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of | |||||
supportingInformation | 0..* | Reference(Resource) | Additional information to support administration | |||||
effective[x] | Σ | 1..1 | Start and end time of administration | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
performer | Σ | 1..1 | 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(CH EMED PractitionerRole) | The author of the medical decision, see also 'Guidance - Authorship' | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
reasonCode | 0..* | CodeableConcept | Treatment 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..1 | Reference(MedicationRequest) | Request administration performed against | |||||
device | 0..* | Reference(Device) | Device used to administer | |||||
note | 0..* | Annotation | Information about the administration | |||||
dosage | C | 1..1 | BackboneElement | Details of how medication was taken mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
text | 0..1 | string | Free text dosage instructions e.g. SIG | |||||
site | 0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | |||||
route | 0..1 | CodeableConcept | Route of administration Binding: EDQM - RouteOfAdministration (required) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..* | Coding | Code defined by a terminology system | ||||
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 | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 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 | Administration method Binding: EDQM - Administration Method (required) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..* | Coding | Code defined by a terminology system | ||||
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 | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 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 | ||||
dose | SC | 0..1 | CHCoreQuantityWithEmedUnits | Amount 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..1 | Dose quantity per unit of time | ||||||
rateRatio | Ratio(CHCoreRatioWithEmedUnits) | |||||||
rateQuantity | Quantity(CHCoreQuantityWithEmedUnits) | |||||||
eventHistory | 0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
MedicationAdministration.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MedicationAdministration.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
MedicationAdministration.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
MedicationAdministration.status | required | Fixed Value: completedhttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1 from the FHIR Standard | ||||
MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-not-given-codes from the FHIR Standard | ||||
MedicationAdministration.category | preferred | MedicationAdministration Category Codeshttp://hl7.org/fhir/ValueSet/medication-admin-category from the FHIR Standard | ||||
MedicationAdministration.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
MedicationAdministration.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationAdministration.performer.function | example | MedicationAdministration Performer Function Codeshttp://hl7.org/fhir/ValueSet/med-admin-perform-function from the FHIR Standard | ||||
MedicationAdministration.performer.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
MedicationAdministration.reasonCode | example | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codes from the FHIR Standard | ||||
MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes from the FHIR Standard | ||||
MedicationAdministration.dosage.route | required | RouteOfAdministrationEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-routeofadministration | ||||
MedicationAdministration.dosage.method | required | AdministrationMethodEDQMhttp://fhir.ch/ig/ch-term/ValueSet/edqm-administrationmethod |
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.dose | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | MedicationAdministration.dosage.dose | The comparator is not used on a SimpleQuantity : comparator.empty() |
This structure is derived from CHEMEDMedicationAdministration
Other representations of profile: CSV, Excel, Schematron