This page is part of the International Patient Access (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Defining URL: | http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement |
Version: | 0.1.0 |
Name: | IPAMedicationStatement |
Title: | IPA-MedicationStatement |
Status: | Draft as of 8/26/19 3:10 PM |
Definition: | Minimum expectations for a MedicationStatement resource when accessed via a International Patient Access API |
Publisher: | HL7 International - Patient Care Workgroup |
Copyright: | Creative Commons Public Domain |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement
The MedicationStatement resource represents all medications a patient is taking, be it those ordered by a clinician or reported by another organization, the patient or a caregiver.
While the relationship between Medication Statement and Medication Request is clear in principle, in practice, when patients report medications, these may also be implicitly treated as statements of intent about what the patient should be taking. As such, information systems may record these statements as either Medication Requests or Medication Statements, or as both. The choice between these options may be influenced by many factors including wording in legislation and regulations.
For this reason, clients implementing the International Patient Access specification SHALL query for both MedicationStatement and MedicationRequest when fetching patient Medication information.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationStatement
Summary
Mandatory: 4 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
This structure is derived from MedicationStatement
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
status | S | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken |
statusReason | S | 0..* | CodeableConcept | Reason for current status |
medication[x] | S | 1..1 | What medication was taken | |
medicationCodeableConcept | CodeableConcept | |||
medicationReference | Reference(IPA-Medication) | |||
subject | S | 1..1 | Reference(IPA-Patient) | Who is/was taking the medication |
context | S | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement |
effective[x] | S | 0..1 | dateTime, Period | The date/time or interval when the medication is/was/will be taken |
informationSource | S | 1..1 | Reference(IPA-Practitioner | IPA-PractitionerRole | IPA-Patient) | Person or organization that provided the information about the taking of this medication |
dosage | S | 0..* | Dosage | Details of how medication is/was taken or should be taken |
text | S | 0..1 | string | Free text dosage instructions e.g. SIG |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External identifier |
basedOn | Σ | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order |
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event |
status | ?!SΣ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. |
statusReason | S | 0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. |
category | Σ | 0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. |
medication[x] | SΣ | 1..1 | What medication was taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | |
medicationCodeableConcept | CodeableConcept | |||
medicationReference | Reference(IPA-Medication) | |||
subject | SΣ | 1..1 | Reference(IPA-Patient) | Who is/was taking the medication |
context | SΣ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement |
effective[x] | SΣ | 0..1 | The date/time or interval when the medication is/was/will be taken | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted? |
informationSource | S | 1..1 | Reference(IPA-Practitioner | IPA-PractitionerRole | IPA-Patient) | Person or organization that provided the information about the taking of this medication |
derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |
reasonCode | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. | |
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication is being/was taken | |
note | 0..* | Annotation | Further information about the statement | |
dosage | S | 0..* | Dosage | Details of how medication is/was taken or should be taken |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
sequence | Σ | 0..1 | integer | The order of the dosage instructions |
text | SΣ | 0..1 | string | Free text dosage instructions e.g. SIG |
additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". |
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions |
timing | Σ | 0..1 | Timing | When medication should be administered |
asNeeded[x] | Σ | 0..1 | Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): 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. | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. |
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. |
doseAndRate | Σ | 0..* | Element | Amount of medication administered |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
type | Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. |
dose[x] | Σ | 0..1 | Amount of medication per dose | |
doseRange | Range | |||
doseQuantity | Quantity(SimpleQuantity) | |||
rate[x] | Σ | 0..1 | Amount of medication per unit of time | |
rateRatio | Ratio | |||
rateRange | Range | |||
rateQuantity | Quantity(SimpleQuantity) | |||
maxDosePerPeriod | Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration |
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
status | ?!Σ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. |
statusReason | 0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | |
medication[x] | Σ | 1..1 | What medication was taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | |
medicationCodeableConcept | CodeableConcept | |||
medicationReference | Reference(IPA-Medication) | |||
subject | Σ | 1..1 | Reference(IPA-Patient) | Who is/was taking the medication |
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement |
effective[x] | Σ | 0..1 | The date/time or interval when the medication is/was/will be taken | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
informationSource | 1..1 | Reference(IPA-Practitioner | IPA-PractitionerRole | IPA-Patient) | Person or organization that provided the information about the taking of this medication | |
dosage | 0..* | Dosage | Details of how medication is/was taken or should be taken | |
text | Σ | 0..1 | string | Free text dosage instructions e.g. SIG |
Documentation for this format |
This structure is derived from MedicationStatement
Summary
Mandatory: 4 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from MedicationStatement
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
status | S | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken |
statusReason | S | 0..* | CodeableConcept | Reason for current status |
medication[x] | S | 1..1 | What medication was taken | |
medicationCodeableConcept | CodeableConcept | |||
medicationReference | Reference(IPA-Medication) | |||
subject | S | 1..1 | Reference(IPA-Patient) | Who is/was taking the medication |
context | S | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement |
effective[x] | S | 0..1 | dateTime, Period | The date/time or interval when the medication is/was/will be taken |
informationSource | S | 1..1 | Reference(IPA-Practitioner | IPA-PractitionerRole | IPA-Patient) | Person or organization that provided the information about the taking of this medication |
dosage | S | 0..* | Dosage | Details of how medication is/was taken or should be taken |
text | S | 0..1 | string | Free text dosage instructions e.g. SIG |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External identifier |
basedOn | Σ | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order |
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event |
status | ?!SΣ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. |
statusReason | S | 0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. |
category | Σ | 0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. |
medication[x] | SΣ | 1..1 | What medication was taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | |
medicationCodeableConcept | CodeableConcept | |||
medicationReference | Reference(IPA-Medication) | |||
subject | SΣ | 1..1 | Reference(IPA-Patient) | Who is/was taking the medication |
context | SΣ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement |
effective[x] | SΣ | 0..1 | The date/time or interval when the medication is/was/will be taken | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted? |
informationSource | S | 1..1 | Reference(IPA-Practitioner | IPA-PractitionerRole | IPA-Patient) | Person or organization that provided the information about the taking of this medication |
derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |
reasonCode | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. | |
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication is being/was taken | |
note | 0..* | Annotation | Further information about the statement | |
dosage | S | 0..* | Dosage | Details of how medication is/was taken or should be taken |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
sequence | Σ | 0..1 | integer | The order of the dosage instructions |
text | SΣ | 0..1 | string | Free text dosage instructions e.g. SIG |
additionalInstruction | Σ | 0..* | CodeableConcept | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". |
patientInstruction | Σ | 0..1 | string | Patient or consumer oriented instructions |
timing | Σ | 0..1 | Timing | When medication should be administered |
asNeeded[x] | Σ | 0..1 | Take "as needed" (for x) Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): 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. | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
site | Σ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. |
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. |
doseAndRate | Σ | 0..* | Element | Amount of medication administered |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
type | Σ | 0..1 | CodeableConcept | The kind of dose or rate specified Binding: DoseAndRateType (example): The kind of dose or rate specified. |
dose[x] | Σ | 0..1 | Amount of medication per dose | |
doseRange | Range | |||
doseQuantity | Quantity(SimpleQuantity) | |||
rate[x] | Σ | 0..1 | Amount of medication per unit of time | |
rateRatio | Ratio | |||
rateRange | Range | |||
rateQuantity | Quantity(SimpleQuantity) | |||
maxDosePerPeriod | Σ | 0..1 | Ratio | Upper limit on medication per unit of time |
maxDosePerAdministration | Σ | 0..1 | SimpleQuantity | Upper limit on medication per administration |
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity | Upper limit on medication per lifetime of the patient |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
MedicationStatement.language | preferred | CommonLanguages Max Binding: AllLanguages |
MedicationStatement.status | required | Medication Status Codes |
MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodes |
MedicationStatement.category | preferred | Medication usage category codes |
MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodes |
MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodes |
MedicationStatement.dosage.additionalInstruction | example | SNOMEDCTAdditionalDosageInstructions |
MedicationStatement.dosage.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes |
MedicationStatement.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodes |
MedicationStatement.dosage.route | example | SNOMEDCTRouteCodes |
MedicationStatement.dosage.method | example | SNOMEDCTAdministrationMethodCodes |
MedicationStatement.dosage.doseAndRate.type | example | DoseAndRateType |