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.
-
Default
What is FQL?
-
FQL Query resources
FQL Playground
Try Firely Query Language in our playground by using this scope as data source.
- FQL Documentation
-
FQL Language
Syntax specification
To learn more about FQL syntax choose this menu item.
-
YamlGen Generate resources
YamlGen Playground
Try YamlGen in our playground by using this scope as data source.
-
YamlGen Language
YamlGen Syntax specification
To learn more about YamlGen syntax choose this.
-
FHIRPath Inspect resource
FHIRPath Playground
Try out the FHIRPath playground and navigate inside this resource.
-
FHIRPath Documentation
FHIRPath Documentation
Find out what FHIRPath is or learn how to write FHIRPath scripts.
-
FHIR
Get this resource using a FHIR client.
-
Embed
Embed this resource in your own website. How?
-
Custom Example generation
Custom Example generation beta
Experiment with resource instance generation using YamlGen and based on this profile.
This feature is in beta. You can help us improve it by giving feedback with the feedback button at the top of the screen.
Dosage
Base StructureDefinition for Dosage Type
- type Profile on Dosage
- FHIR STU3
- status Draft
-
versionnone
The canonical from this resource does not match any claim in this context and conflicts with a claim from another scope.
http://hl7.org/fhir
Dosage | Element | Element idDosageShort description How the medication is/was taken or should be taken DefinitionIndicates how the medication is/was taken or should be taken by the patient. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idDosage.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idDosage.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
sequence | Σ | 0..1 | integer | Element idDosage.sequenceShort description The order of the dosage instructions DefinitionIndicates the order in which the dosage instructions should be applied or interpreted. If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential. 32 bit number; for values larger than this, use decimal
|
text | Σ | 0..1 | string | Element idDosage.textShort description Free text dosage instructions e.g. SIG DefinitionFree text dosage instructions e.g. SIG. Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Note that FHIR strings may not exceed 1MB in size
|
additionalInstruction | Σ | 0..* | CodeableConcept | Element idDosage.additionalInstructionShort description Supplemental instruction - e.g. "with meals" DefinitionSupplemental instruction - e.g. "with meals". Additional instruction such as "Swallow with plenty of water" which may or may not be coded. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". http://hl7.org/fhir/ValueSet/additional-instruction-codes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
patientInstruction | Σ | 0..1 | string | Element idDosage.patientInstructionShort description Patient or consumer oriented instructions DefinitionInstructions in terms that are understood by the patient or consumer. Note that FHIR strings may not exceed 1MB in size
|
timing | Σ | 0..1 | Timing | Element idDosage.timingShort description When medication should be administered DefinitionWhen medication should be administered. The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. This attribute may not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
asNeeded[x] | Σ | 0..1 | Element idDosage.asNeeded[x]Short description Take "as needed" (for x) DefinitionIndicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed". A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. http://hl7.org/fhir/ValueSet/medication-as-needed-reason (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |
asNeededBoolean | boolean | Data type | ||
asNeededCodeableConcept | CodeableConcept | Data type | ||
site | Σ | 0..1 | CodeableConcept | Element idDosage.siteShort description Body site to administer to DefinitionBody site to administer to. A coded specification of the anatomic site where the medication first enters the body. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension body-site-instance. May be a summary code, or a reference to a very precise definition of the location, or both. A coded concept describing the site location the medicine enters into or onto the body. http://hl7.org/fhir/ValueSet/approach-site-codes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
route | Σ | 0..1 | CodeableConcept | Element idDosage.routeShort description How drug should enter body DefinitionHow drug should enter body. A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. http://hl7.org/fhir/ValueSet/route-codes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
method | Σ | 0..1 | CodeableConcept | Element idDosage.methodShort description Technique for administering medication DefinitionTechnique for administering medication. A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV. Terminologies used often pre-coordinate this term with the route and or form of administration. A coded concept describing the technique by which the medicine is administered. http://hl7.org/fhir/ValueSet/administration-method-codes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
dose[x] | Σ | 0..1 | Element idDosage.dose[x]Short description Amount of medication per dose DefinitionAmount of medication per dose. The amount of therapeutic or other substance given at one administration event. Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |
doseRange | Range | Data type | ||
doseQuantity | SimpleQuantity | Data type | ||
maxDosePerPeriod | Σ C | 0..1 | Ratio | Element idDosage.maxDosePerPeriodShort description Upper limit on medication per unit of time DefinitionUpper limit on medication per unit of time. 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. This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
SimpleQuantity | Σ C | 0..1 | SimpleQuantity | Element idDosage.maxDosePerAdministrationShort description Upper limit on medication per administration DefinitionUpper limit on medication per administration. The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
SimpleQuantity | Σ C | 0..1 | SimpleQuantity | Element idDosage.maxDosePerLifetimeShort description Upper limit on medication per lifetime of the patient DefinitionUpper limit on medication per lifetime of the patient. The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
rate[x] | Σ | 0..1 | Element idDosage.rate[x]Short description Amount of medication per unit of time DefinitionAmount of medication per unit of time. Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |
rateRatio | Ratio | Data type | ||
rateRange | Range | Data type | ||
rateQuantity | SimpleQuantity | Data type |