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/MedRecordDispense | Version: 0.1.0 | |||
| Active as of 2023-03-27 | Computable Name: MedRecordDispense | |||
Copyright/Legal: IHE http://www.ihe.net/Governance/#Intellectual_Property |
||||
The profile for Medication Dispense 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 MedicationDispense
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MedicationDispense | 0..* | MedicationDispense | Dispensing a medication to a named patient | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationDispense | C | 0..* | MedicationDispense | Dispensing a medication to a named 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 | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispenseStatusCodes (required): Describes the lifecycle of the dispense. |
 medication | Σ | 1..1 | CodeableReference(Medication) | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. |
 subject | Σ | 1..1 | Reference(Patient | Group) | Who the dispense is for |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationDispense.status | required | MedicationDispenseStatusCodes |
| MedicationDispense.medication | example | SNOMEDCTMedicationCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationDispense | 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 | MedicationDispense | 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 | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationDispense | 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() | |
| mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationDispense | C | 0..* | MedicationDispense | Dispensing a medication to a named 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 that is fulfilled by this dispense | |
| partOf | 0..* | Reference(Procedure | MedicationAdministration) | Event that dispense is part of | |
| status | ?!Σ | 1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispenseStatusCodes (required): Describes the lifecycle of the dispense. |
| notPerformedReason | 0..1 | CodeableReference(DetectedIssue) | Why a dispense was not performed Binding: MedicationDispenseStatusReasonCodes (example) | |
| statusChanged | 0..1 | dateTime | When the status changed | |
| category | 0..* | CodeableConcept | Type of medication dispense Binding: MedicationDispenseAdministrationLocationCodes (example): A code describing where the dispensed medication is expected to be consumed or administered. | |
| medication | Σ | 1..1 | CodeableReference(Medication) | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. |
| subject | Σ | 1..1 | Reference(Patient | Group) | Who the dispense is for |
| encounter | 0..1 | Reference(Encounter) | Encounter associated with event | |
| supportingInformation | 0..* | Reference(Resource) | Information that supports the dispensing of the medication | |
 performer | 0..* | BackboneElement | Who performed event | |
 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 | Who performed the dispense and what they did Binding: MedicationDispensePerformerFunctionCodes (example): A code describing the role an individual played in dispensing a medication. | |
| actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Individual who was performing | |
| location | 0..1 | Reference(Location) | Where the dispense occurred | |
| authorizingPrescription | 0..* | Reference(MedicationRequest) | Medication order that authorizes the dispense | |
| type | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc Binding: ActPharmacySupplyType (example): ActPharmacySupplyType | |
| quantity | 0..1 | SimpleQuantity | Amount dispensed | |
| daysSupply | 0..1 | SimpleQuantity | Amount of medication expressed as a timing amount | |
| recorded | 0..1 | dateTime | When the recording of the dispense started | |
| whenPrepared | ΣC | 0..1 | dateTime | When product was packaged and reviewed |
| whenHandedOver | C | 0..1 | dateTime | When product was given out |
| destination | 0..1 | Reference(Location) | Where the medication was/will be sent | |
| receiver | 0..* | Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole) | Who collected the medication or where the medication was delivered | |
| note | 0..* | Annotation | Information about the dispense | |
| renderedDosageInstruction | 0..1 | markdown | Full representation of the dosage instructions | |
| dosageInstruction | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | |
| substitution | 0..1 | BackboneElement | Whether a substitution was performed on the dispense | |
| 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 |
| wasSubstituted | 1..1 | boolean | Whether a substitution was or was not performed on the dispense | |
| type | 0..1 | CodeableConcept | Code signifying whether a different drug was dispensed from what was prescribed Binding: ActSubstanceAdminSubstitutionCode (example): ActSubstanceAdminSubstitutionCode | |
| reason | 0..* | CodeableConcept | Why was substitution made Binding: SubstanceAdminSubstitutionReason (example): SubstanceAdminSubstitutionReason | |
| responsibleParty | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who is responsible for the substitution | |
| eventHistory | 0..* | Reference(Provenance) | A list of relevant lifecycle events | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationDispense.language | required | AllLanguages |
| MedicationDispense.status | required | MedicationDispenseStatusCodes |
| MedicationDispense.notPerformedReason | example | MedicationDispenseStatusReasonCodes |
| MedicationDispense.category | example | MedicationDispenseAdministrationLocationCodes |
| MedicationDispense.medication | example | SNOMEDCTMedicationCodes |
| MedicationDispense.performer.function | example | MedicationDispensePerformerFunctionCodes |
| MedicationDispense.type | example | ActPharmacySupplyType |
| MedicationDispense.substitution.type | example | ActSubstanceAdminSubstitutionCode |
| MedicationDispense.substitution.reason | example | SubstanceAdminSubstitutionReason |
| 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() |
This structure is derived from MedicationDispense
Differential View
This structure is derived from MedicationDispense
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationDispense | 0..* | MedicationDispense | Dispensing a medication to a named patient | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationDispense | C | 0..* | MedicationDispense | Dispensing a medication to a named 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 | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispenseStatusCodes (required): Describes the lifecycle of the dispense. |
| medication | Σ | 1..1 | CodeableReference(Medication) | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. |
| subject | Σ | 1..1 | Reference(Patient | Group) | Who the dispense is for |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationDispense.status | required | MedicationDispenseStatusCodes |
| MedicationDispense.medication | example | SNOMEDCTMedicationCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationDispense | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationDispense | 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 | MedicationDispense | 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 | MedicationDispense | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationDispense | 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() | |
| mdd-1 | error | MedicationDispense | whenHandedOver cannot be before whenPrepared : whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationDispense | C | 0..* | MedicationDispense | Dispensing a medication to a named 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 that is fulfilled by this dispense | |
| partOf | 0..* | Reference(Procedure | MedicationAdministration) | Event that dispense is part of | |
| status | ?!Σ | 1..1 | code | preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown Binding: MedicationDispenseStatusCodes (required): Describes the lifecycle of the dispense. |
| notPerformedReason | 0..1 | CodeableReference(DetectedIssue) | Why a dispense was not performed Binding: MedicationDispenseStatusReasonCodes (example) | |
| statusChanged | 0..1 | dateTime | When the status changed | |
| category | 0..* | CodeableConcept | Type of medication dispense Binding: MedicationDispenseAdministrationLocationCodes (example): A code describing where the dispensed medication is expected to be consumed or administered. | |
| medication | Σ | 1..1 | CodeableReference(Medication) | What medication was supplied Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying which substance or product can be dispensed. |
| subject | Σ | 1..1 | Reference(Patient | Group) | Who the dispense is for |
| encounter | 0..1 | Reference(Encounter) | Encounter associated with event | |
| supportingInformation | 0..* | Reference(Resource) | Information that supports the dispensing of the medication | |
| performer | 0..* | BackboneElement | Who performed event | |
| 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 | Who performed the dispense and what they did Binding: MedicationDispensePerformerFunctionCodes (example): A code describing the role an individual played in dispensing a medication. | |
| actor | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | Individual who was performing | |
| location | 0..1 | Reference(Location) | Where the dispense occurred | |
| authorizingPrescription | 0..* | Reference(MedicationRequest) | Medication order that authorizes the dispense | |
| type | 0..1 | CodeableConcept | Trial fill, partial fill, emergency fill, etc Binding: ActPharmacySupplyType (example): ActPharmacySupplyType | |
| quantity | 0..1 | SimpleQuantity | Amount dispensed | |
| daysSupply | 0..1 | SimpleQuantity | Amount of medication expressed as a timing amount | |
| recorded | 0..1 | dateTime | When the recording of the dispense started | |
| whenPrepared | ΣC | 0..1 | dateTime | When product was packaged and reviewed |
| whenHandedOver | C | 0..1 | dateTime | When product was given out |
| destination | 0..1 | Reference(Location) | Where the medication was/will be sent | |
| receiver | 0..* | Reference(Patient | Practitioner | RelatedPerson | Location | PractitionerRole) | Who collected the medication or where the medication was delivered | |
| note | 0..* | Annotation | Information about the dispense | |
| renderedDosageInstruction | 0..1 | markdown | Full representation of the dosage instructions | |
| dosageInstruction | 0..* | Dosage | How the medication is to be used by the patient or administered by the caregiver | |
| substitution | 0..1 | BackboneElement | Whether a substitution was performed on the dispense | |
| 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 |
| wasSubstituted | 1..1 | boolean | Whether a substitution was or was not performed on the dispense | |
| type | 0..1 | CodeableConcept | Code signifying whether a different drug was dispensed from what was prescribed Binding: ActSubstanceAdminSubstitutionCode (example): ActSubstanceAdminSubstitutionCode | |
| reason | 0..* | CodeableConcept | Why was substitution made Binding: SubstanceAdminSubstitutionReason (example): SubstanceAdminSubstitutionReason | |
| responsibleParty | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who is responsible for the substitution | |
| eventHistory | 0..* | Reference(Provenance) | A list of relevant lifecycle events | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationDispense.language | required | AllLanguages |
| MedicationDispense.status | required | MedicationDispenseStatusCodes |
| MedicationDispense.notPerformedReason | example | MedicationDispenseStatusReasonCodes |
| MedicationDispense.category | example | MedicationDispenseAdministrationLocationCodes |
| MedicationDispense.medication | example | SNOMEDCTMedicationCodes |
| MedicationDispense.performer.function | example | MedicationDispensePerformerFunctionCodes |
| MedicationDispense.type | example | ActPharmacySupplyType |
| MedicationDispense.substitution.type | example | ActSubstanceAdminSubstitutionCode |
| MedicationDispense.substitution.reason | example | SubstanceAdminSubstitutionReason |
| 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() |
This structure is derived from MedicationDispense
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