This version of the PS-CA Implementation Guide has been superseded by a newer version. Other releases of the PS-CA Implementation Guide may be found on a table on the Home Page of this Project.
MedicationRequest (PS-CA)
Additional information on this profile (including the JSON & XML structure and detailed element descriptions) can be found at Medication Request (PS-CA)
Profile
MedicationRequest | I | MedicationRequest | Element IdMedicationRequest Ordering of medication for patient or group Alternate namesPrescription, Order DefinitionAn order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns. Jurisdictions mapping prescription data into FHIR profiles for the patient summary should support the MedicationRequest resource. Use of the MedicationStatement profile should be reserved for communicating a statement about the patient's usage of the medication that is ultimately provided by a patient, significant other, or a clinician. The MedicationRequest resource is not included in the current (as of November 2021) published release of IPS (release 1.0.0, STU1), but is in the development preview of the next release.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdMedicationRequest.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
RenderedDosageInstruction | I | 0..1 | Extension(string) | Element IdMedicationRequest.extension:RenderedDosageInstruction Extension for representing rendered dosage instruction. Alternate namesextensions, user content DefinitionA free form textual specification generated from the input specifications as created by the provider.This is made up of either an 'Ad-hoc instruction' or 'Textual rendition of the structured dosage lines', plus route, dosage unit, and other pertinent administration information specified by the provider. Use of structured fields for dosage instructions is heavily encouraged by this specification to promote interoperability of patient summaries. However, this extension is provided to make implementers aware that legacy medication data may come from some systems in this format. This extension is used by PrescribeIT implementations when the system has difficulty sending very complex dosage instructions in the form of structured data. Implementers are encouraged to read the PrescribeIT Specification (https://specs.prescribeit.ca/R5.0/erx/extension-ext-medication-rendered-dosage.html) to understand the context around its use. http://prescribeit.ca/fhir/StructureDefinition/ext-rendered-dosage-instruction Constraints
|
identifier | 0..* | Identifier | There are no (further) constraints on this element Element IdMedicationRequest.identifier External ids for this request DefinitionIdentifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. This is a business identifier, not a resource identifier.
| |
status | S Σ ?! | 1..1 | codeBinding | Element IdMedicationRequest.status active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown DefinitionA code specifying the current state of the order. Generally, this will be active or completed state. In the scope of the IPS the entered-in-error concept is not allowed. A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. medicationrequest Status (required)Constraints
|
statusReason | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdMedicationRequest.statusReason Reason for current status DefinitionCaptures the reason for the current state of the MedicationRequest. This is generally only used for "exception" statuses such as "suspended" or "cancelled". The reason why the MedicationRequest was created at all is captured in reasonCode, not here. Identifies the reasons for a given status. medicationRequest Status Reason Codes (example)Constraints
| |
intent | Σ ?! | 1..1 | codeBinding | Element IdMedicationRequest.intent proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option DefinitionWhether the request is a proposal, plan, or an original order. This element is considered mandatory in the Base FHIR R4 Specification. Base R4 Note: It is expected that the type of requester will be restricted for different stages of a MedicationRequest. For example, Proposals can be created by a patient, relatedPerson, Practitioner or Device. Plans can be created by Practitioners, Patients, RelatedPersons and Devices. Original orders can be created by a Practitioner only. An instance-order is an instantiation of a request or order and may be used to populate Medication Administration Record. This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. The kind of medication order. medicationRequest Intent (required)Constraints
|
category | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdMedicationRequest.category Type of medication usage DefinitionIndicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)). The category can be used to include where the medication is expected to be consumed or other types of requests. A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment. medicationRequest Category Codes (example)Constraints
| |
priority | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdMedicationRequest.priority routine | urgent | asap | stat DefinitionIndicates how quickly the Medication Request should be addressed with respect to other requests. Note that FHIR strings SHALL NOT exceed 1MB in size Identifies the level of importance to be assigned to actioning the request. RequestPriority (required)Constraints
|
doNotPerform | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element IdMedicationRequest.doNotPerform True if request is prohibiting action DefinitionIf true indicates that the provider is asking for the medication request not to occur. If do not perform is not specified, the request is a positive request e.g. "do perform".
|
reported[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdMedicationRequest.reported[x] Reported rather than primary record DefinitionIndicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.
| |
reportedBoolean | boolean | There are no (further) constraints on this element Data Type | ||
reportedReference | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | There are no (further) constraints on this element Data Type Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | ||
medication[x] | S Σ | 1..1 | Binding | Element IdMedicationRequest.medication[x] Medication to be taken DefinitionIdentifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code. To improve global interoperability is strongly encouraged that the reference to a medication resource is used, limiting the usage of the medicationCodeableConcept only to the cases in which no other information than a simple code is available. If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource. Unordered, Closed, by $this(Type) Binding A coded concept identifying substance or product that can be ordered. PrescriptionMedicinalProduct (preferred)Constraints
|
medicationReference | S Σ | 0..1 | Reference(Medication (PS-CA)) | Element IdMedicationRequest.medication[x]:medicationReference Medication to be taken DefinitionIdentifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications. If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource.
|
medicationCodeableConcept | S Σ | 0..1 | Data Type: Codeable Concept (PS-CA) | Element IdMedicationRequest.medication[x]:medicationCodeableConcept Code for the medication being administered DefinitionCode for the medication being administered. Future releases of PS-CA may require use of coded entries. In this release, however, implementations that support codings are encouraged to send the codings for codeable concepts if they are available. Consistent with FHIR best practice, receivers should not produce failures or rejections if codings are received. Vendors should expect that some jurisdictions may further constrain support of this element within the context of their own jurisdictional content. Data Type: Codeable Concept (PS-CA) BindingA coded concept identifying substance or product that can be ordered. SNOMEDCTMedicationCodes (example)Constraints
|
subject | S Σ I | 1..1 | Reference(Patient (PS-CA)) | Element IdMedicationRequest.subject Who or group medication request is for DefinitionA link to a resource representing the person or set of individuals to whom the medication will be given. The subject on a medication request is mandatory. For the secondary use case where the actual subject is not provided, there still must be an anonymized subject specified.
|
reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element IdMedicationRequest.subject.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdMedicationRequest.subject.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdMedicationRequest.subject.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedicationRequest.subject.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
encounter | I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element IdMedicationRequest.encounter Encounter created as part of encounter/admission/stay DefinitionThe Encounter during which this [x] was created or to which the creation of this record is tightly associated. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter." If there is a need to link to episodes of care they will be handled with an extension.
|
supportingInformation | I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element IdMedicationRequest.supportingInformation Information to support ordering of the medication DefinitionInclude additional information (for example, patient height and weight) that supports the ordering of the medication. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
authoredOn | S Σ | 0..1 | dateTime | Element IdMedicationRequest.authoredOn When request was initially authored DefinitionThe date (and perhaps time) when the prescription was initially written or authored on. This is a Must Support element in the CA Baseline that will likely make its way into the IPS-UV when/if they decide to profile MedicationRequest (likely at transition to R5). Included as preliminary analysis shows most participating systems could support this, further feedback and discussion is required on whether systems should be able to demonstrate this element for conformance
|
requester | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Element IdMedicationRequest.requester Who/What requested the Request DefinitionThe individual, organization, or device that initiated the request and has responsibility for its activation. IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content. Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Constraints
|
performer | I | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) | There are no (further) constraints on this element Element IdMedicationRequest.performer Intended performer of administration DefinitionThe specified desired performer of the medication treatment (e.g. the performer of the medication administration). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) Constraints
|
performerType | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdMedicationRequest.performerType Desired kind of performer of the medication administration DefinitionIndicates the type of performer of the administration of the medication. If specified without indicating a performer, this indicates that the performer must be of the specified type. If specified with a performer then it indicates the requirements of the performer if the designated performer is not available. Identifies the type of individual that is desired to administer the medication. ProcedurePerformerRoleCodes (example)Constraints
|
recorder | I | 0..1 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element IdMedicationRequest.recorder Person who entered the request DefinitionThe person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole) Constraints
|
reasonCode | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdMedicationRequest.reasonCode Reason or indication for ordering or not ordering the medication DefinitionThe reason or the indication for ordering or not ordering the medication. This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference. A coded concept indicating why the medication was ordered. Condition/Problem/DiagnosisCodes (example)Constraints
| |
reasonReference | I | 0..* | Reference(Condition | Observation) | There are no (further) constraints on this element Element IdMedicationRequest.reasonReference Condition or observation that supports why the prescription is being written DefinitionCondition or observation that supports why the medication was ordered. This is a reference to a condition or observation that is the reason for the medication order. If only a code exists, use reasonCode. Reference(Condition | Observation) Constraints
|
instantiatesCanonical | Σ | 0..* | canonical() | There are no (further) constraints on this element Element IdMedicationRequest.instantiatesCanonical Instantiates FHIR protocol or definition DefinitionThe URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.
|
instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element IdMedicationRequest.instantiatesUri Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
basedOn | Σ I | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | There are no (further) constraints on this element Element IdMedicationRequest.basedOn What request fulfills DefinitionA plan or request that is fulfilled in whole or in part by this medication request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) Constraints
|
groupIdentifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdMedicationRequest.groupIdentifier Composite request this is part of DefinitionA shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription. Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.
|
courseOfTherapyType | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdMedicationRequest.courseOfTherapyType Overall pattern of medication administration DefinitionThe description of the overall patte3rn of the administration of the medication to the patient. This attribute should not be confused with the protocol of the medication. Identifies the overall pattern of medication administratio. medicationRequest Course of Therapy Codes (example)Constraints
| |
insurance | I | 0..* | Reference(Coverage | ClaimResponse) | There are no (further) constraints on this element Element IdMedicationRequest.insurance Associated insurance coverage DefinitionInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Coverage | ClaimResponse) Constraints
|
note | 0..* | Annotation | There are no (further) constraints on this element Element IdMedicationRequest.note Information about the prescription DefinitionExtra information about the prescription that could not be conveyed by the other attributes. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
| |
dosageInstruction | S | 0..* | Dosage | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction How the medication should be taken DefinitionIndicates how the medication is to be used by the patient. There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, "Ondansetron 8mg orally or IV twice a day as needed for nausea" or "Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed.
|
sequence | Σ | 0..1 | integer | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.sequence The order of the dosage instructions DefinitionIndicates the order in which the dosage instructions should be applied or interpreted. If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential. 32 bit number; for values larger than this, use decimal
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.text Free text dosage instructions e.g. SIG DefinitionFree text dosage instructions e.g. SIG. Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text. Note that FHIR strings SHALL NOT exceed 1MB in size
|
additionalInstruction | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.additionalInstruction Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" DefinitionSupplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps"). Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, "Swallow with plenty of water" which might or might not be coded. Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or "immediately following drug x") should be populated in dosage.text. A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". SNOMEDCTAdditionalDosageInstructions (example)Constraints
|
patientInstruction | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.patientInstruction Patient or consumer oriented instructions DefinitionInstructions in terms that are understood by the patient or consumer. Note that FHIR strings SHALL NOT exceed 1MB in size
|
timing | Σ | 0..1 | Timing | Element IdMedicationRequest.dosageInstruction.timing When medication should be administered DefinitionWhen medication should be administered. The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content.
|
asNeeded[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.asNeeded[x] Take "as needed" (for x) DefinitionIndicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed". A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. SNOMEDCTMedicationAsNeededReasonCodes (example)Constraints
| |
asNeededBoolean | boolean | There are no (further) constraints on this element Data Type | ||
asNeededCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
site | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.site Body site to administer to DefinitionBody site to administer to. A coded specification of the anatomic site where the medication first enters the body. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both. A coded concept describing the site location the medicine enters into or onto the body. SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)Constraints
|
route | S Σ | 0..1 | CodeableConceptBinding | Element IdMedicationRequest.dosageInstruction.route How drug should enter body DefinitionHow drug should enter body. A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. SCTCA Route of Administration RouteOfAdministration (preferred)Constraints
|
coding | Σ | 0..* | Coding | Element IdMedicationRequest.dosageInstruction.route.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
routeEDQM | Σ | 0..1 | CodingBinding | Element IdMedicationRequest.dosageInstruction.route.coding:routeEDQM Optional slice for representing EDQM Standards Terms for route DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
routeSCTCA | Σ | 0..1 | CodingBinding | Element IdMedicationRequest.dosageInstruction.route.coding:routeSCTCA Optional slice for representing SNOMED CT CA Route of Administration Codes DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. RouteOfAdministration (required) Constraints
|
RouteOfAdministrationV3PrescribeIT | Σ | 0..* | CodingBinding | Element IdMedicationRequest.dosageInstruction.route.coding:RouteOfAdministrationV3PrescribeIT Optional slice for representing the route of admnistration for the prescription from the PrescribeIT value set. DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. PrescriptionRouteOfAdministration (required) Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.route.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
method | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.method Technique for administering medication DefinitionTechnique for administering medication. A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV. Terminologies used often pre-coordinate this term with the route and or form of administration. A coded concept describing the technique by which the medicine is administered. SNOMEDCTAdministrationMethodCodes (example)Constraints
|
doseAndRate | Σ | 0..* | Element | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate Amount of medication administered DefinitionThe amount of medication administered.
|
type | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.type The kind of dose or rate specified DefinitionThe kind of dose or rate specified, for example, ordered or calculated. If the type is not populated, assume to be "ordered". Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The kind of dose or rate specified. DoseAndRateType (example)Constraints
|
dose[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.dose[x] Amount of medication per dose DefinitionAmount of medication per dose. The amount of therapeutic or other substance given at one administration event. Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.
| |
doseRange | Range | There are no (further) constraints on this element Data Type | ||
doseQuantity | SimpleQuantity | There are no (further) constraints on this element Data Type | ||
rate[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.rate[x] Amount of medication per unit of time DefinitionAmount of medication per unit of time. Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammer where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.
| |
rateRatio | Ratio | There are no (further) constraints on this element Data Type | ||
rateRange | Range | There are no (further) constraints on this element Data Type | ||
rateQuantity | SimpleQuantity | There are no (further) constraints on this element Data Type | ||
maxDosePerPeriod | Σ I | 0..1 | Ratio | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.maxDosePerPeriod Upper limit on medication per unit of time DefinitionUpper limit on medication per unit of time. The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours. This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day".
|
maxDosePerAdministration | Σ I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.maxDosePerAdministration Upper limit on medication per administration DefinitionUpper limit on medication per administration. The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg.
|
maxDosePerLifetime | Σ I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.maxDosePerLifetime Upper limit on medication per lifetime of the patient DefinitionUpper limit on medication per lifetime of the patient. The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
dispenseRequest | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdMedicationRequest.dispenseRequest Medication supply authorization DefinitionIndicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
| |
initialFill | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdMedicationRequest.dispenseRequest.initialFill First fill details DefinitionIndicates the quantity or duration for the first dispense of the medication. If populating this element, either the quantity or the duration must be included.
| |
quantity | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dispenseRequest.initialFill.quantity First fill quantity DefinitionThe amount or quantity to provide as part of the first dispense. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
duration | I | 0..1 | Duration | There are no (further) constraints on this element Element IdMedicationRequest.dispenseRequest.initialFill.duration First fill duration DefinitionThe length of time that the first dispense is expected to last. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
dispenseInterval | I | 0..1 | Duration | There are no (further) constraints on this element Element IdMedicationRequest.dispenseRequest.dispenseInterval Minimum period of time between dispenses DefinitionThe minimum period of time that must occur between dispenses of the medication. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
validityPeriod | I | 0..1 | Period | Element IdMedicationRequest.dispenseRequest.validityPeriod Time period supply is authorized for DefinitionThis indicates the validity period of a prescription (stale dating the Prescription). Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription. IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content. IPS-UV also makes the element cardinality 1..1, with an invariate requiring a value or data-absent-reason extension.
|
numberOfRepeatsAllowed | 0..1 | unsignedInt | There are no (further) constraints on this element Element IdMedicationRequest.dispenseRequest.numberOfRepeatsAllowed Number of refills authorized DefinitionAn integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus "3 repeats", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense. If displaying "number of authorized fills", add 1 to this number.
| |
quantity | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dispenseRequest.quantity Amount of medication to supply per dispense DefinitionThe amount that is to be dispensed for one fill. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
expectedSupplyDuration | I | 0..1 | Duration | There are no (further) constraints on this element Element IdMedicationRequest.dispenseRequest.expectedSupplyDuration Number of days supply per dispense DefinitionIdentifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. In some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage). When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.
|
performer | I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdMedicationRequest.dispenseRequest.performer Intended dispenser DefinitionIndicates the intended dispensing Organization specified by the prescriber. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
substitution | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdMedicationRequest.substitution Any restrictions on medication substitution DefinitionIndicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.
| |
allowed[x] | 1..1 | There are no (further) constraints on this element Element IdMedicationRequest.substitution.allowed[x] Whether substitution is allowed or not DefinitionTrue if the prescriber allows a different drug to be dispensed from what was prescribed. This element is labeled as a modifier because whether substitution is allow or not, it cannot be ignored. Identifies the type of substitution allowed. v3.ActSubstanceAdminSubstitutionCode (example)Constraints
| ||
allowedBoolean | boolean | There are no (further) constraints on this element Data Type | ||
allowedCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
reason | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdMedicationRequest.substitution.reason Why should (not) substitution be made DefinitionIndicates the reason for the substitution, or why substitution must or must not be performed. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. v3.SubstanceAdminSubstitutionReason (example)Constraints
| |
priorPrescription | I | 0..1 | Reference(MedicationRequest) | There are no (further) constraints on this element Element IdMedicationRequest.priorPrescription An order/prescription that is being replaced DefinitionA link to a resource representing an earlier order related order or prescription. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
detectedIssue | I | 0..* | Reference(DetectedIssue) | There are no (further) constraints on this element Element IdMedicationRequest.detectedIssue Clinical Issue with action Alternate namesContraindication, Drug Utilization Review (DUR), Alert DefinitionIndicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc. This element can include a detected issue that has been identified either by a decision support system or by a clinician and may include information on the steps that were taken to address the issue.
|
eventHistory | I | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element IdMedicationRequest.eventHistory A list of events of interest in the lifecycle DefinitionLinks to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource. This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).
|
Extensions
This profile uses the following extensions:
MedicationRequest
: Rendered Dosage Instruction
Key Differences between the IPS-UV and PS-CA
Must Support Differences:
The following elements are considered Must Support in the IPS-UV specification (Continuous Integration build) that are relaxed in this version of the PS-CA profile:
MedicationRequest
MedicationRequest.requester
MedicationRequest.dosageInstruction.timing
MedicationRequest.dispenseRequest.validtityPeriod
and sub-elementsNote: Systems that support these elements are encouraged to send them in patient summaries
Cardinality Differences:
MedicationRequest.dispenseRequest.validityPeriod
minimum cardinality and associated invariant on extension removed.
Vocabulary Differences:
MedicationRequest.medicationCodeableConcept
- the base FHIR example SNOMED CT medication value set is replaced by PrescriptionMedicinalProduct
MedicatonRequest.route
- slices added for SNOMED CT Canadian edition RouteOfAdministration codes, PrescribeIT PrescriptionRouteOfAdministration codes (derived from HL7 v3)
- RouteOfAdministration indicated as preferred
Other differences between the IPS and PS-CA Include:
MedicationRequest
: comment added describing resource originMedicationRequest.subject
: reference target changed to Patient (PS-CA)MedicationRequest.medicationCodeableConcept
: comment added on possible future use of coded values.MedicationRequest.dosageInstruction.route
: IPS datatype profile removed