Page Status: updated 2022-03-25
Dosage
Page index
Introduction
The profile NLLDosage is not a profile on a standalone resource, but on a BackBoneElement called Dosage. A Dosage, shown in the profile NLLDosage, represents a dosage within a prescription or dispense. The dosageInstruction element in a MedicationRequest or MedicationDispense makes it possible to describe how a medication should be used by the patient in a structured machine readable way. The vast number of ways to use different medications can make it quite complex to specify a dosage instruction in the correct way. This page aims to explain some of the concepts used in the Swedish National Medication List, but it is important to read the complete documentation in Handbok för vård- och apotekstjänster to fully understand how to create and understand a dosage instruction.
There are also a number of examples here Dosage - Create that can be of help to understand how different type of instructions are created i FHIR messages.
Regarding information about how the "must support"-property is used in the Swedish National MedicationList, please refer to the page Resources
Overview
NLLDosage (Dosage) | Dosage | There are no (further) constraints on this element Element idDosage How the medication is/was taken or should be taken DefinitionIndicates how the medication is/was taken or should be taken by the patient.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
nllObservandumDose | S I | 0..1 | Extension(boolean) | Element idDosage.extension:nllObservandumDose Dose exceeds recommended dose Alternate namesextensions, user content DefinitionIndicates that the prescriber has made a conscious choice where the dose exceeds what is recommended for the prescribed medication. NB! The same value must be provided in this element on each sequence / subsequence. http://electronichealth.se/fhir/StructureDefinition/NLLObservandumDose Constraints
|
nllAdministeringInstruction | S I | 0..1 | Extension(string) | Element idDosage.extension:nllAdministeringInstruction Patient oriented administration instructions Alternate namesextensions, user content DefinitionAdministration instructions put in terms that are comprehensible to the patient. This shall be generated from the structured administration information attributes. Maximum string length: 512 <br> NB! The same value must be provided in this element on each sequence / subsequence. http://electronichealth.se/fhir/StructureDefinition/NLLAdministeringInstruction Constraints
|
nllMedicalDevice | S I | 0..1 | Extension(CodeableConcept) | Element idDosage.extension:nllMedicalDevice Medical device to use for administration. Alternate namesextensions, user content DefinitionMedical device to use for administration. If there is no appropriate coded value, then the code OTH=Other should be used together with the free text element "text” NB! The same value must be provided in this element on each sequence / subsequence. http://electronichealth.se/fhir/StructureDefinition/NLLMedicalDevice Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.extension:nllMedicalDevice.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.extension:nllMedicalDevice.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idDosage.extension:nllMedicalDevice.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://electronichealth.se/fhir/StructureDefinition/NLLMedicalDevice
| |
value[x] | S | 1..1 | There are no (further) constraints on this element Element idDosage.extension:nllMedicalDevice.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.extension:nllMedicalDevice.value[x].id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.extension:nllMedicalDevice.value[x].extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | S Σ | 0..1 | CodingBinding | Element idDosage.extension:nllMedicalDevice.value[x].coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. http://electronichealth.se/fhir/ValueSet/nll-snomed-medical-device (required) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.extension:nllMedicalDevice.value[x].coding.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.extension:nllMedicalDevice.value[x].coding.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element idDosage.extension:nllMedicalDevice.value[x].coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 reference to some definition that establishes the system clearly and unambiguously.
|
version | S Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.extension:nllMedicalDevice.value[x].coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | code | There are no (further) constraints on this element Element idDosage.extension:nllMedicalDevice.value[x].coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.extension:nllMedicalDevice.value[x].coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idDosage.extension:nllMedicalDevice.value[x].coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | S Σ | 0..1 | string | Element idDosage.extension:nllMedicalDevice.value[x].text Plain text representation of the concept DefinitionA 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. 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. Maximum string length: 256
256
|
nllSubSequence | S I | 0..1 | Extension(integer) | Element idDosage.extension:nllSubSequence Subsequence Alternate namesextensions, user content DefinitionIndicates the order of subqeuences within a sequence. Only used in dosage type "tillfällesdosering”, using "timeOfDay" or "when" The purpose of a subsequence is to provide a repeating mechanism within a sequence. Subsequences enable communication of irregular dosage schedules that should be repeated within a sequence. <br> NB! There are a number of elements that must contain the same values on each sequence and subsequence. For example the dose unit and dose rate unit, the site, route and method and the asNeeded-attribute. http://electronichealth.se/fhir/StructureDefinition/NLLSubSequence Constraints
|
nllDosageType | S I | 0..1 | Extension(code) | Element idDosage.extension:nllDosageType Dosage type Alternate namesextensions, user content DefinitionCalculated by the Swedish eHealth Agency. The dosage type that matches the provided set of dosage data. _ http://electronichealth.se/fhir/StructureDefinition/NLLDosageType Constraints
|
nllSiteQualifier | S I | 0..1 | Extension(CodeableConcept) | Element idDosage.extension:nllSiteQualifier More precise administration site Alternate namesextensions, user content DefinitionQualified adminsitration site is used when more exact information about the site is needed. To be used only when combinated with MedicationRequest.dosageInstruction.site.coding If there is no appropriate coded value, then the code OTH=Other must be used in combination the free text attribute "text". NB! The same value must be provided in this element on each sequence / subsequence. http://electronichealth.se/fhir/StructureDefinition/NLLSiteQualifier Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.extension:nllSiteQualifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.extension:nllSiteQualifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idDosage.extension:nllSiteQualifier.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. http://electronichealth.se/fhir/StructureDefinition/NLLSiteQualifier
| |
value[x] | S | 1..1 | There are no (further) constraints on this element Element idDosage.extension:nllSiteQualifier.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.extension:nllSiteQualifier.value[x].id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.extension:nllSiteQualifier.value[x].extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | S Σ | 1..1 | CodingBinding | There are no (further) constraints on this element Element idDosage.extension:nllSiteQualifier.value[x].coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. http://electronichealth.se/fhir/ValueSet/nll-snomed-qualifier (required) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.extension:nllSiteQualifier.value[x].coding.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.extension:nllSiteQualifier.value[x].coding.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element idDosage.extension:nllSiteQualifier.value[x].coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 reference to some definition that establishes the system clearly and unambiguously.
|
version | S Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.extension:nllSiteQualifier.value[x].coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | code | Element idDosage.extension:nllSiteQualifier.value[x].coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.extension:nllSiteQualifier.value[x].coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idDosage.extension:nllSiteQualifier.value[x].coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | S Σ | 0..1 | string | Element idDosage.extension:nllSiteQualifier.value[x].text Plain text representation of the concept DefinitionA 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. 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. Maximum string length: 256
256
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
sequence | S Σ | 1..1 | integer | Element idDosage.sequence The order of the dosage instructions DefinitionIndicates the order in which the dosage instructions should be applied or interpreted. If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential. NB! There are a number of elements that must contain the same values on each sequence and subsequence. For example the dose unit and dose rate unit, the site, route and method and the asNeeded-attribute.
|
text | S Σ | 0..1 | string | Element idDosage.text Free text dosage DefinitionFree text dosage In the Swedish National Medication List there will be either a free text dosage or coded dosage instructions, never both. Maximum string length: 512
512
|
additionalInstruction | S Σ | 0..1 | CodeableConcept | Element idDosage.additionalInstruction Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" DefinitionSupplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps"). In the Swedish National Medication List Additional instruction is written in free text. NB! The same value must be provided in this element on each sequence / subsequence. A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.additionalInstruction.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.additionalInstruction.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idDosage.additionalInstruction.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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.
|
text | S Σ | 0..1 | string | Element idDosage.additionalInstruction.text Plain text representation of the concept DefinitionA 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. In the Swedish National Medication List Additional instruction is written in free text. Maximum string length: 512
512
|
patientInstruction | S Σ | 1..1 | string | Element idDosage.patientInstruction Patient oriented dosage instructions DefinitionDosage instructions in terms that are understood by the patient. This shall be generated from the structured dosage information attributes. Maximum string length: 512 <br> NB! The same value must be provided in this element on each sequence / subsequence.
512
|
timing | S Σ | 0..1 | Timing | Element idDosage.timing When medication should be administered DefinitionWhen medication should be administered. The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. _
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.timing.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.timing.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.timing.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
event | Σ | 0..* | dateTime | There are no (further) constraints on this element Element idDosage.timing.event When the event occurs DefinitionIdentifies specific times when the event occurs. In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.
|
repeat | S Σ I | 0..1 | Element | There are no (further) constraints on this element Element idDosage.timing.repeat When the event is to occur DefinitionA set of rules that describe when the event is scheduled. Many timing schedules are determined by regular repetitions.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.timing.repeat.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.timing.repeat.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
nllSubSequenceDuration | S I | 0..1 | Extension(Quantity) | Element idDosage.timing.repeat.extension:nllSubSequenceDuration SubSequence duration Alternate namesextensions, user content DefinitionThe duration of the subsequence. This can only be used if there is a subsequence within the sequence. The length of a subsequence is always in the form of a quantity (never a range) and it can only be expressed in days, not hours, weeks or months. Used for the dosage type "tillfällesdosering". _ http://electronichealth.se/fhir/StructureDefinition/NLLSubSequenceDuration Constraints
|
bounds[x] | S Σ | 0..1 | Element idDosage.timing.repeat.bounds[x] Length/Range of lengths DefinitionEither a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. Unordered, Open, by $this(Type) Constraints
| |
boundsDuration | S Σ | 0..1 | Duration | Element idDosage.timing.repeat.bounds[x]:boundsDuration Sequence length DefinitionA duration for the length of the timing schedule.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.timing.repeat.bounds[x]:boundsDuration.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.timing.repeat.bounds[x]:boundsDuration.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
value | S Σ | 1..1 | decimal | Element idDosage.timing.repeat.bounds[x]:boundsDuration.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idDosage.timing.repeat.bounds[x]:boundsDuration.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size If there is no comparator, then there is no modification of the value How the Quantity should be understood and represented.
|
unit | Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.timing.repeat.bounds[x]:boundsDuration.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | S Σ I | 0..1 | uri | There are no (further) constraints on this element Element idDosage.timing.repeat.bounds[x]:boundsDuration.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
code | S Σ | 1..1 | codeBindingFixed Value | Element idDosage.timing.repeat.bounds[x]:boundsDuration.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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. sequence-length-units (required) Constraints
d
|
boundsRange | S Σ | 0..1 | Range | Element idDosage.timing.repeat.bounds[x]:boundsRange Range of lengths DefinitionA range of possible length.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.timing.repeat.bounds[x]:boundsRange.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.timing.repeat.bounds[x]:boundsRange.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
low | S Σ I | 1..1 | SimpleQuantity | Element idDosage.timing.repeat.bounds[x]:boundsRange.low Low limit DefinitionThe low limit. The boundary is inclusive. If the low element is missing, the low boundary is not known.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.timing.repeat.bounds[x]:boundsRange.low.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.timing.repeat.bounds[x]:boundsRange.low.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
value | S Σ | 1..1 | decimal | Element idDosage.timing.repeat.bounds[x]:boundsRange.low.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idDosage.timing.repeat.bounds[x]:boundsRange.low.comparator < | <= | >= | > - how to understand the value DefinitionNot allowed to be used in this context Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size If there is no comparator, then there is no modification of the value How the Quantity should be understood and represented.
|
unit | Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.timing.repeat.bounds[x]:boundsRange.low.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | S Σ I | 0..1 | uri | There are no (further) constraints on this element Element idDosage.timing.repeat.bounds[x]:boundsRange.low.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
code | S Σ | 1..1 | codeBindingFixed Value | Element idDosage.timing.repeat.bounds[x]:boundsRange.low.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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. sequence-length-units (required) Constraints
d
|
high | S Σ I | 1..1 | SimpleQuantity | Element idDosage.timing.repeat.bounds[x]:boundsRange.high High limit DefinitionThe high limit. The boundary is inclusive. If the high element is missing, the high boundary is not known.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.timing.repeat.bounds[x]:boundsRange.high.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.timing.repeat.bounds[x]:boundsRange.high.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
value | S Σ | 1..1 | decimal | Element idDosage.timing.repeat.bounds[x]:boundsRange.high.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
|
comparator | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idDosage.timing.repeat.bounds[x]:boundsRange.high.comparator < | <= | >= | > - how to understand the value DefinitionNot allowed to be used in this context Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size If there is no comparator, then there is no modification of the value How the Quantity should be understood and represented.
|
unit | Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.timing.repeat.bounds[x]:boundsRange.high.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | S Σ I | 0..1 | uri | There are no (further) constraints on this element Element idDosage.timing.repeat.bounds[x]:boundsRange.high.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
code | S Σ | 1..1 | codeBindingFixed Value | Element idDosage.timing.repeat.bounds[x]:boundsRange.high.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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. sequence-length-units (required) Constraints
d
|
count | S Σ | 0..1 | positiveInt | Element idDosage.timing.repeat.count Single dose DefinitionA total count of the desired number of repetitions across the duration of the entire timing specification. In the Swedish National Medication List count is used for describing single dosages that occur one (1) time. The only value allowed is count=1 If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.
|
countMax | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idDosage.timing.repeat.countMax Maximum number of times to repeat DefinitionIf present, indicates that the count is a range - so to perform the action between [count] and [countMax] times. 32 bit number; for values larger than this, use decimal
|
duration | S Σ | 0..1 | decimal | Element idDosage.timing.repeat.duration Duration of the administration DefinitionDuration of the administration of the medication Duration is handled with a maximum precision of 4 decimals. Corresponding regex: (0|[1-9][0-9]*)(.[0-9][0-9][0-9][0-9])
|
durationMax | Σ | 0..1 | decimal | There are no (further) constraints on this element Element idDosage.timing.repeat.durationMax How long when it happens (Max) DefinitionIf present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. Some activities are not instantaneous and need to be maintained for a period of time. For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).
|
durationUnit | S Σ | 0..1 | codeBinding | Element idDosage.timing.repeat.durationUnit min | h - unit of time (UCUM) DefinitionThe units of time for the duration, in UCUM units. Note that FHIR strings SHALL NOT exceed 1MB in size A unit of time (units from UCUM).
|
frequency | S Σ | 0..1 | positiveInt | Element idDosage.timing.repeat.frequency Event occurs frequency times per period DefinitionThe number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency. 32 bit number; for values larger than this, use decimal If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this
|
frequencyMax | S Σ | 0..1 | positiveInt | Element idDosage.timing.repeat.frequencyMax Event occurs up to frequencyMax times per period DefinitionIf present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. 32 bit number; for values larger than this, use decimal
|
period | S Σ | 0..1 | decimal | Element idDosage.timing.repeat.period Event occurs frequency times per period DefinitionIndicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length. Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
periodMax | S Σ | 0..1 | decimal | Element idDosage.timing.repeat.periodMax Upper limit of period (3-4 hours) DefinitionIf present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
|
periodUnit | S Σ | 0..1 | codeBinding | Element idDosage.timing.repeat.periodUnit h | d - unit of time (UCUM) DefinitionThe units of time for the period in UCUM units. Note that FHIR strings SHALL NOT exceed 1MB in size A unit of time (units from UCUM).
|
dayOfWeek | S Σ | 0..* | codeBinding | Element idDosage.timing.repeat.dayOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIf one or more days of week is provided, then the action happens only on the specified day(s). If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.
|
timeOfDay | S Σ | 0..* | time | Element idDosage.timing.repeat.timeOfDay Time of day for action DefinitionSpecified time of day for action to take place. Must currently be expressed on the hour, i.e. 11:00 or 15:00. This may be changed after the transition period (övergångs-perioden) so that half hours, i.e. 11:30, are allowed, as well. When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. Used for the dosage type "tillfällesdosering". The elements “when, frequency and period” cannot be used with the element “timeOfDay” simultaneously. When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.
|
when | S Σ | 0..* | codeBinding | Element idDosage.timing.repeat.when Code for time period of occurrence DefinitionAn approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. Timings are frequently determined by occurrences such as waking, eating and sleep. _ Real world event relating to the schedule.
|
offset | Σ | 0..1 | unsignedInt | There are no (further) constraints on this element Element idDosage.timing.repeat.offset Minutes from event (before or after) DefinitionThe number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event. 32 bit number; for values larger than this, use decimal
|
code | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idDosage.timing.code BID | TID | QID | AM | PM | QD | QOD | + DefinitionA code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times). Code for a known / defined timing pattern.
|
asNeeded[x] | S Σ | 0..1 | Element idDosage.asNeeded[x] Take "as needed" DefinitionIndicates that the medication only should be taken when needed. NB! The same value must be provided in this element on each sequence / subsequence.
| |
asNeededBoolean | boolean | Data type | ||
site | S Σ | 0..1 | CodeableConcept | Element idDosage.site Site of administration DefinitionSite of administration. A coded specification of the anatomic site where the medication first enters the body. If there is no appropriate coded value, then the code OTH=Other should be used together with the free text attribute "text". NB! The same value must be provided in this element on each sequence / subsequence. A coded concept describing the site location the medicine enters into or onto the body.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.site.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.site.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | S Σ | 1..1 | CodingBinding | Element idDosage.site.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. _ Snomed CT codes for administration site, as stipulated by NLL (terminology server).
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.site.coding.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.site.coding.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element idDosage.site.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 reference to some definition that establishes the system clearly and unambiguously.
|
version | S Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.site.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | code | There are no (further) constraints on this element Element idDosage.site.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.site.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idDosage.site.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | S Σ | 0..1 | string | Element idDosage.site.text Plain text representation of the concept DefinitionA human language representation of the administration site. Used when no specific code can describe the site and the code 'OTH' has been selected. 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. Maximum string length: 256
|
route | S Σ | 0..1 | CodeableConcept | Element idDosage.route How the medication should enter the body DefinitionHow the medication should enter the body. A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. If there is no appropriate coded value, then the code OTH=Other must be used together with the free text attribute "text". NB! The same value must be provided in this element on each sequence / subsequence. A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.route.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.route.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | S Σ | 1..1 | CodingBinding | Element idDosage.route.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. _ Snomed CT codes for administration route, as stipulated by NLL
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.route.coding.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.route.coding.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element idDosage.route.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 reference to some definition that establishes the system clearly and unambiguously.
|
version | S Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.route.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | code | There are no (further) constraints on this element Element idDosage.route.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.route.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idDosage.route.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | S Σ | 0..1 | string | Element idDosage.route.text Plain text representation of the concept DefinitionA human language representation of the administration route. Used when no specific code can describe the route and the code 'OTH' has been selected. 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. Maximum string length: 256
256
|
method | S Σ | 0..1 | CodeableConcept | Element idDosage.method Method used for administering the medication DefinitionMethod used for administering the medication. A coded value indicating the method by which the medication is introduced into or onto the body. If there is no appropriate coded value, then the code OTH=Other should be used together with the free text attribute "text". NB! The same value must be provided in this element on each sequence / subsequence. A coded concept describing the technique by which the medicine is administered.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.method.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.method.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | S Σ | 1..1 | CodingBinding | Element idDosage.method.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. _ Snomed CT codes for administration method, as stipulated by NLL (terminology server).
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.method.coding.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.method.coding.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element idDosage.method.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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 reference to some definition that establishes the system clearly and unambiguously.
|
version | S Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.method.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | code | There are no (further) constraints on this element Element idDosage.method.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.method.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idDosage.method.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | S Σ | 0..1 | string | Element idDosage.method.text Plain text representation of the concept DefinitionA human language representation of the administration method. Used when no specific code can describe the method and the code 'OTH' has been selected. 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. Maximum string length: 256
256
|
doseAndRate | S Σ | 0..1 | Element | There are no (further) constraints on this element Element idDosage.doseAndRate Amount of medication administered DefinitionThe amount of medication administered.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.doseAndRate.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.doseAndRate.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
type | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idDosage.doseAndRate.type The kind of dose or rate specified DefinitionThe kind of dose or rate specified, for example, ordered or calculated. If the type is not populated, assume to be "ordered". Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The kind of dose or rate specified.
|
dose[x] | S Σ | 0..1 | Binding | Element idDosage.doseAndRate.dose[x] Amount of medication per dose DefinitionAmount of medication per dose. The amount of therapeutic or other substance given at one administration event. _ Unordered, Open, by $this(Type) Binding Constraints
|
doseRange | S Σ | 0..1 | Range | Element idDosage.doseAndRate.dose[x]:doseRange Amount of medication per dose DefinitionAmount of medication per dose. The amount of therapeutic or other substance given at one administration event. Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.doseAndRate.dose[x]:doseRange.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.doseAndRate.dose[x]:doseRange.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
low | S Σ I | 1..1 | SimpleQuantity | Element idDosage.doseAndRate.dose[x]:doseRange.low Low limit DefinitionThe low limit. The boundary is inclusive. If the low element is missing, the low boundary is not known.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.doseAndRate.dose[x]:doseRange.low.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.doseAndRate.dose[x]:doseRange.low.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
value | S Σ | 1..1 | decimal | Element idDosage.doseAndRate.dose[x]:doseRange.low.value Dose range low value DefinitionDose range low value Dose range low value is handled with a maximum precision of 4 decimals. Corresponding regex: (0|[1-9][0-9]*)(.[0-9][0-9][0-9][0-9])
|
comparator | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idDosage.doseAndRate.dose[x]:doseRange.low.comparator < | <= | >= | > - how to understand the value DefinitionNot allowed to be used in this context Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size If there is no comparator, then there is no modification of the value How the Quantity should be understood and represented.
|
unit | Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.doseAndRate.dose[x]:doseRange.low.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | S Σ I | 0..1 | uri | There are no (further) constraints on this element Element idDosage.doseAndRate.dose[x]:doseRange.low.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
code | S Σ | 1..1 | code | Element idDosage.doseAndRate.dose[x]:doseRange.low.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
high | S Σ I | 1..1 | SimpleQuantity | Element idDosage.doseAndRate.dose[x]:doseRange.high High limit DefinitionThe high limit. The boundary is inclusive. If the high element is missing, the high boundary is not known.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.doseAndRate.dose[x]:doseRange.high.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.doseAndRate.dose[x]:doseRange.high.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
value | S Σ | 1..1 | decimal | Element idDosage.doseAndRate.dose[x]:doseRange.high.value Dose range high value DefinitionDose range high value Dose range high value is handled with a maximum precision of 4 decimals. Corresponding regex: (0|[1-9][0-9]*)(.[0-9][0-9][0-9][0-9])
|
comparator | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idDosage.doseAndRate.dose[x]:doseRange.high.comparator < | <= | >= | > - how to understand the value DefinitionNot allowed to be used in this context Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size If there is no comparator, then there is no modification of the value How the Quantity should be understood and represented.
|
unit | Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.doseAndRate.dose[x]:doseRange.high.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | S Σ I | 0..1 | uri | There are no (further) constraints on this element Element idDosage.doseAndRate.dose[x]:doseRange.high.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
code | S Σ | 1..1 | code | Element idDosage.doseAndRate.dose[x]:doseRange.high.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
doseQuantity | S Σ | 0..1 | SimpleQuantity | Element idDosage.doseAndRate.dose[x]:doseQuantity Amount of medication per dose DefinitionAmount of medication per dose. The amount of therapeutic or other substance given at one administration event. Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.doseAndRate.dose[x]:doseQuantity.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.doseAndRate.dose[x]:doseQuantity.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
value | S Σ | 0..1 | decimal | Element idDosage.doseAndRate.dose[x]:doseQuantity.value Dose quantity value DefinitionDose quantity value. Dose quantity value is handled with a maximum precision of 4 decimals. Corresponding regex: (0|[1-9][0-9]*)(.[0-9][0-9][0-9][0-9])
|
comparator | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idDosage.doseAndRate.dose[x]:doseQuantity.comparator < | <= | >= | > - how to understand the value DefinitionNot allowed to be used in this context Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size If there is no comparator, then there is no modification of the value How the Quantity should be understood and represented.
|
unit | Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.doseAndRate.dose[x]:doseQuantity.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | S Σ I | 0..1 | uri | There are no (further) constraints on this element Element idDosage.doseAndRate.dose[x]:doseQuantity.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
code | S Σ | 0..1 | code | Element idDosage.doseAndRate.dose[x]:doseQuantity.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
rate[x] | S Σ | 0..1 | Binding | Element idDosage.doseAndRate.rate[x] Amount of medication per unit of time DefinitionAmount of medication per unit of time. _ _
|
rateQuantity | SimpleQuantity | Data type | ||
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.doseAndRate.rate[x].id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.doseAndRate.rate[x].extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
value | S Σ | 0..1 | decimal | Element idDosage.doseAndRate.rate[x].value Rate value DefinitionRate value Rate value is handled with a maximum precision of 4 decimals. Corresponding regex: (0|[1-9][0-9]*)(.[0-9][0-9][0-9][0-9])
|
comparator | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idDosage.doseAndRate.rate[x].comparator < | <= | >= | > - how to understand the value DefinitionNot allowed to be used in this context Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size If there is no comparator, then there is no modification of the value How the Quantity should be understood and represented.
|
unit | Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.doseAndRate.rate[x].unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | S Σ I | 0..1 | uri | There are no (further) constraints on this element Element idDosage.doseAndRate.rate[x].system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
code | S Σ | 1..1 | code | Element idDosage.doseAndRate.rate[x].code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. NB! The same value must be provided in this element on each sequence / subsequence.
|
maxDosePerPeriod | S Σ I | 0..1 | Ratio | Element idDosage.maxDosePerPeriod Upper limit on medication per day DefinitionUpper limit on medication per day. 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. NB! The same value must be provided in this element on each sequence / subsequence.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.maxDosePerPeriod.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.maxDosePerPeriod.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
numerator | S Σ I | 0..1 | QuantityBinding | Element idDosage.maxDosePerPeriod.numerator Numerator value DefinitionThe value of the numerator. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.maxDosePerPeriod.numerator.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.maxDosePerPeriod.numerator.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
value | S Σ | 0..1 | decimal | Element idDosage.maxDosePerPeriod.numerator.value Max dose therapeutic substance value DefinitionMax dose therapeutic substance value NB! If maxDosePerPeriod contains a value, it must be > 0 (greater than zero); i.e 0 and negative numbers are not allowed. Max dose therapeutic substance value is handled with a maximum precision of 4 decimals. Corresponing regex: ^(?!0*[.,]0*$|[.,]0*$|0*$)\d+[,.]?\d{0,4}$
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idDosage.maxDosePerPeriod.numerator.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size If there is no comparator, then there is no modification of the value How the Quantity should be understood and represented.
|
unit | Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.maxDosePerPeriod.numerator.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | S Σ I | 0..1 | uri | There are no (further) constraints on this element Element idDosage.maxDosePerPeriod.numerator.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
code | S Σ | 1..1 | code | Element idDosage.maxDosePerPeriod.numerator.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
|
denominator | S Σ I | 0..1 | QuantityFixed Value | Element idDosage.maxDosePerPeriod.denominator Denominator value DefinitionThe value of the denominator. 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.
{ "value": 1, "system": "http://unitsofmeasure.org", "code": "d" }
|
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.maxDosePerPeriod.denominator.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDosage.maxDosePerPeriod.denominator.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
value | S Σ | 0..1 | decimalFixed Value | Element idDosage.maxDosePerPeriod.denominator.value Numerical value (with implicit precision) DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value. Precision is handled implicitly in almost all cases of measurement. 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).
1
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idDosage.maxDosePerPeriod.denominator.comparator < | <= | >= | > - how to understand the value DefinitionHow 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. Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. Note that FHIR strings SHALL NOT exceed 1MB in size If there is no comparator, then there is no modification of the value How the Quantity should be understood and represented.
|
unit | Σ | 0..1 | string | There are no (further) constraints on this element Element idDosage.maxDosePerPeriod.denominator.unit Unit representation DefinitionA human-readable form of the unit. There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. Note that FHIR strings SHALL NOT exceed 1MB in size
|
system | S Σ I | 0..1 | uriFixed Value | Element idDosage.maxDosePerPeriod.denominator.system System that defines coded unit form DefinitionThe identification of the system that provides the coded form of the unit. Need to know the system that defines the coded form of the unit. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://unitsofmeasure.org
|
code | S Σ | 0..1 | codeFixed Value | Element idDosage.maxDosePerPeriod.denominator.code Coded form of the unit DefinitionA computer processable form of the unit in some unit representation system. 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. 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.
d
|
maxDosePerAdministration | Σ I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idDosage.maxDosePerAdministration Upper limit on medication per administration DefinitionUpper limit on medication per administration. The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg.
|
maxDosePerLifetime | Σ I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idDosage.maxDosePerLifetime Upper limit on medication per lifetime of the patient DefinitionUpper limit on medication per lifetime of the patient. The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
Details
Description of all elements can be found here, Element descriptions.
Mapping of FHIR element names to the National Medication List names can be found here, Element language mappings.
Element dosageInstruction in MedicationRequest and MedicationDispense
The element dosageInstruction is mandatory in MedicationRequest with one exception regarding prescribed consumables, for which a dosage instruction is optional. On a MedicationDispense made based on a prescription available NLL (NLLMedicationDispense) the dosageInstruction must only be specified when it differs from the dosageInstruction on the MedicationRequest. When a prescription isn't available (NLLDispensePaperPrescription), a dosageInstruction shall be specified.
A dosage is described in one or more dosageInstructions. This means that the dosage can be described as a set of 'steps' where each step is described in a separate dosageInstruction.
For each dosageInstruction it is possible to enter information that applies to that specific dosageInstruction/step. NB! Some elements must have the same values on each dosageInstruction (this is validated in the national medication list):
- The dose unit must be the same on all dosageInstructions, i.e. the code form Dosenhet (nll-ucum-unit) or Doseringshastighetsenhet (nll-ucum-rate-unit) must be the same on each dosageInstruction. This also means that it's not allowed to specify 'dose' on some dosageInstructions and 'dose rate' on other dosageInstructions.
- The administering instructions must have the same values on all dosageInstructions, i.e. site, nllSiteQualifier, route, method and nllMedicalDevice must have the same values on each dosageInstruction.
- The patientInstruction, additionalInstruction and nllAdministeringInstruction must have the same values on all dosageInstructions.
- The dosage type must be the same on all dosageInstructions. See Dosage type for more information about different dosage types.
Sequence
The attribute 'sequence' specifies the order of the dosageInstructions. The sequence on the first dosageInstruction must always have the value 1.
If two dosage instuctions have the same value in a sequence, they should be treated as parallell instructions and not sequential. This is the case when a patient uses two different doses at the same time, e.g. "1 tablet in the morning and 2 tables in the evening".
Sequential sequences start with 1 and increment by 1 without gaps.
NB! Two sequences that run in parallel shall not have the medication administration times at the same time of day, as that would imply that the doses of the different dosage instructions would be added and administered to the patient at the same point in time.
Subsequence
Subsequences enable irregular dosage schedules that should be repeated within a sequence. Please read the Handbok för vård- och apotekstjänster for more information about scenarios when it is needed to use subsequences.
A dosage can be divided into subsequences, sub-steps. A subsequence is described with a dosageInstruction. The attribute subsequence is used for subsequences to be in correct order. Subsequences start with 1 and increment by 1 without gaps.
Subsequences can only be used for timed administration (sv. tillfällesdosering), see Timed administration.
Subsequences can be both sequential and parallel. Two dosing subsequences that run in parallel shall not have the medication administration times on the same time of day, as that would imply that the doses of the different dosage instructions would be added and administered to the patient at the same point in time.
Dosage type
Timed administration (sv. tillfällesdosering)
Timed administration dosage type is used when the medication should be administered at specific points in time during the day.
Exact time (time of day)
A dosage can be expressed as a dose which should be administered at certain times of the day, for example '1 tablet at 7:00, 15:00 and 23:00' or '1 tablet at 8:00 every other day'.
NB! This type of dosage must be used for prescribing medications that are dose dispensed.
Approximated time (when)
A dosage can be expressed as an approximated time in different ways, for example as '1 tablet in the morning, at lunchtime and in the evening' or '1 tablet in the morning every other day'. The allowed values for approximated times are descibed in the value set Period på dygnet (nll-event-timing)
Sequences
The dosage type 'timed administration' allows the dosageInstructions to be both sequential and parallell. This means that the sequence must start with 1, increment by 1 and have no gaps. Two dosageInstructions may have the same sequence number which then means that they are parallell dosageInstructions.
Subsequences
Subsequences can be used for the dosage type 'timed administration'.
Frequence administration (sv. frekvensdosering)
The frequence administration dosage type describes the dose and the number of administrations during a defined period, for example '1 tablet 3 times a day' or '1 tablet every other day'.
This means that the exact days and points in time where the medication should be administered are not defined for a frequence administration.
Sequences
The frequence administration dosage type only allows the dosage instructions to be sequential. This means that the sequence must start with 1, increment by 1, have no gaps and that each dosage must have a unique sequence number.
Subsequences
It is not permitted to use subsequences for the frequence administration dosage type.
Interval administration (sv. intervalldosering)
The interval administration dosage type is used when the dose and administration should take place with a certain time interval during the day, for example '1 tablet every 8 hours'.
Sequences
The interval administration dosage type only allows the dosage instructions to be sequential. This means that the sequence must start with 1, increment by 1, have no gaps and that each dosage must have a unique sequence number.
Subsequences
It is not permitted to use subsequences for the interval administration dosage type.
One time administration (sv. engångsdosering)
A one time dosage is used when the medicine should be administrated only once. It is possible to specify the time or period of the day.
Sequences
The one time dosage type only allows one dosage instruction (sequence = 1).
Subsequences
It is not permitted to use subsequences for the one time dosage type.
Free text dosage (sv. fritextdosering)
A dosage described in free text is intended for situations when it is difficult to specify the instruction in a structured way. This type of dosage shall be avoided as far as possible, as it does not create the same opportunities to facilitate the care of the patient.
Sequences
The free text dosage type only allows one dosage instruction (sequence = 1).
Subsequences
It is not permitted to use subsequences for the free text dosage type.