Linked Care Implementation Guide
0.9.1 - ci-build
Linked Care Implementation Guide - Local Development build (v0.9.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Definitions for the linca-dipsense-documentation resource profile.
Guidance on how to interpret the contents of this table can be found here
0. MedicationDispense | |
Definition | Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order. |
Short | Dispensing a medication to a named patient |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() )dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() )dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.exists() )mdd-1: whenHandedOver cannot be before whenPrepared ( whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared ) |
2. MedicationDispense.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Short | Logical id of this artifact |
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
Control | 0..1 |
Type | id |
Is Modifier | false |
Must Support | false |
Summary | true |
4. MedicationDispense.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Short | Metadata about the resource |
Control | 0..1 |
Type | Meta |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
6. MedicationDispense.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Short | A set of rules under which this content was created |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
8. MedicationDispense.language | |
Definition | The base language in which the resource is written. |
Short | Language of the resource content |
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). |
Control | 0..1 |
Binding | The codes SHALL be taken from AllLanguages IETF language tag for a human language |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
10. MedicationDispense.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Short | Text summary of the resource, for human interpretation |
Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Control | 0..1 This element is affected by the following invariants: dom-6 |
Type | Narrative |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | narrative, html, xhtml, display |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
12. MedicationDispense.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
Short | Contained, inline Resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. |
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
14. MedicationDispense.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
16. MedicationDispense.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Must Support | false |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
18. MedicationDispense.identifier | |
Definition | Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
Short | External identifier |
Comments | This is a business identifier, not a resource identifier. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
20. MedicationDispense.basedOn | |
Definition | A plan that is fulfilled in whole or in part by this MedicationDispense. |
Short | Plan that is fulfilled by this dispense |
Control | 0..* |
Type | Reference(CarePlan) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
22. MedicationDispense.partOf | |
Definition | The procedure or medication administration that triggered the dispense. |
Short | Event that dispense is part of |
Comments | While both a procedure and a medication administration may have triggered the dispense, but it is not expected that multiple procedures and/or multiple medication administrations would be triggers. |
Control | 0..* |
Type | Reference(Procedure, MedicationAdministration) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
24. MedicationDispense.status | |
Definition | A code specifying the state of the set of dispense events. |
Short | A dispense ends the chain of the workflow. Therefore the status is fixed to 'completed' |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Control | 1..1 |
Binding | The codes SHALL be taken from MedicationDispenseStatusCodes Describes the lifecycle of the dispense. |
Type | code |
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Pattern Value | completed |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
26. MedicationDispense.notPerformedReason | |
Definition | Indicates the reason why a dispense was not performed. |
Short | Why a dispense was not performed |
Control | 0..1 |
Binding | For example codes, see MedicationDispenseStatusReasonCodes |
Type | CodeableReference(DetectedIssue) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
28. MedicationDispense.statusChanged | |
Definition | The date (and maybe time) when the status of the dispense record changed. |
Short | When the status changed |
Control | 0..1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
30. MedicationDispense.category | |
Definition | Indicates the type of medication dispense (for example, drug classification like ATC, where meds would be administered, legal category of the medication.). |
Short | Type of medication dispense |
Comments | The category can be used to include where the medication is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind. |
Control | 0..* |
Binding | For example codes, see MedicationDispenseAdministrationLocationCodes A code describing where the dispensed medication is expected to be consumed or administered. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
32. MedicationDispense.medication | |
Definition | Identifies the medication supplied. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
Short | Medication that was dispensed, in conformance with ELGA CodeSystems (text-only, or text and number referencing one of the supported catalogs, as for example the PZN of the Austrian ASP). |
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, then you must reference the Medication resource. |
Control | 1..1 |
Binding | The codes SHALL be taken from https://termgit.elga.gv.at/CodeSystem-asp-liste |
Type | CodeableReference(LINCA Medication (LINCAMeds)) |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
34. MedicationDispense.subject | |
Definition | A link to a resource representing the person or the group to whom the medication will be given. |
Short | Patient conform HL7 AT. Make sure the patient is identifiable somehow |
Comments | SubstanceAdministration->subject->Patient. |
Control | 1..1 |
Type | Reference(HL7® AT Core Patient Profile) |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
36. MedicationDispense.encounter | |
Definition | The encounter that establishes the context for this event. |
Short | Encounter associated with event |
Control | 0..1 |
Type | Reference(Encounter) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
38. MedicationDispense.supportingInformation | |
Definition | Additional information that supports the medication being dispensed. For example, there may be requirements that a specific lab test has been completed prior to dispensing or the patient's weight at the time of dispensing is documented. |
Short | Information that supports the dispensing of the medication |
Control | 0..* |
Type | Reference(Resource) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
40. MedicationDispense.performer | |
Definition | Indicates who or what performed the event. |
Short | Who performed event |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
42. MedicationDispense.performer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
44. MedicationDispense.performer.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
46. MedicationDispense.performer.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
48. MedicationDispense.performer.function | |
Definition | Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker. |
Short | Who performed the dispense and what they did |
Control | 0..1 |
Binding | For example codes, see MedicationDispensePerformerFunctionCodes A code describing the role an individual played in dispensing a medication. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Allows disambiguation of the types of involvement of different performers. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
50. MedicationDispense.performer.actor | |
Definition | The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication. |
Short | Reference to dispensing pharmacy (GDA index) |
Control | 1..1 |
Type | Reference(Organization) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
52. MedicationDispense.location | |
Definition | The principal physical location where the dispense was performed. |
Short | Where the dispense occurred |
Control | 0..1 |
Type | Reference(Location) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
54. MedicationDispense.authorizingPrescription | |
Definition | Indicates the medication order that is being dispensed against. |
Short | Prescription that authorized dispense of this medication |
Comments | Maps to basedOn in Event logical model. |
Control | 1..1 |
Type | Reference(LINCA Prescription (LINCAPrescriptionMedicationRequest)) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
56. MedicationDispense.type | |
Definition | Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. |
Short | Possible values: FFC (First-fill complete for completly fulfilled orders), FFP (first-fill part fill, for pratially fulfilled orders) |
Control | 0..1 |
Binding | For example codes, see ActPharmacySupplyType ActPharmacySupplyType |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
58. MedicationDispense.quantity | |
Definition | The amount of medication that has been dispensed. Includes unit of measure. |
Short | Amount dispensed |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
60. MedicationDispense.daysSupply | |
Definition | The amount of medication expressed as a timing amount. |
Short | Amount of medication expressed as a timing amount |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
62. MedicationDispense.recorded | |
Definition | The date (and maybe time) when the dispense activity started if whenPrepared or whenHandedOver is not populated. |
Short | When the recording of the dispense started |
Control | 0..1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
64. MedicationDispense.whenPrepared | |
Definition | The time when the dispensed product was packaged and reviewed. |
Short | When product was packaged and reviewed |
Control | 0..1 This element is affected by the following invariants: mdd-1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
66. MedicationDispense.whenHandedOver | |
Definition | The time the dispensed product was provided to the patient or their representative. |
Short | When product was given out |
Control | 0..1 This element is affected by the following invariants: mdd-1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
68. MedicationDispense.destination | |
Definition | Identification of the facility/location where the medication was/will be shipped to, as part of the dispense event. |
Short | Where the medication was/will be sent |
Control | 0..1 |
Type | Reference(Location) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
70. MedicationDispense.receiver | |
Definition | Identifies the person who picked up the medication or the location of where the medication was delivered. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location. |
Short | Who collected the medication or where the medication was delivered |
Control | 0..* |
Type | Reference(Patient, Practitioner, RelatedPerson, Location, PractitionerRole) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
72. MedicationDispense.note | |
Definition | Extra information about the dispense that could not be conveyed in the other attributes. |
Short | Information about the dispense |
Control | 0..* |
Type | Annotation |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
74. MedicationDispense.renderedDosageInstruction | |
Definition | The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses. |
Short | Full representation of the dosage instructions |
Comments | The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content. |
Control | 0..1 |
Type | markdown |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
76. MedicationDispense.dosageInstruction | |
Definition | Indicates how the medication is to be used by the patient. |
Short | How the medication is to be used by the patient or administered by the caregiver |
Comments | When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed. |
Control | 0..* |
Type | Dosage |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
78. MedicationDispense.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. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
80. MedicationDispense.dosageInstruction.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on MedicationDispense.dosageInstruction.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
82. MedicationDispense.dosageInstruction.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
84. MedicationDispense.dosageInstruction.sequence | |
Definition | Indicates the order in which the dosage instructions should be applied or interpreted. |
Short | The order of the dosage instructions |
Control | 0..1 |
Type | integer |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
86. MedicationDispense.dosageInstruction.text | |
Definition | Free text dosage instructions e.g. SIG. |
Short | Free text dosage instructions e.g. SIG |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
88. MedicationDispense.dosageInstruction.additionalInstruction | |
Definition | Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps"). |
Short | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" |
Comments | Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or take "immediately following drug x") should be populated in dosage.text. |
Control | 0..* |
Binding | For example codes, see SNOMEDCTAdditionalDosageInstructions A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Requirements | Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, "Swallow with plenty of water" which might or might not be coded. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
90. MedicationDispense.dosageInstruction.patientInstruction | |
Definition | Instructions in terms that are understood by the patient or consumer. |
Short | Patient or consumer oriented instructions |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
92. MedicationDispense.dosageInstruction.timing | |
Definition | When medication should be administered. |
Short | When medication should be administered |
Comments | This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing. |
Control | 0..1 |
Type | Timing |
Is Modifier | false |
Summary | true |
Requirements | The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
94. MedicationDispense.dosageInstruction.asNeeded | |
Definition | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option). |
Short | Take "as needed" |
Comments | Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. |
Control | 0..1 This element is affected by the following invariants: dos-1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
96. MedicationDispense.dosageInstruction.asNeededFor | |
Definition | Indicates whether the Medication is only taken based on a precondition for taking the Medication (CodeableConcept). |
Short | Take "as needed" (for x) |
Comments | Can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be False, then the dose is given according to the schedule and is not "prn" or "as needed". |
Control | 0..* This element is affected by the following invariants: dos-1 |
Binding | For example codes, see SNOMEDCTMedicationAsNeededReasonCodes 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. |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
98. MedicationDispense.dosageInstruction.site | |
Definition | Body site to administer to. |
Short | Body site to administer to |
Comments | If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension http://hl7.org/fhir/StructureDefinition/bodySite. May be a summary code, or a reference to a very precise definition of the location, or both. |
Control | 0..1 |
Binding | For example codes, see SNOMEDCTAnatomicalStructureAdministrationSites A coded concept describing the site location the medicine enters into or onto the body. |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Requirements | A coded specification of the anatomic site where the medication first enters the body. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
100. MedicationDispense.dosageInstruction.route | |
Definition | How drug should enter body. |
Short | How drug should enter body |
Control | 0..1 |
Binding | For example codes, see SNOMEDCTRouteCodes A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Requirements | A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
102. MedicationDispense.dosageInstruction.method | |
Definition | Technique for administering medication. |
Short | Technique for administering medication |
Comments | Terminologies used often pre-coordinate this term with the route and or form of administration. |
Control | 0..1 |
Binding | For example codes, see SNOMEDCTAdministrationMethodCodes A coded concept describing the technique by which the medicine is administered. |
Type | CodeableConcept |
Is Modifier | false |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
104. MedicationDispense.dosageInstruction.doseAndRate | |
Definition | Depending on the resource,this is the amount of medication administered, to be administered or typical amount to be administered. |
Short | Amount of medication administered, to be administered or typical amount to be administered |
Control | 0..* |
Type | Element |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
106. MedicationDispense.dosageInstruction.doseAndRate.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
108. MedicationDispense.dosageInstruction.doseAndRate.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on MedicationDispense.dosageInstruction.doseAndRate.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
110. MedicationDispense.dosageInstruction.doseAndRate.type | |
Definition | The kind of dose or rate specified, for example, ordered or calculated. |
Short | The kind of dose or rate specified |
Control | 0..1 |
Binding | For example codes, see DoseAndRateType The kind of dose or rate specified. |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Requirements | If the type is not populated, assume to be "ordered". |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
112. MedicationDispense.dosageInstruction.doseAndRate.dose[x] | |
Definition | Amount of medication per dose. |
Short | Amount of medication per dose |
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. |
Control | 0..1 |
Type | Choice of: Range, Quantity(SimpleQuantity) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Is Modifier | false |
Summary | true |
Requirements | The amount of therapeutic or other substance given at one administration event. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
Slicing | This element introduces a set of slices on MedicationDispense.dosageInstruction.doseAndRate.dose[x] . The slices are unordered and Open, and can be differentiated using the following discriminators: |
114. MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity | |
Slice Name | doseQuantity |
Definition | The comparator is not used on a SimpleQuantity |
Short | A fixed quantity (no comparator) |
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. |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Is Modifier | false |
Requirements | The amount of therapeutic or other substance given at one administration event. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists() )sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty() ) |
116. MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
118. MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on MedicationDispense.dosageInstruction.doseAndRate.dose[x].extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
120. MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Short | Numerical value (with implicit precision) |
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). |
Control | 0..1 |
Type | decimal |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
122. MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.comparator | |
Definition | Not allowed to be used in this context |
Short | < | <= | >= | > | ad - how to understand the value |
Control | 0..0 |
Binding | The codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented. |
Type | code |
Is Modifier | true because 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 |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
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. |
Meaning if Missing | If there is no comparator, then there is no modification of the value |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
124. MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.unit | |
Definition | A human-readable form of the unit. |
Short | Unit representation |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
126. MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Short | System that defines coded unit form |
Control | 0..1 This element is affected by the following invariants: qty-3 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
128. MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Short | Coded form of the unit |
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. |
Control | 0..1 This element is affected by the following invariants: qty-3 |
Binding | The codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/elga-medikationdarreichungsform |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
130. MedicationDispense.dosageInstruction.doseAndRate.rate[x] | |
Definition | Amount of medication per unit of time. |
Short | Amount of medication per unit of time |
Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammar where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour. |
Control | 0..1 |
Type | Choice of: Ratio, Range, Quantity(SimpleQuantity) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Is Modifier | false |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
132. MedicationDispense.dosageInstruction.maxDosePerPeriod | |
Definition | Upper limit on medication per unit of time. |
Short | Upper limit on medication per unit of time |
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". |
Control | 0..* |
Type | Ratio |
Is Modifier | false |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
134. MedicationDispense.dosageInstruction.maxDosePerAdministration | |
Definition | Upper limit on medication per administration. |
Short | Upper limit on medication 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. |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Summary | true |
Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
136. MedicationDispense.dosageInstruction.maxDosePerLifetime | |
Definition | Upper limit on medication per lifetime of the patient. |
Short | Upper limit on medication per lifetime of the patient |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Summary | true |
Requirements | The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
138. MedicationDispense.substitution | |
Definition | Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done. |
Short | Whether a substitution was performed on the dispense |
Control | 0..1 |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
140. MedicationDispense.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. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
142. MedicationDispense.substitution.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
144. MedicationDispense.substitution.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
146. MedicationDispense.substitution.wasSubstituted | |
Definition | True if the dispenser dispensed a different drug or product from what was prescribed. |
Short | Whether a substitution was or was not performed on the dispense |
Control | 1..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
148. MedicationDispense.substitution.type | |
Definition | A code signifying whether a different drug was dispensed from what was prescribed. |
Short | Code signifying whether a different drug was dispensed from what was prescribed |
Control | 0..1 |
Binding | For example codes, see ActSubstanceAdminSubstitutionCode ActSubstanceAdminSubstitutionCode |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
150. MedicationDispense.substitution.reason | |
Definition | Indicates the reason for the substitution (or lack of substitution) from what was prescribed. |
Short | Why was substitution made |
Control | 0..* |
Binding | For example codes, see SubstanceAdminSubstitutionReason SubstanceAdminSubstitutionReason |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
152. MedicationDispense.substitution.responsibleParty | |
Definition | The person or organization that has primary responsibility for the substitution. |
Short | Who is responsible for the substitution |
Control | 0..1 |
Type | Reference(Practitioner, PractitionerRole, Organization) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
154. MedicationDispense.eventHistory | |
Definition | A summary of the events of interest that have occurred, such as when the dispense was verified. |
Short | A list of relevant lifecycle events |
Comments | This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.). |
Control | 0..* |
Type | Reference(Provenance) |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |