ERP ServiceRequest MedicationRequest
Übersicht über das Profil
Name | Description | Canonical_URL | Status | Version | Basiert auf |
---|---|---|---|---|---|
ERPServiceRequestMedicationRequest | Medical and pharmaceutical information for the prescription request | https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-medication-request | draft | 1.2 | http://hl7.org/fhir/StructureDefinition/MedicationRequest |
Über das Profil
Motivation
Dieses Profil wird in den Anwendungsfällen genutzt, um angefragte, verordnete oder dispensierte Arzneimittelinformationen zu übertragen.
Als Anfragender möchte ich angeben können, welche Medikation ich für einen Patienten anfragen möchte. Eine Einrichtung/ Person, die eine Verordnung anfragt nutzt dieses Profil, um strukturiert anzugeben, welche Medikation benötigt wird. Hierzu muss in ERPServiceRequestPrescriptionRequest.basedOn ein ERPServiceRequestMedicationRequest mit angegeben werden. Dieser enthält die medizinische Information, die der Verordnende benötigt, um ein entsprechendes Rezept auszustellen.
Analog kann der Verordnende angeben, welches Arzneimittel er verordnet hat, sowie ein abgebender LE welches Arzneimittel geliefert wird.
Die anzugebende Medication entspricht dabei den Medication Profilen aus dem eRezept Projekt der KBV.
Da die KBV_PR_ERP_Prescription Informationen voraussetzt, die u.U. im Moment der Anfrage nicht bekannt sind, wurde dieses Profil spezifiziert. Es lehnt sich an die Spezifikation der KBV_PR_ERP_Prescription an, ist aber offener, erlaubt also auch dass die fehlenden Informationen nicht angegeben werden müssen.
Inhalt des Profils
Folgende Ansichten existieren auf das Profil:
ERPServiceRequestMedicationRequest (MedicationRequest) | I | MedicationRequest | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | S I | 0..* | Extension |
PriorPrescriptionID | S I | 0..1 | Extension(Identifier Profile for Prescription IDs (GEM_ERP_PR_PrescriptionId)) |
modifierExtension | ?! I | 0..* | Extension |
requestMVO | S ?! I | 0..1 | Extension(boolean) |
identifier | 0..* | Identifier | |
status | Σ ?! | 1..1 | codeBinding |
statusReason | 0..1 | CodeableConcept | |
intent | Σ ?! | 1..1 | codeBinding |
category | 0..* | CodeableConcept | |
priority | Σ | 0..1 | codeBinding |
doNotPerform | Σ ?! | 0..1 | boolean |
reported[x] | Σ | 0..1 | |
reportedBoolean | boolean | ||
reportedReference | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | ||
medication[x] | S Σ | 1..1 | |
medicationReference | Reference(KBV_PR_ERP_Medication_PZN | KBV_PR_ERP_Medication_Compounding | KBV_PR_ERP_Medication_Ingredient | KBV_PR_ERP_Medication_FreeText) | ||
subject | S Σ I | 1..1 | Reference(ERPServiceRequestPatient) |
encounter | I | 0..1 | Reference(Encounter) |
supportingInformation | I | 0..* | Reference(Resource) |
authoredOn | Σ | 0..1 | dateTime |
requester | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) |
performer | I | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) |
performerType | Σ | 0..1 | CodeableConcept |
recorder | I | 0..1 | Reference(Practitioner | PractitionerRole) |
reasonCode | 0..* | CodeableConcept | |
reasonReference | I | 0..* | Reference(Condition | Observation) |
instantiatesCanonical | Σ | 0..* | canonical() |
instantiatesUri | Σ | 0..* | uri |
basedOn | Σ I | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) |
groupIdentifier | Σ | 0..1 | Identifier |
courseOfTherapyType | 0..1 | CodeableConcept | |
insurance | I | 0..* | Reference(Coverage | ClaimResponse) |
note | 0..* | Annotation | |
dosageInstruction | S | 0..* | Dosage |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
sequence | Σ | 0..1 | integer |
text | S Σ | 0..1 | string |
additionalInstruction | Σ | 0..* | CodeableConcept |
patientInstruction | S Σ | 0..1 | string |
timing | Σ | 0..1 | Timing |
asNeeded[x] | Σ | 0..1 | |
asNeededBoolean | boolean | ||
asNeededCodeableConcept | CodeableConcept | ||
site | Σ | 0..1 | CodeableConcept |
route | Σ | 0..1 | CodeableConcept |
method | Σ | 0..1 | CodeableConcept |
doseAndRate | Σ | 0..* | Element |
id | 0..1 | string | |
extension | I | 0..* | Extension |
type | Σ | 0..1 | CodeableConcept |
dose[x] | Σ | 0..1 | |
doseRange | Range | ||
doseQuantity | SimpleQuantity | ||
rate[x] | Σ | 0..1 | |
rateRatio | Ratio | ||
rateRange | Range | ||
rateQuantity | SimpleQuantity | ||
maxDosePerPeriod | Σ I | 0..1 | Ratio |
maxDosePerAdministration | Σ I | 0..1 | SimpleQuantity |
maxDosePerLifetime | Σ I | 0..1 | SimpleQuantity |
dispenseRequest | S | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
initialFill | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
quantity | I | 0..1 | SimpleQuantity |
duration | I | 0..1 | Duration |
dispenseInterval | I | 0..1 | Duration |
validityPeriod | I | 0..1 | Period |
numberOfRepeatsAllowed | 0..1 | unsignedInt | |
quantity | S I | 1..1 | SimpleQuantity |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | S Σ | 1..1 | string |
system | Σ I | 0..1 | uriFixed Value |
code | Σ | 0..1 | code |
expectedSupplyDuration | I | 0..1 | Duration |
performer | I | 0..1 | Reference(Organization) |
substitution | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
allowed[x] | 1..1 | ||
allowedBoolean | boolean | ||
allowedCodeableConcept | CodeableConcept | ||
reason | 0..1 | CodeableConcept | |
priorPrescription | I | 0..1 | Reference(MedicationRequest) |
detectedIssue | I | 0..* | Reference(DetectedIssue) |
eventHistory | I | 0..* | Reference(Provenance) |
MedicationRequest | |
Definition | An 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. |
Cardinality | 0...* |
Alias | Prescription, Order |
Invariants |
|
Mappings |
|
MedicationRequest.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
MedicationRequest.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
MedicationRequest.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
MedicationRequest.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
MedicationRequest.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
MedicationRequest.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
MedicationRequest.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Must Support | True |
Alias | extensions, user content |
Comments | If the previous recipe ID is known, it can be named here |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationRequest.extension:PriorPrescriptionID | |
Definition | The MedicationRequest can contain a PrescriptionId of a prescription that has already been issued. If a previous prescription ID is known, the writing system MAY indicate this in the medication request. If this ID is available, the receiving system MUST be able to search for the previous regulation and give the user the opportunity to display and compare the content. |
Cardinality | 0...1 |
Type | Extension(Identifier Profile for Prescription IDs (GEM_ERP_PR_PrescriptionId)) |
Must Support | True |
Alias | extensions, user content |
Comments | Must be given in the form xxx.xxx.xxx.xxx.xxx.xx. |
Invariants |
|
Mappings |
|
MedicationRequest.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | 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. |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationRequest.modifierExtension:requestMVO | |
Definition | If the prescription is should be a multiple prescription order. Only the 'Kennzeichen' should be stated, indicating that the prescription is requested to be a multiple prescription order. |
Cardinality | 0...1 |
Type | Extension(boolean) |
Must Support | True |
Modifier | True |
Alias | extensions, user content |
Requirements | 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. |
Comments | When this extension is received by a PVS, the prescriber has to be visually notified about the request for a multiple prescription order. |
Invariants |
|
Mappings |
|
MedicationRequest.identifier | |
Definition | Identifiers 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. |
Cardinality | 0...* |
Type | Identifier |
Comments | This is a business identifier, not a resource identifier. |
Invariants |
|
Mappings |
|
MedicationRequest.status | |
Definition | A code specifying the current state of the order. Generally, this will be active or completed state. |
Cardinality | 1...1 |
Type | code |
Binding | A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. |
Modifier | True |
Summary | True |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Invariants |
|
Mappings |
|
MedicationRequest.statusReason | |
Definition | Captures the reason for the current state of the MedicationRequest. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Identifies the reasons for a given status. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.intent | |
Definition | Whether the request is a proposal, plan, or an original order. |
Cardinality | 1...1 |
Type | code |
Binding | The kind of medication order. |
Modifier | True |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.category | |
Definition | Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)). |
Cardinality | 0...* |
Type | CodeableConcept |
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. |
Comments | The category can be used to include where the medication is expected to be consumed or other types of requests. |
Invariants |
|
Mappings |
|
MedicationRequest.priority | |
Definition | Indicates how quickly the Medication Request should be addressed with respect to other requests. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the level of importance to be assigned to actioning the request. |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.doNotPerform | |
Definition | If true indicates that the provider is asking for the medication request not to occur. |
Cardinality | 0...1 |
Type | boolean |
Modifier | True |
Summary | True |
Comments | If do not perform is not specified, the request is a positive request e.g. "do perform". |
Invariants |
|
Mappings |
|
MedicationRequest.reported[x] | |
Definition | Indicates 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. |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Invariants |
|
Mappings |
|
MedicationRequest.medication[x] | |
Definition | Identifies 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. |
Cardinality | 1...1 |
Type | Reference(KBV_PR_ERP_Medication_PZN | KBV_PR_ERP_Medication_Compounding | KBV_PR_ERP_Medication_Ingredient | KBV_PR_ERP_Medication_FreeText) |
Must Support | True |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.subject | |
Definition | A link to a resource representing the person or set of individuals to whom the medication will be given. |
Cardinality | 1...1 |
Type | Reference(ERPServiceRequestPatient) |
Must Support | True |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.encounter | |
Definition | The Encounter during which this [x] was created or to which the creation of this record is tightly associated. |
Cardinality | 0...1 |
Type | Reference(Encounter) |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.supportingInformation | |
Definition | Include additional information (for example, patient height and weight) that supports the ordering of the medication. |
Cardinality | 0...* |
Type | Reference(Resource) |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.authoredOn | |
Definition | The date (and perhaps time) when the prescription was initially written or authored on. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Invariants |
|
Mappings |
|
MedicationRequest.requester | |
Definition | The individual, organization, or device that initiated the request and has responsibility for its activation. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.performer | |
Definition | The specified desired performer of the medication treatment (e.g. the performer of the medication administration). |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam) |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.performerType | |
Definition | Indicates the type of performer of the administration of the medication. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Identifies the type of individual that is desired to administer the medication. |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.recorder | |
Definition | The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole) |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.reasonCode | |
Definition | The reason or the indication for ordering or not ordering the medication. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A coded concept indicating why the medication was ordered. |
Comments | This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference. |
Invariants |
|
Mappings |
|
MedicationRequest.reasonReference | |
Definition | Condition or observation that supports why the medication was ordered. |
Cardinality | 0...* |
Type | Reference(Condition | Observation) |
Comments | This is a reference to a condition or observation that is the reason for the medication order. If only a code exists, use reasonCode. |
Invariants |
|
Mappings |
|
MedicationRequest.instantiatesCanonical | |
Definition | The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest. |
Cardinality | 0...* |
Type | canonical() |
Summary | True |
Comments | |
Invariants |
|
Mappings |
|
MedicationRequest.instantiatesUri | |
Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest. |
Cardinality | 0...* |
Type | uri |
Summary | True |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
MedicationRequest.basedOn | |
Definition | A plan or request that is fulfilled in whole or in part by this medication request. |
Cardinality | 0...* |
Type | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.groupIdentifier | |
Definition | A 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. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Requirements | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.courseOfTherapyType | |
Definition | The description of the overall patte3rn of the administration of the medication to the patient. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Identifies the overall pattern of medication administratio. |
Comments | This attribute should not be confused with the protocol of the medication. |
Invariants |
|
Mappings |
|
MedicationRequest.insurance | |
Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service. |
Cardinality | 0...* |
Type | Reference(Coverage | ClaimResponse) |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.note | |
Definition | Extra information about the prescription that could not be conveyed by the other attributes. |
Cardinality | 0...* |
Type | Annotation |
Comments | 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). |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction | |
Definition | Indicates how the medication is to be used by the patient. |
Cardinality | 0...* |
Type | Dosage |
Must Support | True |
Comments | There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, "Ondansetron 8mg orally or IV twice a day as needed for nausea" or "Compazine® (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationRequest.dosageInstruction.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.sequence | |
Definition | Indicates the order in which the dosage instructions should be applied or interpreted. |
Cardinality | 0...1 |
Type | integer |
Summary | True |
Requirements | 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. |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.text | |
Definition | Dosieranweisung einer Verordnung |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | 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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.additionalInstruction | |
Definition | Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps"). |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". |
Summary | True |
Requirements | 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. |
Comments | Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or "immediately following drug x") should be populated in dosage.text. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.patientInstruction | |
Definition | Gebrauchsanweisung einer Rezeptur |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.timing | |
Definition | When medication should be administered. |
Cardinality | 0...1 |
Type | Timing |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.asNeeded[x] | |
Definition | Indicates 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). |
Cardinality | 0...1 |
Type | boolean |
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. |
Summary | True |
Comments | 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". |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.site | |
Definition | Body site to administer to. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept describing the site location the medicine enters into or onto the body. |
Summary | True |
Requirements | A coded specification of the anatomic site where the medication first enters the body. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.route | |
Definition | How drug should enter body. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. |
Summary | True |
Requirements | A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.method | |
Definition | Technique for administering medication. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept describing the technique by which the medicine is administered. |
Summary | True |
Requirements | 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. |
Comments | Terminologies used often pre-coordinate this term with the route and or form of administration. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.doseAndRate | |
Definition | The amount of medication administered. |
Cardinality | 0...* |
Type | Element |
Summary | True |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.doseAndRate.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationRequest.dosageInstruction.doseAndRate.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.doseAndRate.type | |
Definition | The kind of dose or rate specified, for example, ordered or calculated. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The kind of dose or rate specified. |
Summary | True |
Requirements | If the type is not populated, assume to be "ordered". |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.doseAndRate.dose[x] | |
Definition | Amount of medication per dose. |
Cardinality | 0...1 |
Type | Range |
Summary | True |
Requirements | The amount of therapeutic or other substance given at one administration event. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.doseAndRate.rate[x] | |
Definition | Amount of medication per unit of time. |
Cardinality | 0...1 |
Type | Ratio |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.maxDosePerPeriod | |
Definition | Upper limit on medication per unit of time. |
Cardinality | 0...1 |
Type | Ratio |
Summary | True |
Requirements | 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. |
Comments | 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". |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.maxDosePerAdministration | |
Definition | Upper limit on medication per administration. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Summary | True |
Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.maxDosePerLifetime | |
Definition | Upper limit on medication per lifetime of the patient. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Summary | True |
Requirements | The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest | |
Definition | Indicates 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. |
Cardinality | 0...1 |
Type | BackboneElement |
Must Support | True |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationRequest.dispenseRequest.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.initialFill | |
Definition | Indicates the quantity or duration for the first dispense of the medication. |
Cardinality | 0...1 |
Type | BackboneElement |
Comments | If populating this element, either the quantity or the duration must be included. |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.initialFill.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationRequest.dispenseRequest.initialFill.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.initialFill.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.initialFill.quantity | |
Definition | The amount or quantity to provide as part of the first dispense. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.initialFill.duration | |
Definition | The length of time that the first dispense is expected to last. |
Cardinality | 0...1 |
Type | Duration |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.dispenseInterval | |
Definition | The minimum period of time that must occur between dispenses of the medication. |
Cardinality | 0...1 |
Type | Duration |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.validityPeriod | |
Definition | This indicates the validity period of a prescription (stale dating the Prescription). |
Cardinality | 0...1 |
Type | Period |
Requirements | Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.numberOfRepeatsAllowed | |
Definition | An 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. |
Cardinality | 0...1 |
Type | unsignedInt |
Comments | If displaying "number of authorized fills", add 1 to this number. |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.quantity | |
Definition | The number of units of the medication to be supplied per dispense. Usually value and unit are stated which are free text variants. If a structured code is used it must be from UnitsOfMeasure. |
Cardinality | 1...1 |
Type | SimpleQuantity |
Must Support | True |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.quantity.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationRequest.dispenseRequest.quantity.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.quantity.value | |
Definition | Number prescribed |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.quantity.comparator | |
Definition | Not allowed to be used in this context |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.quantity.unit | |
Definition | This is a free text field that can be used to specify the units of the prescription. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.quantity.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Fixed Value | http://unitsofmeasure.org |
Mappings |
|
MedicationRequest.dispenseRequest.quantity.code | |
Definition | If a structured code is used it must be from UnitsOfMeasure |
Cardinality | 0...1 |
Type | code |
Summary | True |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.expectedSupplyDuration | |
Definition | Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. |
Cardinality | 0...1 |
Type | Duration |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.performer | |
Definition | Indicates the intended dispensing Organization specified by the prescriber. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.substitution | |
Definition | Indicates 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. |
Cardinality | 0...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
MedicationRequest.substitution.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MedicationRequest.substitution.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MedicationRequest.substitution.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.substitution.allowed[x] | |
Definition | True if the prescriber allows a different drug to be dispensed from what was prescribed. |
Cardinality | 1...1 |
Type | boolean |
Binding | Identifies the type of substitution allowed. |
Comments | This element is labeled as a modifier because whether substitution is allow or not, it cannot be ignored. |
Invariants |
|
Mappings |
|
MedicationRequest.substitution.reason | |
Definition | Indicates the reason for the substitution, or why substitution must or must not be performed. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.priorPrescription | |
Definition | A link to a resource representing an earlier order related order or prescription. |
Cardinality | 0...1 |
Type | Reference(MedicationRequest) |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.detectedIssue | |
Definition | Indicates 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. |
Cardinality | 0...* |
Type | Reference(DetectedIssue) |
Alias | Contraindication, Drug Utilization Review (DUR), Alert |
Comments | 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. |
Invariants |
|
Mappings |
|
MedicationRequest.eventHistory | |
Definition | Links 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. |
Cardinality | 0...* |
Type | Reference(Provenance) |
Comments | 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.). |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="erp-service-request-medication-request" /> <url value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-medication-request" /> <version value="1.2" /> <name value="ERPServiceRequestMedicationRequest" /> <title value="ERP Service Request Medication Request" /> <status value="draft" /> <experimental value="false" /> <date value="2025-01-01" /> <publisher value="gematik GmbH" /> <description value="Medical and pharmaceutical information for the prescription request" /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="MedicationRequest" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/MedicationRequest" /> <derivation value="constraint" /> <differential> <element id="MedicationRequest.extension"> <path value="MedicationRequest.extension" /> <comment value="If the previous recipe ID is known, it can be named here" /> <mustSupport value="true" /> </element> <element id="MedicationRequest.extension:PriorPrescriptionID"> <path value="MedicationRequest.extension" /> <sliceName value="PriorPrescriptionID" /> <short value="Provide a previous PrescriptionID that corresponds to the requested medication." /> <definition value="The MedicationRequest can contain a PrescriptionId of a prescription that has already been issued.\nIf a previous prescription ID is known, the writing system MAY indicate this in the medication request.\nIf this ID is available, the receiving system MUST be able to search for the previous regulation and give the user the opportunity to display and compare the content." /> <comment value="Must be given in the form xxx.xxx.xxx.xxx.xxx.xx." /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/prescription-id-ex" /> </type> <mustSupport value="true" /> </element> <element id="MedicationRequest.modifierExtension:requestMVO"> <path value="MedicationRequest.modifierExtension" /> <sliceName value="requestMVO" /> <short value="Multiple prescription order" /> <definition value="If the prescription is should be a multiple prescription order. Only the 'Kennzeichen' should be stated, indicating that the prescription is requested to be a multiple prescription order." /> <comment value="When this extension is received by a PVS, the prescriber has to be visually notified about the request for a multiple prescription order." /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/request-mvo-ex" /> </type> <mustSupport value="true" /> <isModifierReason value="When this extension is received by a PVS, the prescriber has to be visually notified about the request for a multiple prescription order." /> </element> <element id="MedicationRequest.medication[x]"> <path value="MedicationRequest.medication[x]" /> <type> <code value="Reference" /> <targetProfile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Medication_PZN" /> <targetProfile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Medication_Compounding" /> <targetProfile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Medication_Ingredient" /> <targetProfile value="https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Medication_FreeText" /> </type> <mustSupport value="true" /> </element> <element id="MedicationRequest.subject"> <path value="MedicationRequest.subject" /> <short value="Patient for whom a dispense is requested on behalf of the patient." /> <type> <code value="Reference" /> <targetProfile value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-patient" /> </type> <mustSupport value="true" /> </element> <element id="MedicationRequest.dosageInstruction"> <path value="MedicationRequest.dosageInstruction" /> <mustSupport value="true" /> </element> <element id="MedicationRequest.dosageInstruction.text"> <path value="MedicationRequest.dosageInstruction.text" /> <short value="Dosieranweisung" /> <definition value="Dosieranweisung einer Verordnung" /> <maxLength value="500" /> <mustSupport value="true" /> </element> <element id="MedicationRequest.dosageInstruction.patientInstruction"> <path value="MedicationRequest.dosageInstruction.patientInstruction" /> <short value="Gebrauchsanweisung einer Rezeptur" /> <definition value="Gebrauchsanweisung einer Rezeptur" /> <maxLength value="500" /> <mustSupport value="true" /> </element> <element id="MedicationRequest.dispenseRequest"> <path value="MedicationRequest.dispenseRequest" /> <mustSupport value="true" /> </element> <element id="MedicationRequest.dispenseRequest.quantity"> <path value="MedicationRequest.dispenseRequest.quantity" /> <short value="Number of prescribed units" /> <definition value="The number of units of the medication to be supplied per dispense. Usually value and unit are stated which are free text variants. If a structured code is used it must be from UnitsOfMeasure." /> <min value="1" /> <mustSupport value="true" /> </element> <element id="MedicationRequest.dispenseRequest.quantity.value"> <path value="MedicationRequest.dispenseRequest.quantity.value" /> <short value="Number prescribed" /> <definition value="Number prescribed" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="MedicationRequest.dispenseRequest.quantity.unit"> <path value="MedicationRequest.dispenseRequest.quantity.unit" /> <short value="Requested units of the prescription" /> <definition value="This is a free text field that can be used to specify the units of the prescription." /> <min value="1" /> <mustSupport value="true" /> </element> <element id="MedicationRequest.dispenseRequest.quantity.system"> <path value="MedicationRequest.dispenseRequest.quantity.system" /> <fixedUri value="http://unitsofmeasure.org" /> </element> <element id="MedicationRequest.dispenseRequest.quantity.code"> <path value="MedicationRequest.dispenseRequest.quantity.code" /> <short value="Code from Unit of measure" /> <definition value="If a structured code is used it must be from UnitsOfMeasure" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "erp-service-request-medication-request", "url": "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-medication-request", "version": "1.2", "name": "ERPServiceRequestMedicationRequest", "title": "ERP Service Request Medication Request", "status": "draft", "experimental": false, "date": "2025-01-01", "publisher": "gematik GmbH", "description": "Medical and pharmaceutical information for the prescription request", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "MedicationRequest", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/MedicationRequest", "derivation": "constraint", "differential": { "element": [ { "id": "MedicationRequest.extension", "path": "MedicationRequest.extension", "comment": "If the previous recipe ID is known, it can be named here", "mustSupport": true }, { "id": "MedicationRequest.extension:PriorPrescriptionID", "path": "MedicationRequest.extension", "sliceName": "PriorPrescriptionID", "short": "Provide a previous PrescriptionID that corresponds to the requested medication.", "definition": "\nThe MedicationRequest can contain a PrescriptionId of a prescription that has already been issued.\nIf a previous prescription ID is known, the writing system MAY indicate this in the medication request.\nIf this ID is available, the receiving system MUST be able to search for the previous regulation and give the user the opportunity to display and compare the content.\n", "comment": "Must be given in the form xxx.xxx.xxx.xxx.xxx.xx.", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/prescription-id-ex" ] } ], "mustSupport": true }, { "id": "MedicationRequest.modifierExtension:requestMVO", "path": "MedicationRequest.modifierExtension", "sliceName": "requestMVO", "short": "Multiple prescription order", "definition": "If the prescription is should be a multiple prescription order. Only the 'Kennzeichen' should be stated, indicating that the prescription is requested to be a multiple prescription order.", "comment": "When this extension is received by a PVS, the prescriber has to be visually notified about the request for a multiple prescription order.", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/request-mvo-ex" ] } ], "mustSupport": true, "isModifierReason": "When this extension is received by a PVS, the prescriber has to be visually notified about the request for a multiple prescription order." }, { "id": "MedicationRequest.medication[x]", "path": "MedicationRequest.medication[x]", "type": [ { "code": "Reference", "targetProfile": [ "https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Medication_PZN", "https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Medication_Compounding", "https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Medication_Ingredient", "https://fhir.kbv.de/StructureDefinition/KBV_PR_ERP_Medication_FreeText" ] } ], "mustSupport": true }, { "id": "MedicationRequest.subject", "path": "MedicationRequest.subject", "short": "Patient for whom a dispense is requested on behalf of the patient.", "type": [ { "code": "Reference", "targetProfile": [ "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-patient" ] } ], "mustSupport": true }, { "id": "MedicationRequest.dosageInstruction", "path": "MedicationRequest.dosageInstruction", "mustSupport": true }, { "id": "MedicationRequest.dosageInstruction.text", "path": "MedicationRequest.dosageInstruction.text", "short": "Dosieranweisung", "definition": "Dosieranweisung einer Verordnung", "maxLength": 500, "mustSupport": true }, { "id": "MedicationRequest.dosageInstruction.patientInstruction", "path": "MedicationRequest.dosageInstruction.patientInstruction", "short": "Gebrauchsanweisung einer Rezeptur", "definition": "Gebrauchsanweisung einer Rezeptur", "maxLength": 500, "mustSupport": true }, { "id": "MedicationRequest.dispenseRequest", "path": "MedicationRequest.dispenseRequest", "mustSupport": true }, { "id": "MedicationRequest.dispenseRequest.quantity", "path": "MedicationRequest.dispenseRequest.quantity", "short": "Number of prescribed units", "definition": "The number of units of the medication to be supplied per dispense. Usually value and unit are stated which are free text variants. If a structured code is used it must be from UnitsOfMeasure.", "min": 1, "mustSupport": true }, { "id": "MedicationRequest.dispenseRequest.quantity.value", "path": "MedicationRequest.dispenseRequest.quantity.value", "short": "Number prescribed", "definition": "Number prescribed", "min": 1, "mustSupport": true }, { "id": "MedicationRequest.dispenseRequest.quantity.unit", "path": "MedicationRequest.dispenseRequest.quantity.unit", "short": "Requested units of the prescription", "definition": "This is a free text field that can be used to specify the units of the prescription.", "min": 1, "mustSupport": true }, { "id": "MedicationRequest.dispenseRequest.quantity.system", "path": "MedicationRequest.dispenseRequest.quantity.system", "fixedUri": "http://unitsofmeasure.org" }, { "id": "MedicationRequest.dispenseRequest.quantity.code", "path": "MedicationRequest.dispenseRequest.quantity.code", "short": "Code from Unit of measure", "definition": "If a structured code is used it must be from UnitsOfMeasure" } ] } }
Terminologie Bindings
Folgende Bindings sind für diese Ressource spezifiziert:
Constraints
Folgende Constraints sind für diese Ressource spezifiziert: