International Patient Summary Implementation Guide
2.0.0 -

International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions

## Resource Profile: MedicationStatement (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/MedicationStatement-uv-ips | Version: 2.0.0
Standards status: Trial-use Active as of 2024-06-19 | Maturity Level: 3 | Computable Name: MedicationStatementIPS

This profile represents the constraints applied to the MedicationStatement resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR R4. A record of a medication statement is represented in the patient summary as an instance of a MedicationStatement resource constrained by this profile.

> medicationCodeableConcept vs. medicationReference

> In the previously balloted versions, medicationCodeableConcept was not allowed to represent medications. To better support implementations, both options (medicationCodeableConcept and medicationReference) are now allowed, recognizing that different jurisdictions may provide different guidance worldwide and that future FHIR releases introduce CodeableReference

> STU implementers are encouraged to provide their feedback about this design choice.

Usages:

- Use this Profile: Bundle (IPS)
- Refer to this Profile: Composition (IPS)
- Examples for this Profile: MedicationStatement/eumfh-39-07-1
- CapabilityStatements using this Profile: IPS Server Capability Statement

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

- Key Elements Table
- Differential Table
- Snapshot Table
- Obligations
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MedicationStatement |  | 0..* | MedicationStatement | Record of medication being taken by a patient
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
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.
medication[x] | SO Σ | 1..1 |  | What medication was taken Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
medicationCodeableConcept |  |  | CodeableConcept(CodeableConceptIPS) |
medicationReference |  |  | Reference(Medication (IPS)) |
subject | SO Σ | 1..1 | Reference(Patient (IPS)) | Who is/was taking the medication
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
Slices for effective[x] | SO Σ | 1..1 |  | The date/time or interval when the medication is/was/will be taken Slice: Unordered, Open by type:$this
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
effectiveDateTime |  |  | dateTime |
effectivePeriod |  |  | Period |
effective[x]:effectiveDateTime | SO Σ | 0..1 | dateTime | The date/time or interval when the medication is/was/will be taken
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
dosage | SO | 0..* | Dosage | Details of how medication is/was taken or should be taken
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
text | SO Σ | 0..1 | string | Free text dosage instructions e.g. SIG
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
timing | SO Σ | 0..1 | Timing | When medication should be administered
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (preferred): SNOMED Route Terms
Additional Bindings | Purpose
Medicine EDQM Route of Administration - IPS | candidate
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
MedicationStatement |  |
medication[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
subject | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for effective[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
effective[x]:effectiveDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
dosage | SHALL:populate-if-known | SHALL:handle SHOULD:display
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
timing | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
MedicationStatement.​status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std.
MedicationStatement.​medication[x] | Base | preferred | Medications - IPS | 📦2.0.0 | This IG
MedicationStatement.​dosage.route | Base | preferred | SNOMED CT Route Codes | 📦4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | MedicationStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | MedicationStatement | 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-5 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | MedicationStatement | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MedicationStatement |  |  | MedicationStatement |
status |  | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
medication[x] | SO | 1..1 |  | What medication was taken Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
medicationCodeableConcept |  |  | CodeableConcept(CodeableConceptIPS) |
medicationReference |  |  | Reference(Medication (IPS)) |
subject | SO | 1..1 | Reference(Patient (IPS)) | Who is/was taking the medication
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reference | SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
Slices for effective[x] | SO | 1..1 | dateTime, Period | The date/time or interval when the medication is/was/will be taken Slice: Unordered, Open by type:$this
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
effective[x]:effectiveDateTime | SO | 0..1 | dateTime | The date/time or interval when the medication is/was/will be taken
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
dosage | SO | 0..* | Dosage | Details of how medication is/was taken or should be taken
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
text | SO | 0..1 | string | Free text dosage instructions e.g. SIG
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
timing | SO | 0..1 | Timing | When medication should be administered
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
route |  | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (preferred): SNOMED Route Terms
Additional Bindings | Purpose
Medicine EDQM Route of Administration - IPS | candidate
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
MedicationStatement |  |
medication[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
subject | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for effective[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
effective[x]:effectiveDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
dosage | SHALL:populate-if-known | SHALL:handle SHOULD:display
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
timing | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
MedicationStatement.​medication[x] | Base | preferred | Medications - IPS | 📦2.0.0 | This IG
MedicationStatement.​dosage.route | Base | preferred | SNOMED CT Route Codes | 📦4.0.1 | FHIR Std.

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MedicationStatement |  | 0..* | MedicationStatement | Record of medication being taken by a patient
id | Σ | 0..1 | id | 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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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 | ?!Σ | 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.
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] | SO Σ | 1..1 |  | What medication was taken Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
medicationCodeableConcept |  |  | CodeableConcept(CodeableConceptIPS) |
medicationReference |  |  | Reference(Medication (IPS)) |
subject | SO Σ | 1..1 | Reference(Patient (IPS)) | Who is/was taking the medication
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement
Slices for effective[x] | SO Σ | 1..1 |  | The date/time or interval when the medication is/was/will be taken Slice: Unordered, Open by type:$this
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
effectiveDateTime |  |  | dateTime |
effectivePeriod |  |  | Period |
effective[x]:effectiveDateTime | SO Σ | 0..1 | dateTime | The date/time or interval when the medication is/was/will be taken
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted?
informationSource |  | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | 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 | SO | 0..* | Dosage | Details of how medication is/was taken or should be taken
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
id |  | 0..1 | string | Unique id for inter-element referencing
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 | SO Σ | 0..1 | string | Free text dosage instructions e.g. SIG
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO Σ | 0..1 | Timing | When medication should be administered
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 (preferred): SNOMED Route Terms
Additional Bindings | Purpose
Medicine EDQM Route of Administration - IPS | candidate
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
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(4.0.1) | Upper limit on medication per administration
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per lifetime of the patient
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
MedicationStatement |  |
medication[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
subject | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for effective[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
effective[x]:effectiveDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
dosage | SHALL:populate-if-known | SHALL:handle SHOULD:display
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
timing | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
MedicationStatement.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
MedicationStatement.​status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std.
MedicationStatement.​statusReason | Base | example | SNOMED CT Drug Therapy Status codes | 📍4.0.1 | FHIR Std.
MedicationStatement.​category | Base | preferred | Medication usage category codes | 📍4.0.1 | FHIR Std.
MedicationStatement.​medication[x] | Base | preferred | Medications - IPS | 📦2.0.0 | This IG
MedicationStatement.​subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
MedicationStatement.​reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std.
MedicationStatement.​dosage.additionalInstruction | Base | example | SNOMED CT Additional Dosage Instructions | 📍4.0.1 | FHIR Std.
MedicationStatement.​dosage.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std.
MedicationStatement.​dosage.site | Base | example | SNOMED CT Anatomical Structure for Administration Site Codes | 📍4.0.1 | FHIR Std.
MedicationStatement.​dosage.route | Base | preferred | SNOMED CT Route Codes | 📦4.0.1 | FHIR Std.
MedicationStatement.​dosage.method | Base | example | SNOMED CT Administration Method Codes | 📍4.0.1 | FHIR Std.
MedicationStatement.​dosage.doseAndRate.type | Base | example | DoseAndRateType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | MedicationStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | MedicationStatement | 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-5 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | MedicationStatement | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
MedicationStatement |  |
medication[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
subject | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for effective[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
effective[x]:effectiveDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
dosage | SHALL:populate-if-known | SHALL:handle SHOULD:display
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
timing | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

Summary

Mandatory: 2 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

- Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
- Medication (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Medication-uv-ips)
- Patient (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of MedicationStatement.effective[x]

Maturity: 3

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MedicationStatement |  | 0..* | MedicationStatement | Record of medication being taken by a patient
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
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.
medication[x] | SO Σ | 1..1 |  | What medication was taken Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
medicationCodeableConcept |  |  | CodeableConcept(CodeableConceptIPS) |
medicationReference |  |  | Reference(Medication (IPS)) |
subject | SO Σ | 1..1 | Reference(Patient (IPS)) | Who is/was taking the medication
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
Slices for effective[x] | SO Σ | 1..1 |  | The date/time or interval when the medication is/was/will be taken Slice: Unordered, Open by type:$this
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
effectiveDateTime |  |  | dateTime |
effectivePeriod |  |  | Period |
effective[x]:effectiveDateTime | SO Σ | 0..1 | dateTime | The date/time or interval when the medication is/was/will be taken
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
dosage | SO | 0..* | Dosage | Details of how medication is/was taken or should be taken
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
text | SO Σ | 0..1 | string | Free text dosage instructions e.g. SIG
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
timing | SO Σ | 0..1 | Timing | When medication should be administered
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
route | Σ | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (preferred): SNOMED Route Terms
Additional Bindings | Purpose
Medicine EDQM Route of Administration - IPS | candidate
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
MedicationStatement |  |
medication[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
subject | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for effective[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
effective[x]:effectiveDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
dosage | SHALL:populate-if-known | SHALL:handle SHOULD:display
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
timing | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
MedicationStatement.​status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std.
MedicationStatement.​medication[x] | Base | preferred | Medications - IPS | 📦2.0.0 | This IG
MedicationStatement.​dosage.route | Base | preferred | SNOMED CT Route Codes | 📦4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | MedicationStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | MedicationStatement | 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-5 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | MedicationStatement | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MedicationStatement |  |  | MedicationStatement |
status |  | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
medication[x] | SO | 1..1 |  | What medication was taken Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
medicationCodeableConcept |  |  | CodeableConcept(CodeableConceptIPS) |
medicationReference |  |  | Reference(Medication (IPS)) |
subject | SO | 1..1 | Reference(Patient (IPS)) | Who is/was taking the medication
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reference | SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
Slices for effective[x] | SO | 1..1 | dateTime, Period | The date/time or interval when the medication is/was/will be taken Slice: Unordered, Open by type:$this
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
effective[x]:effectiveDateTime | SO | 0..1 | dateTime | The date/time or interval when the medication is/was/will be taken
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
dosage | SO | 0..* | Dosage | Details of how medication is/was taken or should be taken
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
text | SO | 0..1 | string | Free text dosage instructions e.g. SIG
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
timing | SO | 0..1 | Timing | When medication should be administered
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
route |  | 0..1 | CodeableConcept | How drug should enter body Binding: SNOMEDCTRouteCodes (preferred): SNOMED Route Terms
Additional Bindings | Purpose
Medicine EDQM Route of Administration - IPS | candidate
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
MedicationStatement |  |
medication[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
subject | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for effective[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
effective[x]:effectiveDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
dosage | SHALL:populate-if-known | SHALL:handle SHOULD:display
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
timing | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
MedicationStatement.​medication[x] | Base | preferred | Medications - IPS | 📦2.0.0 | This IG
MedicationStatement.​dosage.route | Base | preferred | SNOMED CT Route Codes | 📦4.0.1 | FHIR Std.

Snapshot ViewView

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
MedicationStatement |  | 0..* | MedicationStatement | Record of medication being taken by a patient
id | Σ | 0..1 | id | 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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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 | ?!Σ | 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.
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] | SO Σ | 1..1 |  | What medication was taken Binding: Medications - IPS (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
medicationCodeableConcept |  |  | CodeableConcept(CodeableConceptIPS) |
medicationReference |  |  | Reference(Medication (IPS)) |
subject | SO Σ | 1..1 | Reference(Patient (IPS)) | Who is/was taking the medication
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement
Slices for effective[x] | SO Σ | 1..1 |  | The date/time or interval when the medication is/was/will be taken Slice: Unordered, Open by type:$this
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
effectiveDateTime |  |  | dateTime |
effectivePeriod |  |  | Period |
effective[x]:effectiveDateTime | SO Σ | 0..1 | dateTime | The date/time or interval when the medication is/was/will be taken
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted?
informationSource |  | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | 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 | SO | 0..* | Dosage | Details of how medication is/was taken or should be taken
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
id |  | 0..1 | string | Unique id for inter-element referencing
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 | SO Σ | 0..1 | string | Free text dosage instructions e.g. SIG
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO Σ | 0..1 | Timing | When medication should be administered
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 (preferred): SNOMED Route Terms
Additional Bindings | Purpose
Medicine EDQM Route of Administration - IPS | candidate
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
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(4.0.1) | Upper limit on medication per administration
maxDosePerLifetime | Σ | 0..1 | SimpleQuantity(4.0.1) | Upper limit on medication per lifetime of the patient
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
MedicationStatement |  |
medication[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
subject | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for effective[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
effective[x]:effectiveDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
dosage | SHALL:populate-if-known | SHALL:handle SHOULD:display
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
timing | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
MedicationStatement.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
MedicationStatement.​status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std.
MedicationStatement.​statusReason | Base | example | SNOMED CT Drug Therapy Status codes | 📍4.0.1 | FHIR Std.
MedicationStatement.​category | Base | preferred | Medication usage category codes | 📍4.0.1 | FHIR Std.
MedicationStatement.​medication[x] | Base | preferred | Medications - IPS | 📦2.0.0 | This IG
MedicationStatement.​subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
MedicationStatement.​reasonCode | Base | example | Condition/Problem/Diagnosis Codes | 📍4.0.1 | FHIR Std.
MedicationStatement.​dosage.additionalInstruction | Base | example | SNOMED CT Additional Dosage Instructions | 📍4.0.1 | FHIR Std.
MedicationStatement.​dosage.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std.
MedicationStatement.​dosage.site | Base | example | SNOMED CT Anatomical Structure for Administration Site Codes | 📍4.0.1 | FHIR Std.
MedicationStatement.​dosage.route | Base | preferred | SNOMED CT Route Codes | 📦4.0.1 | FHIR Std.
MedicationStatement.​dosage.method | Base | example | SNOMED CT Administration Method Codes | 📍4.0.1 | FHIR Std.
MedicationStatement.​dosage.doseAndRate.type | Base | example | DoseAndRateType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | MedicationStatement | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | MedicationStatement | 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-5 | error | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | MedicationStatement | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
MedicationStatement |  |
medication[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
subject | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for effective[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
effective[x]:effectiveDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
dosage | SHALL:populate-if-known | SHALL:handle SHOULD:display
text | SHALL:populate-if-known | SHALL:handle SHOULD:display
timing | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

Summary

Mandatory: 2 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

- Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
- Medication (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Medication-uv-ips)
- Patient (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of MedicationStatement.effective[x]

Maturity: 3

Other representations of profile: CSV, Excel, Schematron