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/MedRecordOrder | Version: 0.1.0 | |||
| Active as of 2023-03-27 | Computable Name: MedRecordOrder | |||
Copyright/Legal: IHE http://www.ihe.net/Governance/#Intellectual_Property |
||||
The profile for Medication Prescription in a Medication Record - a record of a order or request for a medication or a change of medication, implicit or explicit
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MedicationRequest | 0..* | MedicationRequest | Ordering of medication for patient or group | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest | 0..* | MedicationRequest | Ordering of medication for patient or group | |
  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 | active | on-hold | ended | stopped | completed | cancelled | entered-in-error | draft | unknown Binding: MedicationrequestStatus (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. |
| intent | ?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: MedicationRequestIntent (required): The kind of medication order. |
| doNotPerform | ?!Σ | 0..1 | boolean | True if patient is to stop taking or not to start taking the medication |
 medication | Σ | 1..1 | CodeableReference(Medication) | Medication to be taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. |
 subject | Σ | 1..1 | Reference(Patient | Group) | Individual or group for whom the medication has been requested |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationRequest.status | required | MedicationrequestStatus |
| MedicationRequest.intent | required | MedicationRequestIntent |
| MedicationRequest.medication | example | SNOMEDCTMedicationCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationRequest | 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 | MedicationRequest | 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 | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationRequest | 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 |
|---|---|---|---|---|
| MedicationRequest | 0..* | MedicationRequest | Ordering of medication for patient or group | |
| 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 ids for this request | |
| basedOn | Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | A plan or request that is fulfilled in whole or in part by this medication request |
| priorPrescription | 0..1 | Reference(MedicationRequest) | Reference to an order/prescription that is being replaced by this MedicationRequest | |
| groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of |
| status | ?!Σ | 1..1 | code | active | on-hold | ended | stopped | completed | cancelled | entered-in-error | draft | unknown Binding: MedicationrequestStatus (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. |
| statusReason | 0..1 | CodeableConcept | Reason for current status Binding: MedicationRequestStatusReasonCodes (example): Identifies the reasons for a given status. | |
| statusChanged | 0..1 | dateTime | When the status was changed | |
| intent | ?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: MedicationRequestIntent (required): The kind of medication order. |
| category | 0..* | CodeableConcept | Grouping or category of medication request Binding: MedicationRequestAdministrationLocationCodes (example): A coded concept identifying where the medication is to be consumed or administered. | |
| priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
| doNotPerform | ?!Σ | 0..1 | boolean | True if patient is to stop taking or not to start taking the medication |
| medication | Σ | 1..1 | CodeableReference(Medication) | Medication to be taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. |
| subject | Σ | 1..1 | Reference(Patient | Group) | Individual or group for whom the medication has been requested |
| informationSource | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | The person or organization who provided the information about this request, if the source is someone other than the requestor | |
| encounter | 0..1 | Reference(Encounter) | Encounter created as part of encounter/admission/stay | |
| supportingInformation | 0..* | Reference(Resource) | Information to support fulfilling of the medication | |
| authoredOn | Σ | 0..1 | dateTime | When request was initially authored |
| requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/What requested the Request |
| reported | Σ | 0..1 | boolean | Reported rather than primary record |
| performerType | Σ | 0..1 | CodeableConcept | Desired kind of performer of the medication administration Binding: MedicationIntendedPerformerRole (extensible): Identifies the type of individual that is desired to administer the medication. |
| performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | Patient | DeviceDefinition | RelatedPerson | CareTeam | HealthcareService) | Intended performer of administration | |
| device | 0..* | CodeableReference(DeviceDefinition) | Intended type of device for the administration | |
| recorder | 0..1 | Reference(Practitioner | PractitionerRole) | Person who entered the request | |
| reason | 0..* | CodeableReference(Condition | Observation) | Reason or indication for ordering or not ordering the medication Binding: ConditionProblemDiagnosisCodes (example): A coded concept indicating why the medication was ordered. | |
| courseOfTherapyType | 0..1 | CodeableConcept | Overall pattern of medication administration Binding: MedicationRequestCourseOfTherapyCodes (extensible): Identifies the overall pattern of medication administratio. | |
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |
| note | 0..* | Annotation | Information about the prescription | |
| renderedDosageInstruction | 0..1 | markdown | Full representation of the dosage instructions | |
| effectiveDosePeriod | 0..1 | Period | Period over which the medication is to be taken | |
| dosageInstruction | 0..* | Dosage | Specific instructions for how the medication should be taken | |
 dispenseRequest | 0..1 | BackboneElement | Medication supply authorization | |
 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 |
| initialFill | 0..1 | BackboneElement | First fill details | |
| 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 |
| quantity | 0..1 | SimpleQuantity | First fill quantity | |
| duration | 0..1 | Duration | First fill duration | |
| dispenseInterval | 0..1 | Duration | Minimum period of time between dispenses | |
| validityPeriod | 0..1 | Period | Time period supply is authorized for | |
| numberOfRepeatsAllowed | 0..1 | unsignedInt | Number of refills authorized | |
| quantity | 0..1 | SimpleQuantity | Amount of medication to supply per dispense | |
| expectedSupplyDuration | 0..1 | Duration | Number of days supply per dispense | |
| dispenser | 0..1 | Reference(Organization) | Intended performer of dispense | |
| dispenserInstruction | 0..* | Annotation | Additional information for the dispenser | |
| doseAdministrationAid | 0..1 | CodeableConcept | Type of adherence packaging to use for the dispense Binding: MedicationDoseAids (example) | |
| substitution | 0..1 | BackboneElement | Any restrictions on medication substitution | |
| 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 |
 allowed[x] | 1..1 | Whether substitution is allowed or not Binding: ActSubstanceAdminSubstitutionCode (preferred): Identifies the type of substitution allowed. | ||
| allowedBoolean | boolean | |||
| allowedCodeableConcept | CodeableConcept | |||
| reason | 0..1 | CodeableConcept | Why should (not) substitution be made Binding: SubstanceAdminSubstitutionReason (example): SubstanceAdminSubstitutionReason | |
| eventHistory | TU | 0..* | Reference(Provenance) | A list of events of interest in the lifecycle |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationRequest.language | required | AllLanguages |
| MedicationRequest.status | required | MedicationrequestStatus |
| MedicationRequest.statusReason | example | MedicationRequestStatusReasonCodes |
| MedicationRequest.intent | required | MedicationRequestIntent |
| MedicationRequest.category | example | MedicationRequestAdministrationLocationCodes |
| MedicationRequest.priority | required | RequestPriority |
| MedicationRequest.medication | example | SNOMEDCTMedicationCodes |
| MedicationRequest.performerType | extensible | MedicationIntendedPerformerRole |
| MedicationRequest.reason | example | ConditionProblemDiagnosisCodes |
| MedicationRequest.courseOfTherapyType | extensible | MedicationRequestCourseOfTherapyCodes |
| MedicationRequest.dispenseRequest.doseAdministrationAid | example | MedicationDoseAids |
| MedicationRequest.substitution.allowed[x] | preferred | ActSubstanceAdminSubstitutionCode |
| MedicationRequest.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 MedicationRequest
Differential View
This structure is derived from MedicationRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest | 0..* | MedicationRequest | Ordering of medication for patient or group | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationRequest | 0..* | MedicationRequest | Ordering of medication for patient or group | |
| 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 | active | on-hold | ended | stopped | completed | cancelled | entered-in-error | draft | unknown Binding: MedicationrequestStatus (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. |
| intent | ?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: MedicationRequestIntent (required): The kind of medication order. |
| doNotPerform | ?!Σ | 0..1 | boolean | True if patient is to stop taking or not to start taking the medication |
| medication | Σ | 1..1 | CodeableReference(Medication) | Medication to be taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. |
| subject | Σ | 1..1 | Reference(Patient | Group) | Individual or group for whom the medication has been requested |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationRequest.status | required | MedicationrequestStatus |
| MedicationRequest.intent | required | MedicationRequestIntent |
| MedicationRequest.medication | example | SNOMEDCTMedicationCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MedicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationRequest | 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 | MedicationRequest | 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 | MedicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationRequest | 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 |
|---|---|---|---|---|
| MedicationRequest | 0..* | MedicationRequest | Ordering of medication for patient or group | |
| 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 ids for this request | |
| basedOn | Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | A plan or request that is fulfilled in whole or in part by this medication request |
| priorPrescription | 0..1 | Reference(MedicationRequest) | Reference to an order/prescription that is being replaced by this MedicationRequest | |
| groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of |
| status | ?!Σ | 1..1 | code | active | on-hold | ended | stopped | completed | cancelled | entered-in-error | draft | unknown Binding: MedicationrequestStatus (required): A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. |
| statusReason | 0..1 | CodeableConcept | Reason for current status Binding: MedicationRequestStatusReasonCodes (example): Identifies the reasons for a given status. | |
| statusChanged | 0..1 | dateTime | When the status was changed | |
| intent | ?!Σ | 1..1 | code | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: MedicationRequestIntent (required): The kind of medication order. |
| category | 0..* | CodeableConcept | Grouping or category of medication request Binding: MedicationRequestAdministrationLocationCodes (example): A coded concept identifying where the medication is to be consumed or administered. | |
| priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
| doNotPerform | ?!Σ | 0..1 | boolean | True if patient is to stop taking or not to start taking the medication |
| medication | Σ | 1..1 | CodeableReference(Medication) | Medication to be taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying substance or product that can be ordered. |
| subject | Σ | 1..1 | Reference(Patient | Group) | Individual or group for whom the medication has been requested |
| informationSource | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | The person or organization who provided the information about this request, if the source is someone other than the requestor | |
| encounter | 0..1 | Reference(Encounter) | Encounter created as part of encounter/admission/stay | |
| supportingInformation | 0..* | Reference(Resource) | Information to support fulfilling of the medication | |
| authoredOn | Σ | 0..1 | dateTime | When request was initially authored |
| requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/What requested the Request |
| reported | Σ | 0..1 | boolean | Reported rather than primary record |
| performerType | Σ | 0..1 | CodeableConcept | Desired kind of performer of the medication administration Binding: MedicationIntendedPerformerRole (extensible): Identifies the type of individual that is desired to administer the medication. |
| performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | Patient | DeviceDefinition | RelatedPerson | CareTeam | HealthcareService) | Intended performer of administration | |
| device | 0..* | CodeableReference(DeviceDefinition) | Intended type of device for the administration | |
| recorder | 0..1 | Reference(Practitioner | PractitionerRole) | Person who entered the request | |
| reason | 0..* | CodeableReference(Condition | Observation) | Reason or indication for ordering or not ordering the medication Binding: ConditionProblemDiagnosisCodes (example): A coded concept indicating why the medication was ordered. | |
| courseOfTherapyType | 0..1 | CodeableConcept | Overall pattern of medication administration Binding: MedicationRequestCourseOfTherapyCodes (extensible): Identifies the overall pattern of medication administratio. | |
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |
| note | 0..* | Annotation | Information about the prescription | |
| renderedDosageInstruction | 0..1 | markdown | Full representation of the dosage instructions | |
| effectiveDosePeriod | 0..1 | Period | Period over which the medication is to be taken | |
| dosageInstruction | 0..* | Dosage | Specific instructions for how the medication should be taken | |
| dispenseRequest | 0..1 | BackboneElement | Medication supply authorization | |
| 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 |
| initialFill | 0..1 | BackboneElement | First fill details | |
| 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 |
| quantity | 0..1 | SimpleQuantity | First fill quantity | |
| duration | 0..1 | Duration | First fill duration | |
| dispenseInterval | 0..1 | Duration | Minimum period of time between dispenses | |
| validityPeriod | 0..1 | Period | Time period supply is authorized for | |
| numberOfRepeatsAllowed | 0..1 | unsignedInt | Number of refills authorized | |
| quantity | 0..1 | SimpleQuantity | Amount of medication to supply per dispense | |
| expectedSupplyDuration | 0..1 | Duration | Number of days supply per dispense | |
| dispenser | 0..1 | Reference(Organization) | Intended performer of dispense | |
| dispenserInstruction | 0..* | Annotation | Additional information for the dispenser | |
| doseAdministrationAid | 0..1 | CodeableConcept | Type of adherence packaging to use for the dispense Binding: MedicationDoseAids (example) | |
| substitution | 0..1 | BackboneElement | Any restrictions on medication substitution | |
| 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 |
| allowed[x] | 1..1 | Whether substitution is allowed or not Binding: ActSubstanceAdminSubstitutionCode (preferred): Identifies the type of substitution allowed. | ||
| allowedBoolean | boolean | |||
| allowedCodeableConcept | CodeableConcept | |||
| reason | 0..1 | CodeableConcept | Why should (not) substitution be made Binding: SubstanceAdminSubstitutionReason (example): SubstanceAdminSubstitutionReason | |
| eventHistory | TU | 0..* | Reference(Provenance) | A list of events of interest in the lifecycle |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationRequest.language | required | AllLanguages |
| MedicationRequest.status | required | MedicationrequestStatus |
| MedicationRequest.statusReason | example | MedicationRequestStatusReasonCodes |
| MedicationRequest.intent | required | MedicationRequestIntent |
| MedicationRequest.category | example | MedicationRequestAdministrationLocationCodes |
| MedicationRequest.priority | required | RequestPriority |
| MedicationRequest.medication | example | SNOMEDCTMedicationCodes |
| MedicationRequest.performerType | extensible | MedicationIntendedPerformerRole |
| MedicationRequest.reason | example | ConditionProblemDiagnosisCodes |
| MedicationRequest.courseOfTherapyType | extensible | MedicationRequestCourseOfTherapyCodes |
| MedicationRequest.dispenseRequest.doseAdministrationAid | example | MedicationDoseAids |
| MedicationRequest.substitution.allowed[x] | preferred | ActSubstanceAdminSubstitutionCode |
| MedicationRequest.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 MedicationRequest
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