ZD MedicationStatement
Resources conforming to this profile are requested by ZorgDomein when populating the referral letter or request form with data from the source information system.
Queries on the https://[FHIRServerUrl]/MedicationStatement endpoint may include the following query parameters:
patient=[PatientID]:[PatientID]refers to the patient ID as provided in the Task resource that is requested by ZorgDomein during SSO.effective=ge[date]: the resources in the search result must only contain MedicationStatement resources that have aMedicationStatement.effectivevalue that is greater than or equal to[date]. ForeffectivePeriodvalues this implies that the range defined by the period must overlap with the period from[date]onwards.effective=lt[date]: the resources in the search result must only contain MedicationStatement resources that have aMedicationStatement.effectivevalue that is less than[date]. ForeffectivePeriodvalues this implies that the range defined by the period must overlap with the period before[date].effective:missing=true: the resources in the search result must only contain MedicationStatement resources that have no value forMedicationStatement.effective.context=[EpisodeOfCareIds]: the resources in the search result must only contain MedicationStatement resources that reference one or more of the episodes identified by[EpisodeOfCareIds]inMedicationStatement.context.[EpisodeOfCareIds]may contain multiple, comma separated IDs. This query parameter is used to filter the list of medication records in the data selection modal for “Medicatie actueel”.context:missing=true: indicates that the search result must not contain any MedicationStatement resource that has a value forMedicationStatement.context. This query parameter is used to filter the list of medication records in the data selection modal for “Medicatie actueel”._sort=-effective: indicates that the resources in the search result must be sorted by effective date, descending.
The canonical URL for this profile is:
http://zorgdomein.nl/fhir/StructureDefinition/zd-medicationstatement
This profile builds on MedicationStatement.
| MedicationStatement | S | 0..* | MedicationStatement | Element IdMedicationStatement Record of medication being taken by a patient DefinitionA record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now, or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information. When interpreting a medicationStatement, the value of the status and NotTaken needed to be considered: MedicationStatement.status + MedicationStatement.wasNotTaken Status=Active + NotTaken=T = Not currently taking Status=Completed + NotTaken=T = Not taken in the past Status=Intended + NotTaken=T = No intention of taking Status=Active + NotTaken=F = Taking, but not as prescribed Status=Active + NotTaken=F = Taking Status=Intended +NotTaken= F = Will be taking (not started) Status=Completed + NotTaken=F = Taken in past Status=In Error + NotTaken=N/A = In Error.
|
| identifier | Σ | 0..* | Identifier | Element IdMedicationStatement.identifier External identifier DefinitionExternal identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.
|
| basedOn | Σ | 0..* | Reference(MedicationRequest | CarePlan | ProcedureRequest | ReferralRequest) | Element IdMedicationStatement.basedOn Fulfils plan, proposal or order DefinitionA plan, proposal or order that is fulfilled in whole or in part by this event. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(MedicationRequest | CarePlan | ProcedureRequest | ReferralRequest) Constraints
|
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Element IdMedicationStatement.partOf Part of referenced event DefinitionA larger event of which this particular event is a component or step. This should not be used when indicating which resource a MedicationStatement has been derived from. If that is the use case, then MedicationStatement.derivedFrom should be used. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) Constraints
|
| context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Element IdMedicationStatement.context Encounter / Episode associated with MedicationStatement DefinitionThe encounter or episode of care that establishes the context for this MedicationStatement. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Encounter | EpisodeOfCare) Constraints
|
| status | Σ ?! | 1..1 | codeBinding | Element IdMedicationStatement.status active | completed | entered-in-error | intended | stopped | on-hold DefinitionA code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally this will be active or completed. MedicationStatement is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for MedicationStatement.status contains codes that assert the status of the use of the medication by the patient (for example, stopped or on hold) as well as codes that assert the status of the medication statement itself (for example, entered in error). This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. MedicationStatementStatus (required) Constraints
|
| category | Σ | 0..1 | CodeableConceptBinding | Element IdMedicationStatement.category Type of medication usage DefinitionIndicates where type of medication statement and where the medication is expected to be consumed or administered. 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. MedicationStatementCategory (preferred) Constraints
|
| medication[x] | S Σ | 1..1 | Element IdMedicationStatement.medication[x] Medication. At least Medication.Codeableconcept.text or Medication.Reference.display should be set. DefinitionIdentifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example if you require form or lot number, then you must reference the Medication resource. . SNOMED CT Medication Codes (example) Constraints
| |
| medicationCodeableConcept | CodeableConcept | Data Type | ||
| medicationReference | Reference(Medication) | Data Type | ||
| effective[x] | S Σ | 0..1 | Element IdMedicationStatement.effective[x] The date/time or interval when the medication was taken DefinitionThe interval of time during which it is being asserted that the patient was taking the medication (or was not taking, when the wasNotGiven element is true). This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken at the time the statement is recorded, the "end" date will be omitted.
| |
| effectiveDateTime | dateTime | Data Type | ||
| effectivePeriod | Period | Data Type | ||
| dateAsserted | Σ | 0..1 | dateTime | Element IdMedicationStatement.dateAsserted When the statement was asserted? DefinitionThe date when the medication statement was asserted by the information source.
|
| informationSource | 0..1 | Reference(Patient | Practitioner | RelatedPerson | Organization) | Element IdMedicationStatement.informationSource Person or organization that provided the information about the taking of this medication DefinitionThe person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g Claim or MedicationRequest. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Patient | Practitioner | RelatedPerson | Organization) Constraints
| |
| subject | S Σ | 1..1 | Reference(Patient | Group) | Element IdMedicationStatement.subject Patient taking the medication DefinitionThe person, animal or group who is/was taking the medication. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| derivedFrom | 0..* | Reference(Resource) | Element IdMedicationStatement.derivedFrom Additional supporting information DefinitionAllows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement. Likely references would be to MedicationRequest, MedicationDispense, Claim, Observation or QuestionnaireAnswers. The most common use cases for deriving a MedicationStatement comes from creating a MedicationStatement from a MedicationRequest or from a lab observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the MedicationStatement from.
| |
| taken | Σ ?! | 1..1 | codeBinding | Element IdMedicationStatement.taken y | n | unk | na DefinitionIndicator of the certainty of whether the medication was taken by the patient. This element is labeled as a modifier because it indicates that the medication was not taken. MedicationStatementTaken (required) Constraints
|
| reasonNotTaken | 0..* | CodeableConcept | Element IdMedicationStatement.reasonNotTaken True if asserting medication was not given DefinitionA code indicating why the medication was not taken. 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. SNOMED CT Drugs not taken/completed Codes (example) Constraints
| |
| reasonCode | 0..* | CodeableConcept | Element IdMedicationStatement.reasonCode Reason for why the medication is being/was taken DefinitionA reason for why the medication is being/was taken. This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference. Condition/Problem/Diagnosis Codes (example) Constraints
| |
| reasonReference | 0..* | Reference(Condition | Observation) | Element IdMedicationStatement.reasonReference Condition or observation that supports why the medication is being/was taken DefinitionCondition or observation that supports why the medication is being/was taken. This is a reference to a condition that is the reason why the medication is being/was taken. If only a code exists, use reasonForUseCode. Reference(Condition | Observation) Constraints
| |
| note | 0..* | Annotation | Element IdMedicationStatement.note Further information about the statement DefinitionProvides extra information about the medication statement that is not conveyed by the other attributes. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
| |
| dosage | S | 0..* | Dosage | Element IdMedicationStatement.dosage Dosage of medication DefinitionIndicates how the medication is/was or should be taken by the patient. The dates included in the dosage on a Medication Statement reflect the dates for a given dose. For example, "from November 1, 2016 to November 3, 2016, take one tablet daily and from November 4, 2016 to November 7, 2016, take two tablets daily." It is expected that this specificity may only be populated where the patient brings in their labeled container or where the Medication Statement is derived from a MedicationRequest.
|
| sequence | Σ | 0..1 | integer | Element IdMedicationStatement.dosage.sequence The order of the dosage instructions DefinitionIndicates the order in which the dosage instructions should be applied or interpreted. If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential. 32 bit number; for values larger than this, use decimal
|
| text | S Σ | 1..1 | string | Element IdMedicationStatement.dosage.text Text represenation of dosage, for example: "two times a day" 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 IdMedicationStatement.dosage.additionalInstruction 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. SNOMED CT Additional Dosage Instructions (example) Constraints
|
| patientInstruction | Σ | 0..1 | string | Element IdMedicationStatement.dosage.patientInstruction 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 IdMedicationStatement.dosage.timing 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.
|
| asNeeded[x] | Σ | 0..1 | Element IdMedicationStatement.dosage.asNeeded[x] 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". SNOMED CT Medication As Needed Reason Codes (example) Constraints
| |
| asNeededBoolean | boolean | Data Type | ||
| asNeededCodeableConcept | CodeableConcept | Data Type | ||
| site | Σ | 0..1 | CodeableConcept | Element IdMedicationStatement.dosage.site 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. SNOMED CT Anatomical Structure for Administration Site Codes (example) Constraints
|
| route | Σ | 0..1 | CodeableConcept | Element IdMedicationStatement.dosage.route 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. SNOMED CT Route Codes (example) Constraints
|
| method | Σ | 0..1 | CodeableConcept | Element IdMedicationStatement.dosage.method 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. SNOMED CT Administration Method Codes (example) Constraints
|
| dose[x] | Σ | 0..1 | Element IdMedicationStatement.dosage.dose[x] 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.
| |
| doseRange | Range | Data Type | ||
| doseQuantity | SimpleQuantity | Data Type | ||
| maxDosePerPeriod | Σ | 0..1 | Ratio | Element IdMedicationStatement.dosage.maxDosePerPeriod 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".
|
| maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Element IdMedicationStatement.dosage.maxDosePerAdministration Upper limit on medication per administration DefinitionUpper limit on medication per administration. The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg.
|
| maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Element IdMedicationStatement.dosage.maxDosePerLifetime Upper limit on medication per lifetime of the patient DefinitionUpper limit on medication per lifetime of the patient. The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
| rate[x] | Σ | 0..1 | Element IdMedicationStatement.dosage.rate[x] 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.
| |
| rateRatio | Ratio | Data Type | ||
| rateRange | Range | Data Type | ||
| rateQuantity | SimpleQuantity | Data Type |
See the profile on simplifier.net for additional details.
Resource example
Below you find an example of a MedicationStatement resource that conforms to the ZD MedicationStatement profile.
{
"resourceType" : "MedicationStatement",
"id" : "zd-medicationstatement-1",
"meta" : {
"profile" : [
"http://zorgdomein.nl/fhir/StructureDefinition/zd-medicationstatement"
]
},
"status" : "completed",
"medicationCodeableConcept" : {
"text" : "Amoxicillin (product)"
},
"effectiveDateTime" : "2014-01-23",
"subject" : {
"reference" : "Patient/zd-patient-1",
"display" : "K. Aelbrinck-de Jager"
},
"taken" : "y",
"dosage" : [
{
"text" : "one capsule three times daily"
}
]
}
<MedicationStatement xmlns='http://hl7.org/fhir'>
<id value='zd-medicationstatement-1'/>
<meta>
<profile value='http://zorgdomein.nl/fhir/StructureDefinition/zd-medicationstatement'/>
</meta>
<status value='completed'/>
<medicationCodeableConcept>
<text value='Amoxicillin (product)'/>
</medicationCodeableConcept>
<effectiveDateTime value='2014-01-23'/>
<subject>
<reference value='Patient/zd-patient-1'/>
<display value='K. Aelbrinck-de Jager'/>
</subject>
<taken value='y'/>
<dosage>
<text value='one capsule three times daily'/>
</dosage>
</MedicationStatement>