MedicationRequest
CareConnect-MedicationRequest-1 (MedicationRequest) | I | MedicationRequest | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | I | 0..1 | Narrative |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
repeatInformation | I | 0..1 | Extension(Complex) |
statusReason | I | 0..1 | Extension(Complex) |
prescriptionType | I | 0..1 | Extension(CodeableConcept) |
modifierExtension | ?! I | 0..* | Extension |
identifier | 0..* | Identifier | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
definition | Σ I | 0..* | Reference(ActivityDefinition | PlanDefinition) |
basedOn | Σ I | 0..* | Reference(CarePlan | ProcedureRequest | ReferralRequest | ) |
groupIdentifier | Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference() |
status | Σ ?! | 0..1 | codeBinding |
intent | Σ ?! | 1..1 | codeBinding |
category | 0..1 | CodeableConceptBinding | |
priority | Σ | 0..1 | codeBinding |
medication[x] | Σ | 1..1 | |
medicationCodeableConcept | CodeableConcept | ||
medicationReference | Reference() | ||
subject | Σ I | 1..1 | Reference(Group | ) |
context | I | 0..1 | Reference(EpisodeOfCare | https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1) |
supportingInformation | I | 0..* | Reference(Resource) |
authoredOn | Σ | 0..1 | dateTime |
requester | Σ I | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
agent | Σ I | 1..1 | Reference(RelatedPerson | Device | | | ) |
onBehalfOf | Σ I | 0..1 | Reference() |
recorder | I | 0..1 | Reference() |
reasonCode | 0..* | CodeableConcept | |
reasonReference | I | 0..* | Reference( | ) |
note | 0..* | Annotation | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
author[x] | Σ | 0..1 | |
authorString | string | ||
authorReference | Reference(RelatedPerson | | ) | ||
time | Σ | 0..1 | dateTime |
text | 1..1 | string | |
dosageInstruction | 0..* | Dosage | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
sequence | Σ | 0..1 | integer |
text | Σ | 0..1 | string |
additionalInstruction | Σ | 0..* | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..1 | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
snomedCTDescriptionID | I | 0..1 | Extension(Complex) |
system | Σ | 1..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
patientInstruction | Σ | 0..1 | string |
timing | Σ | 0..1 | Timing |
asNeeded[x] | Σ | 0..1 | |
asNeededBoolean | boolean | ||
asNeededCodeableConcept | CodeableConcept | ||
site | Σ | 0..1 | CodeableConcept |
route | Σ | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..1 | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
snomedCTDescriptionID | I | 0..1 | Extension(Complex) |
system | Σ | 1..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
method | Σ | 0..1 | CodeableConcept |
dose[x] | Σ | 0..1 | |
doseRange | Range | ||
doseQuantity | SimpleQuantity | ||
maxDosePerPeriod | Σ I | 0..1 | Ratio |
maxDosePerAdministration | Σ I | 0..1 | SimpleQuantity |
maxDosePerLifetime | Σ I | 0..1 | SimpleQuantity |
rate[x] | Σ | 0..1 | |
rateRatio | Ratio | ||
rateRange | Range | ||
rateQuantity | SimpleQuantity | ||
dispenseRequest | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
validityPeriod | I | 0..1 | Period |
numberOfRepeatsAllowed | 0..1 | positiveInt | |
quantity | I | 0..1 | SimpleQuantity |
id | 0..1 | string | |
extension | I | 0..* | Extension |
quantityText | I | 0..1 | Extension(string) |
value | Σ | 0..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | Σ | 0..1 | string |
system | Σ I | 0..1 | uri |
code | Σ | 0..1 | code |
expectedSupplyDuration | I | 0..1 | Duration |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | Σ | 1..1 | decimal |
comparator | Σ ?! | 0..1 | codeBinding |
unit | Σ | 0..1 | string |
system | Σ I | 1..1 | uriFixed Value |
code | Σ | 1..1 | codeBinding |
performer | I | 0..1 | Reference() |
substitution | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
allowed | ?! | 1..1 | boolean |
reason | 0..1 | CodeableConcept | |
priorPrescription | I | 0..1 | Reference() |
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 | id |
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. |
Invariants |
|
Mappings |
|
MedicationRequest.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may 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. |
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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
Invariants |
|
Mappings |
|
MedicationRequest.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. Common Languages (extensible) |
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 may 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 in formation 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. |
Mappings |
|
MedicationRequest.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order 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. |
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.extension:repeatInformation | |
Definition | Medication repeat information. |
Cardinality | 0...1 |
Type | Extension(Complex) |
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. |
Invariants |
|
Mappings |
|
MedicationRequest.extension:statusReason | |
Definition | To record the reason the medication (plan or order) was stopped and the date this occurred. |
Cardinality | 0...1 |
Type | Extension(Complex) |
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. |
Invariants |
|
Mappings |
|
MedicationRequest.extension:prescriptionType | |
Definition | To record the type of prescription. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
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. |
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. Usually modifier elements provide negation or qualification. In order 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. |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
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.identifier | |
Definition | This records 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. For example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records must be tracked through an entire system. |
Cardinality | 0...* |
Type | Identifier |
Invariants |
|
Mappings |
|
MedicationRequest.identifier.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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.identifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . IdentifierUse (required) |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
MedicationRequest.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Mappings |
|
MedicationRequest.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Examples | General http://www.acme.com/identifiers/patient |
Mappings |
|
MedicationRequest.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
MedicationRequest.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval|Duration. |
Invariants |
|
Mappings |
|
MedicationRequest.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference() |
Summary | True |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants |
|
Mappings |
|
MedicationRequest.definition | |
Definition | Protocol or definition followed by this request. |
Cardinality | 0...* |
Type | Reference(ActivityDefinition | PlanDefinition) |
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.basedOn | |
Definition | A plan or request that is fulfilled in whole or in part by this medication request. |
Cardinality | 0...* |
Type | Reference(CarePlan | ProcedureRequest | ReferralRequest | ) |
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.groupIdentifier.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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.groupIdentifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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.groupIdentifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . IdentifierUse (required) |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
MedicationRequest.groupIdentifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Mappings |
|
MedicationRequest.groupIdentifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Examples | General http://www.acme.com/identifiers/patient |
Mappings |
|
MedicationRequest.groupIdentifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
MedicationRequest.groupIdentifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval|Duration. |
Invariants |
|
Mappings |
|
MedicationRequest.groupIdentifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference() |
Summary | True |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants |
|
Mappings |
|
MedicationRequest.status | |
Definition | A code specifying the current state of the order. Generally this will be active or completed state. |
Cardinality | 0...1 |
Type | code |
Binding | A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription MedicationRequestStatus (required) |
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.intent | |
Definition | Whether the request is a proposal, plan, or an original order. |
Cardinality | 1...1 |
Type | code |
Binding | The kind of medication order MedicationRequestIntent (required) |
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 order and where the medication is expected to be consumed or administered. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept identifying where the medication ordered is expected to be consumed or administered MedicationRequestCategory (preferred) |
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.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 MedicationRequestPriority (required) |
Summary | True |
Comments | Note that FHIR strings may not exceed 1MB in size |
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(), CodeableConcept |
Binding | A coded concept identifying substance or product that can be ordered. SNOMED CT Medication Codes (example) |
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(Group | ) |
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.context | |
Definition | A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider. |
Cardinality | 0...1 |
Type | Reference(EpisodeOfCare | https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1) |
Comments | SubstanceAdministration->component->EncounterEvent. |
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 | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
MedicationRequest.requester.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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.requester.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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.requester.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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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.requester.agent | |
Definition | The healthcare professional responsible for authorizing the initial prescription. |
Cardinality | 1...1 |
Type | Reference(RelatedPerson | Device | | | ) |
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. |
Invariants |
|
Mappings |
|
MedicationRequest.requester.onBehalfOf | |
Definition | The organization the device or practitioner was acting on behalf of. |
Cardinality | 0...1 |
Type | Reference() |
Summary | True |
Requirements | Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. |
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.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() |
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 the medication. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A coded concept indicating why the medication was ordered. Condition/Problem/Diagnosis Codes (example) |
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( | ) |
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.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.note.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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.note.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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.note.author[x] | |
Definition | The individual responsible for making the annotation. |
Cardinality | 0...1 |
Type | Reference(RelatedPerson | | ), string |
Summary | True |
Invariants |
|
Mappings |
|
MedicationRequest.note.time | |
Definition | Indicates when this particular annotation was made. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Invariants |
|
Mappings |
|
MedicationRequest.note.text | |
Definition | The text of the annotation. |
Cardinality | 1...1 |
Type | string |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction | |
Definition | Indicates how the medication is to be used by the patient. |
Cardinality | 0...* |
Type | Dosage |
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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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.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 | Free text dosage instructions e.g. SIG. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.additionalInstruction | |
Definition | Supplemental instruction - e.g. "with meals". |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". SNOMED CT Additional Dosage Instructions (example) |
Summary | True |
Requirements | Additional instruction such as "Swallow with plenty of water" which may or may not be coded. |
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.additionalInstruction.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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.additionalInstruction.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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.additionalInstruction.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Slicing | Unordered, Open, by system(Value) |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Summary | True |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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.additionalInstruction.coding:snomedCT.extension:snomedCTDescriptionID | |
Definition | The SNOMED CT Description ID for the display. |
Cardinality | 0...1 |
Type | Extension(Complex) |
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. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://snomed.info/sct |
Mappings |
|
MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.additionalInstruction.coding:snomedCT.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.additionalInstruction.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.patientInstruction | |
Definition | Instructions in terms that are understood by the patient or consumer. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Note that FHIR strings may 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. The Schedule 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 may 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, CodeableConcept |
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. SNOMED CT Medication As Needed Reason Codes (example) |
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. SNOMED CT Anatomical Structure for Administration Site Codes (example) |
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 body-site-instance. 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. SNOMED CT Route Codes (example) |
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.route.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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.route.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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.route.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Slicing | Unordered, Open, by system(Value) |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.route.coding:snomedCT | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration. (preferred) |
Summary | True |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.route.coding:snomedCT.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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.route.coding:snomedCT.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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.route.coding:snomedCT.extension:snomedCTDescriptionID | |
Definition | The SNOMED CT Description ID for the display. |
Cardinality | 0...1 |
Type | Extension(Complex) |
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. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.route.coding:snomedCT.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://snomed.info/sct |
Mappings |
|
MedicationRequest.dosageInstruction.route.coding:snomedCT.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.route.coding:snomedCT.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.route.coding:snomedCT.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.route.coding:snomedCT.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
MedicationRequest.dosageInstruction.route.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
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. SNOMED CT Administration Method Codes (example) |
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.dose[x] | |
Definition | Amount of medication per dose. |
Cardinality | 0...1 |
Type | Range, SimpleQuantity |
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.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.dosageInstruction.rate[x] | |
Definition | Amount of medication per unit of time. |
Cardinality | 0...1 |
Type | Ratio, Range, SimpleQuantity |
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. |
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 |
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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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.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. |
Cardinality | 0...1 |
Type | positiveInt |
Comments | If displaying "number of authorized fills", add 1 to this number. |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.quantity | |
Definition | The amount that is to be dispensed for one fill. |
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.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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.quantity.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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.extension:quantityText | |
Definition | Quantity representation. |
Cardinality | 0...1 |
Type | Extension(string) |
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. |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.quantity.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 0...1 |
Type | decimal |
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. QuantityComparator (required) |
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 | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.quantity.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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 may 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 |
|
Mappings |
|
MedicationRequest.dispenseRequest.quantity.code | |
Definition | A computer processable form of the unit in some unit representation system. |
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.expectedSupplyDuration.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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.expectedSupplyDuration.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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.expectedSupplyDuration.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
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.expectedSupplyDuration.comparator | |
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. QuantityComparator (required) |
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 | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.expectedSupplyDuration.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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 may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.dispenseRequest.expectedSupplyDuration.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 1...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.expectedSupplyDuration.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
Binding | A unit of time (units from UCUM). UnitsOfTime (required) |
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.performer | |
Definition | Indicates the intended dispensing Organization specified by the prescriber. |
Cardinality | 0...1 |
Type | Reference() |
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 |
Comments | Note that FHIR strings may not exceed 1MB in size |
Invariants |
|
Mappings |
|
MedicationRequest.substitution.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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 | |
Definition | True if the prescriber allows a different drug to be dispensed from what was prescribed. |
Cardinality | 1...1 |
Type | boolean |
Modifier | True |
Comments | This element is labeled as a modifer because whether substitution is allow or not 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. SubstanceAdminSubstitutionReason (example) |
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() |
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 | 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.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 may 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 |
|
Background
Medication orders within UK ePMA systems and how the are supported with FHIR
Typically within UK hospitals, ePMA systems support three types of medication request (or order).
- Initial medication request
- Re-supply of a previous medication
- Discharge medication request
Initial medication request
Represents the first time a request for a medicine is made for a patient. This can include a long-term medicine or an acute medicine for a specified duration. Each request shall be for one medication.
The structured dosage instruction shall specify the administration requirement, for example: "50 mg daily with food", and any time or dosing bounds - for example: "for 7 days", all represented in the structured and machine readable FHIR dosage structure.
Most ePMA medication requests are deemed to be on-going unless specifically stated within the dosage instruction with date, time or dose bounds. Where no end criteria is specified the hospital pharmacy will typically dispense a quantity of medication as per their local agreed best practice. For example, sufficient medication for a given number of days, depending on how frequently the ward and pharmacy want to re-order medication.
When more medication is required, a “Re-Supply Medication Request” should be submitted.
Re-Supply Medication Request
When a patient requires a re-supply of the same medication as previously ordered.
For a minimum viable product (MVP) implementation it is recommended to reference a previous MedicationRequest
using the priorPrescription
element. This can either reference the last MedicationRequest or the first MedicationRequest. This choice can be a local implementation decision.
basedOn
element. For this guidance it is recommended basedOn
, if used, it used to reference a CarePlan resource.
It is recommended that a re-supply should;
- only be made against a previous order that has a status of
active
orcomplete
- be identical to the previous supply with regard to the medication and dosageInstruction
- allow a different requester and / or recorder to the previous supply
- allow a different dispenseRequest (if implemented within the system) to the previous supply to cater for the scenario where a re-supply is required for a certain number of days or quantity of medication. For example, a final supply prior to the end of the treatment or course or before the patient is to be discharged.
Discharge Medication Request
When a patient requires medication that they will take away with them on discharge from hospital for administration at home. This could be following an inpatient stay or from an outpatient department.
A discharge medication request is identified using the category element with a value of discharge
.
Discharge medication for patient self-administration at home may be;
- labelled differently to medications administered within the hospital
- include specific dispensing instructions for pharmacy within the dispenseRequest element
- identified differently within the ePMA system to ensure the patient receives the medication before they leave the hospital
- used as in input for discharge instructions for the patient’s GP for medication that should be continued.
FHIR Resource Relationships
This implementation guidance defines a Minimum Viable Product (MVP) for each FHIR Resource required to support the target use case of medication requests from a hospital ePMA system to a hospital pharmacy system.
An implementation is recommended to adhere to the MVP but can also choose to implement other elements from the chosen FHIR standard. For the purposes of this guidance, an “implementation” is the partnership between an ePMA system supplier and a hospital pharmacy system supplier within a given Trust.
The MVP requires the implementation of four FHIR Resources, profiled within CareConnect implementation of FHIR STU3:
The MedicationRequest can reference many other FHIR resources but the four above are required for the recommended MVP.
Minimum Viable Product
Links to the definitions of MedicationRequest
covered within this guidance:
Element: definition
It is recommended this element is optional for an MVP implementation.
Element: basedOn
A reference to any number of CarePlan
, MedicationRequest
, ServiceRequest
or ReferralRequest
resources.
priorPrescription
.
If the clinical system has implemented the
CarePlan
resource, a logical link to the care plan for which the medication request is based has business benefit.
Element: groupIdentifier
The ability to group medication requests from the same requester, and in additional for the same patient may add business benefit in an enhanced implementation. Such medication requests may or may not be contained within the same interaction
Bundle
.
For example, the FHIR interface for the Electronic Prescription Service uses the
groupIdentifier
to group medication requests for the same patient, prescribed at the same time, contained within a single Bundle
.
Where Bundles are not used, or where requests are split across Bundles then the groupIdentifier
provides the means to link requests by the same prescriber for the same patient.
Element: status
When used it must be populated with a fixed valueset defined within the FHIR standard.
It is expected that most implementations will require the use of status to support workflow.
The scope of status
may vary depending on the nature of the implementation. The FHIR standard defines the status
of Completed
as “All actions that are implied by the prescription have occurred”.
This allows for different design decisions for tracking a medication request status.
An implementation may track the
status
through to the receipt of the medication request at the pharmacy, after which thestatus
isCompleted
An implementation may track the
status
through to completion of dispensing events, after which thestatus
isCompleted
An implementation may track the
status
through to completion of administration events for the medication that has been dispensed, after which thestatus
isCompleted
.
The following guidance is based on an implementation tracking the status through to completion of dispensing events.
Status | FHIR Definition | Recommendation |
---|---|---|
Draft |
The prescription is not yet "actionable", e.g. it is a work in progress, requires sign-off, verification or needs to be run through decision support process. | The order is work in progress within the ePMA system and has not yet sent to the pharmacy. |
Active |
The prescription is "actionable", but not all actions that are implied by it have occurred yet. | The order has been sent and accepted by the pharmacy. Dispensing and administration activities may of started but are not yet `Complete`. |
Completed |
All actions that are implied by the prescription have occurred yet. | Dispensing activities have been completed for the medication defined within the order. |
On-Hold |
Actions implied by the prescription are to be temporarily halted, but are expected to continue later. May also be called `Suspended`. | Will prevent the order being sent to the pharmacy. If already sent, an update needs to be sent to the pharmacy to temporarily halt further dispensing. |
Cancelled |
The prescription has been withdrawn before any administrations have occurred. | Will prevent the order being sent to the pharmacy. If already sent, an update needs to be sent to the pharmacy so that no further medication is dispensed. |
Stopped |
Actions implied by the prescription are to be permanently halted, before all of the administrations occurred. This should not be used if the original order was entered in error. | The order needs to be stopped on clinical grounds. An update needs to be sent to the pharmacy so that no further medication is dispensed. |
Entered in Error |
Some of the actions that are implied by the medication request may have occurred. For example, the medication may have been dispensed and the patient may have taken some of the medication. Clinical decision support systems should take this status into account. | The order needs to be stopped due to human data entry error. An update needs to be sent to the pharmacy so that no further medication is dispensed. |
Unknown |
The authoring/source system does not know which of the status values currently applies for this observation. Note: This concept is not to be used for ‘other’ - one of the listed statuses is presumed to apply, but the authoring/source system does not know which. | Recommended not to be supported as the use case for this status value is unclear. |
Logical medicationRequest
status transitions
This state transition diagram is an enhancement over the generic State Machine defined within the FHIR specification. It includes the status values associated with a medication request with transitions applicable to a UK implementation.
Status transitions explained
Previous | Future | Interoperability Recommendation |
---|---|---|
Draft |
Active |
This transition will trigger the sending / sharing of the MedicationRequest from the ePMA system to the pharmacy system to start dispensing activities. Within a RESTful implementation this would be typically implemented as an HTTP POST .
|
Draft |
Cancelled |
Contained within the ePMA system. |
Draft |
On-Hold |
Contained within the ePMA system. |
Draft |
Entered-in-Error |
Contained within the ePMA system. |
On-Hold |
Draft |
Contained within the ePMA system. |
On-Hold |
Active |
This transition will trigger an update to the MedicationRequest from the ePMA system to the pharmacy system to restart dispensing activities. Within a RESTful implementation this would be typically implemented as either an HTTP PUT or HTTP PATCH .
|
On-Hold |
Active |
Contained within the ePMA system. |
On-Hold |
Stopped |
Contained within the ePMA system. |
On-Hold |
Entered-in-error |
Contained within the ePMA system. |
Active |
Active |
Not a MedicationRequest status transition but the pharmacy system could send / share dispensing activities with the ePMA system, typically using a FHIR profile based on MedicationDispense . Within a RESTful implementation this would be typically implemented as an HTTP POST .
|
Active |
On-Hold |
This transition will trigger an update to the MedicationRequest from the ePMA system to the pharmacy system to suspend dispensing activities. Within a RESTful implementation this would be typically implemented as either an HTTP PUT or PATCH .
If dispensing has already occurred but meds have not been delivered to the ward then they can stay within the pharmacy until the request is re-activated. If meds have been delivered to the ward then there is no action required by the pharmacy system. |
Active |
Entered-in-Error |
This transition will trigger an update to the MedicationRequest from the ePMA system to the pharmacy system to stop dispensing activities. Within a RESTful implementation this would be typically implemented as either an HTTP PUT or PATCH .
|
Active |
Stopped |
This transition will trigger an update to the MedicationRequest from the ePMA system to the pharmacy system to stop dispensing activities. Within a RESTful implementation this would be typically implemented as either an HTTP PUT or PATCH .
|
Active |
Completed |
Contained within the ePMA system. All requested medication has been received from pharmacy and has been recorded / confirmed within the ePMA system. |
Element: intent
The value order
should be used to denote this is a medication request order.
Element: category
It is expected that any implementation will need to distinguish between medication orders for processes for dispensing and / or administration so this element is business required.
The STU3
suggested value-set is defined as:
inpatient
outpatient
community
The R4
suggested value-set is extended with discharge
.
For a UK implementation based on STU3
, it is recommended to extend this value-set with both discharge
and leave
.
Category | FHIR Definition / Description |
---|---|
inpatient |
Includes requests for medications to be administered or consumed in an inpatient or acute care setting. |
outpatient |
Includes requests for medications to be administered or consumed in an outpatient setting (for example, Emergency Department, Outpatient Clinic, Outpatient Surgery, Doctor’s office). |
community |
Includes requests for medications to be administered or consumed by the patient in their home (this would include long term care or nursing homes, hospices, etc.). |
discharge |
Includes requests for medications created when the patient is being released from a facility. |
leave |
Note: Not included within the FHIR standard. Requests for medications that the patient will take away with them during any short break from inpatient care. Typically requests would be dispensed by the hospital pharmacy to be self-administered at home with or without the assistance of community based nursing staff. |
Category values mapped to target use-cases
The in-scope use-cases for this version of the implementation guidance are as follows:
Category | Use-case | Scenario |
---|---|---|
inpatient |
Inpatient medication requests, for a named patient, to be dispensed by the hospital pharmacy and intended for administration on a hospital ward. | Patient Anne Teak is admitted as an inpatient is prescribed Amoxicillin 500mg orally three times daily for a suspected chest infection. |
inpatient |
Medication requests, for a named patient who is on short-term leave from an inpatient stay (but is not discharged), to be dispensed by the hospital pharmacy and intended for administration at home. | Current inpatient Jackie Taitor is going home for weekend leave and is prescribed 3 days supply of Citalopram 20mg tablets one to be taken in the morning. |
inpatient |
Discharge medications requests, for a named patient, to be dispensed by the hospital pharmacy and issued on discharge for administration at home. | Patient Bill Ding is discharged from hospital following an admission where they were diagnosed as being diabetic. They were prescribed 4 weeks quantity of Metformin 500mg tablets to take twice daily on an on-going basis. Their GP will be instructed to continue this course of medication within a discharge note. |
outpatient |
Outpatient medication requests, for a named patient, to be dispensed by the hospital pharmacy and intended for administration in the Outpatients department, Accident and Emergency department, or Day unit. | Patient Moe DeGrasse is prescribed a Goserelin 3.6mg implant to be administered by IM injection in the Outpatients department on 1st May 2020. |
outpatient |
Outpatient medication requests, for a named patient, to be dispensed by the hospital pharmacy for administration at home. | Patient Lorna Mower has attended the dermatology outpatients clinic and is prescribed Betamethasone 0.1% cream to be applied sparingly twice daily for 2 weeks. |
Element: priority
The stating of a priority, in any business context including healthcare, is often de-valued as given the choice, every clinician wants medication urgently for their patients.
The FHIR standard uses a fixed value-set, that cannot be modified, denoting priority in increasing order of magnitude, with stat
being the highest possible priority, e.g. an emergency.
Code | Display | Definition |
---|---|---|
routine |
Routine | The request has normal priority. |
urgent |
Urgent | The order should be urgently. |
stat |
STAT | The order is time-critical. |
asap |
ASAP | The order should be acted on as soon as possible. |
Usage of the term "STAT"
The STAT
request priority is potentially confusing as it has two meanings:
- to indicate a "here and now" order going to pharmacy
- used within a
dosageInstruction
can also mean "give once immediately"
If priority
is used, consider only initially supporting the routine
and urgent
request priorities, and set clear criteria for when a medicationRequest
should be marked and handled as urgent
.
Element: medication[x]
Where the requested medication is contained within the NHS dm+d then it must be recorded using the dm+d standard
Medication
resource.
Note: At the time of writing an alpha implementation of a dm+d FHIR Medication Resource Server is available from the North East CSU as a demonstrator and associated API.
It is recommended that the medicationReference.display
is populated with the medication description as selected by the clinician. This may be slightly different to the medication described as returned by a SNOMED/dm+d terminology FHIR server if the ePMA system has not fully implemented dm+d into their medication picking list.
Requested medication with no dm+d code
Medication not published within the dm+d may be requested in the Acute care setting.
In this scenario it is recommended to use the CodeableConcept
variant for this element.
Software logic can then clearly distinguish this from nationally coded dm+d medication.
If the ePMA system has both a locally assigned code and description for the medication then;
- The
medicationCodeableConcept.text
should be the description for the medication. - The
medicationCodeableConcept.coding.code
should be the code for the medication. - The
medicationCodeableConcept.coding.display
should be the description for the medication, i.e. the same value asmedicationCodeableConcept.text
.
If the ePMA system only has a description for the medication then;
- The
medicationCodeableConcept.text
should be the locally assigned description for the medication.
Element: subject
Note: It is acknowledged that a typical Hospital Patient Administration System (PAS) available today will not expose a FHIR interface so referencing by URL will most likely not be available for some time; however, this should be a target architecture so that the FHIR-enabled PAS can be used as a trusted source of Patient resources across multiple hospital systems.
See population of a Patient resource.
Element: context
It is recommended this element is optional for an MVP implementation.
If implemented as a reference to an Encounter resource, within R4 this is supported by a new encounter element, giving a clear migration path.
Any reference to an EpisodeOfCare
resource within an STU3
or CareConnect
implementation will not be supported if migrated to FHIR R4
.
EpisodeOfCare
resource within an STU3
implementation.
Element: supportingInformation
Can reference any number of FHIR resources and if implemented, some examples of use include:
- Reference an Observation resource to share data like the patient’s height and weight.
- Reference a Condition resource to share a patient’s condition if this influences the pharmacy dispensing process. For example; 105502003 Dependence on renal dialysis (finding) or 46177005 End stage renal disease (disorder) would justify an unusual dosage on a prescription.
- Reference an AllergyIntolorance resource to share a patient’s allergy to make it clear why certain medication is being requested. For example, a Penicillin allergy.
- Reference a CarePlan resource where medication dispensing is considered as part of a specific treatment regimen. For example, care plans for stroke patients.
Element: requester
- should be a required business element for most MVP implementations
- should be the prescriber recorded on the ePMA system for the medication request
- should implement as a reference a FHIR Practitioner resource.
Where an implementation requires the identification of a person plus an organisation then the solution differs depending on the version of FHIR. Within an STU3
implementation, reference an Organization resource within the requester.onBehalfOf
element.
Within an R4
implementation replace the Practitioner
resource with a PractitionerRole
resource.
Element: recorder
recorder
as a required business element for most MVP implementations to be used as an additional point of contact for the pharmacy, together with the requester for any queries related to the medication request.
Requester and Recorder combination examples
Scenario | Requester | Recorder |
---|---|---|
Prescibing clinician Fred is requesting new medication | Fred | Fred |
Prescibing clinician Fred is re-ordering previous medication he previously prescribed | Fred | Fred |
Prescibing clinician Jane is re-ordering previous medication, without any clinical changes, that Fred previously prescribed | Fred | Jane |
Prescibing clinician Jane is re-ordering previous medication that Fred previously prescribed, with clinical changes | Jane | Jane |
Nurse Rodger is ordering medication prescribed by Fred | Fred | Rodger |
Pharmacy technical Sally is re-ordering medication prescribed by Fred | Fred | Sally |
Element: reasonCode
Optional, but useful to the wider clinical team as an additional safety check, especially if the requested medication is normally prescribed for different reasons, to avoid confusion between clinical teams. Recording an indication against a medication request also gives valuable insight when data is collated for secondary uses, especially if linked with outcome data.
Where possible this should be a coded term from the SNOMED-CT hierarchy as a descendant of the concept 404684003 (Clinical finding); however, free-text reasons are also acceptable.
reasonCode
and reasonReference
are mutually exclusive and not both populated.
Element: reasonReference
A reference to a FHIR Condition
or Observation
resource.
indication
, as either a Condition
or Observation
resource) then a logical link to that resource has business benefit. If implemented, reasonCode
and reasonReference
are mutually exclusive and should not both be populated.
Element: note
An optional element for when the ePMA user wishes to provides supporting textual information to the pharmacy. This element must not be used for dosing instructions, see dosageInstruction.
Where no supporting information is required, this element can be omitted.
Element: dosageInstruction
Population of just the dosageInstruction.text
element would be unacceptable for a successful implementation.
Refer to FHIR Dose Syntax Implementation Guidance (or any subsequent version) for guidance.
View the R4 FHIR Dose Syntax Guidance
Element: dispenseRequest
Used to convey specific dispensing requests to the pharmacy that are not otherwise detailed within the dosageInstruction
For most medication requests the hospital pharmacy will typically dispense a quantity of medication appropriate for the medication and dosage, as per their local agreed best practice, to balance the quantity of medication held in pharmacy to that held on the ward.
The inclusion of a dispenseRequest
may be useful when requesting discharge medication requests.
Use case | Original Medication | Discharge Medication | Dispense request |
---|---|---|---|
Instruction to the pharmacy to dispense a specific quantity of medication, either expressed as a number of days or as a dose form quantity. | Paracetamol - 1g - four times a day | Paracetamol - 1g - four times a day | 7 days or 56 tablets |
Any inpatient scenario where the pharmacy is instructed to dispense a specific quantity of medication. For example, if the patient is known to be discharged soon. | Atenolol - 50mg - daily | Atenolol - 50mg - daily | 3 tablets |
Element: substitution
Within UK healthcare, substitution is not the norm so the international FHIR definition where "If nothing is specified substitution may be done." does not align with UK healthcare prescribing best practice.
It could be unwise to assume all UK implementations will prevent substitution if not explicitly stated, especially if the same clinical system has been previously implemented outside the UK.
false
to denote substitution is not allowed.
Allowing substitution
Where substitution to be be allowed, set to true
. The inclusion of the coded reason is optional as the valueset defined in FHIR is of limited benefit to UK healthcare.
Element: priorPrescription
An optional element for when either the ePMA or pharmacy system would benefit from being able to link re-supply requests with a previous request.
The published FHIR specifications described this element is slightly different ways in different parts of the FHIR specification:
- A link to a resource representing an earlier order related order or prescription.
- An order or prescription that is being replaced.
The following guidance applies to each use case.
Linking to an earlier request
A medication request that is a re-supply medication request based on a previous request referenced within priorPrescription
. This would allow both the ePMA and pharmacy systems to logically link requests and add verification checks to flag any differences to the user.
Linking to an order that is being replaced
The medicationRequest
being replaced will be referenced within priorPrescription
. It would be expected that the referenced resource would be updated with a status of cancelled
, entered-in-error
or stopped
.
This will allow both the ePMA and pharmacy systems to make it clear to the human user that one medication request replaces another.
Element: detectedIssue
It is recommended this element is optional for an MVP implementation.
Element: eventHistory
It is recommended this element is optional for an MVP implementation.
Element: id
It is highly recommended that the logical id value is a Universally Unique Identifier (UUID) using a standard UUID generator available in most programming languages. The most comprehensive current definition of the logical id is within the FHIR R4 standard.
Optional as this is an internally facing unique identifier. The unique business identifier essential for interoperability is an identifier
.
Element: text
It is recommended this element is not implemented as part of an MVP.
or
Where the user of the ePMA system has selected a pre-defined medication order, often known as an “order sentence”, the textual description of the order sentence should be populated as the text for this resource.
This is so that the text chosen on-screen by the user is captured within the MedicationRequest
resource. Where an ePMA system does not use a concept akin to selecting an order sentence then this element does not form part of the recommended MVP.
Element: repeatInformation
(extension)
It is recommended this element is optional for an MVP implementation.
Element: statusReason
(extension)
It is recommended this element is optional for an MVP implementation.
Within the CareConnect implementation of STU3, this element was modelled as an extension (statusreason).
If used as part of a CareConnect implementation then it would migrate to being the statusReason within an R4 implementation.
Element: prescriptionType
(extension)
It is recommended this element is optional for an MVP implementation.
Note: The value set for this STU3
extension aligns with the legacy HL7v3
PrescriptionTreatmentType
vocabulary:
- acute
- repeat
- repeat dispensing
- delayed prescribing.
If UK Core R4 is extended to support this type of data then the extension name should ideally not be called prescriptionType
as it confused with a different legacy HL7v3
vocabulary for prescriptionType
which serves a different purpose