IHE Pharmacy Medication Record
0.1.0 - ci-build
IHE Pharmacy Medication Record
0.1.0 - ci-build
IHE Pharmacy Medication Record, published by Integrating the Healthcare Enterprise (IHE). This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/IHE/pharm-medo/ and changes regularly. See the Directory of published versions
| Official URL: http://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/MedRecordAdministration | Version: 0.1.0 | |||
| Active as of 2023-03-27 | Computable Name: MedRecordAdministration | |||
Copyright/Legal: IHE http://www.ihe.net/Governance/#Intellectual_Property |
||||
The profile for Medication Administration in a Medication Record - a record of a single administration event
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationAdministration
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MedicationAdministration | 0..* | MedicationAdministration | Administration of medication to a patient | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationAdministration | 0..* | MedicationAdministration | Administration of medication to a patient | |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministrationStatusCodes (required): A set of codes indicating the current status of a MedicationAdministration. |
 medication | Σ | 1..1 | CodeableReference(Medication) | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. |
| subject | Σ | 1..1 | Reference(Patient | Group) | Who received medication |
  occurence[x] | Σ | 1..1 | Specific date/time or interval of time during which the administration took place (or did not take place) | |
 occurenceDateTime | dateTime | |||
 occurencePeriod | Period | |||
 occurenceTiming | Timing | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationAdministration.status | required | MedicationAdministrationStatusCodes |
| MedicationAdministration.medication | example | SNOMEDCTMedicationCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationAdministration | 0..* | MedicationAdministration | Administration of medication to a patient | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier | External identifier | |
| basedOn | 0..* | Reference(CarePlan) | Plan this is fulfilled by this administration | |
| partOf | Σ | 0..* | Reference(MedicationAdministration | Procedure | MedicationDispense) | Part of referenced event |
| status | ?!Σ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministrationStatusCodes (required): A set of codes indicating the current status of a MedicationAdministration. |
| statusReason | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated. | |
| category | 0..* | CodeableConcept | Type of medication administration Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur. | |
| medication | Σ | 1..1 | CodeableReference(Medication) | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. |
| subject | Σ | 1..1 | Reference(Patient | Group) | Who received medication |
| encounter | 0..1 | Reference(Encounter) | Encounter administered as part of | |
| supportingInformation | 0..* | Reference(Resource) | Additional information to support administration | |
 occurence[x] | Σ | 1..1 | Specific date/time or interval of time during which the administration took place (or did not take place) | |
 occurenceDateTime | dateTime | |||
| occurencePeriod | Period | |||
| occurenceTiming | Timing | |||
| recorded | Σ | 0..1 | dateTime | When the MedicationAdministration was first captured in the subject's record |
| isSubPotent | 0..1 | boolean | Full dose was not administered | |
| subPotentReason | 0..* | CodeableConcept | Reason full dose was not administered Binding: MedicationAdministrationSubpotentReason (example) | |
| performer | Σ | 0..* | BackboneElement | Who or what performed the medication administration and what type of performance they did |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | 0..1 | CodeableConcept | Type of performance Binding: MedicationAdministrationPerformerFunctionCodes (example): A code describing the role an individual played in administering the medication. | |
| actor | Σ | 1..1 | CodeableReference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who or what performed the medication administration |
| reason | 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Concept, condition or observation that supports why the medication was administered Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made. | |
| request | 0..1 | Reference(MedicationRequest) | Request administration performed against | |
| device | 0..* | CodeableReference(Device) | Device used to administer | |
| note | 0..* | Annotation | Information about the administration | |
| dosage | C | 0..1 | BackboneElement | Details of how medication was taken |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| text | C | 0..1 | string | Free text dosage instructions e.g. SIG |
| site | 0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureAdministrationSites (example): A coded concept describing the site location the medicine enters into or onto the body. | |
| route | 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 | C | 0..1 | SimpleQuantity | Amount of medication per dose |
| rate[x] | C | 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 |
| MedicationAdministration.language | required | AllLanguages |
| MedicationAdministration.status | required | MedicationAdministrationStatusCodes |
| MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodes |
| MedicationAdministration.category | example | MedicationAdministrationLocationCodes |
| MedicationAdministration.medication | example | SNOMEDCTMedicationCodes |
| MedicationAdministration.subPotentReason | example | MedicationAdministrationSubpotentReason |
| MedicationAdministration.performer.function | example | MedicationAdministrationPerformerFunctionCodes |
| MedicationAdministration.reason | example | ReasonMedicationGivenCodes |
| MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureAdministrationSites |
| MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodes |
| MedicationAdministration.dosage.method | example | SNOMEDCTAdministrationMethodCodes |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mad-1 | error | MedicationAdministration.dosage | If dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x] : (dose.exists() or rate.exists() or text.exists()) |
This structure is derived from MedicationAdministration
Differential View
This structure is derived from MedicationAdministration
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationAdministration | 0..* | MedicationAdministration | Administration of medication to a patient | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationAdministration | 0..* | MedicationAdministration | Administration of medication to a patient | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministrationStatusCodes (required): A set of codes indicating the current status of a MedicationAdministration. |
| medication | Σ | 1..1 | CodeableReference(Medication) | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. |
| subject | Σ | 1..1 | Reference(Patient | Group) | Who received medication |
| occurence[x] | Σ | 1..1 | Specific date/time or interval of time during which the administration took place (or did not take place) | |
| occurenceDateTime | dateTime | |||
| occurencePeriod | Period | |||
| occurenceTiming | Timing | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationAdministration.status | required | MedicationAdministrationStatusCodes |
| MedicationAdministration.medication | example | SNOMEDCTMedicationCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationAdministration | 0..* | MedicationAdministration | Administration of medication to a patient | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier | External identifier | |
| basedOn | 0..* | Reference(CarePlan) | Plan this is fulfilled by this administration | |
| partOf | Σ | 0..* | Reference(MedicationAdministration | Procedure | MedicationDispense) | Part of referenced event |
| status | ?!Σ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministrationStatusCodes (required): A set of codes indicating the current status of a MedicationAdministration. |
| statusReason | 0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated. | |
| category | 0..* | CodeableConcept | Type of medication administration Binding: MedicationAdministrationLocationCodes (example): A coded concept describing where the medication administered is expected to occur. | |
| medication | Σ | 1..1 | CodeableReference(Medication) | What was administered Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. |
| subject | Σ | 1..1 | Reference(Patient | Group) | Who received medication |
| encounter | 0..1 | Reference(Encounter) | Encounter administered as part of | |
| supportingInformation | 0..* | Reference(Resource) | Additional information to support administration | |
| occurence[x] | Σ | 1..1 | Specific date/time or interval of time during which the administration took place (or did not take place) | |
| occurenceDateTime | dateTime | |||
| occurencePeriod | Period | |||
| occurenceTiming | Timing | |||
| recorded | Σ | 0..1 | dateTime | When the MedicationAdministration was first captured in the subject's record |
| isSubPotent | 0..1 | boolean | Full dose was not administered | |
| subPotentReason | 0..* | CodeableConcept | Reason full dose was not administered Binding: MedicationAdministrationSubpotentReason (example) | |
| performer | Σ | 0..* | BackboneElement | Who or what performed the medication administration and what type of performance they did |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | 0..1 | CodeableConcept | Type of performance Binding: MedicationAdministrationPerformerFunctionCodes (example): A code describing the role an individual played in administering the medication. | |
| actor | Σ | 1..1 | CodeableReference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who or what performed the medication administration |
| reason | 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Concept, condition or observation that supports why the medication was administered Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made. | |
| request | 0..1 | Reference(MedicationRequest) | Request administration performed against | |
| device | 0..* | CodeableReference(Device) | Device used to administer | |
| note | 0..* | Annotation | Information about the administration | |
| dosage | C | 0..1 | BackboneElement | Details of how medication was taken |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| text | C | 0..1 | string | Free text dosage instructions e.g. SIG |
| site | 0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureAdministrationSites (example): A coded concept describing the site location the medicine enters into or onto the body. | |
| route | 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 | C | 0..1 | SimpleQuantity | Amount of medication per dose |
| rate[x] | C | 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 |
| MedicationAdministration.language | required | AllLanguages |
| MedicationAdministration.status | required | MedicationAdministrationStatusCodes |
| MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodes |
| MedicationAdministration.category | example | MedicationAdministrationLocationCodes |
| MedicationAdministration.medication | example | SNOMEDCTMedicationCodes |
| MedicationAdministration.subPotentReason | example | MedicationAdministrationSubpotentReason |
| MedicationAdministration.performer.function | example | MedicationAdministrationPerformerFunctionCodes |
| MedicationAdministration.reason | example | ReasonMedicationGivenCodes |
| MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureAdministrationSites |
| MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodes |
| MedicationAdministration.dosage.method | example | SNOMEDCTAdministrationMethodCodes |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| mad-1 | error | MedicationAdministration.dosage | If dosage attribute is present then SHALL have at least one of dosage.text or dosage.dose or dosage.rate[x] : (dose.exists() or rate.exists() or text.exists()) |
This structure is derived from MedicationAdministration
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ Integrating the Healthcare Enterprise (IHE). Package ihe-fhir-pharm-medicationrecord#0.1.0 based on FHIR 5.0.0. Generated 2023-03-27
Links: Table of Contents |
QA Report
Version History |
|
Propose a change