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.
-
Project FHIR API
This is the location where you can find your resource using a FHIR client.
-
Simplifier FHIR API
The global endpoint is where users can search for all resources in Simplifier. Resources have a globally unique guid Id here.
-
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.
HCIM MedicationAgreement
This profile is based on the Dutch Health and Care Information models (Dutch: Zorginformatiebouwsteen or ZIB) MedicationAgreement version 1.0.1, year 2017. A medication agreement is a prescriber’s proposal for a patient to use medication. An agreement to discontinue the use of medication is also a medication agreement.
- type Profile on MedicationRequest
- FHIR STU3
- status Active
-
version2.2.9
The canonical from this resource does not match any claim in this context and conflicts with a claim from another scope.
http://nictiz.nl/fhir/
Canonical claims are used to verify ownership of your canonical URLs.
You're probably missing a package or made a typo in your canonical.
- Could not resolve: http://hl7.org/fhir/StructureDefinition/MedicationRequest
Zib MedicationAgreement (MedicationRequest) | http://hl7.org/fhir/StructureDefinition/MedicationRequest | There are no (further) constraints on this element Element idMedicationRequest MedicationAgreement Alternate namesMedicatieafspraak DefinitionA medication agreement is a prescriber’s proposal for a patient to use medication. An agreement to discontinue the use of medication is also a medication agreement. http://hl7.org/fhir/StructureDefinition/MedicationRequest Mappings
| ||
extension | There are no (further) constraints on this element Element idMedicationRequest.extension Unordered, Open, by url(Value) | |||
periodOfUse | ..1 | Extension(Period) | There are no (further) constraints on this element Element idMedicationRequest.extension:periodOfUse PeriodOfUse DefinitionStart date: This is the time at which the agreement was to take effect (or took effect or will take effect). This is the time at which the instructions for use in this agreement start. In the case of an agreement to discontinue use, this is the start date of the original medication agreement. The end date indicates from when the medication is to be discontinued. End date: The time at which the period of use ends (or ended or will end). In the case of an agreement to discontinue use, this is the time at which the medication is to be discontinued. To avoid confusion between 'to' and 'up to', the submission of time is always mandatory for the end date. With medication for an indefinite period only a start date is indicated. According to the HCIM TimeInterval, a time interval is defined by either a start and end time, a start time and duration, or a duration and end time. As this HCIM is expressed by the periodOfUse and usageDuration extensions in this profile, this means that precisely two elements out of Extension(Period) Extension URLhttp://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse Mappings
| |
usageDuration | ..1 | Extension(Duration) | There are no (further) constraints on this element Element idMedicationRequest.extension:usageDuration Duration Alternate namesDuur DefinitionDuration: The intended duration of use. E.g. 5 days or 8 weeks. It is not allowed to indicate the duration in months, because different months have a variable duration in days. According to the HCIM TimeInterval, a time interval is defined by either a start and end time, a start time and duration, or a duration and end time. As this HCIM is expressed by the periodOfUse and usageDuration extensions in this profile, this means that precisely two elements out of Extension(Duration) Extension URLhttp://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration Mappings
| |
additionalInformation | Extension(CodeableConcept) | There are no (further) constraints on this element Element idMedicationRequest.extension:additionalInformation MedicationAgreementAdditionalInformation Alternate namesMedicatieafspraakAanvullendeInformatie DefinitionAdditional information includes details on the structure of the agreement made that are relevant for pharmacovigilance and fulfillment by the pharmacist. This can be used e.g. to indicate that there was a conscious decision to deviate from the norm or that the agreement is to be structured in a certain way. When choosing a medicine, you can deviate from what is expected or from what the standard is. For example, when the hospital uses a different formulary than the community pharmacy. For reasons of efficiency, for example, one gastric acid inhibitor has been chosen in the hospital: pantoprazole. Upon admission, a patient with omeprazole is converted to pantoprazole for the duration of the stay. When discharged, the patient goes back to omeprazole. It is clear that something can go wrong here and that the patient takes both omeprazole and pantoprazole when there is no intervention. In the hospital's medication agreement for pantoprazole a remark can be made about the deviation so that it is clear that pantoprazole is the substitute for omeprazole or that it should be used in addition to omeprazole. Another example are the half strengths. The hospital sometimes stocks tablets with half the strength of the normal trade preparation (own production). Where the patient enters the hospital on 25 mg chlortalidone, half a tablet once a day, he receives 12.5 mg intramural chlortalidone, one tablet once a day. Then the nursing does not have to break tablets in this case. Here there is a risk that the patient will use the 25 mg again at home, but then a whole tablet at a time in stead of half a tablet. By means of an explanation in the medication agreement (Additional information) of the last chlortalidone 25 mg, it can be indicated whether this has been a intended increase. Extension(CodeableConcept) Extension URLhttp://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation Mappings
| ||
valueCodeableConcept | Binding | There are no (further) constraints on this element Element idMedicationRequest.extension:additionalInformation.valueCodeableConcept:valueCodeableConcept MedicatieafspraakAanvullendeInformatieCodelijst MedicatieafspraakAanvullendeInformatieCodelijst (extensible)Examples Example of MedicationAgreementAdditionalInformation { "coding": [ { "system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.20.77.5.2.3.2050", "code": "1", "display": "Bewust hoge dosering" } ] } | ||
medicationTreatment | ..1 | Extension(Identifier) | There are no (further) constraints on this element Element idMedicationRequest.extension:medicationTreatment Medication Treatment Alternate namesMedicamenteuze behandeling DefinitionThis extension is to describe which overarching medication treatment this information is part of. This is done by the use of an identifier of that medication treatment. No HCIM concept is available for this element. Therefore a mapping to the relevant Medication Process data element is provided. Extension(Identifier) Extension URLhttp://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment Mappings
| |
nl-core-episodeofcare | 0..* | Extension(Reference(nl-core-episodeofcare)) | There are no (further) constraints on this element Element idMedicationRequest.extension:nl-core-episodeofcare It is recommended to use the nl-core-episodeofcare extension to reference nl-core-episodeofcare (EpisodeOfCare) instances rather than the Extension(Reference(nl-core-episodeofcare)) Extension URLhttp://nictiz.nl/fhir/StructureDefinition/extension-context-nl-core-episodeofcare | |
modifierExtension | There are no (further) constraints on this element Element idMedicationRequest.modifierExtension Unordered, Open, by url(Value) | |||
stopType | ..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idMedicationRequest.modifierExtension:stopType Extension(CodeableConcept) Extension URLhttp://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType Mappings
| |
valueCodeableConcept | Binding | There are no (further) constraints on this element Element idMedicationRequest.modifierExtension:stopType.valueCodeableConcept:valueCodeableConcept | ||
repeatPeriodCyclicalSchedule | ..1 | Extension(Duration) | There are no (further) constraints on this element Element idMedicationRequest.modifierExtension:repeatPeriodCyclicalSchedule RepeatPeriodCyclicalSchedule DefinitionThe repeated period in a cyclical schedule (of one or more dosing instructions). A cyclic schedule is noted in days, the corresponding dosing duration is also in days. Examples of a cyclical schedule: contraceptive pill (21 days, 1 pill 1x a day, then skip for 7 days, repeat), repeat period here is 28 days. RepeatPeriodCyclicalSchedule Extension(Duration) Extension URLhttp://nictiz.nl/fhir/StructureDefinition/zib-Medication-RepeatPeriodCyclicalSchedule Mappings
| |
identifier | There are no (further) constraints on this element Element idMedicationRequest.identifier
| |||
intent | Fixed Value | There are no (further) constraints on this element Element idMedicationRequest.intent order | ||
category | 1.. | There are no (further) constraints on this element Element idMedicationRequest.category | ||
coding | There are no (further) constraints on this element Element idMedicationRequest.category.coding Unordered, Open, by code(Value) | |||
medicationAgreementCode | There are no (further) constraints on this element Element idMedicationRequest.category.coding:medicationAgreementCode MedicationAgreementCode DefinitionCategory SNOMED code used for indexing/retrieval of the HCIM MedicationAgreement. The SNOMED code 16076005 for this resource is stated in the Medication Process v09. | |||
system | Fixed Value | There are no (further) constraints on this element Element idMedicationRequest.category.coding:medicationAgreementCode.system http://snomed.info/sct | ||
code | Fixed Value | There are no (further) constraints on this element Element idMedicationRequest.category.coding:medicationAgreementCode.code 16076005 | ||
display | There are no (further) constraints on this element Element idMedicationRequest.category.coding:medicationAgreementCode.display Prescription (procedure) | |||
medicationReference | Reference(Zib PharmaceuticalProduct) | There are no (further) constraints on this element Element idMedicationRequest.medication[x]:medicationReference AgreedMedicine Alternate namesAfgesprokengeneesmiddel DefinitionThe medicine agreed upon to be used. Reference(Zib PharmaceuticalProduct) Mappings
| ||
subject | Reference(nl-core-patient | http://hl7.org/fhir/StructureDefinition/Group) | There are no (further) constraints on this element Element idMedicationRequest.subject Reference(nl-core-patient | http://hl7.org/fhir/StructureDefinition/Group) Mappings
| ||
context | Reference(Zib Encounter | nl-core-episodeofcare) | There are no (further) constraints on this element Element idMedicationRequest.context It is recommended to use the nl-core-episodeofcare extension to reference nl-core-episodeofcare (EpisodeOfCare) instances rather than the Reference(Zib Encounter | nl-core-episodeofcare) | ||
authoredOn | 1.. | There are no (further) constraints on this element Element idMedicationRequest.authoredOn MedicationAgreementDateTime Alternate namesAfspraakdatum DefinitionThe time at which the agreement was made. Appointment date + time are required (order of the appointments must be clear in cases with multiple appointments on one day)
| ||
requester | There are no (further) constraints on this element Element idMedicationRequest.requester Prescriber Alternate namesVoorschrijver DefinitionThe health professional that entered the medication agreement with the patient. Note that in FHIR STU3, there is an agent Reference type PractitionerRole missing. PractitionerRole, contrary to Practitioner, allows for specialism and organization. This issue has been fixed in FHIR R4. For FHIR STU3, you can use the practitionerrole-reference extension on requester.agent.
| |||
agent | Reference(nl-core-practitioner | nl-core-organization | nl-core-patient | nl-core-relatedperson | http://hl7.org/fhir/StructureDefinition/Device) | There are no (further) constraints on this element Element idMedicationRequest.requester.agent The health professional's speciality, role, and organization are captured and communicated through the PractitionerRole Resource based on the nl-core-practitionerrole profile. Reference(nl-core-practitioner | nl-core-organization | nl-core-patient | nl-core-relatedperson | http://hl7.org/fhir/StructureDefinition/Device) | ||
extension | There are no (further) constraints on this element Element idMedicationRequest.requester.agent.extension Unordered, Open, by url(Value) | |||
practitionerRole | ..1 | Extension(Reference(nl-core-practitionerrole)) | There are no (further) constraints on this element Element idMedicationRequest.requester.agent.extension:practitionerRole Extension(Reference(nl-core-practitionerrole)) Extension URLhttp://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |
onBehalfOf | Reference(nl-core-organization) | There are no (further) constraints on this element Element idMedicationRequest.requester.onBehalfOf Reference(nl-core-organization) | ||
recorder | Reference(nl-core-practitioner) | There are no (further) constraints on this element Element idMedicationRequest.recorder Reference(nl-core-practitioner) | ||
extension | There are no (further) constraints on this element Element idMedicationRequest.recorder.extension Unordered, Open, by url(Value) | |||
practitionerRole | ..1 | Extension(Reference(nl-core-practitionerrole)) | There are no (further) constraints on this element Element idMedicationRequest.recorder.extension:practitionerRole Extension(Reference(nl-core-practitionerrole)) Extension URLhttp://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference | |
reasonCode | Binding | There are no (further) constraints on this element Element idMedicationRequest.reasonCode ReasonMedicationAgreement Alternate namesRedenMedicatieafspraak DefinitionReason for this agreement. This can be the reason to start, change or stop the medication treatment. RedenWijzigenOfStakenCodelijst RedenWijzigenOfStakenCodelijst (extensible)Mappings
| ||
reasonReference | Reference(http://hl7.org/fhir/StructureDefinition/Observation | Zib Problem) | There are no (further) constraints on this element Element idMedicationRequest.reasonReference PrescriptionReason Alternate namesRedenVanVoorschrijven DefinitionThe medical reason for the prescription or for use of the medication. This can be used to enter a medical indication which was the direct cause for prescription or for use of the medication in question. It can concern every type of problem (or condition) of the patient, almost all diagnoses, complaints or symptoms. Please note: The BST401T file of the G standard contains a “special reference” to indicate that “exchange of the reason for prescription is essential”. Reference(http://hl7.org/fhir/StructureDefinition/Observation | Zib Problem) Mappings
| ||
note | There are no (further) constraints on this element Element idMedicationRequest.note Comment Alternate namesToelichting DefinitionExplanation for the medication agreement. This explanation can contain e.g. information on why a prescriber makes a medication agreement that deviates from the norm.
| |||
dosageInstruction | Zib InstructionsForUse | There are no (further) constraints on this element Element idMedicationRequest.dosageInstruction Instructions for the use of the medication, e.g. dose and route of administration
|