FQL is a query language that allows you to retrieve, filter and project data from any data source containing FHIR Resources. It brings the power of three existing languages together: SQL, JSON and FhirPath. It allows you to create tables and is useful for gaining insight and perform quality control.
Dosage | |
Definition | Indicates how the medication is/was taken or should be taken by the patient. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Dosage.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.extension:nllObservandumDose | |
Definition | Indicates that the prescriber has made a conscious choice where the dose exceeds what is recommended for the prescribed medication. |
Cardinality | 0...1 |
Type | Extension(boolean) |
Must Support | True |
Alias | extensions, user content |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
Dosage.extension:nllAdministeringInstruction | |
Definition | Administration instructions put in terms that are comprehensible to the patient. This shall be generated from the structured administration information attributes. |
Cardinality | 0...1 |
Type | Extension(string) |
Must Support | True |
Alias | extensions, user content |
Comments | Maximum string length: 512 <br> NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
Dosage.extension:nllMedicalDevice | |
Definition | Medical device to use for administration. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Must Support | True |
Alias | extensions, user content |
Requirements | If there is no appropriate coded value, then the code OTH=Other should be used together with the free text element "text” |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
Dosage.extension:nllMedicalDevice.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.extension:nllMedicalDevice.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.extension:nllMedicalDevice.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | 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. |
Fixed Value | http://electronichealth.se/fhir/StructureDefinition/NLLMedicalDevice |
Mappings |
|
Dosage.extension:nllMedicalDevice.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | CodeableConcept |
Must Support | True |
Invariants |
|
Mappings |
|
Dosage.extension:nllMedicalDevice.value[x].id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.extension:nllMedicalDevice.value[x].extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.extension:nllMedicalDevice.value[x].coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | http://electronichealth.se/fhir/ValueSet/nll-snomed-medical-device (required) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Dosage.extension:nllMedicalDevice.value[x].coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.extension:nllMedicalDevice.value[x].coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.extension:nllMedicalDevice.value[x].coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
Dosage.extension:nllMedicalDevice.value[x].coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Dosage.extension:nllMedicalDevice.value[x].coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Dosage.extension:nllMedicalDevice.value[x].coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Dosage.extension:nllMedicalDevice.value[x].coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Dosage.extension:nllMedicalDevice.value[x].text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Maximum string length: 256 |
Invariants |
|
Mappings |
|
Dosage.extension:nllSubSequence | |
Definition | Indicates the order of subqeuences within a sequence. |
Cardinality | 0...1 |
Type | Extension(integer) |
Must Support | True |
Alias | extensions, user content |
Requirements | Only used in dosage type "tillfällesdosering”, using "timeOfDay" or "when" |
Comments | 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. |
Invariants |
|
Mappings |
|
Dosage.extension:nllDosageType | |
Definition | Calculated by the Swedish eHealth Agency. The dosage type that matches the provided set of dosage data. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
Comments | _ |
Invariants |
|
Mappings |
|
Dosage.extension:nllSiteQualifier | |
Definition | Qualified adminsitration site is used when more exact information about the site is needed. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Must Support | True |
Alias | extensions, user content |
Requirements | 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". |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
Dosage.extension:nllSiteQualifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.extension:nllSiteQualifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.extension:nllSiteQualifier.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | 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. |
Fixed Value | http://electronichealth.se/fhir/StructureDefinition/NLLSiteQualifier |
Mappings |
|
Dosage.extension:nllSiteQualifier.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | CodeableConcept |
Must Support | True |
Invariants |
|
Mappings |
|
Dosage.extension:nllSiteQualifier.value[x].id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.extension:nllSiteQualifier.value[x].extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.extension:nllSiteQualifier.value[x].coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Binding | http://electronichealth.se/fhir/ValueSet/nll-snomed-qualifier (required) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Dosage.extension:nllSiteQualifier.value[x].coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.extension:nllSiteQualifier.value[x].coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.extension:nllSiteQualifier.value[x].coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
Dosage.extension:nllSiteQualifier.value[x].coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Dosage.extension:nllSiteQualifier.value[x].coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Dosage.extension:nllSiteQualifier.value[x].coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Dosage.extension:nllSiteQualifier.value[x].coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Dosage.extension:nllSiteQualifier.value[x].text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Maximum string length: 256 |
Invariants |
|
Mappings |
|
Dosage.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Dosage.sequence | |
Definition | Indicates the order in which the dosage instructions should be applied or interpreted. |
Cardinality | 1...1 |
Type | integer |
Must Support | True |
Summary | True |
Requirements | If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential. |
Comments | 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. |
Invariants |
|
Mappings |
|
Dosage.text | |
Definition | Free text dosage |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | In the Swedish National Medication List there will be either a free text dosage or coded dosage instructions, never both. |
Comments | Maximum string length: 512 |
Invariants |
|
Mappings |
|
Dosage.additionalInstruction | |
Definition | Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps"). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". |
Must Support | True |
Summary | True |
Requirements | In the Swedish National Medication List Additional instruction is written in free text. |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
Dosage.additionalInstruction.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.additionalInstruction.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.additionalInstruction.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Dosage.additionalInstruction.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | In the Swedish National Medication List Additional instruction is written in free text. |
Comments | Maximum string length: 512 |
Invariants |
|
Mappings |
|
Dosage.patientInstruction | |
Definition | Dosage instructions in terms that are understood by the patient. This shall be generated from the structured dosage information attributes. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Maximum string length: 512 <br> NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
Dosage.timing | |
Definition | When medication should be administered. |
Cardinality | 0...1 |
Type | Timing |
Must Support | True |
Summary | True |
Requirements | The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. |
Comments | _ |
Invariants |
|
Mappings |
|
Dosage.timing.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.timing.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.timing.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Dosage.timing.event | |
Definition | Identifies specific times when the event occurs. |
Cardinality | 0...* |
Type | dateTime |
Summary | True |
Requirements | In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification. |
Invariants |
|
Mappings |
|
Dosage.timing.repeat | |
Definition | A set of rules that describe when the event is scheduled. |
Cardinality | 0...1 |
Type | Element |
Must Support | True |
Summary | True |
Requirements | Many timing schedules are determined by regular repetitions. |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.timing.repeat.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.extension:nllSubSequenceDuration | |
Definition | The 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. |
Cardinality | 0...1 |
Type | Extension(Quantity) |
Must Support | True |
Alias | extensions, user content |
Requirements | Used for the dosage type "tillfällesdosering". |
Comments | _ |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x] | |
Definition | Either 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. |
Cardinality | 0...1 |
Type | Duration |
Must Support | True |
Summary | True |
Slicing | Unordered, Open, by $this(Type) |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsDuration | |
Definition | A duration for the length of the timing schedule. |
Cardinality | 0...1 |
Type | Duration |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsDuration.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsDuration.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsDuration.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsDuration.comparator | |
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsDuration.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsDuration.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsDuration.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
Binding | sequence-length-units (required) |
Must Support | True |
Summary | True |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Invariants |
|
Fixed Value | d |
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange | |
Definition | A range of possible length. |
Cardinality | 0...1 |
Type | Range |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.low | |
Definition | The low limit. The boundary is inclusive. |
Cardinality | 1...1 |
Type | SimpleQuantity |
Must Support | True |
Summary | True |
Comments | If the low element is missing, the low boundary is not known. |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.low.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.low.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.low.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.low.comparator | |
Definition | Not allowed to be used in this context |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.low.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.low.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.low.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
Binding | sequence-length-units (required) |
Must Support | True |
Summary | True |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Invariants |
|
Fixed Value | d |
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.high | |
Definition | The high limit. The boundary is inclusive. |
Cardinality | 1...1 |
Type | SimpleQuantity |
Must Support | True |
Summary | True |
Comments | If the high element is missing, the high boundary is not known. |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.high.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.high.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.high.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.high.comparator | |
Definition | Not allowed to be used in this context |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.high.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.high.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.bounds[x]:boundsRange.high.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
Binding | sequence-length-units (required) |
Must Support | True |
Summary | True |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Invariants |
|
Fixed Value | d |
Mappings |
|
Dosage.timing.repeat.count | |
Definition | A total count of the desired number of repetitions across the duration of the entire timing specification. |
Cardinality | 0...1 |
Type | positiveInt |
Must Support | True |
Summary | True |
Requirements | 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 |
Comments | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens. |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.countMax | |
Definition | If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times. |
Cardinality | 0...1 |
Type | positiveInt |
Summary | True |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.duration | |
Definition | Duration of the administration of the medication |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | |
Comments | 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]) |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.durationMax | |
Definition | If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. |
Cardinality | 0...1 |
Type | decimal |
Summary | True |
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
Comments | 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). |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.durationUnit | |
Definition | The units of time for the duration, in UCUM units. |
Cardinality | 0...1 |
Type | code |
Binding | A unit of time (units from UCUM). |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.frequency | |
Definition | The 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. |
Cardinality | 0...1 |
Type | positiveInt |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.frequencyMax | |
Definition | If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. |
Cardinality | 0...1 |
Type | positiveInt |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.period | |
Definition | Indicates 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. |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.periodMax | |
Definition | If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.periodUnit | |
Definition | The units of time for the period in UCUM units. |
Cardinality | 0...1 |
Type | code |
Binding | A unit of time (units from UCUM). |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.dayOfWeek | |
Definition | If one or more days of week is provided, then the action happens only on the specified day(s). |
Cardinality | 0...* |
Type | code |
Binding | DaysOfWeek (required) |
Must Support | True |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.timeOfDay | |
Definition | Specified 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. |
Cardinality | 0...* |
Type | time |
Must Support | True |
Summary | True |
Requirements | Used for the dosage type "tillfällesdosering". The elements “when, frequency and period” cannot be used with the element “timeOfDay” simultaneously. |
Comments | 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. |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.when | |
Definition | An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. |
Cardinality | 0...* |
Type | code |
Binding | Real world event relating to the schedule. |
Must Support | True |
Summary | True |
Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep. |
Comments | _ |
Invariants |
|
Mappings |
|
Dosage.timing.repeat.offset | |
Definition | The 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. |
Cardinality | 0...1 |
Type | unsignedInt |
Summary | True |
Invariants |
|
Mappings |
|
Dosage.timing.code | |
Definition | A 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). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Code for a known / defined timing pattern. |
Summary | True |
Comments | 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). |
Invariants |
|
Mappings |
|
Dosage.asNeeded[x] | |
Definition | Indicates that the medication only should be taken when needed. |
Cardinality | 0...1 |
Type | boolean |
Must Support | True |
Summary | True |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
Dosage.site | |
Definition | Site of administration. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept describing the site location the medicine enters into or onto the body. |
Must Support | True |
Summary | True |
Requirements | 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". |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
Dosage.site.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.site.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.site.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Binding | Snomed CT codes for administration site, as stipulated by NLL (terminology server). |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | _ |
Invariants |
|
Mappings |
|
Dosage.site.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.site.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.site.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
Dosage.site.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Dosage.site.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Dosage.site.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Dosage.site.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Dosage.site.text | |
Definition | A human language representation of the administration site. Used when no specific code can describe the site and the code 'OTH' has been selected. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Maximum string length: 256 |
Invariants |
|
Mappings |
|
Dosage.route | |
Definition | How the medication should enter the body. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. |
Must Support | True |
Summary | True |
Requirements | 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". |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
Dosage.route.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.route.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.route.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Binding | Snomed CT codes for administration route, as stipulated by NLL |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | _ |
Invariants |
|
Mappings |
|
Dosage.route.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.route.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.route.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
Dosage.route.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Dosage.route.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Dosage.route.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Dosage.route.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Dosage.route.text | |
Definition | A human language representation of the administration route. Used when no specific code can describe the route and the code 'OTH' has been selected. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Maximum string length: 256 |
Invariants |
|
Mappings |
|
Dosage.method | |
Definition | Method used for administering the medication. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept describing the technique by which the medicine is administered. |
Must Support | True |
Summary | True |
Requirements | 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". |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
Dosage.method.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.method.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.method.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Binding | Snomed CT codes for administration method, as stipulated by NLL (terminology server). |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | _ |
Invariants |
|
Mappings |
|
Dosage.method.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.method.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.method.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
Dosage.method.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Dosage.method.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Dosage.method.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Dosage.method.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Dosage.method.text | |
Definition | A human language representation of the administration method. Used when no specific code can describe the method and the code 'OTH' has been selected. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Maximum string length: 256 |
Invariants |
|
Mappings |
|
Dosage.doseAndRate | |
Definition | The amount of medication administered. |
Cardinality | 0...1 |
Type | Element |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.doseAndRate.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.type | |
Definition | The kind of dose or rate specified, for example, ordered or calculated. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The kind of dose or rate specified. |
Summary | True |
Requirements | If the type is not populated, assume to be "ordered". |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x] | |
Definition | Amount of medication per dose. |
Cardinality | 0...1 |
Type | Range |
Binding | nll-ucum-unit (required) |
Must Support | True |
Summary | True |
Requirements | The amount of therapeutic or other substance given at one administration event. |
Comments | _ |
Slicing | Unordered, Open, by $this(Type) |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange | |
Definition | Amount of medication per dose. |
Cardinality | 0...1 |
Type | Range |
Must Support | True |
Summary | True |
Requirements | The amount of therapeutic or other substance given at one administration event. |
Comments | Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.low | |
Definition | The low limit. The boundary is inclusive. |
Cardinality | 1...1 |
Type | SimpleQuantity |
Must Support | True |
Summary | True |
Comments | If the low element is missing, the low boundary is not known. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.low.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.low.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.low.value | |
Definition | Dose range low value |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | |
Comments | 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]) |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.low.comparator | |
Definition | Not allowed to be used in this context |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.low.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.low.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.low.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.high | |
Definition | The high limit. The boundary is inclusive. |
Cardinality | 1...1 |
Type | SimpleQuantity |
Must Support | True |
Summary | True |
Comments | If the high element is missing, the high boundary is not known. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.high.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.high.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.high.value | |
Definition | Dose range high value |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | |
Comments | 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]) |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.high.comparator | |
Definition | Not allowed to be used in this context |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.high.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.high.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseRange.high.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseQuantity | |
Definition | Amount of medication per dose. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Must Support | True |
Summary | True |
Requirements | The amount of therapeutic or other substance given at one administration event. |
Comments | Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseQuantity.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.doseAndRate.dose[x]:doseQuantity.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseQuantity.value | |
Definition | Dose quantity value. |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | |
Comments | 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]) |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseQuantity.comparator | |
Definition | Not allowed to be used in this context |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseQuantity.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseQuantity.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.dose[x]:doseQuantity.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.rate[x] | |
Definition | Amount of medication per unit of time. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Binding | nll-ucum-rate-unit (required) |
Must Support | True |
Summary | True |
Requirements | _ |
Comments | _ |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.rate[x].id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.doseAndRate.rate[x].extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.rate[x].value | |
Definition | Rate value |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | |
Comments | 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]) |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.rate[x].comparator | |
Definition | Not allowed to be used in this context |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.rate[x].unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.rate[x].system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
Dosage.doseAndRate.rate[x].code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
Dosage.maxDosePerPeriod | |
Definition | Upper limit on medication per day. |
Cardinality | 0...1 |
Type | Ratio |
Must Support | True |
Summary | True |
Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours. |
Comments | NB! The same value must be provided in this element on each sequence / subsequence. |
Invariants |
|
Mappings |
|
Dosage.maxDosePerPeriod.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.maxDosePerPeriod.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.maxDosePerPeriod.numerator | |
Definition | The value of the numerator. |
Cardinality | 0...1 |
Type | Quantity |
Binding | nll-ucum-unit (required) |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Dosage.maxDosePerPeriod.numerator.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.maxDosePerPeriod.numerator.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.maxDosePerPeriod.numerator.value | |
Definition | Max dose therapeutic substance value |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | |
Comments | 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}$ |
Invariants |
|
Mappings |
|
Dosage.maxDosePerPeriod.numerator.comparator | |
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
Dosage.maxDosePerPeriod.numerator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
Dosage.maxDosePerPeriod.numerator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
Dosage.maxDosePerPeriod.numerator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Invariants |
|
Mappings |
|
Dosage.maxDosePerPeriod.denominator | |
Definition | The value of the denominator. |
Cardinality | 0...1 |
Type | Quantity |
Must Support | True |
Summary | True |
Invariants |
|
Fixed Value | { "value": 1, "system": "http://unitsofmeasure.org", "code": "d" } |
Mappings |
|
Dosage.maxDosePerPeriod.denominator.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Dosage.maxDosePerPeriod.denominator.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Dosage.maxDosePerPeriod.denominator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
Invariants |
|
Fixed Value | 1 |
Mappings |
|
Dosage.maxDosePerPeriod.denominator.comparator | |
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
Summary | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Invariants |
|
Mappings |
|
Dosage.maxDosePerPeriod.denominator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Invariants |
|
Mappings |
|
Dosage.maxDosePerPeriod.denominator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Fixed Value | http://unitsofmeasure.org |
Mappings |
|
Dosage.maxDosePerPeriod.denominator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Invariants |
|
Fixed Value | d |
Mappings |
|
Dosage.maxDosePerAdministration | |
Definition | Upper limit on medication per administration. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Summary | True |
Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. |
Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg. |
Invariants |
|
Mappings |
|
Dosage.maxDosePerLifetime | |
Definition | Upper limit on medication per lifetime of the patient. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Summary | True |
Requirements | The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject. |
Invariants |
|
Mappings |
|