MedicationStatement |
S |
0..* |
MedicationStatement |
Element Id
Short description
Record of medication being taken by a patient Definition
A 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.
Comments
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.
Data Type
MedicationStatement Constraints
- dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
- dom-1:If the resource is contained in another resource, it SHALL NOT contain any narrative
contained.text.empty()
- dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
- dom-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
- mst-1:Reason not taken is only permitted if Taken is No
reasonNotTaken.exists().not() or (taken = 'n')
Mappings
- rim:Entity. Role, or Act
- workflow:..Event
- rim:SubstanceAdministration
- w5:clinical.medication
|
identifier |
Σ |
0..* |
Identifier |
Element Id
MedicationStatement.identifier
Short description
External identifier Definition
External 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.
Data Type
Identifier Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- workflow:…identifer
- rim:.id
- w5:id
|
basedOn |
Σ |
0..* |
Reference(MedicationRequest | CarePlan | ProcedureRequest | ReferralRequest) |
Element Id
MedicationStatement.basedOn
Short description
Fulfils plan, proposal or order Definition
A plan, proposal or order that is fulfilled in whole or in part by this event.
Requirements
Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.
Comments
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.
Data Type
Reference(MedicationRequest | CarePlan | ProcedureRequest | ReferralRequest) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
- ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow:…basedOn
- rim:.outboundRelationship[typeCode=FLFS].target[classCode=SBADM or PROC or PCPR or OBS, moodCode=RQO orPLAN or PRP]
|
partOf |
Σ |
0..* |
Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) |
Element Id
MedicationStatement.partOf
Short description
Part of referenced event Definition
A larger event of which this particular event is a component or step.
Requirements
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.
Comments
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.
Data Type
Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
- ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow:…part of
- rim:.outboundRelationship[typeCode=COMP]/target[classCode=SPLY or SBADM or PROC or OBS,moodCode=EVN]
|
context |
Σ |
0..1 |
Reference(Encounter | EpisodeOfCare) |
Element Id
MedicationStatement.context
Short description
Encounter / Episode associated with MedicationStatement Definition
The encounter or episode of care that establishes the context for this MedicationStatement.
Comments
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.
Data Type
Reference(Encounter | EpisodeOfCare) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
- ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow:…context
- rim:.inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code="type of encounter or episode"]
|
status |
Σ ?! |
1..1 |
codeBinding |
Element Id
MedicationStatement.status
Short description
active | completed | entered-in-error | intended | stopped | on-hold Definition
A 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.
Comments
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.
Data Type
code Binding
MedicationStatementStatus (required) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- workflow:…status
- rim:.statusCode
- w5:status
|
category |
Σ |
0..1 |
CodeableConceptBinding |
Element Id
MedicationStatement.category
Short description
Type of medication usage Definition
Indicates where type of medication statement and where the medication is expected to be consumed or administered.
Comments
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.
Data Type
CodeableConcept Binding
MedicationStatementCategory (preferred) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim:.inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code="type of medication usage"].value
- w5:class
|
medication[x] |
S Σ |
1..1 |
|
Element Id
MedicationStatement.medication[x]
Short description
Medication. At least Medication.Codeableconcept.text or Medication.Reference.display should be set. Definition
Identifies 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.
Comments
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. .
Binding
SNOMED CT Medication Codes (example) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow:…code
- rim:.participation[typeCode=CSM].role[classCode=ADMM or MANU]
- w5:what
|
medicationCodeableConcept |
|
|
CodeableConcept |
Data Type
CodeableConcept
|
medicationReference |
|
|
Reference(Medication) |
Data Type
Reference(Medication)
|
effective[x] |
S Σ |
0..1 |
|
Element Id
MedicationStatement.effective[x]
Short description
The date/time or interval when the medication was taken Definition
The 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).
Comments
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.
Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- workflow:…occurrence[x]
- rim:.effectiveTime
- w5:when.done
|
effectiveDateTime |
|
|
dateTime |
Data Type
dateTime
|
effectivePeriod |
|
|
Period |
Data Type
Period
|
dateAsserted |
Σ |
0..1 |
dateTime |
Element Id
MedicationStatement.dateAsserted
Short description
When the statement was asserted? Definition
The date when the medication statement was asserted by the information source.
Data Type
dateTime Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- rim:.participation[typeCode=AUT].time
- w5:when.recorded
|
informationSource |
|
0..1 |
Reference(Patient | Practitioner | RelatedPerson | Organization) |
Element Id
MedicationStatement.informationSource
Short description
Person or organization that provided the information about the taking of this medication Definition
The 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.
Comments
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.
Data Type
Reference(Patient | Practitioner | RelatedPerson | Organization) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
- ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- rim:.participation[typeCode=INF].role[classCode=PAT, or codes for Practioner or Related Person (if PAT is the informer, then syntax for self-reported =true)
- w5:who.source
|
subject |
S Σ |
1..1 |
Reference(Patient | Group) |
Element Id
MedicationStatement.subject
Short description
Patient taking the medication Definition
The person, animal or group who is/was taking the medication.
Comments
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.
Data Type
Reference(Patient | Group) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
- ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow:…subject
- v2:PID-3-Patient ID List
- rim:.participation[typeCode=SBJ].role[classCode=PAT]
- w5:who
|
derivedFrom |
|
0..* |
Reference(Resource) |
Element Id
MedicationStatement.derivedFrom
Short description
Additional supporting information Definition
Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.
Comments
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.
Data Type
Reference(Resource) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
- ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- rim:.outboundRelationship[typeCode=SPRT]/target[classCode=ACT,moodCode=EVN]
|
taken |
Σ ?! |
1..1 |
codeBinding |
Element Id
MedicationStatement.taken
Short description
y | n | unk | na Definition
Indicator of the certainty of whether the medication was taken by the patient.
Comments
This element is labeled as a modifier because it indicates that the medication was not taken.
Data Type
code Binding
MedicationStatementTaken (required) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- workflow:…notDone
- rim:.actionNegationInd
|
reasonNotTaken |
|
0..* |
CodeableConcept |
Element Id
MedicationStatement.reasonNotTaken
Short description
True if asserting medication was not given Definition
A code indicating why the medication was not taken.
Comments
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.
Data Type
CodeableConcept Binding
SNOMED CT Drugs not taken/completed Codes (example) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim:.outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code="reason not taken"].value
|
reasonCode |
|
0..* |
CodeableConcept |
Element Id
MedicationStatement.reasonCode
Short description
Reason for why the medication is being/was taken Definition
A reason for why the medication is being/was taken.
Comments
This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference.
Data Type
CodeableConcept Binding
Condition/Problem/Diagnosis Codes (example) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow:…reasoneCodeableConcept
- rim:.reasonCode
- w5:why
|
reasonReference |
|
0..* |
Reference(Condition | Observation) |
Element Id
MedicationStatement.reasonReference
Short description
Condition or observation that supports why the medication is being/was taken Definition
Condition or observation that supports why the medication is being/was taken.
Comments
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.
Data Type
Reference(Condition | Observation) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
- ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow:…reasonReference
- rim:.outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code="reason for use"].value
- w5:why
|
note |
|
0..* |
Annotation |
Element Id
Short description
Further information about the statement Definition
Provides extra information about the medication statement that is not conveyed by the other attributes.
Comments
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).
Data Type
Annotation Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:N/A
- rim:Act
- workflow:…note
- rim:.inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code="annotation"].value
|
dosage |
S |
0..* |
Dosage |
Element Id
MedicationStatement.dosage
Short description
Dosage of medication Definition
Indicates how the medication is/was or should be taken by the patient.
Comments
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.
Data Type
Dosage Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- rim:.outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]
- rim:refer dosageInstruction mapping
|
sequence |
Σ |
0..1 |
integer |
Element Id
MedicationStatement.dosage.sequence
Short description
The order of the dosage instructions Definition
Indicates the order in which the dosage instructions should be applied or interpreted.
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
32 bit number; for values larger than this, use decimal
Data Type
integer Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
|
text |
S Σ |
1..1 |
string |
Element Id
MedicationStatement.dosage.text
Short description
Text represenation of dosage, for example: "two times a day" Definition
Free text dosage instructions e.g. SIG.
Requirements
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.
Comments
Note that FHIR strings may not exceed 1MB in size
Data Type
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
|
additionalInstruction |
Σ |
0..* |
CodeableConcept |
Element Id
MedicationStatement.dosage.additionalInstruction
Short description
Supplemental instruction - e.g. "with meals" Definition
Supplemental instruction - e.g. "with meals".
Requirements
Additional instruction such as "Swallow with plenty of water" which may or may not be coded.
Comments
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.
Data Type
CodeableConcept Binding
SNOMED CT Additional Dosage Instructions (example) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim:.text
|
patientInstruction |
Σ |
0..1 |
string |
Element Id
MedicationStatement.dosage.patientInstruction
Short description
Patient or consumer oriented instructions Definition
Instructions in terms that are understood by the patient or consumer.
Comments
Note that FHIR strings may not exceed 1MB in size
Data Type
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
|
timing |
Σ |
0..1 |
Timing |
Element Id
MedicationStatement.dosage.timing
Short description
When medication should be administered Definition
When medication should be administered.
Requirements
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.
Comments
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.
Data Type
Timing Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:N/A
- rim:QSET<TS> (GTS)
- rim:.effectiveTime
|
asNeeded[x] |
Σ |
0..1 |
|
Element Id
MedicationStatement.dosage.asNeeded[x]
Short description
Take "as needed" (for x) Definition
Indicates 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).
Comments
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".
Binding
SNOMED CT Medication As Needed Reason Codes (example) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- rim:.outboundRelationship[typeCode=PRCN].target[classCode=OBS, moodCode=EVN, code="as needed"].value=boolean or codable concept
|
asNeededBoolean |
|
|
boolean |
Data Type
boolean
|
asNeededCodeableConcept |
|
|
CodeableConcept |
Data Type
CodeableConcept
|
site |
Σ |
0..1 |
CodeableConcept |
Element Id
MedicationStatement.dosage.site
Short description
Body site to administer to Definition
Body site to administer to.
Requirements
A coded specification of the anatomic site where the medication first enters the body.
Comments
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.
Data Type
CodeableConcept Binding
SNOMED CT Anatomical Structure for Administration Site Codes (example) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim:.approachSiteCode
|
route |
Σ |
0..1 |
CodeableConcept |
Element Id
MedicationStatement.dosage.route
Short description
How drug should enter body Definition
How drug should enter body.
Requirements
A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.
Comments
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.
Data Type
CodeableConcept Binding
SNOMED CT Route Codes (example) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim:.routeCode
|
method |
Σ |
0..1 |
CodeableConcept |
Element Id
MedicationStatement.dosage.method
Short description
Technique for administering medication Definition
Technique for administering medication.
Requirements
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.
Comments
Terminologies used often pre-coordinate this term with the route and or form of administration.
Data Type
CodeableConcept Binding
SNOMED CT Administration Method Codes (example) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim:.doseQuantity
|
dose[x] |
Σ |
0..1 |
|
Element Id
MedicationStatement.dosage.dose[x]
Short description
Amount of medication per dose Definition
Amount of medication per dose.
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.
Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
- rng-2:If present, low SHALL have a lower value than high
low.empty() or high.empty() or (low <= high)
Mappings
- rim:n/a
- v2:NR and also possibly SN (but see also quantity)
- rim:IVL<QTY[not(type="TS")]> [lowClosed="true" and highClosed="true"]or URG<QTY[not(type="TS")]>
- rim:.doseQuantity
|
doseRange |
|
|
Range |
Data Type
Range
|
doseQuantity |
|
|
SimpleQuantity |
Data Type
SimpleQuantity
|
maxDosePerPeriod |
Σ |
0..1 |
Ratio |
Element Id
MedicationStatement.dosage.maxDosePerPeriod
Short description
Upper limit on medication per unit of time Definition
Upper limit on medication per unit of time.
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
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".
Data Type
Ratio Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
- rat-1:Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
Mappings
- rim:n/a
- v2:N/A
- rim:RTO
- rim:.maxDoseQuantity
|
maxDosePerAdministration |
Σ |
0..1 |
SimpleQuantity |
Element Id
MedicationStatement.dosage.maxDosePerAdministration
Short description
Upper limit on medication per administration Definition
Upper limit on medication per administration.
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.
Data Type
SimpleQuantity Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
- qty-3:If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
- sqty-1:The comparator is not used on a SimpleQuantity
comparator.empty()
Mappings
- rim:n/a
- v2:SN (see also Range) or CQ
- rim:PQ, IVL<PQ>, MO, CO, depending on the values
- rim:not supported
|
maxDosePerLifetime |
Σ |
0..1 |
SimpleQuantity |
Element Id
MedicationStatement.dosage.maxDosePerLifetime
Short description
Upper limit on medication per lifetime of the patient Definition
Upper limit on medication per lifetime of the patient.
Requirements
The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject.
Comments
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.
Data Type
SimpleQuantity Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
- qty-3:If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
- sqty-1:The comparator is not used on a SimpleQuantity
comparator.empty()
Mappings
- rim:n/a
- v2:SN (see also Range) or CQ
- rim:PQ, IVL<PQ>, MO, CO, depending on the values
- rim:not supported
|
rate[x] |
Σ |
0..1 |
|
Element Id
MedicationStatement.dosage.rate[x]
Short description
Amount of medication per unit of time Definition
Amount of medication per unit of time.
Requirements
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.
Comments
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.
Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
- rat-1:Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
Mappings
- rim:n/a
- v2:N/A
- rim:RTO
- rim:.rateQuantity
|
rateRatio |
|
|
Ratio |
Data Type
Ratio
|
rateRange |
|
|
Range |
Data Type
Range
|
rateQuantity |
|
|
SimpleQuantity |
Data Type
SimpleQuantity
|