Canadian Baseline
1.1.0 - CI Build
Canadian Baseline, published by HL7 Canada - FHIR Implementation Work Group. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-Canada/ca-baseline/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-medicationadministration | Version: 1.1.0 | |||
Draft as of 2024-12-13 | Computable Name: MedicationAdministrationProfile |
Proposed constraints and extensions on the MedicationAdministration resource. Generated as a first step toward creating a set of Canadian Baseline FHIR profiles.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationAdministration
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | MedicationAdministration | MedicationAdministration Profile | |
partOf | 0..* | Reference(MedicationAdministration Profile | Procedure Profile) | Part of referenced event | |
status | S | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown |
medication[x] | S | 1..1 | What was administered Binding: https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct (preferred): TBD. This is a placeholder for a comprehensive valueset, consisting of all Manufactured Product (MP), Non-proprietary Therapeutic Product (NTP) and Therapeutic Moiety (TM) codes, which would be created and maintained by Canada Health Infoway. Medicinal products for prescribing and dispensing in Canada. The content of this subset only contains commonly used medicinal products that are available for prescribing and dispensing in Canada. This content will expand to include all human medicinal products over time. | |
medicationCodeableConcept | CodeableConcept | |||
medicationReference | Reference(Medication Profile) | |||
subject | S | 1..1 | Reference(Patient Profile) | Who received medication |
context | S | 0..1 | Reference(Encounter Profile | EpisodeOfCare) | Encounter or Episode of Care administered as part of |
effective[x] | S | 1..1 | dateTime, Period | Start and end time of administration |
performer | S | 0..* | BackboneElement | Who performed the medication administration and what they did |
actor | S | 1..1 | Reference(Practitioner Profile (General) | PractitionerRole Profile (General) | Patient Profile | RelatedPerson | Device Profile (Implantable)) | Who performed the medication administration |
reasonReference | 0..* | Reference(Condition Profile | Observation Profile (General Use) | DiagnosticReport Profile for Laboratory Results Reporting | Diagnostic Report for Report and Note Exchange Profile) | Condition or observation that supports why the medication was administered | |
request | 0..1 | Reference(MedicationRequest Profile) | Request administration performed against | |
device | 0..* | Reference(Device Profile (Implantable)) | Device used to administer | |
dosage | S | 0..1 | BackboneElement | Details of how medication was taken |
text | S | 0..1 | string | Free text dosage instructions e.g. SIG |
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationAdministration.medication[x] | preferred | https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproducthttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | MedicationAdministration | MedicationAdministration Profile dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
partOf | Σ | 0..* | Reference(MedicationAdministration Profile | Procedure Profile) | Part of referenced event ele-1: All FHIR elements must have a @value or children |
status | ?!SΣ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. ele-1: All FHIR elements must have a @value or children |
medication[x] | SΣ | 1..1 | What was administered Binding: https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct (preferred): TBD. This is a placeholder for a comprehensive valueset, consisting of all Manufactured Product (MP), Non-proprietary Therapeutic Product (NTP) and Therapeutic Moiety (TM) codes, which would be created and maintained by Canada Health Infoway. Medicinal products for prescribing and dispensing in Canada. The content of this subset only contains commonly used medicinal products that are available for prescribing and dispensing in Canada. This content will expand to include all human medicinal products over time. ele-1: All FHIR elements must have a @value or children | |
medicationCodeableConcept | CodeableConcept | |||
medicationReference | Reference(Medication Profile) | |||
subject | SΣ | 1..1 | Reference(Patient Profile) | Who received medication ele-1: All FHIR elements must have a @value or children |
context | S | 0..1 | Reference(Encounter Profile | EpisodeOfCare) | Encounter or Episode of Care administered as part of ele-1: All FHIR elements must have a @value or children |
effective[x] | SΣ | 1..1 | Start and end time of administration ele-1: All FHIR elements must have a @value or children | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
performer | SΣ | 0..* | BackboneElement | Who performed the medication administration and what they did ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
actor | SΣ | 1..1 | Reference(Practitioner Profile (General) | PractitionerRole Profile (General) | Patient Profile | RelatedPerson | Device Profile (Implantable)) | Who performed the medication administration ele-1: All FHIR elements must have a @value or children |
reasonReference | 0..* | Reference(Condition Profile | Observation Profile (General Use) | DiagnosticReport Profile for Laboratory Results Reporting | Diagnostic Report for Report and Note Exchange Profile) | Condition or observation that supports why the medication was administered ele-1: All FHIR elements must have a @value or children | |
request | 0..1 | Reference(MedicationRequest Profile) | Request administration performed against ele-1: All FHIR elements must have a @value or children | |
device | 0..* | Reference(Device Profile (Implantable)) | Device used to administer ele-1: All FHIR elements must have a @value or children | |
dosage | SC | 0..1 | BackboneElement | Details of how medication was taken ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
text | S | 0..1 | string | Free text dosage instructions e.g. SIG ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationAdministration.status | required | MedicationAdministration Status Codeshttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1 from the FHIR Standard | |
MedicationAdministration.medication[x] | preferred | https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproducthttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationAdministration | 0..* | MedicationAdministration | MedicationAdministration Profile | |||||
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 | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | External identifier | |||||
instantiates | Σ | 0..* | uri | Instantiates protocol or definition | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration Profile | Procedure Profile) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. | ||||
statusReason | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated. | |||||
category | 0..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur. | |||||
medication[x] | SΣ | 1..1 | What was administered Binding: https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct (preferred): TBD. This is a placeholder for a comprehensive valueset, consisting of all Manufactured Product (MP), Non-proprietary Therapeutic Product (NTP) and Therapeutic Moiety (TM) codes, which would be created and maintained by Canada Health Infoway. Medicinal products for prescribing and dispensing in Canada. The content of this subset only contains commonly used medicinal products that are available for prescribing and dispensing in Canada. This content will expand to include all human medicinal products over time. | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(Medication Profile) | |||||||
subject | SΣ | 1..1 | Reference(Patient Profile) | Who received medication | ||||
context | S | 0..1 | Reference(Encounter Profile | EpisodeOfCare) | Encounter or Episode of Care administered as part of | ||||
supportingInformation | 0..* | Reference(Resource) | Additional information to support administration | |||||
effective[x] | SΣ | 1..1 | Start and end time of administration | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
performer | SΣ | 0..* | BackboneElement | Who performed the medication administration and what they did | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | 0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication. | |||||
actor | SΣ | 1..1 | Reference(Practitioner Profile (General) | PractitionerRole Profile (General) | Patient Profile | RelatedPerson | Device Profile (Implantable)) | Who performed the medication administration | ||||
reasonCode | 0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made. | |||||
reasonReference | 0..* | Reference(Condition Profile | Observation Profile (General Use) | DiagnosticReport Profile for Laboratory Results Reporting | Diagnostic Report for Report and Note Exchange Profile) | Condition or observation that supports why the medication was administered | |||||
request | 0..1 | Reference(MedicationRequest Profile) | Request administration performed against | |||||
device | 0..* | Reference(Device Profile (Implantable)) | Device used to administer | |||||
note | 0..* | Annotation | Information about the administration | |||||
dosage | SC | 0..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 | S | 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 | Path of substance into body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||
method | 0..1 | CodeableConcept | How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | |||||
dose | 0..1 | SimpleQuantity | Amount of medication per dose | |||||
rate[x] | 0..1 | Dose quantity per unit of time | ||||||
rateRatio | Ratio | |||||||
rateQuantity | Quantity(SimpleQuantity) | |||||||
eventHistory | 0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationAdministration.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MedicationAdministration.status | required | MedicationAdministration Status Codeshttp://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] | preferred | https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproducthttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct | ||||
MedicationAdministration.performer.function | example | MedicationAdministration Performer Function Codeshttp://hl7.org/fhir/ValueSet/med-admin-perform-function 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 | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | ||||
MedicationAdministration.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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() |
This structure is derived from MedicationAdministration
Summary
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from MedicationAdministration
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | MedicationAdministration | MedicationAdministration Profile | |
partOf | 0..* | Reference(MedicationAdministration Profile | Procedure Profile) | Part of referenced event | |
status | S | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown |
medication[x] | S | 1..1 | What was administered Binding: https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct (preferred): TBD. This is a placeholder for a comprehensive valueset, consisting of all Manufactured Product (MP), Non-proprietary Therapeutic Product (NTP) and Therapeutic Moiety (TM) codes, which would be created and maintained by Canada Health Infoway. Medicinal products for prescribing and dispensing in Canada. The content of this subset only contains commonly used medicinal products that are available for prescribing and dispensing in Canada. This content will expand to include all human medicinal products over time. | |
medicationCodeableConcept | CodeableConcept | |||
medicationReference | Reference(Medication Profile) | |||
subject | S | 1..1 | Reference(Patient Profile) | Who received medication |
context | S | 0..1 | Reference(Encounter Profile | EpisodeOfCare) | Encounter or Episode of Care administered as part of |
effective[x] | S | 1..1 | dateTime, Period | Start and end time of administration |
performer | S | 0..* | BackboneElement | Who performed the medication administration and what they did |
actor | S | 1..1 | Reference(Practitioner Profile (General) | PractitionerRole Profile (General) | Patient Profile | RelatedPerson | Device Profile (Implantable)) | Who performed the medication administration |
reasonReference | 0..* | Reference(Condition Profile | Observation Profile (General Use) | DiagnosticReport Profile for Laboratory Results Reporting | Diagnostic Report for Report and Note Exchange Profile) | Condition or observation that supports why the medication was administered | |
request | 0..1 | Reference(MedicationRequest Profile) | Request administration performed against | |
device | 0..* | Reference(Device Profile (Implantable)) | Device used to administer | |
dosage | S | 0..1 | BackboneElement | Details of how medication was taken |
text | S | 0..1 | string | Free text dosage instructions e.g. SIG |
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationAdministration.medication[x] | preferred | https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproducthttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationAdministration | 0..* | MedicationAdministration | MedicationAdministration Profile dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
partOf | Σ | 0..* | Reference(MedicationAdministration Profile | Procedure Profile) | Part of referenced event ele-1: All FHIR elements must have a @value or children |
status | ?!SΣ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. ele-1: All FHIR elements must have a @value or children |
medication[x] | SΣ | 1..1 | What was administered Binding: https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct (preferred): TBD. This is a placeholder for a comprehensive valueset, consisting of all Manufactured Product (MP), Non-proprietary Therapeutic Product (NTP) and Therapeutic Moiety (TM) codes, which would be created and maintained by Canada Health Infoway. Medicinal products for prescribing and dispensing in Canada. The content of this subset only contains commonly used medicinal products that are available for prescribing and dispensing in Canada. This content will expand to include all human medicinal products over time. ele-1: All FHIR elements must have a @value or children | |
medicationCodeableConcept | CodeableConcept | |||
medicationReference | Reference(Medication Profile) | |||
subject | SΣ | 1..1 | Reference(Patient Profile) | Who received medication ele-1: All FHIR elements must have a @value or children |
context | S | 0..1 | Reference(Encounter Profile | EpisodeOfCare) | Encounter or Episode of Care administered as part of ele-1: All FHIR elements must have a @value or children |
effective[x] | SΣ | 1..1 | Start and end time of administration ele-1: All FHIR elements must have a @value or children | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
performer | SΣ | 0..* | BackboneElement | Who performed the medication administration and what they did ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
actor | SΣ | 1..1 | Reference(Practitioner Profile (General) | PractitionerRole Profile (General) | Patient Profile | RelatedPerson | Device Profile (Implantable)) | Who performed the medication administration ele-1: All FHIR elements must have a @value or children |
reasonReference | 0..* | Reference(Condition Profile | Observation Profile (General Use) | DiagnosticReport Profile for Laboratory Results Reporting | Diagnostic Report for Report and Note Exchange Profile) | Condition or observation that supports why the medication was administered ele-1: All FHIR elements must have a @value or children | |
request | 0..1 | Reference(MedicationRequest Profile) | Request administration performed against ele-1: All FHIR elements must have a @value or children | |
device | 0..* | Reference(Device Profile (Implantable)) | Device used to administer ele-1: All FHIR elements must have a @value or children | |
dosage | SC | 0..1 | BackboneElement | Details of how medication was taken ele-1: All FHIR elements must have a @value or children 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
text | S | 0..1 | string | Free text dosage instructions e.g. SIG ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
MedicationAdministration.status | required | MedicationAdministration Status Codeshttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1 from the FHIR Standard | |
MedicationAdministration.medication[x] | preferred | https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproducthttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationAdministration | 0..* | MedicationAdministration | MedicationAdministration Profile | |||||
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 | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | External identifier | |||||
instantiates | Σ | 0..* | uri | Instantiates protocol or definition | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration Profile | Procedure Profile) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. | ||||
statusReason | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated. | |||||
category | 0..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur. | |||||
medication[x] | SΣ | 1..1 | What was administered Binding: https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct (preferred): TBD. This is a placeholder for a comprehensive valueset, consisting of all Manufactured Product (MP), Non-proprietary Therapeutic Product (NTP) and Therapeutic Moiety (TM) codes, which would be created and maintained by Canada Health Infoway. Medicinal products for prescribing and dispensing in Canada. The content of this subset only contains commonly used medicinal products that are available for prescribing and dispensing in Canada. This content will expand to include all human medicinal products over time. | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(Medication Profile) | |||||||
subject | SΣ | 1..1 | Reference(Patient Profile) | Who received medication | ||||
context | S | 0..1 | Reference(Encounter Profile | EpisodeOfCare) | Encounter or Episode of Care administered as part of | ||||
supportingInformation | 0..* | Reference(Resource) | Additional information to support administration | |||||
effective[x] | SΣ | 1..1 | Start and end time of administration | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
performer | SΣ | 0..* | BackboneElement | Who performed the medication administration and what they did | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | 0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication. | |||||
actor | SΣ | 1..1 | Reference(Practitioner Profile (General) | PractitionerRole Profile (General) | Patient Profile | RelatedPerson | Device Profile (Implantable)) | Who performed the medication administration | ||||
reasonCode | 0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made. | |||||
reasonReference | 0..* | Reference(Condition Profile | Observation Profile (General Use) | DiagnosticReport Profile for Laboratory Results Reporting | Diagnostic Report for Report and Note Exchange Profile) | Condition or observation that supports why the medication was administered | |||||
request | 0..1 | Reference(MedicationRequest Profile) | Request administration performed against | |||||
device | 0..* | Reference(Device Profile (Implantable)) | Device used to administer | |||||
note | 0..* | Annotation | Information about the administration | |||||
dosage | SC | 0..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 | S | 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 | Path of substance into body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||
method | 0..1 | CodeableConcept | How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | |||||
dose | 0..1 | SimpleQuantity | Amount of medication per dose | |||||
rate[x] | 0..1 | Dose quantity per unit of time | ||||||
rateRatio | Ratio | |||||||
rateQuantity | Quantity(SimpleQuantity) | |||||||
eventHistory | 0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
MedicationAdministration.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MedicationAdministration.status | required | MedicationAdministration Status Codeshttp://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] | preferred | https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproducthttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct | ||||
MedicationAdministration.performer.function | example | MedicationAdministration Performer Function Codeshttp://hl7.org/fhir/ValueSet/med-admin-perform-function 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 | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard | ||||
MedicationAdministration.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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() |
This structure is derived from MedicationAdministration
Summary
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron