FQL is a query language that allows you to retrieve, filter and project data from any data source containing FHIR Resources. It brings the power of three existing languages together: SQL, JSON and FhirPath. It allows you to create tables and is useful for gaining insight and perform quality control.
Query
-
Default
What is FQL?
-
FQL Query resources
FQL Playground
Try Firely Query Language in our playground by using this scope as data source.
- FQL Documentation
-
FQL Language
Syntax specification
To learn more about FQL syntax choose this menu item.
-
YamlGen Generate resources
YamlGen Playground
Try YamlGen in our playground by using this scope as data source.
-
YamlGen Language
YamlGen Syntax specification
To learn more about YamlGen syntax choose this.
-
FHIRPath Inspect resource
FHIRPath Playground
Try out the FHIRPath playground and navigate inside this resource.
-
FHIRPath Documentation
FHIRPath Documentation
Find out what FHIRPath is or learn how to write FHIRPath scripts.
API
-
Project FHIR API
This is the location where you can find your resource using a FHIR client.
-
Simplifier FHIR API
The global endpoint is where users can search for all resources in Simplifier. Resources have a globally unique guid Id here.
Tools
-
Custom Example generation
Custom Example generation beta
Experiment with resource instance generation using YamlGen and based on this profile.
This feature is in beta. You can help us improve it by giving feedback with the feedback button at the top of the screen.
Organization Canadian FHIR Registry /
Project ACCESS Gateway EHR Specification
ACCESS MedicationRequest (Patient) Profile
Constraints on the MedicationRequest resource to reflect source data mappings for the ACCESS Health project. Focus of this profile is on display of medication request information to citizen/patient viewers.
- type Profile on MedicationRequest
- FHIR R4
- status Authoring
-
version0.1.0
Missing canonical claim
The canonical from this resource does not match any claims.
Canonical claims are used to verify ownership of your canonical URLs.
Canonical
| AccessMedicationRequest-Pat (MedicationRequest) | I | MedicationRequest | Element idMedicationRequest ACCESS MedicationRequest (Patient) Profile 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.
| |
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idMedicationRequest.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idMedicationRequest.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idMedicationRequest.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedicationRequest.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language. | |
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idMedicationRequest.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
| contained | 0..* | Resource | There are no (further) constraints on this element Element idMedicationRequest.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
| extension | 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.
| |
| modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idMedicationRequest.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
| identifier | 0..* | Identifier | 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. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Mapping Note: Implementors need to be aware that the Act Status Codes recommended by CeRX only partially match the codes to the MedicationRequest status (required) value set. MedicationRequest Status Codes
|
| statusReason | 0..1 | CodeableConcept | Element idMedicationRequest.statusReason Reason for current status DefinitionCaptures the reason for the current state of the MedicationRequest. Mapping Note: The mappable value from CeRX ActDetectedIssueCode value set is not semantically perfect. Conversion for this FHIR element should be limited to non-active statuses because the only semantic similar CeRX field that was found relates to reasons for refusal to fill or detected issue statuses. MedicationRequest Status Reason Codes
| |
| intent | S Σ | 1..1 | codeBinding | Element idMedicationRequest.intent proposal | plan | order | original-order | instance-order | option DefinitionWhether the request is a proposal, plan, or an original order. SME Note: From a mapping perspective, the requests that exist in V3 systems today would have RQO as the mood code. This would map to ""order"" for MedicationRequest.intent. Given that this profile focuses on FHIR resources generated from CeRX messages by Canadian Drug Information Systems, the codes most likely applicable from the required value set are: ""order"", ""plan"", and ""proposal"" SME Note: From a mapping perspective, the requests that exist in V3 systems today would have RQO as the mood code. This would map to ""order"" for MedicationRequest.intent. If patient requests are supported in the future, these would be an intent of "proposal". MedicationRequest Intent
|
| 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.
| |
| 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. Identifies the level of importance to be assigned to actioning the request.
|
| 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 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. Implementors need to be aware that the medication codes utilized by the source DIS will likely come from the Clinical Drug CeRX value set (https://infocentral.infoway-inforoute.ca/extra/ns/cerx43-html/html/vocabulary.html?type=vs&id=ClinicalDrug) which draws in codes from various other code systems (HC-DIN, HC-NPN, HC-AIGC, etc.). There is currently no equivalent FHIR value set that supports this superset to recommend when binding. Implementors need to be aware that the medication codes utilized by the source DIS will likely come from the Clinical Drug CeRX value set (https://infocentral.infoway-inforoute.ca/extra/ns/cerx43-html/html/vocabulary.html?type=vs&id=ClinicalDrug) which draws in codes from various other code systems (HC-DIN, HC-NPN, HC-AIGC, etc.). There is currently no equivalent FHIR value set that supports this superset to recommend when binding. Canadian Clinical Drug Data (CCDD) Medicinal Products
|
| medicationCodeableConcept | CodeableConcept | Data type | ||
| medicationReference | Reference(http://hl7.org/fhir/ca/core/StructureDefinition/profile-medication) | Data type Reference(http://hl7.org/fhir/ca/core/StructureDefinition/profile-medication) | ||
| subject | S Σ | 1..1 | Reference(http://hl7.org/fhir/ca/core/StructureDefinition/profile-patient) | Element idMedicationRequest.subject Who 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(http://hl7.org/fhir/ca/core/StructureDefinition/profile-patient) Mappings
|
| encounter | 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 | 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.
| |
| 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.
|
| requester | S Σ | 0..1 | Reference(http://hl7.org/fhir/ca/core/StructureDefinition/profile-practitioner) | Element idMedicationRequest.requester Who/What requested the MedicationRequest DefinitionThe individual, organization, or device that initiated the request and has responsibility for its activation. Reference(http://hl7.org/fhir/ca/core/StructureDefinition/profile-practitioner) Mappings
|
| performer | 0..1 | Reference(http://hl7.org/fhir/ca/core/StructureDefinition/profile-practitioner | http://hl7.org/fhir/ca/core/StructureDefinition/profile-organization) | Element idMedicationRequest.performer Intended performer of administration or dispense DefinitionThe specified desired performer of the medication treatment (e.g. the performer of the medication administration). SME Note: While this is allowed as optional and the CeRX specification supports the mappable data element, it is unlikely to be frequently populated since most prescribers don't specify who should administer or what their role is. Reference(http://hl7.org/fhir/ca/core/StructureDefinition/profile-practitioner | http://hl7.org/fhir/ca/core/StructureDefinition/profile-organization) Mappings
| |
| 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.
|
| recorder | 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. Reference(Practitioner | PractitionerRole) Mappings
| |
| reasonCode | 0..* | CodeableConcept | 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. Condition/Problem/DiagnosisCodes
| |
| reasonReference | 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) Mappings
| |
| 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.
|
| basedOn | Σ | 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. Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) Mappings
|
| 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 | CodeableConceptBinding | 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. v3 ActCode
| |
| insurance | 0..* | Reference(Coverage) | 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. SME Note: The frequency in which insurance is recorded in CeRX messages is unclear but the specification supports it.
| |
| note | 0..* | Annotation | Element idMedicationRequest.note Information about the prescription DefinitionExtra information about the prescription that could not be conveyed by the other attributes.
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idMedicationRequest.note.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | 0..* | Extension | There are no (further) constraints on this element Element idMedicationRequest.note.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 element. 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) Extensions are always sliced by (at least) url Mappings
| |
| author[x] | Σ | 0..1 | There are no (further) constraints on this element Element idMedicationRequest.note.author[x] Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment. Unordered, Open, by $this(Type) Mappings
| |
| (All Slices) | There are no (further) constraints on this element | |||
| authorString | string | There are no (further) constraints on this element Data type | ||
| authorReference | Σ | 0..1 | Reference(http://hl7.org/fhir/ca/core/StructureDefinition/profile-practitioner | http://hl7.org/fhir/ca/core/StructureDefinition/profile-organization | http://hl7.org/fhir/ca/core/StructureDefinition/profile-patient | RelatedPerson) | Element idMedicationRequest.note.author[x]:authorReference Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment. Reference(http://hl7.org/fhir/ca/core/StructureDefinition/profile-practitioner | http://hl7.org/fhir/ca/core/StructureDefinition/profile-organization | http://hl7.org/fhir/ca/core/StructureDefinition/profile-patient | RelatedPerson) Mappings
|
| time | Σ | 0..1 | dateTime | Element idMedicationRequest.note.time When the note was made DefinitionIndicates when this particular annotation was made.
|
| text | Σ | 1..1 | markdown | Element idMedicationRequest.note.text The annotation - text content (as markdown) DefinitionThe text of the annotation in markdown format.
|
| dosageInstruction | S | 0..* | Dosage | 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | 0..* | Extension | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.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 element. 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) Extensions are always sliced by (at least) url Mappings
| |
| modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
| sequence | Σ | 0..1 | integer | 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.
|
| text | S Σ | 1..1 | string | 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.
|
| 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".
|
| 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.
|
| timing | Σ | 0..1 | Timing | There are no (further) constraints on this element 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. This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing.
|
| 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.
| |
| 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.
|
| route | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element 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. A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
|
| method | Σ | 0..1 | CodeableConcept | 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.
|
| doseAndRate | Σ | 0..* | Element | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.doseAndRate Amount of medication administered DefinitionThe amount of medication administered.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.doseAndRate.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | 0..* | Extension | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction.doseAndRate.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 element. 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) Extensions are always sliced by (at least) url Mappings
| |
| 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". The kind of dose or rate specified.
|
| 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 | Σ | 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 | Σ | 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 | Σ | 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.
|
| dispenseRequest | S | 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | 0..* | Extension | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.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 element. 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.
| |
| modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
| 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.
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.initialFill.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | 0..* | Extension | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.initialFill.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 element. 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.
| |
| modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idMedicationRequest.dispenseRequest.initialFill.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
| quantity | 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.
| |
| duration | 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.
| |
| dispenseInterval | 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.
| |
| validityPeriod | 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. It reflects the prescribers' perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations.
| |
| numberOfRepeatsAllowed | S | 0..1 | unsignedInt | 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 | S | 0..1 | SimpleQuantity | Element idMedicationRequest.dispenseRequest.quantity Amount of medication to supply per dispense DefinitionThe amount that is to be dispensed for one fill.
|
| expectedSupplyDuration | 0..1 | Duration | 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 | 0..1 | Reference(http://hl7.org/fhir/ca/core/StructureDefinition/profile-organization) | Element idMedicationRequest.dispenseRequest.performer Intended dispenser DefinitionIndicates the intended dispensing Organization specified by the prescriber. SME Note: This element would indicate where the prescriber expects the prescription to be dispensed. Sometimes useful for the clinician and patient to know, but should be confirmed with end-users. Reference(http://hl7.org/fhir/ca/core/StructureDefinition/profile-organization) Mappings
| |
| substitution | 0..1 | BackboneElement | 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.
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idMedicationRequest.substitution.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | 0..* | Extension | There are no (further) constraints on this element Element idMedicationRequest.substitution.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 element. 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.
| |
| modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idMedicationRequest.substitution.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
| 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. Unordered, Open, by $this(Type) BindingIdentifies the type of substitution allowed.
| ||
| (All Slices) | There are no (further) constraints on this element | |||
| allowedCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
| allowedBoolean | 0..1 | boolean | Element idMedicationRequest.substitution.allowed[x]:allowedBoolean Whether substitution is allowed or not DefinitionTrue if the prescriber allows a different drug to be dispensed from what was prescribed. Mapping Note: CeRX has two ways of expressing substitution permission. If it's not allowed, a boolean "false" response for negationInd will be present. If it is allowed substitutionPermission.code will default to "G" which is a codeableconcept ties to the Act Code System.
| |
| 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. A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.
| |
| priorPrescription | 0..1 | Reference(ACCESS MedicationRequest (Clinician) Profile) | Element idMedicationRequest.priorPrescription An order/prescription that is being replaced DefinitionA link to a resource representing an earlier order related order or prescription. Reference(ACCESS MedicationRequest (Clinician) Profile) Mappings
| |
| detectedIssue | 0..* | Reference(DetectedIssue) | Element idMedicationRequest.detectedIssue Clinical Issue with the 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 | 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.).
|
Last updated on