HdBe-MedicationAgreement
Profile | Description | Status | URL |
---|---|---|---|
HdBe-MedicationAgreement | A medication agreement is a prescriber’s proposal for a patient to use medication. An agreement to discontinue the use of medication is also a medication agreement. | draft | https://fhir.healthdata.be/StructureDefinition/HdBe-MedicationAgreement |
MedicationRequest | I | MedicationRequest | Element IdMedicationRequest MedicationAgreement Alternate namesPrescription, Order, Medicatieafspraak 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.
| |
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
|
medicationAgreementAdditionalInformation | I | 0..* | Extension(CodeableConcept) | Element IdMedicationRequest.extension:medicationAgreementAdditionalInformation Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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.
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.extension:medicationAgreementAdditionalInformation.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-MedicationAgreement.AdditionalInformation
| |
value[x] | 0..1 | Binding | Element IdMedicationRequest.extension:medicationAgreementAdditionalInformation.value[x] MedicationAgreementAdditionalInformation Alternate namesMedicatieafspraakAanvullendeInformatie DefinitionAdditional information includes details on the structure of the agreement made that are relevant for pharmacovigilance and fulfillment by the pharmacist. This can be used e.g. to indicate that there was a conscious decision to deviate from the norm or that the agreement is to be structured in a certain way. MedicationAgreementAdditionalInformation (required) Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
renderedDosageInstruction | I | 0..1 | Extension(string) | Element IdMedicationRequest.extension:renderedDosageInstruction Optional Extensions Element Alternate namesextensions, user content DefinitionPre-adopt from FHIR R5 of the 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. https://fhir.healthdata.be/StructureDefinition/ext-RenderedDosageInstruction Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.extension:renderedDosageInstruction.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-RenderedDosageInstruction
| |
value[x] | 0..1 | Element IdMedicationRequest.extension:renderedDosageInstruction.value[x] Description Alternate namesOmschrijving DefinitionTextual description of the complete instructions for use including the period of use. The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
periodOfUse | I | 0..1 | Extension(HdBe-TimeInterval) | Element IdMedicationRequest.extension:periodOfUse Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. https://fhir.healthdata.be/StructureDefinition/ext-TimeInterval.Period Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-TimeInterval.Period
| |
value[x] | I | 0..1 | Element IdMedicationRequest.extension:periodOfUse.value[x] PeriodOfUse Alternate namesGebruiksperiode DefinitionStart date: This is the time at which the agreement was to take effect (or took effect or will take effect). This is the time at which the instructions for use in this agreement start. In the case of an agreement to discontinue use, this is the start date of the original medication agreement. The end date indicates from when the medication is to be discontinued. Duration: The intended duration of use. E.g. 5 days or 8 weeks. It is not allowed to indicate the duration in months, because different months have a variable duration in days. End date: The time at which the period of use ends (or ended or will end). In the case of an agreement to discontinue use, this is the time at which the medication is to be discontinued. To avoid confusion between 'to' and 'up to', the submission of time is always mandatory for the end date. With medication for an indefinite period only a start date is indicated. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |
valuePeriod | HdBe-TimeInterval | There are no (further) constraints on this element Data Type | ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].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) Constraints
|
duration | I | 0..1 | Extension(Duration) | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].extension:duration Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. https://fhir.healthdata.be/StructureDefinition/ext-TimeInterval.Duration Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].extension:duration.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-TimeInterval.Duration
| |
value[x] | 0..1 | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].extension:duration.value[x] Duration Alternate namestijdsDuur DefinitionThe duration of the interval in appropriate units of time (e.g. days or hours, etc.
| ||
valueDuration | Duration | There are no (further) constraints on this element Data Type | ||
start | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].start startDateTime Alternate namesstartDatumTijd DefinitionThe start date and time of the interval If the low element is missing, the meaning is that the low boundary is not known.
|
end | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].end endDateTime Alternate nameseindDatumTijd DefinitionThe end date and time of the interval The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing
|
modifierExtension | ?! I | 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. Unordered, Open, by url(Value) Constraints
|
stopType | ?! I | 0..1 | Extension(CodeableConcept) | Element IdMedicationRequest.modifierExtension:stopType Optional Extensions Element Alternate namesextensions, user content DefinitionThis StopType ModifierExtension works differently than the For example: suppose you want the patient to stop taking medication definitively three days from today. This is a stop medication agreement with a StopType of definitive. However today, tomorrow and the day after tomorrow the 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. https://fhir.healthdata.be/StructureDefinition/ext-StopType Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.modifierExtension:stopType.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-StopType
| |
value[x] | 0..1 | Binding | Element IdMedicationRequest.modifierExtension:stopType.value[x] MedicationAgreementStopType Alternate namesMedicatieafspraakStopType DefinitionStop type, the manner in which this medication is discontinued (temporary or definitive). MedicationAgreementStopType, AdministrationAgreementStopType and MedicationUseStopType all have a bound ValueSet that contain the exact same StopType values. These are represented in the CBB with the same Valueset. This MedicationStopType is used to bind to this extension and reusing this extension for all three concepts. StopType values, based on the valueset named MedicatioStopType, which are applicable for StopType in MedicationAgreement, AdministrationAgreement and MedicationUse. MedicationStopType (required)Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
repeatPeriodCyclicalSchedule | ?! I | 0..1 | Extension(Duration) | Element IdMedicationRequest.modifierExtension:repeatPeriodCyclicalSchedule Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. https://fhir.healthdata.be/StructureDefinition/ext-InstructionsForUse.RepeatPeriodCyclicalSchedule Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.modifierExtension:repeatPeriodCyclicalSchedule.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-InstructionsForUse.RepeatPeriodCyclicalSchedule
| |
value[x] | 0..1 | Element IdMedicationRequest.modifierExtension:repeatPeriodCyclicalSchedule.value[x] RepeatPeriodCyclicalSchedule Alternate namesHerhaalperiodeCyclischSchema DefinitionThe repeated period in a cyclical schedule (of one or more dosing instructions). A cyclic schedule is noted in days, the corresponding dosing duration is also in days. Examples of a cyclical schedule:
| ||
valueDuration | Duration | There are no (further) constraints on this element Data Type | ||
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 | Σ ?! | 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 implictly mapped to the CBB concepts period_of_use medication_agreement_stop_type. Unless the status is explicitly recorded, the following guidance applies:
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 DefinitionUnless 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 | 1..* | CodeableConcept | 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. Unordered, Open, by $this(Value) Binding 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
| |
medicationAgreementCode | 1..1 | CodeableConceptPattern | Element IdMedicationRequest.category:medicationAgreementCode 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
{ "coding": [ { "system": "http://snomed.info/sct", "code": "16076005" } ] }
| |
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] | Σ | 1..1 | 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. Unordered, Open, by $this(Type) Binding A coded concept identifying substance or product that can be ordered. SNOMEDCTMedicationCodes (example)Constraints
| |
medicationCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
medicationReference | Σ | 0..1 | Reference(Medication | HdBe-PharmaceuticalProduct) | Element IdMedicationRequest.medication[x]:medicationReference AgreedMedicine Alternate namesAfgesprokengeneesmiddel DefinitionThe medicine agreed upon to be used. 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. Reference(Medication | HdBe-PharmaceuticalProduct) Constraints
|
subject | Σ I | 1..1 | Reference(Group | HdBe-Patient) | 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(Group | HdBe-Patient) Constraints
|
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 | Σ | 0..1 | dateTime | Element IdMedicationRequest.authoredOn MedicationAgreementDateTime Alternate namesMedicatieafspraakDatumTijd DefinitionThe time at which the agreement was made. Appointment date + time are required (order of the appointments must be clear in cases with multiple appointments on one day).
|
requester | Σ I | 0..1 | pattern HealthProfessional Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | HdBe-HealthProfessional PractitionerRole) | Element IdMedicationRequest.requester Prescriber Alternate namesVoorschrijver DefinitionThe health professional that entered the medication agreement with the patient. Each occurrence of the CBB HealthProfessional is normally represented by two FHIR resources: a PractitionerRole resource (instance of HdBe-HealthProfessional-PractitionerRole) and a Practitioner resource (instance of HdBe-HealthProfessional-Practitioner). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance. In rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the HdBe-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile. pattern HealthProfessional Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | HdBe-HealthProfessional PractitionerRole) 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..1 | CodeableConceptBinding | Element IdMedicationRequest.reasonCode ReasonMedicationAgreement Alternate namesRedenMedicatieafspraak DefinitionReason for this agreement. This can be the reason to start, change or stop the medication treatment. 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. MedicationReason (required)Constraints
| |
reasonReference | I | 0..1 | Reference(Condition | Observation | HdBe-Problem) | Element IdMedicationRequest.reasonReference PrescriptionReason Alternate namesRedenVanVoorschrijven DefinitionThe medical reason for the prescription or for use of the medication. This can be used to enter a medical indication which was the direct cause for prescription or for use of the medication in question. It can concern every type of problem (or condition) of the patient, almost all diagnoses, complaints or symptoms. 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 | HdBe-Problem) 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..1 | 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).
| |
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.
| |
authorString | string | There are no (further) constraints on this element Data Type | ||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Data Type Reference(Practitioner | Patient | RelatedPerson | Organization) | ||
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdMedicationRequest.note.time When the annotation was made DefinitionIndicates when this particular annotation was made.
|
text | Σ | 1..1 | markdown | Element IdMedicationRequest.note.text Comment Alternate namesToelichting DefinitionComments regarding to the medication agreement. For example: in consultation with the medical specialist. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
|
dosageInstruction | 0..* | HdBe-InstructionsForUse.DosageInstructions | Element IdMedicationRequest.dosageInstruction DosingInstructions / InstructionsForUse Alternate namesDoseerinstructie, Gebruiksinstructie DefinitionInstructions for the use of the medication, e.g. dose and route of administration. This element mostly represents the DosingInstructions container from CBB InstructionsForUse, but also includes the AdditionalInstructions and RouteOfAdministration concepts, which are normally placed on the same level as this container. As a result, these concepts are duplicated in every repetition of this element, even though these concepts should be present just once according to the CBB. The RepeatPeriodCyclicalSchedule and Description elements of the CBB are not represented in this profile. When a HdBe profile contains a InstructionsForUse.DosageInstructions datatype, the RepeatPeriodCyclicalSchedule and Description elements are separately added to this profile as well. This element does not contain a mapping to the Dosage container from CBB InstructionsForUse. However, the child concepts of Dosage are all mapped. Multiple Dosage instances are represented by another DosingInstructions that contains a similiar SequenceNumber. HdBe-InstructionsForUse.DosageInstructions Constraints
| |
sequence | Σ | 0..1 | integer | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.sequence SequenceNumber Alternate namesVolgnummer DefinitionThis indicates the sequence of the dosing instructions within the medication agreement. 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 | Σ | 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 AdditionalInstructions Alternate namesAanvullendeInstructie DefinitionThe additional instructions contain extra information on the use of the current prescription. This includes all instructions for use. The text can come from the original “paper" medication prescription, but can also be generated from the coded information. This concept may contain more information than what is structurally coded in the information below, but may not conflict with it. The instructions may not conflict with other components of the request for administration. The instructions can also refer to an existing protocol. 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. Please note that in contrast to the CBB, this AdditionalInstructions concept is grouped under the DosingInstructions concept. This CBB concept should thus be duplicated when there are multiple DosingInstructions. 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 | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing AdministeringSchedule Alternate namesToedieningsschema DefinitionSpecifications of the times at which the medication is to be administered. This is indicated as follows:
If a certain medication is not to be taken daily, the aforementioned can be combined with daily indications:
The specified administration “infinite” is automatically to be repeated until:
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.
|
event | Σ | 0..* | dateTime | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.event When the event occurs DefinitionIdentifies specific times when the event occurs. In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
|
repeat | Σ I | 0..1 | Element | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat When the event is to occur DefinitionA set of rules that describe when the event is scheduled. Many timing schedules are determined by regular repetitions.
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.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) Constraints
|
timingExact | I | 0..1 | Extension(boolean) | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.extension:timingExact Whether specified times must be followed as closely as possible Alternate namesextensions, user content DefinitionIf true, indicates that the specified times, frequencies, periods are expected to be adhered to as precisely as possible. If false, indicates that a typical degree of variability based on institutional and/or patient convenience is acceptable. 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. http://hl7.org/fhir/StructureDefinition/timing-exact Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.extension:timingExact.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/timing-exact
| |
value[x] | 1..1 | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.extension:timingExact.value[x] Value of extension DefinitionIndicates that the timing as specified by The times can be chosen freely, but distribution throughout the day is more precise, and the interval between times is important (e.g. in the case of antibiotics) In the case of Baxter packs and intramural care, such a prescription is used to draw up a (location-specific) outline for distribution times (logistics). Notes on the CBB concepts Frequency and Interval:
In summary:
| ||
valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
bounds[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.bounds[x] Length/Range of lengths, or (Start and/or end) limits DefinitionEither a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. Unordered, Open, by $this(Type) Constraints
| |
boundsRange | Range | There are no (further) constraints on this element Data Type | ||
boundsPeriod | Period | There are no (further) constraints on this element Data Type | ||
boundsDuration | Σ | 0..1 | Duration | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.bounds[x]:boundsDuration DoseDuration Alternate namesDoseerduur DefinitionThe intended time duration for these dosing instructions, e.g. 5 days or 8 weeks. In the case of medication for an indefinite period, the dosing duration is left empty in the last dosing instruction.
|
count | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.count Frequency / minimumValue / nominalValue Alternate namesFrequentie, nominaleWaarde, minimumWaarde DefinitionUsually, frequency comprises both amount and time unit (3 times a day), but it can occur without the time unit (single use). This is represented by this A reasonable distribution over the day is expected, but exact times are not given. This is left to the patient. It is the most common manner of extramural prescription. In the case of Baxter packs and intramural care, such a prescription is used to draw up a (location-specific) outline for distribution times (logistics). Repetitions may be limited by end time or total occurrences. Notes on the CBB concepts Frequency and Interval:
In summary:
|
countMax | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.countMax Frequency / maximumValue Alternate namesFrequentie, maximumWaarde DefinitionUsually, frequency comprises both amount and time unit (3 times a day), but it can occur without the time unit (single use). This is represented by the A reasonable distribution over the day is expected, but exact times are not given. This is left to the patient. It is the most common manner of extramural prescription. In the case of Baxter packs and intramural care, such a prescription is used to draw up a (location-specific) outline for distribution times (logistics). Notes on the CBB concepts Frequency and Interval:
In summary:
|
duration | Σ | 0..1 | decimal | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.duration DurationOfAdministration Alternate namesToedieningsduur DefinitionThe duration of administration defines the length of time during which the drug is administered and is mainly used in the slow parenteral administration of fluids. The Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
|
durationMax | Σ | 0..1 | decimal | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.durationMax How long when it happens (Max) DefinitionIf present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
|
durationUnit | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.durationUnit DurationOfAdministration Alternate namesToedieningsduur DefinitionThe units of time, in UCUM units, for the duration of administration of time during which the drug is administered. Note that FHIR strings SHALL NOT exceed 1MB in size A unit of time (units from UCUM). UnitsOfTime (required)Constraints
|
frequency | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.frequency Frequency / minimumValue / nominalValue / Interval Alternate namesFrequentie, minimumWaarde, nominaleWaarde, Interval DefinitionThe number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency. If the If the Notes on the CBB concepts Frequency and Interval:
In summary:
If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
|
frequencyMax | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.frequencyMax Frequency / maximumValue Alternate namesmaximumWaarde, Frequentie DefinitionIf present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. If the If the Notes on the CBB concepts Frequency and Interval:
In summary:
|
period | Σ | 0..1 | decimal | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.period Frequency / Interval Alternate namesFrequentie, Interval DefinitionIndicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length. If the If the Notes on the CBB concepts Frequency and Interval:
In summary:
|
periodMax | Σ | 0..1 | decimal | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.periodMax Upper limit of period (3-4 hours) DefinitionIf present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
periodUnit | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.periodUnit Frequency / Interval Alternate namesFrequentie, Interval DefinitionThe units of time for the period in UCUM units for Frequency and Interval. If the If the Notes on the CBB concepts Frequency and Interval:
In summary:
A unit of time (units from UCUM). UnitsOfTime (required)Constraints
|
dayOfWeek | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.dayOfWeek WeekDay Alternate namesWeekdag DefinitionWeekDay indicates a pattern of doses on fixed week days. If no days are specified, the action is assumed to happen every day as otherwise specified. Use ConceptMap 'WeekDay_to_DaysOfWeek' to translate CBB terminology to profile terminology in ValueSet 'DaysOfWeek.' DaysOfWeek (required)Permitted Values Constraints
|
timeOfDay | Σ | 0..* | time | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.timeOfDay AdministrationTime Alternate namesToedientijd DefinitionThe time of administration is a specific time of day (on the clock). This time usually isn’t (intended to be) exact. There can be multiple administering times in one day. The ideal time of administration can also be entered as a time of day (morning, afternoon, evening, night-time). The administration time is then to be left empty, and the time of day can be entered in the TimeOfDay concept. If there's a timeOfDay, there cannot be a when, or vice versa.
|
when | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.when TimeOfDay Alternate namesDagdeel DefinitionTime of day: morning, afternoon, evening, night. Timings are frequently determined by occurrences such as waking, eating and sleep. When more than one event is listed, the event is tied to the union of the specified events. Use ConceptMap 'TimeOfDay_to_EventTiming' to translate CBB terminology to profile terminology in ValueSet 'EventTiming.' EventTiming (required)Permitted Values Constraints
|
offset | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.offset Minutes from event (before or after) DefinitionThe number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event. 32 bit number; for values larger than this, use decimal
|
code | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.code BID | TID | QID | AM | PM | QD | QOD | + DefinitionA code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times). Code for a known / defined timing pattern. TimingAbbreviation (preferred)Constraints
|
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". Unordered, Open, by $this(Type) Binding 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 | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.asNeeded[x]:asNeededCodeableConcept Condition Alternate namesCriterium DefinitionThe condition for administering medication can be:
Physiological measurement values or other conditions do not need to be coded. These can be expressed in free text in the Description concept. 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. AsNeededCriterium (required)Constraints
|
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 | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.route RouteOfAdministration Alternate namesToedieningsweg DefinitionThe route through which the medication is administered (oral, nasal, intravenous, etc.). A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. Please note that in contrast to the CBB, this RouteOfAdministration concept is grouped under the DosingInstructions concept. This CBB concept should thus be duplicated when there are multiple DosingInstructions. A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. RouteOfMedicationAdministration (required)Constraints
|
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 Dosage Alternate namesDosering DefinitionInstructions for the administrator to administer the medication (the patient themselves, a nurse or other aid). When taking stock of medication use, the dosage describes the pattern of use established by the patient. Once the dose schedule (distribution of doses over time) and the dose have been determined, then there should be one single instruction for use. Multiple parallel instructions for use can be included in the event of a changing dose within one day and in the event of a variable use frequency. Multiple sequential instructions for use can be included in the event of changing doses within one period and/or in the event of a changing dose schedule. DurationOfAdministration is not mapped to this element but to
|
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] Dose Alternate namesKeerdosis DefinitionThe dose indicates the amount/unit per administration. The unit can be any unit that can occur with this particular medicine. 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. Unordered, Open, by $this(Type) Constraints
| |
doseRange | Σ | 0..1 | Range | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseRange 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.
|
low | Σ I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseRange.low minimumValue Alternate namesminimumWaarde DefinitionThe minimal value of the range. The boundary is inclusive. If the low element is missing, the low boundary is not known.
|
high | Σ I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseRange.high maximumValue Alternate namesmaximumWaarde DefinitionThe maximum value of the range. The boundary is inclusive. If the high element is missing, the high boundary is not known.
|
doseQuantity | Σ | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseQuantity nominalValue Alternate namesnominaleWaarde DefinitionAmount of medication per dose. The nominal value of the quantity. 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.
|
rate[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.rate[x] AdministeringSpeed Alternate namesToedieningssnelheid DefinitionThe administering speed is used in slow administration of liquid. In practice, the measuring unit is almost always ml/hour. Entering an interval (such as 0-10 ml/hour) is also a commonly used option. For example, with an administering speed of 10ml/hour:
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. Unordered, Open, by $this(Type) Constraints
| |
rateRatio | Ratio | There are no (further) constraints on this element Data Type | ||
rateRange | Σ | 0..1 | Range | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateRange 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.
|
low | Σ I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateRange.low minimumValue Alternate namesminimumWaarde DefinitionThe minimal value of the range. The boundary is inclusive. If the low element is missing, the low boundary is not known.
|
high | Σ I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateRange.high maximumValue Alternate namesmaximumWaarde DefinitionThe maximum value of the range. The boundary is inclusive. If the high element is missing, the high boundary is not known.
|
rateQuantity | Σ | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateQuantity nominalValue Alternate namesnominaleWaarde DefinitionThe nominal value of the quantity. 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.
|
maxDosePerPeriod | Σ I | 0..1 | Ratio | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.maxDosePerPeriod MaximumDose Alternate namesMaximaleDosering DefinitionA maximum dose maximizes (in time) the usage of a drug in an 'as needed' prescription. 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 | There are no (further) constraints on this element 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 | 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.).
|
MedicationRequest | I | MedicationRequest | Element IdMedicationRequest MedicationAgreement Alternate namesPrescription, Order, Medicatieafspraak 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.
| |
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
|
medicationAgreementAdditionalInformation | I | 0..* | Extension(CodeableConcept) | Element IdMedicationRequest.extension:medicationAgreementAdditionalInformation Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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.
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.extension:medicationAgreementAdditionalInformation.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-MedicationAgreement.AdditionalInformation
| |
value[x] | 0..1 | Binding | Element IdMedicationRequest.extension:medicationAgreementAdditionalInformation.value[x] MedicationAgreementAdditionalInformation Alternate namesMedicatieafspraakAanvullendeInformatie DefinitionAdditional information includes details on the structure of the agreement made that are relevant for pharmacovigilance and fulfillment by the pharmacist. This can be used e.g. to indicate that there was a conscious decision to deviate from the norm or that the agreement is to be structured in a certain way. MedicationAgreementAdditionalInformation (required) Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
renderedDosageInstruction | I | 0..1 | Extension(string) | Element IdMedicationRequest.extension:renderedDosageInstruction Optional Extensions Element Alternate namesextensions, user content DefinitionPre-adopt from FHIR R5 of the 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. https://fhir.healthdata.be/StructureDefinition/ext-RenderedDosageInstruction Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.extension:renderedDosageInstruction.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-RenderedDosageInstruction
| |
value[x] | 0..1 | Element IdMedicationRequest.extension:renderedDosageInstruction.value[x] Description Alternate namesOmschrijving DefinitionTextual description of the complete instructions for use including the period of use. The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
periodOfUse | I | 0..1 | Extension(HdBe-TimeInterval) | Element IdMedicationRequest.extension:periodOfUse Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. https://fhir.healthdata.be/StructureDefinition/ext-TimeInterval.Period Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-TimeInterval.Period
| |
value[x] | I | 0..1 | Element IdMedicationRequest.extension:periodOfUse.value[x] PeriodOfUse Alternate namesGebruiksperiode DefinitionStart date: This is the time at which the agreement was to take effect (or took effect or will take effect). This is the time at which the instructions for use in this agreement start. In the case of an agreement to discontinue use, this is the start date of the original medication agreement. The end date indicates from when the medication is to be discontinued. Duration: The intended duration of use. E.g. 5 days or 8 weeks. It is not allowed to indicate the duration in months, because different months have a variable duration in days. End date: The time at which the period of use ends (or ended or will end). In the case of an agreement to discontinue use, this is the time at which the medication is to be discontinued. To avoid confusion between 'to' and 'up to', the submission of time is always mandatory for the end date. With medication for an indefinite period only a start date is indicated. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |
valuePeriod | HdBe-TimeInterval | There are no (further) constraints on this element Data Type | ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].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) Constraints
|
duration | I | 0..1 | Extension(Duration) | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].extension:duration Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. https://fhir.healthdata.be/StructureDefinition/ext-TimeInterval.Duration Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].extension:duration.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-TimeInterval.Duration
| |
value[x] | 0..1 | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].extension:duration.value[x] Duration Alternate namestijdsDuur DefinitionThe duration of the interval in appropriate units of time (e.g. days or hours, etc.
| ||
valueDuration | Duration | There are no (further) constraints on this element Data Type | ||
start | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].start startDateTime Alternate namesstartDatumTijd DefinitionThe start date and time of the interval If the low element is missing, the meaning is that the low boundary is not known.
|
end | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].end endDateTime Alternate nameseindDatumTijd DefinitionThe end date and time of the interval The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing
|
modifierExtension | ?! I | 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. Unordered, Open, by url(Value) Constraints
|
stopType | ?! I | 0..1 | Extension(CodeableConcept) | Element IdMedicationRequest.modifierExtension:stopType Optional Extensions Element Alternate namesextensions, user content DefinitionThis StopType ModifierExtension works differently than the For example: suppose you want the patient to stop taking medication definitively three days from today. This is a stop medication agreement with a StopType of definitive. However today, tomorrow and the day after tomorrow the 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. https://fhir.healthdata.be/StructureDefinition/ext-StopType Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.modifierExtension:stopType.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-StopType
| |
value[x] | 0..1 | Binding | Element IdMedicationRequest.modifierExtension:stopType.value[x] MedicationAgreementStopType Alternate namesMedicatieafspraakStopType DefinitionStop type, the manner in which this medication is discontinued (temporary or definitive). MedicationAgreementStopType, AdministrationAgreementStopType and MedicationUseStopType all have a bound ValueSet that contain the exact same StopType values. These are represented in the CBB with the same Valueset. This MedicationStopType is used to bind to this extension and reusing this extension for all three concepts. StopType values, based on the valueset named MedicatioStopType, which are applicable for StopType in MedicationAgreement, AdministrationAgreement and MedicationUse. MedicationStopType (required)Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
repeatPeriodCyclicalSchedule | ?! I | 0..1 | Extension(Duration) | Element IdMedicationRequest.modifierExtension:repeatPeriodCyclicalSchedule Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. https://fhir.healthdata.be/StructureDefinition/ext-InstructionsForUse.RepeatPeriodCyclicalSchedule Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.modifierExtension:repeatPeriodCyclicalSchedule.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-InstructionsForUse.RepeatPeriodCyclicalSchedule
| |
value[x] | 0..1 | Element IdMedicationRequest.modifierExtension:repeatPeriodCyclicalSchedule.value[x] RepeatPeriodCyclicalSchedule Alternate namesHerhaalperiodeCyclischSchema DefinitionThe repeated period in a cyclical schedule (of one or more dosing instructions). A cyclic schedule is noted in days, the corresponding dosing duration is also in days. Examples of a cyclical schedule:
| ||
valueDuration | Duration | There are no (further) constraints on this element Data Type | ||
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 | Σ ?! | 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 implictly mapped to the CBB concepts period_of_use medication_agreement_stop_type. Unless the status is explicitly recorded, the following guidance applies:
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 DefinitionUnless 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 | 1..* | CodeableConcept | 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. Unordered, Open, by $this(Value) Binding 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
| |
medicationAgreementCode | 1..1 | CodeableConceptPattern | Element IdMedicationRequest.category:medicationAgreementCode 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
{ "coding": [ { "system": "http://snomed.info/sct", "code": "16076005" } ] }
| |
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] | Σ | 1..1 | 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. Unordered, Open, by $this(Type) Binding A coded concept identifying substance or product that can be ordered. SNOMEDCTMedicationCodes (example)Constraints
| |
medicationCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
medicationReference | Σ | 0..1 | Reference(Medication | HdBe-PharmaceuticalProduct) | Element IdMedicationRequest.medication[x]:medicationReference AgreedMedicine Alternate namesAfgesprokengeneesmiddel DefinitionThe medicine agreed upon to be used. 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. Reference(Medication | HdBe-PharmaceuticalProduct) Constraints
|
subject | Σ I | 1..1 | Reference(Group | HdBe-Patient) | 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(Group | HdBe-Patient) Constraints
|
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 | Σ | 0..1 | dateTime | Element IdMedicationRequest.authoredOn MedicationAgreementDateTime Alternate namesMedicatieafspraakDatumTijd DefinitionThe time at which the agreement was made. Appointment date + time are required (order of the appointments must be clear in cases with multiple appointments on one day).
|
requester | Σ I | 0..1 | pattern HealthProfessional Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | HdBe-HealthProfessional PractitionerRole) | Element IdMedicationRequest.requester Prescriber Alternate namesVoorschrijver DefinitionThe health professional that entered the medication agreement with the patient. Each occurrence of the CBB HealthProfessional is normally represented by two FHIR resources: a PractitionerRole resource (instance of HdBe-HealthProfessional-PractitionerRole) and a Practitioner resource (instance of HdBe-HealthProfessional-Practitioner). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance. In rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the HdBe-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile. pattern HealthProfessional Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | HdBe-HealthProfessional PractitionerRole) 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..1 | CodeableConceptBinding | Element IdMedicationRequest.reasonCode ReasonMedicationAgreement Alternate namesRedenMedicatieafspraak DefinitionReason for this agreement. This can be the reason to start, change or stop the medication treatment. 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. MedicationReason (required)Constraints
| |
reasonReference | I | 0..1 | Reference(Condition | Observation | HdBe-Problem) | Element IdMedicationRequest.reasonReference PrescriptionReason Alternate namesRedenVanVoorschrijven DefinitionThe medical reason for the prescription or for use of the medication. This can be used to enter a medical indication which was the direct cause for prescription or for use of the medication in question. It can concern every type of problem (or condition) of the patient, almost all diagnoses, complaints or symptoms. 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 | HdBe-Problem) 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..1 | 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).
| |
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.
| |
authorString | string | There are no (further) constraints on this element Data Type | ||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Data Type Reference(Practitioner | Patient | RelatedPerson | Organization) | ||
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdMedicationRequest.note.time When the annotation was made DefinitionIndicates when this particular annotation was made.
|
text | Σ | 1..1 | markdown | Element IdMedicationRequest.note.text Comment Alternate namesToelichting DefinitionComments regarding to the medication agreement. For example: in consultation with the medical specialist. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
|
dosageInstruction | 0..* | HdBe-InstructionsForUse.DosageInstructions | Element IdMedicationRequest.dosageInstruction DosingInstructions / InstructionsForUse Alternate namesDoseerinstructie, Gebruiksinstructie DefinitionInstructions for the use of the medication, e.g. dose and route of administration. This element mostly represents the DosingInstructions container from CBB InstructionsForUse, but also includes the AdditionalInstructions and RouteOfAdministration concepts, which are normally placed on the same level as this container. As a result, these concepts are duplicated in every repetition of this element, even though these concepts should be present just once according to the CBB. The RepeatPeriodCyclicalSchedule and Description elements of the CBB are not represented in this profile. When a HdBe profile contains a InstructionsForUse.DosageInstructions datatype, the RepeatPeriodCyclicalSchedule and Description elements are separately added to this profile as well. This element does not contain a mapping to the Dosage container from CBB InstructionsForUse. However, the child concepts of Dosage are all mapped. Multiple Dosage instances are represented by another DosingInstructions that contains a similiar SequenceNumber. HdBe-InstructionsForUse.DosageInstructions Constraints
| |
sequence | Σ | 0..1 | integer | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.sequence SequenceNumber Alternate namesVolgnummer DefinitionThis indicates the sequence of the dosing instructions within the medication agreement. 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 | Σ | 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 AdditionalInstructions Alternate namesAanvullendeInstructie DefinitionThe additional instructions contain extra information on the use of the current prescription. This includes all instructions for use. The text can come from the original “paper" medication prescription, but can also be generated from the coded information. This concept may contain more information than what is structurally coded in the information below, but may not conflict with it. The instructions may not conflict with other components of the request for administration. The instructions can also refer to an existing protocol. 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. Please note that in contrast to the CBB, this AdditionalInstructions concept is grouped under the DosingInstructions concept. This CBB concept should thus be duplicated when there are multiple DosingInstructions. 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 | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing AdministeringSchedule Alternate namesToedieningsschema DefinitionSpecifications of the times at which the medication is to be administered. This is indicated as follows:
If a certain medication is not to be taken daily, the aforementioned can be combined with daily indications:
The specified administration “infinite” is automatically to be repeated until:
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.
|
event | Σ | 0..* | dateTime | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.event When the event occurs DefinitionIdentifies specific times when the event occurs. In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
|
repeat | Σ I | 0..1 | Element | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat When the event is to occur DefinitionA set of rules that describe when the event is scheduled. Many timing schedules are determined by regular repetitions.
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.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) Constraints
|
timingExact | I | 0..1 | Extension(boolean) | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.extension:timingExact Whether specified times must be followed as closely as possible Alternate namesextensions, user content DefinitionIf true, indicates that the specified times, frequencies, periods are expected to be adhered to as precisely as possible. If false, indicates that a typical degree of variability based on institutional and/or patient convenience is acceptable. 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. http://hl7.org/fhir/StructureDefinition/timing-exact Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.extension:timingExact.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/timing-exact
| |
value[x] | 1..1 | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.extension:timingExact.value[x] Value of extension DefinitionIndicates that the timing as specified by The times can be chosen freely, but distribution throughout the day is more precise, and the interval between times is important (e.g. in the case of antibiotics) In the case of Baxter packs and intramural care, such a prescription is used to draw up a (location-specific) outline for distribution times (logistics). Notes on the CBB concepts Frequency and Interval:
In summary:
| ||
valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
bounds[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.bounds[x] Length/Range of lengths, or (Start and/or end) limits DefinitionEither a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. Unordered, Open, by $this(Type) Constraints
| |
boundsRange | Range | There are no (further) constraints on this element Data Type | ||
boundsPeriod | Period | There are no (further) constraints on this element Data Type | ||
boundsDuration | Σ | 0..1 | Duration | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.bounds[x]:boundsDuration DoseDuration Alternate namesDoseerduur DefinitionThe intended time duration for these dosing instructions, e.g. 5 days or 8 weeks. In the case of medication for an indefinite period, the dosing duration is left empty in the last dosing instruction.
|
count | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.count Frequency / minimumValue / nominalValue Alternate namesFrequentie, nominaleWaarde, minimumWaarde DefinitionUsually, frequency comprises both amount and time unit (3 times a day), but it can occur without the time unit (single use). This is represented by this A reasonable distribution over the day is expected, but exact times are not given. This is left to the patient. It is the most common manner of extramural prescription. In the case of Baxter packs and intramural care, such a prescription is used to draw up a (location-specific) outline for distribution times (logistics). Repetitions may be limited by end time or total occurrences. Notes on the CBB concepts Frequency and Interval:
In summary:
|
countMax | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.countMax Frequency / maximumValue Alternate namesFrequentie, maximumWaarde DefinitionUsually, frequency comprises both amount and time unit (3 times a day), but it can occur without the time unit (single use). This is represented by the A reasonable distribution over the day is expected, but exact times are not given. This is left to the patient. It is the most common manner of extramural prescription. In the case of Baxter packs and intramural care, such a prescription is used to draw up a (location-specific) outline for distribution times (logistics). Notes on the CBB concepts Frequency and Interval:
In summary:
|
duration | Σ | 0..1 | decimal | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.duration DurationOfAdministration Alternate namesToedieningsduur DefinitionThe duration of administration defines the length of time during which the drug is administered and is mainly used in the slow parenteral administration of fluids. The Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
|
durationMax | Σ | 0..1 | decimal | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.durationMax How long when it happens (Max) DefinitionIf present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
|
durationUnit | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.durationUnit DurationOfAdministration Alternate namesToedieningsduur DefinitionThe units of time, in UCUM units, for the duration of administration of time during which the drug is administered. Note that FHIR strings SHALL NOT exceed 1MB in size A unit of time (units from UCUM). UnitsOfTime (required)Constraints
|
frequency | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.frequency Frequency / minimumValue / nominalValue / Interval Alternate namesFrequentie, minimumWaarde, nominaleWaarde, Interval DefinitionThe number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency. If the If the Notes on the CBB concepts Frequency and Interval:
In summary:
If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
|
frequencyMax | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.frequencyMax Frequency / maximumValue Alternate namesmaximumWaarde, Frequentie DefinitionIf present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. If the If the Notes on the CBB concepts Frequency and Interval:
In summary:
|
period | Σ | 0..1 | decimal | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.period Frequency / Interval Alternate namesFrequentie, Interval DefinitionIndicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length. If the If the Notes on the CBB concepts Frequency and Interval:
In summary:
|
periodMax | Σ | 0..1 | decimal | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.periodMax Upper limit of period (3-4 hours) DefinitionIf present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
periodUnit | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.periodUnit Frequency / Interval Alternate namesFrequentie, Interval DefinitionThe units of time for the period in UCUM units for Frequency and Interval. If the If the Notes on the CBB concepts Frequency and Interval:
In summary:
A unit of time (units from UCUM). UnitsOfTime (required)Constraints
|
dayOfWeek | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.dayOfWeek WeekDay Alternate namesWeekdag DefinitionWeekDay indicates a pattern of doses on fixed week days. If no days are specified, the action is assumed to happen every day as otherwise specified. Use ConceptMap 'WeekDay_to_DaysOfWeek' to translate CBB terminology to profile terminology in ValueSet 'DaysOfWeek.' DaysOfWeek (required)Permitted Values Constraints
|
timeOfDay | Σ | 0..* | time | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.timeOfDay AdministrationTime Alternate namesToedientijd DefinitionThe time of administration is a specific time of day (on the clock). This time usually isn’t (intended to be) exact. There can be multiple administering times in one day. The ideal time of administration can also be entered as a time of day (morning, afternoon, evening, night-time). The administration time is then to be left empty, and the time of day can be entered in the TimeOfDay concept. If there's a timeOfDay, there cannot be a when, or vice versa.
|
when | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.when TimeOfDay Alternate namesDagdeel DefinitionTime of day: morning, afternoon, evening, night. Timings are frequently determined by occurrences such as waking, eating and sleep. When more than one event is listed, the event is tied to the union of the specified events. Use ConceptMap 'TimeOfDay_to_EventTiming' to translate CBB terminology to profile terminology in ValueSet 'EventTiming.' EventTiming (required)Permitted Values Constraints
|
offset | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.offset Minutes from event (before or after) DefinitionThe number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event. 32 bit number; for values larger than this, use decimal
|
code | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.code BID | TID | QID | AM | PM | QD | QOD | + DefinitionA code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times). Code for a known / defined timing pattern. TimingAbbreviation (preferred)Constraints
|
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". Unordered, Open, by $this(Type) Binding 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 | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.asNeeded[x]:asNeededCodeableConcept Condition Alternate namesCriterium DefinitionThe condition for administering medication can be:
Physiological measurement values or other conditions do not need to be coded. These can be expressed in free text in the Description concept. 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. AsNeededCriterium (required)Constraints
|
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 | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.route RouteOfAdministration Alternate namesToedieningsweg DefinitionThe route through which the medication is administered (oral, nasal, intravenous, etc.). A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. Please note that in contrast to the CBB, this RouteOfAdministration concept is grouped under the DosingInstructions concept. This CBB concept should thus be duplicated when there are multiple DosingInstructions. A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. RouteOfMedicationAdministration (required)Constraints
|
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 Dosage Alternate namesDosering DefinitionInstructions for the administrator to administer the medication (the patient themselves, a nurse or other aid). When taking stock of medication use, the dosage describes the pattern of use established by the patient. Once the dose schedule (distribution of doses over time) and the dose have been determined, then there should be one single instruction for use. Multiple parallel instructions for use can be included in the event of a changing dose within one day and in the event of a variable use frequency. Multiple sequential instructions for use can be included in the event of changing doses within one period and/or in the event of a changing dose schedule. DurationOfAdministration is not mapped to this element but to
|
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] Dose Alternate namesKeerdosis DefinitionThe dose indicates the amount/unit per administration. The unit can be any unit that can occur with this particular medicine. 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. Unordered, Open, by $this(Type) Constraints
| |
doseRange | Σ | 0..1 | Range | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseRange 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.
|
low | Σ I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseRange.low minimumValue Alternate namesminimumWaarde DefinitionThe minimal value of the range. The boundary is inclusive. If the low element is missing, the low boundary is not known.
|
high | Σ I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseRange.high maximumValue Alternate namesmaximumWaarde DefinitionThe maximum value of the range. The boundary is inclusive. If the high element is missing, the high boundary is not known.
|
doseQuantity | Σ | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseQuantity nominalValue Alternate namesnominaleWaarde DefinitionAmount of medication per dose. The nominal value of the quantity. 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.
|
rate[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.rate[x] AdministeringSpeed Alternate namesToedieningssnelheid DefinitionThe administering speed is used in slow administration of liquid. In practice, the measuring unit is almost always ml/hour. Entering an interval (such as 0-10 ml/hour) is also a commonly used option. For example, with an administering speed of 10ml/hour:
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. Unordered, Open, by $this(Type) Constraints
| |
rateRatio | Ratio | There are no (further) constraints on this element Data Type | ||
rateRange | Σ | 0..1 | Range | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateRange 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.
|
low | Σ I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateRange.low minimumValue Alternate namesminimumWaarde DefinitionThe minimal value of the range. The boundary is inclusive. If the low element is missing, the low boundary is not known.
|
high | Σ I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateRange.high maximumValue Alternate namesmaximumWaarde DefinitionThe maximum value of the range. The boundary is inclusive. If the high element is missing, the high boundary is not known.
|
rateQuantity | Σ | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateQuantity nominalValue Alternate namesnominaleWaarde DefinitionThe nominal value of the quantity. 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.
|
maxDosePerPeriod | Σ I | 0..1 | Ratio | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.maxDosePerPeriod MaximumDose Alternate namesMaximaleDosering DefinitionA maximum dose maximizes (in time) the usage of a drug in an 'as needed' prescription. 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 | There are no (further) constraints on this element 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 | 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.).
|
MedicationRequest | I | MedicationRequest | Element IdMedicationRequest MedicationAgreement Alternate namesPrescription, Order, Medicatieafspraak 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.
| |
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
|
medicationAgreementAdditionalInformation | I | 0..* | Extension(CodeableConcept) | Element IdMedicationRequest.extension:medicationAgreementAdditionalInformation Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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.
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.extension:medicationAgreementAdditionalInformation.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-MedicationAgreement.AdditionalInformation
| |
value[x] | 0..1 | Binding | Element IdMedicationRequest.extension:medicationAgreementAdditionalInformation.value[x] MedicationAgreementAdditionalInformation Alternate namesMedicatieafspraakAanvullendeInformatie DefinitionAdditional information includes details on the structure of the agreement made that are relevant for pharmacovigilance and fulfillment by the pharmacist. This can be used e.g. to indicate that there was a conscious decision to deviate from the norm or that the agreement is to be structured in a certain way. MedicationAgreementAdditionalInformation (required) Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
renderedDosageInstruction | I | 0..1 | Extension(string) | Element IdMedicationRequest.extension:renderedDosageInstruction Optional Extensions Element Alternate namesextensions, user content DefinitionPre-adopt from FHIR R5 of the 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. https://fhir.healthdata.be/StructureDefinition/ext-RenderedDosageInstruction Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.extension:renderedDosageInstruction.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-RenderedDosageInstruction
| |
value[x] | 0..1 | Element IdMedicationRequest.extension:renderedDosageInstruction.value[x] Description Alternate namesOmschrijving DefinitionTextual description of the complete instructions for use including the period of use. The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.
| ||
valueString | string | There are no (further) constraints on this element Data Type | ||
periodOfUse | I | 0..1 | Extension(HdBe-TimeInterval) | Element IdMedicationRequest.extension:periodOfUse Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. https://fhir.healthdata.be/StructureDefinition/ext-TimeInterval.Period Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-TimeInterval.Period
| |
value[x] | I | 0..1 | Element IdMedicationRequest.extension:periodOfUse.value[x] PeriodOfUse Alternate namesGebruiksperiode DefinitionStart date: This is the time at which the agreement was to take effect (or took effect or will take effect). This is the time at which the instructions for use in this agreement start. In the case of an agreement to discontinue use, this is the start date of the original medication agreement. The end date indicates from when the medication is to be discontinued. Duration: The intended duration of use. E.g. 5 days or 8 weeks. It is not allowed to indicate the duration in months, because different months have a variable duration in days. End date: The time at which the period of use ends (or ended or will end). In the case of an agreement to discontinue use, this is the time at which the medication is to be discontinued. To avoid confusion between 'to' and 'up to', the submission of time is always mandatory for the end date. With medication for an indefinite period only a start date is indicated. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
| |
valuePeriod | HdBe-TimeInterval | There are no (further) constraints on this element Data Type | ||
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].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) Constraints
|
duration | I | 0..1 | Extension(Duration) | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].extension:duration Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. https://fhir.healthdata.be/StructureDefinition/ext-TimeInterval.Duration Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].extension:duration.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-TimeInterval.Duration
| |
value[x] | 0..1 | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].extension:duration.value[x] Duration Alternate namestijdsDuur DefinitionThe duration of the interval in appropriate units of time (e.g. days or hours, etc.
| ||
valueDuration | Duration | There are no (further) constraints on this element Data Type | ||
start | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].start startDateTime Alternate namesstartDatumTijd DefinitionThe start date and time of the interval If the low element is missing, the meaning is that the low boundary is not known.
|
end | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element IdMedicationRequest.extension:periodOfUse.value[x].end endDateTime Alternate nameseindDatumTijd DefinitionThe end date and time of the interval The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing
|
modifierExtension | ?! I | 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. Unordered, Open, by url(Value) Constraints
|
stopType | ?! I | 0..1 | Extension(CodeableConcept) | Element IdMedicationRequest.modifierExtension:stopType Optional Extensions Element Alternate namesextensions, user content DefinitionThis StopType ModifierExtension works differently than the For example: suppose you want the patient to stop taking medication definitively three days from today. This is a stop medication agreement with a StopType of definitive. However today, tomorrow and the day after tomorrow the 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. https://fhir.healthdata.be/StructureDefinition/ext-StopType Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.modifierExtension:stopType.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-StopType
| |
value[x] | 0..1 | Binding | Element IdMedicationRequest.modifierExtension:stopType.value[x] MedicationAgreementStopType Alternate namesMedicatieafspraakStopType DefinitionStop type, the manner in which this medication is discontinued (temporary or definitive). MedicationAgreementStopType, AdministrationAgreementStopType and MedicationUseStopType all have a bound ValueSet that contain the exact same StopType values. These are represented in the CBB with the same Valueset. This MedicationStopType is used to bind to this extension and reusing this extension for all three concepts. StopType values, based on the valueset named MedicatioStopType, which are applicable for StopType in MedicationAgreement, AdministrationAgreement and MedicationUse. MedicationStopType (required)Constraints
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
repeatPeriodCyclicalSchedule | ?! I | 0..1 | Extension(Duration) | Element IdMedicationRequest.modifierExtension:repeatPeriodCyclicalSchedule Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. https://fhir.healthdata.be/StructureDefinition/ext-InstructionsForUse.RepeatPeriodCyclicalSchedule Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.modifierExtension:repeatPeriodCyclicalSchedule.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttps://fhir.healthdata.be/StructureDefinition/ext-InstructionsForUse.RepeatPeriodCyclicalSchedule
| |
value[x] | 0..1 | Element IdMedicationRequest.modifierExtension:repeatPeriodCyclicalSchedule.value[x] RepeatPeriodCyclicalSchedule Alternate namesHerhaalperiodeCyclischSchema DefinitionThe repeated period in a cyclical schedule (of one or more dosing instructions). A cyclic schedule is noted in days, the corresponding dosing duration is also in days. Examples of a cyclical schedule:
| ||
valueDuration | Duration | There are no (further) constraints on this element Data Type | ||
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 | Σ ?! | 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 implictly mapped to the CBB concepts period_of_use medication_agreement_stop_type. Unless the status is explicitly recorded, the following guidance applies:
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 DefinitionUnless 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 | 1..* | CodeableConcept | 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. Unordered, Open, by $this(Value) Binding 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
| |
medicationAgreementCode | 1..1 | CodeableConceptPattern | Element IdMedicationRequest.category:medicationAgreementCode 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
{ "coding": [ { "system": "http://snomed.info/sct", "code": "16076005" } ] }
| |
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] | Σ | 1..1 | 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. Unordered, Open, by $this(Type) Binding A coded concept identifying substance or product that can be ordered. SNOMEDCTMedicationCodes (example)Constraints
| |
medicationCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
medicationReference | Σ | 0..1 | Reference(Medication | HdBe-PharmaceuticalProduct) | Element IdMedicationRequest.medication[x]:medicationReference AgreedMedicine Alternate namesAfgesprokengeneesmiddel DefinitionThe medicine agreed upon to be used. 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. Reference(Medication | HdBe-PharmaceuticalProduct) Constraints
|
subject | Σ I | 1..1 | Reference(Group | HdBe-Patient) | 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(Group | HdBe-Patient) Constraints
|
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 | Σ | 0..1 | dateTime | Element IdMedicationRequest.authoredOn MedicationAgreementDateTime Alternate namesMedicatieafspraakDatumTijd DefinitionThe time at which the agreement was made. Appointment date + time are required (order of the appointments must be clear in cases with multiple appointments on one day).
|
requester | Σ I | 0..1 | pattern HealthProfessional Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | HdBe-HealthProfessional PractitionerRole) | Element IdMedicationRequest.requester Prescriber Alternate namesVoorschrijver DefinitionThe health professional that entered the medication agreement with the patient. Each occurrence of the CBB HealthProfessional is normally represented by two FHIR resources: a PractitionerRole resource (instance of HdBe-HealthProfessional-PractitionerRole) and a Practitioner resource (instance of HdBe-HealthProfessional-Practitioner). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance. In rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the HdBe-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile. pattern HealthProfessional Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | HdBe-HealthProfessional PractitionerRole) 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..1 | CodeableConceptBinding | Element IdMedicationRequest.reasonCode ReasonMedicationAgreement Alternate namesRedenMedicatieafspraak DefinitionReason for this agreement. This can be the reason to start, change or stop the medication treatment. 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. MedicationReason (required)Constraints
| |
reasonReference | I | 0..1 | Reference(Condition | Observation | HdBe-Problem) | Element IdMedicationRequest.reasonReference PrescriptionReason Alternate namesRedenVanVoorschrijven DefinitionThe medical reason for the prescription or for use of the medication. This can be used to enter a medical indication which was the direct cause for prescription or for use of the medication in question. It can concern every type of problem (or condition) of the patient, almost all diagnoses, complaints or symptoms. 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 | HdBe-Problem) 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..1 | 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).
| |
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.
| |
authorString | string | There are no (further) constraints on this element Data Type | ||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Data Type Reference(Practitioner | Patient | RelatedPerson | Organization) | ||
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdMedicationRequest.note.time When the annotation was made DefinitionIndicates when this particular annotation was made.
|
text | Σ | 1..1 | markdown | Element IdMedicationRequest.note.text Comment Alternate namesToelichting DefinitionComments regarding to the medication agreement. For example: in consultation with the medical specialist. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
|
dosageInstruction | 0..* | HdBe-InstructionsForUse.DosageInstructions | Element IdMedicationRequest.dosageInstruction DosingInstructions / InstructionsForUse Alternate namesDoseerinstructie, Gebruiksinstructie DefinitionInstructions for the use of the medication, e.g. dose and route of administration. This element mostly represents the DosingInstructions container from CBB InstructionsForUse, but also includes the AdditionalInstructions and RouteOfAdministration concepts, which are normally placed on the same level as this container. As a result, these concepts are duplicated in every repetition of this element, even though these concepts should be present just once according to the CBB. The RepeatPeriodCyclicalSchedule and Description elements of the CBB are not represented in this profile. When a HdBe profile contains a InstructionsForUse.DosageInstructions datatype, the RepeatPeriodCyclicalSchedule and Description elements are separately added to this profile as well. This element does not contain a mapping to the Dosage container from CBB InstructionsForUse. However, the child concepts of Dosage are all mapped. Multiple Dosage instances are represented by another DosingInstructions that contains a similiar SequenceNumber. HdBe-InstructionsForUse.DosageInstructions Constraints
| |
sequence | Σ | 0..1 | integer | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.sequence SequenceNumber Alternate namesVolgnummer DefinitionThis indicates the sequence of the dosing instructions within the medication agreement. 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 | Σ | 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 AdditionalInstructions Alternate namesAanvullendeInstructie DefinitionThe additional instructions contain extra information on the use of the current prescription. This includes all instructions for use. The text can come from the original “paper" medication prescription, but can also be generated from the coded information. This concept may contain more information than what is structurally coded in the information below, but may not conflict with it. The instructions may not conflict with other components of the request for administration. The instructions can also refer to an existing protocol. 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. Please note that in contrast to the CBB, this AdditionalInstructions concept is grouped under the DosingInstructions concept. This CBB concept should thus be duplicated when there are multiple DosingInstructions. 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 | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing AdministeringSchedule Alternate namesToedieningsschema DefinitionSpecifications of the times at which the medication is to be administered. This is indicated as follows:
If a certain medication is not to be taken daily, the aforementioned can be combined with daily indications:
The specified administration “infinite” is automatically to be repeated until:
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.
|
event | Σ | 0..* | dateTime | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.event When the event occurs DefinitionIdentifies specific times when the event occurs. In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
|
repeat | Σ I | 0..1 | Element | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat When the event is to occur DefinitionA set of rules that describe when the event is scheduled. Many timing schedules are determined by regular repetitions.
|
extension | I | 0..* | Extension | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.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) Constraints
|
timingExact | I | 0..1 | Extension(boolean) | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.extension:timingExact Whether specified times must be followed as closely as possible Alternate namesextensions, user content DefinitionIf true, indicates that the specified times, frequencies, periods are expected to be adhered to as precisely as possible. If false, indicates that a typical degree of variability based on institutional and/or patient convenience is acceptable. 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. http://hl7.org/fhir/StructureDefinition/timing-exact Constraints
|
url | 1..1 | System.StringFixed Value | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.extension:timingExact.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. System.String Fixed Valuehttp://hl7.org/fhir/StructureDefinition/timing-exact
| |
value[x] | 1..1 | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.extension:timingExact.value[x] Value of extension DefinitionIndicates that the timing as specified by The times can be chosen freely, but distribution throughout the day is more precise, and the interval between times is important (e.g. in the case of antibiotics) In the case of Baxter packs and intramural care, such a prescription is used to draw up a (location-specific) outline for distribution times (logistics). Notes on the CBB concepts Frequency and Interval:
In summary:
| ||
valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
bounds[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.bounds[x] Length/Range of lengths, or (Start and/or end) limits DefinitionEither a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. Unordered, Open, by $this(Type) Constraints
| |
boundsRange | Range | There are no (further) constraints on this element Data Type | ||
boundsPeriod | Period | There are no (further) constraints on this element Data Type | ||
boundsDuration | Σ | 0..1 | Duration | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.bounds[x]:boundsDuration DoseDuration Alternate namesDoseerduur DefinitionThe intended time duration for these dosing instructions, e.g. 5 days or 8 weeks. In the case of medication for an indefinite period, the dosing duration is left empty in the last dosing instruction.
|
count | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.count Frequency / minimumValue / nominalValue Alternate namesFrequentie, nominaleWaarde, minimumWaarde DefinitionUsually, frequency comprises both amount and time unit (3 times a day), but it can occur without the time unit (single use). This is represented by this A reasonable distribution over the day is expected, but exact times are not given. This is left to the patient. It is the most common manner of extramural prescription. In the case of Baxter packs and intramural care, such a prescription is used to draw up a (location-specific) outline for distribution times (logistics). Repetitions may be limited by end time or total occurrences. Notes on the CBB concepts Frequency and Interval:
In summary:
|
countMax | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.countMax Frequency / maximumValue Alternate namesFrequentie, maximumWaarde DefinitionUsually, frequency comprises both amount and time unit (3 times a day), but it can occur without the time unit (single use). This is represented by the A reasonable distribution over the day is expected, but exact times are not given. This is left to the patient. It is the most common manner of extramural prescription. In the case of Baxter packs and intramural care, such a prescription is used to draw up a (location-specific) outline for distribution times (logistics). Notes on the CBB concepts Frequency and Interval:
In summary:
|
duration | Σ | 0..1 | decimal | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.duration DurationOfAdministration Alternate namesToedieningsduur DefinitionThe duration of administration defines the length of time during which the drug is administered and is mainly used in the slow parenteral administration of fluids. The Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
|
durationMax | Σ | 0..1 | decimal | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.durationMax How long when it happens (Max) DefinitionIf present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
|
durationUnit | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.durationUnit DurationOfAdministration Alternate namesToedieningsduur DefinitionThe units of time, in UCUM units, for the duration of administration of time during which the drug is administered. Note that FHIR strings SHALL NOT exceed 1MB in size A unit of time (units from UCUM). UnitsOfTime (required)Constraints
|
frequency | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.frequency Frequency / minimumValue / nominalValue / Interval Alternate namesFrequentie, minimumWaarde, nominaleWaarde, Interval DefinitionThe number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency. If the If the Notes on the CBB concepts Frequency and Interval:
In summary:
If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
|
frequencyMax | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.frequencyMax Frequency / maximumValue Alternate namesmaximumWaarde, Frequentie DefinitionIf present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. If the If the Notes on the CBB concepts Frequency and Interval:
In summary:
|
period | Σ | 0..1 | decimal | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.period Frequency / Interval Alternate namesFrequentie, Interval DefinitionIndicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length. If the If the Notes on the CBB concepts Frequency and Interval:
In summary:
|
periodMax | Σ | 0..1 | decimal | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.periodMax Upper limit of period (3-4 hours) DefinitionIf present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
periodUnit | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.periodUnit Frequency / Interval Alternate namesFrequentie, Interval DefinitionThe units of time for the period in UCUM units for Frequency and Interval. If the If the Notes on the CBB concepts Frequency and Interval:
In summary:
A unit of time (units from UCUM). UnitsOfTime (required)Constraints
|
dayOfWeek | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.dayOfWeek WeekDay Alternate namesWeekdag DefinitionWeekDay indicates a pattern of doses on fixed week days. If no days are specified, the action is assumed to happen every day as otherwise specified. Use ConceptMap 'WeekDay_to_DaysOfWeek' to translate CBB terminology to profile terminology in ValueSet 'DaysOfWeek.' DaysOfWeek (required)Permitted Values Constraints
|
timeOfDay | Σ | 0..* | time | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.timeOfDay AdministrationTime Alternate namesToedientijd DefinitionThe time of administration is a specific time of day (on the clock). This time usually isn’t (intended to be) exact. There can be multiple administering times in one day. The ideal time of administration can also be entered as a time of day (morning, afternoon, evening, night-time). The administration time is then to be left empty, and the time of day can be entered in the TimeOfDay concept. If there's a timeOfDay, there cannot be a when, or vice versa.
|
when | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.when TimeOfDay Alternate namesDagdeel DefinitionTime of day: morning, afternoon, evening, night. Timings are frequently determined by occurrences such as waking, eating and sleep. When more than one event is listed, the event is tied to the union of the specified events. Use ConceptMap 'TimeOfDay_to_EventTiming' to translate CBB terminology to profile terminology in ValueSet 'EventTiming.' EventTiming (required)Permitted Values Constraints
|
offset | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.repeat.offset Minutes from event (before or after) DefinitionThe number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event. 32 bit number; for values larger than this, use decimal
|
code | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.timing.code BID | TID | QID | AM | PM | QD | QOD | + DefinitionA code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times). Code for a known / defined timing pattern. TimingAbbreviation (preferred)Constraints
|
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". Unordered, Open, by $this(Type) Binding 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 | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.asNeeded[x]:asNeededCodeableConcept Condition Alternate namesCriterium DefinitionThe condition for administering medication can be:
Physiological measurement values or other conditions do not need to be coded. These can be expressed in free text in the Description concept. 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. AsNeededCriterium (required)Constraints
|
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 | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.route RouteOfAdministration Alternate namesToedieningsweg DefinitionThe route through which the medication is administered (oral, nasal, intravenous, etc.). A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. Please note that in contrast to the CBB, this RouteOfAdministration concept is grouped under the DosingInstructions concept. This CBB concept should thus be duplicated when there are multiple DosingInstructions. A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. RouteOfMedicationAdministration (required)Constraints
|
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 Dosage Alternate namesDosering DefinitionInstructions for the administrator to administer the medication (the patient themselves, a nurse or other aid). When taking stock of medication use, the dosage describes the pattern of use established by the patient. Once the dose schedule (distribution of doses over time) and the dose have been determined, then there should be one single instruction for use. Multiple parallel instructions for use can be included in the event of a changing dose within one day and in the event of a variable use frequency. Multiple sequential instructions for use can be included in the event of changing doses within one period and/or in the event of a changing dose schedule. DurationOfAdministration is not mapped to this element but to
|
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] Dose Alternate namesKeerdosis DefinitionThe dose indicates the amount/unit per administration. The unit can be any unit that can occur with this particular medicine. 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. Unordered, Open, by $this(Type) Constraints
| |
doseRange | Σ | 0..1 | Range | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseRange 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.
|
low | Σ I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseRange.low minimumValue Alternate namesminimumWaarde DefinitionThe minimal value of the range. The boundary is inclusive. If the low element is missing, the low boundary is not known.
|
high | Σ I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseRange.high maximumValue Alternate namesmaximumWaarde DefinitionThe maximum value of the range. The boundary is inclusive. If the high element is missing, the high boundary is not known.
|
doseQuantity | Σ | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseQuantity nominalValue Alternate namesnominaleWaarde DefinitionAmount of medication per dose. The nominal value of the quantity. 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.
|
rate[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.rate[x] AdministeringSpeed Alternate namesToedieningssnelheid DefinitionThe administering speed is used in slow administration of liquid. In practice, the measuring unit is almost always ml/hour. Entering an interval (such as 0-10 ml/hour) is also a commonly used option. For example, with an administering speed of 10ml/hour:
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. Unordered, Open, by $this(Type) Constraints
| |
rateRatio | Ratio | There are no (further) constraints on this element Data Type | ||
rateRange | Σ | 0..1 | Range | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateRange 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.
|
low | Σ I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateRange.low minimumValue Alternate namesminimumWaarde DefinitionThe minimal value of the range. The boundary is inclusive. If the low element is missing, the low boundary is not known.
|
high | Σ I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateRange.high maximumValue Alternate namesmaximumWaarde DefinitionThe maximum value of the range. The boundary is inclusive. If the high element is missing, the high boundary is not known.
|
rateQuantity | Σ | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateQuantity nominalValue Alternate namesnominaleWaarde DefinitionThe nominal value of the quantity. 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.
|
maxDosePerPeriod | Σ I | 0..1 | Ratio | There are no (further) constraints on this element Element IdMedicationRequest.dosageInstruction.maxDosePerPeriod MaximumDose Alternate namesMaximaleDosering DefinitionA maximum dose maximizes (in time) the usage of a drug in an 'as needed' prescription. 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 | There are no (further) constraints on this element 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 | 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.).
|
Mapping FHIR profile to CBB
Path | map | CBB | comment |
---|---|---|---|
MedicationRequest.extension:renderedDosageInstruction | InstructionsForUse.Description | HdBe-InstructionsForUse | |
MedicationRequest.modifierExtension:repeatPeriodCyclicalSchedule | InstructionsForUse.RepeatPeriodCyclicalSchedule | HdBe-InstructionsForUse | |
MedicationRequest.modifierExtension:repeatPeriodCyclicalSchedule.value[x] | InstructionsForUse.RepeatPeriodCyclicalSchedule | HdBe-InstructionsForUse | |
MedicationRequest | MedicationAgreement | HdBe-MedicationAgreement | |
MedicationRequest.extension:medicationAgreementAdditionalInformation.value[x] | MedicationAgreement.MedicationAgreementAdditionalInformation | HdBe-MedicationAgreement | |
MedicationRequest.extension:periodOfUse.value[x] | MedicationAgreement.PeriodOfUse | HdBe-MedicationAgreement | |
MedicationRequest.modifierExtension:stopType.value[x] | MedicationAgreement.MedicationAgreementStopType | HdBe-MedicationAgreement | |
MedicationRequest.status | MedicationAgreement.PeriodOfUse | HdBe-MedicationAgreement | implicit, main mapping is on the extensions ext-TimeInterval.Period and ext-TimeInterval.Duration |
MedicationRequest.status | MedicationAgreement.MedicationAgreementStopType | HdBe-MedicationAgreement | implicit, main mapping is on StopType extension |
MedicationRequest.medication[x]:medicationReference | MedicationAgreement.AgreedMedicine | HdBe-MedicationAgreement | |
MedicationRequest.authoredOn | MedicationAgreement.MedicationAgreementDateTime | HdBe-MedicationAgreement | |
MedicationRequest.requester | MedicationAgreement.Prescriber | HdBe-MedicationAgreement | |
MedicationRequest.reasonCode | MedicationAgreement.ReasonMedicationAgreement | HdBe-MedicationAgreement | |
MedicationRequest.reasonReference | MedicationAgreement.PrescriptionReason | HdBe-MedicationAgreement | |
MedicationRequest.note.text | MedicationAgreement.Comment | HdBe-MedicationAgreement | |
MedicationRequest.dosageInstruction | MedicationAgreement.InstructionsForUse | HdBe-MedicationAgreement |
zib MedicationAgreement difference
Concept | Category | Description |
---|---|---|
status |
textual | Replaced Dutch SNOMED-CT codes with the corresponding codes in the ValueSet MedicationStopType in the guidance on the correct use of status. |
reasonReference |
textual | Removed context regarding the Dutch G-standard. |
modifierExtension:stopType |
terminology | Renamed ValueSet from MedicationAgreementStopType to MedicationStopType, to be able to reuse it at MedicationUse and AdministrationAgreement. Also replaced Dutch SNOMED-CT codes with international codes in ValueSet MedicationStopType. |
reasonCode |
terminology | Renamed ValueSet from MedicationAgreementReason to MedicationReason, to be able to reuse it at MedicationUse2. Replaced several values in ValueSet. 1. Added SNOMED-CT code for Unknown and Other. 2. Added CodeSystem MedicationReason which replaces all Dutch SNOMED-CT codes. 3. Removed all Dutch SNOMED-CT codes from valueset. |
extension:medicationAgreementAdditionalInformation |
terminology | Replaced several values in MedicationAgreementAdditionalInformation valueSet. 1. Replaced OTH with SNOMED-CT code for Other. 2. Added SNOMED-CT code for Unknown. 3. Added CodeSystem MedicationAgreementAdditionalInformation which replaces all Dutch SNOMED-CT codes. 4. Removed all Dutch SNOMED-CT codes from valueset. |
Terminology Bindings
Path | Name | Strength | URL | ConceptMap |
---|---|---|---|---|
MedicationRequest.reasonCode | MedicationReason | required | https://fhir.healthdata.be/ValueSet/MedicationReason | No bound ConceptMap |