Care Coordination Management
0.0.1 - ci-build Estonia (EST)

Care Coordination Management, published by Helex OÜ. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/helexlab/ig-ccm/ and changes regularly. See the Directory of published versions

Resource Profile: MedicationStatementCcm

Official URL: http://helex.org/ig/ccm/StructureDefinition/medication-statement-ccm Version: 0.0.1
Draft as of 2025-12-05 Computable Name: MedicationStatementCcm

CCM MedicationStatement profile linking a patient with a ResearchStudy and tracking lifecycle via progress entries.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... category Σ 0..* CodeableConcept Type of medication statement
Binding: MedicationRequestAdministrationLocationCodes (example): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationrequest-admin-location
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: community
..... display 1..1 string Representation defined by the system
Fixed Value: Community
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... medication SΣ 1..1 CodeableReference(MedicationCcm) What medication was taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
... subject SΣ 1..1 Reference(PatientCcm) Who is/was taking the medication
... Slices for effective[x] Σ 1..1 dateTime The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime SΣ 1..1 dateTime The date/time or interval when the medication is/was/will be taken
... reason S 0..1 CodeableReference(Condition | Observation | DiagnosticReport) Reason for why the medication is being/was taken
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-meds-reason--1.0.0 (extensible)
... note S 0..* Annotation Further information about the usage
... dosage S 1..1 Dosage Details of how medication is/was taken or should be taken
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text SΣ 0..1 string Free text dosage instructions e.g. SIG
.... timing SΣ 0..1 Timing When medication should be administered
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... repeat ΣC 0..1 Element When the event is to occur
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
...... duration ΣC 0..1 decimal How long when it happens
...... period ΣC 0..1 decimal The duration to which the frequency applies. I.e. Event occurs frequency times per period
...... when SΣC 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real-world event relating to the schedule.
.... asNeeded SΣC 1..1 boolean Take "as needed"
.... doseAndRate SΣ 0..1 Element Amount of medication administered, to be administered or typical amount to be administered
..... Slices for dose[x] Σ 1..1 SimpleQuantity(5.0.0) Amount of medication per dose
Slice: Unordered, Closed by type:$this
...... dose[x]:doseQuantity SΣ 1..1 SimpleQuantity Amount of medication per dose

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationStatement.​status Base required MedicationStatement Status Codes 📍5.0.0 FHIR Std.
MedicationStatement.​category Base example medicationRequest Administration Location Codes 📍5.0.0 FHIR Std.
MedicationStatement.​medication Base example SNOMED CT Medication Codes 📍5.0.0 FHIR Std.
MedicationStatement.​reason Base extensible https://dev.termx.org/api/fhir/ValueSet/ccm-meds-reason--1.0.0 Not State Unknown
MedicationStatement.​dosage.timing.repeat.​when Base required EventTiming 📍5.0.0 FHIR Std.
MedicationStatement.​adherence.code Base example MedicationStatement Adherence Codes 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
tim-1 error MedicationStatement.dosage.timing.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error MedicationStatement.dosage.timing.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error MedicationStatement.dosage.timing.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error MedicationStatement.dosage.timing.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error MedicationStatement.dosage.timing.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error MedicationStatement.dosage.timing.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error MedicationStatement.dosage.timing.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error MedicationStatement.dosage.timing.repeat If there's an offset, there must be a when (and not C, CM, CD, CV) offset.empty() or (when.exists() and when.select($this in ('C' | 'CM' | 'CD' | 'CV')).allFalse())
tim-10 error MedicationStatement.dosage.timing.repeat If there's a timeOfDay, there cannot be a when, or vice versa timeOfDay.empty() or when.empty()

This structure is derived from MedicationStatement

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationStatement 0..* MedicationStatement Record of medication being taken by a patient
... partOf 0..0 Part of referenced event
... status 1..1 code recorded | entered-in-error | draft
Required Pattern: recorded
... category 0..* CodeableConcept Type of medication statement
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationrequest-admin-location
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: community
..... display 1..1 string Representation defined by the system
Fixed Value: Community
... subject S 1..1 Reference(PatientCcm) Who is/was taking the medication
... encounter 0..0 Encounter associated with MedicationStatement
... Slices for effective[x] 1..1 dateTime The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime S 1..1 dateTime The date/time or interval when the medication is/was/will be taken
... dateAsserted 0..0 When the usage was asserted?
... informationSource 0..0 Person or organization that provided the information about the taking of this medication
... derivedFrom S 0..0 Link to information used to derive the MedicationStatement
... reason S 0..1 CodeableReference(Condition | Observation | DiagnosticReport) Reason for why the medication is being/was taken
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-meds-reason--1.0.0 (extensible)
... note S 0..* Annotation Further information about the usage
... relatedClinicalInformation 0..0 Link to information relevant to the usage of a medication
... renderedDosageInstruction 0..0 Full representation of the dosage instructions
... dosage S 1..1 Dosage Details of how medication is/was taken or should be taken
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... timing S 0..1 Timing When medication should be administered
..... repeat
...... when S 0..* code Code for time period of occurrence
.... asNeeded S 1..1 boolean Take "as needed"
.... doseAndRate S 0..1 Element Amount of medication administered, to be administered or typical amount to be administered
..... Slices for dose[x] 1..1 SimpleQuantity(5.0.0) Amount of medication per dose
Slice: Unordered, Open by type:$this
...... dose[x]:doseQuantity S 1..1 SimpleQuantity Amount of medication per dose
... adherence 0..0 Indicates whether the medication is or is not being consumed or administered

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationStatement.​reason Base extensible https://dev.termx.org/api/fhir/ValueSet/ccm-meds-reason--1.0.0 Not State Unknown
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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
... status ?!Σ 1..1 code recorded | entered-in-error | draft
Binding: MedicationStatementStatusCodes (required): A coded concept indicating the current status of a MedicationStatement.
Required Pattern: recorded
... category Σ 0..* CodeableConcept Type of medication statement
Binding: MedicationRequestAdministrationLocationCodes (example): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationrequest-admin-location
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: community
..... display 1..1 string Representation defined by the system
Fixed Value: Community
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... medication SΣ 1..1 CodeableReference(MedicationCcm) What medication was taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
... subject SΣ 1..1 Reference(PatientCcm) Who is/was taking the medication
... Slices for effective[x] Σ 1..1 dateTime The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime SΣ 1..1 dateTime The date/time or interval when the medication is/was/will be taken
... reason S 0..1 CodeableReference(Condition | Observation | DiagnosticReport) Reason for why the medication is being/was taken
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-meds-reason--1.0.0 (extensible)
... note S 0..* Annotation Further information about the usage
... dosage S 1..1 Dosage Details of how medication is/was taken or should be taken
.... id 0..1 id 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 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 SΣ 0..1 Timing When medication should be administered
..... id 0..1 id 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
..... event Σ 0..* dateTime When the event occurs
..... repeat ΣC 0..1 Element When the event is to occur
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits
....... boundsDuration Duration
....... boundsRange Range
....... boundsPeriod Period
...... count ΣC 0..1 positiveInt Number of times to repeat
...... countMax ΣC 0..1 positiveInt Maximum number of times to repeat
...... duration ΣC 0..1 decimal How long when it happens
...... durationMax ΣC 0..1 decimal How long when it happens (Max)
...... durationUnit ΣC 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
...... frequency Σ 0..1 positiveInt Indicates the number of repetitions that should occur within a period. I.e. Event occurs frequency times per period
...... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
...... period ΣC 0..1 decimal The duration to which the frequency applies. I.e. Event occurs frequency times per period
...... periodMax ΣC 0..1 decimal Upper limit of period (3-4 hours)
...... periodUnit ΣC 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
...... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay ΣC 0..* time Time of day for action
...... when SΣC 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real-world event relating to the schedule.
...... offset ΣC 0..1 unsignedInt Minutes from event (before or after)
..... code Σ 0..1 CodeableConcept C | BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
.... asNeeded SΣC 1..1 boolean Take "as needed"
.... asNeededFor ΣC 0..* CodeableConcept 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.
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureAdministrationSites (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 SΣ 0..1 Element Amount of medication administered, to be administered or typical amount to be 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.
..... Slices for dose[x] Σ 1..1 SimpleQuantity(5.0.0) Amount of medication per dose
Slice: Unordered, Closed by type:$this
...... dose[x]:doseQuantity SΣ 1..1 SimpleQuantity Amount of medication per dose
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..* Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity(5.0.0) Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity(5.0.0) Upper limit on medication per lifetime of the patient

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationStatement.​language Base required All Languages 📍5.0.0 FHIR Std.
MedicationStatement.​status Base required MedicationStatement Status Codes 📍5.0.0 FHIR Std.
MedicationStatement.​category Base example medicationRequest Administration Location Codes 📍5.0.0 FHIR Std.
MedicationStatement.​medication Base example SNOMED CT Medication Codes 📍5.0.0 FHIR Std.
MedicationStatement.​reason Base extensible https://dev.termx.org/api/fhir/ValueSet/ccm-meds-reason--1.0.0 Not State Unknown
MedicationStatement.​dosage.additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​durationUnit Base required UnitsOfTime 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​periodUnit Base required UnitsOfTime 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​dayOfWeek Base required Days Of Week 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​when Base required EventTiming 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.timing.code Base preferred TimingAbbreviation 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.asNeededFor Base example SNOMED CT Medication As Needed Reason Codes 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.route Base example SNOMED CT Route Codes 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.method Base example SNOMED CT Administration Method Codes 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.doseAndRate.type Base example DoseAndRateType 📦1.0.0 THO v7.0
MedicationStatement.​adherence.code Base example MedicationStatement Adherence Codes 📍5.0.0 FHIR Std.
MedicationStatement.​adherence.reason Base example SNOMED CT Drug Therapy Status codes 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
tim-1 error MedicationStatement.dosage.timing.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error MedicationStatement.dosage.timing.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error MedicationStatement.dosage.timing.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error MedicationStatement.dosage.timing.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error MedicationStatement.dosage.timing.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error MedicationStatement.dosage.timing.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error MedicationStatement.dosage.timing.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error MedicationStatement.dosage.timing.repeat If there's an offset, there must be a when (and not C, CM, CD, CV) offset.empty() or (when.exists() and when.select($this in ('C' | 'CM' | 'CD' | 'CV')).allFalse())
tim-10 error MedicationStatement.dosage.timing.repeat If there's a timeOfDay, there cannot be a when, or vice versa timeOfDay.empty() or when.empty()

This structure is derived from MedicationStatement

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Must-Support: 13 elements
Prohibited: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationStatement.effective[x]
  • The element 1 is sliced based on the value of MedicationStatement.dosage.doseAndRate.dose[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... category Σ 0..* CodeableConcept Type of medication statement
Binding: MedicationRequestAdministrationLocationCodes (example): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationrequest-admin-location
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: community
..... display 1..1 string Representation defined by the system
Fixed Value: Community
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... medication SΣ 1..1 CodeableReference(MedicationCcm) What medication was taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
... subject SΣ 1..1 Reference(PatientCcm) Who is/was taking the medication
... Slices for effective[x] Σ 1..1 dateTime The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime SΣ 1..1 dateTime The date/time or interval when the medication is/was/will be taken
... reason S 0..1 CodeableReference(Condition | Observation | DiagnosticReport) Reason for why the medication is being/was taken
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-meds-reason--1.0.0 (extensible)
... note S 0..* Annotation Further information about the usage
... dosage S 1..1 Dosage Details of how medication is/was taken or should be taken
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text SΣ 0..1 string Free text dosage instructions e.g. SIG
.... timing SΣ 0..1 Timing When medication should be administered
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... repeat ΣC 0..1 Element When the event is to occur
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
...... duration ΣC 0..1 decimal How long when it happens
...... period ΣC 0..1 decimal The duration to which the frequency applies. I.e. Event occurs frequency times per period
...... when SΣC 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real-world event relating to the schedule.
.... asNeeded SΣC 1..1 boolean Take "as needed"
.... doseAndRate SΣ 0..1 Element Amount of medication administered, to be administered or typical amount to be administered
..... Slices for dose[x] Σ 1..1 SimpleQuantity(5.0.0) Amount of medication per dose
Slice: Unordered, Closed by type:$this
...... dose[x]:doseQuantity SΣ 1..1 SimpleQuantity Amount of medication per dose

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationStatement.​status Base required MedicationStatement Status Codes 📍5.0.0 FHIR Std.
MedicationStatement.​category Base example medicationRequest Administration Location Codes 📍5.0.0 FHIR Std.
MedicationStatement.​medication Base example SNOMED CT Medication Codes 📍5.0.0 FHIR Std.
MedicationStatement.​reason Base extensible https://dev.termx.org/api/fhir/ValueSet/ccm-meds-reason--1.0.0 Not State Unknown
MedicationStatement.​dosage.timing.repeat.​when Base required EventTiming 📍5.0.0 FHIR Std.
MedicationStatement.​adherence.code Base example MedicationStatement Adherence Codes 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
tim-1 error MedicationStatement.dosage.timing.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error MedicationStatement.dosage.timing.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error MedicationStatement.dosage.timing.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error MedicationStatement.dosage.timing.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error MedicationStatement.dosage.timing.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error MedicationStatement.dosage.timing.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error MedicationStatement.dosage.timing.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error MedicationStatement.dosage.timing.repeat If there's an offset, there must be a when (and not C, CM, CD, CV) offset.empty() or (when.exists() and when.select($this in ('C' | 'CM' | 'CD' | 'CV')).allFalse())
tim-10 error MedicationStatement.dosage.timing.repeat If there's a timeOfDay, there cannot be a when, or vice versa timeOfDay.empty() or when.empty()

Differential View

This structure is derived from MedicationStatement

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationStatement 0..* MedicationStatement Record of medication being taken by a patient
... partOf 0..0 Part of referenced event
... status 1..1 code recorded | entered-in-error | draft
Required Pattern: recorded
... category 0..* CodeableConcept Type of medication statement
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationrequest-admin-location
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: community
..... display 1..1 string Representation defined by the system
Fixed Value: Community
... subject S 1..1 Reference(PatientCcm) Who is/was taking the medication
... encounter 0..0 Encounter associated with MedicationStatement
... Slices for effective[x] 1..1 dateTime The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime S 1..1 dateTime The date/time or interval when the medication is/was/will be taken
... dateAsserted 0..0 When the usage was asserted?
... informationSource 0..0 Person or organization that provided the information about the taking of this medication
... derivedFrom S 0..0 Link to information used to derive the MedicationStatement
... reason S 0..1 CodeableReference(Condition | Observation | DiagnosticReport) Reason for why the medication is being/was taken
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-meds-reason--1.0.0 (extensible)
... note S 0..* Annotation Further information about the usage
... relatedClinicalInformation 0..0 Link to information relevant to the usage of a medication
... renderedDosageInstruction 0..0 Full representation of the dosage instructions
... dosage S 1..1 Dosage Details of how medication is/was taken or should be taken
.... text S 0..1 string Free text dosage instructions e.g. SIG
.... timing S 0..1 Timing When medication should be administered
..... repeat
...... when S 0..* code Code for time period of occurrence
.... asNeeded S 1..1 boolean Take "as needed"
.... doseAndRate S 0..1 Element Amount of medication administered, to be administered or typical amount to be administered
..... Slices for dose[x] 1..1 SimpleQuantity(5.0.0) Amount of medication per dose
Slice: Unordered, Open by type:$this
...... dose[x]:doseQuantity S 1..1 SimpleQuantity Amount of medication per dose
... adherence 0..0 Indicates whether the medication is or is not being consumed or administered

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationStatement.​reason Base extensible https://dev.termx.org/api/fhir/ValueSet/ccm-meds-reason--1.0.0 Not State Unknown

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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
... status ?!Σ 1..1 code recorded | entered-in-error | draft
Binding: MedicationStatementStatusCodes (required): A coded concept indicating the current status of a MedicationStatement.
Required Pattern: recorded
... category Σ 0..* CodeableConcept Type of medication statement
Binding: MedicationRequestAdministrationLocationCodes (example): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationrequest-admin-location
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: community
..... display 1..1 string Representation defined by the system
Fixed Value: Community
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... medication SΣ 1..1 CodeableReference(MedicationCcm) What medication was taken
Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken.
... subject SΣ 1..1 Reference(PatientCcm) Who is/was taking the medication
... Slices for effective[x] Σ 1..1 dateTime The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime SΣ 1..1 dateTime The date/time or interval when the medication is/was/will be taken
... reason S 0..1 CodeableReference(Condition | Observation | DiagnosticReport) Reason for why the medication is being/was taken
Binding: https://dev.termx.org/api/fhir/ValueSet/ccm-meds-reason--1.0.0 (extensible)
... note S 0..* Annotation Further information about the usage
... dosage S 1..1 Dosage Details of how medication is/was taken or should be taken
.... id 0..1 id 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 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 SΣ 0..1 Timing When medication should be administered
..... id 0..1 id 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
..... event Σ 0..* dateTime When the event occurs
..... repeat ΣC 0..1 Element When the event is to occur
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits
....... boundsDuration Duration
....... boundsRange Range
....... boundsPeriod Period
...... count ΣC 0..1 positiveInt Number of times to repeat
...... countMax ΣC 0..1 positiveInt Maximum number of times to repeat
...... duration ΣC 0..1 decimal How long when it happens
...... durationMax ΣC 0..1 decimal How long when it happens (Max)
...... durationUnit ΣC 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
...... frequency Σ 0..1 positiveInt Indicates the number of repetitions that should occur within a period. I.e. Event occurs frequency times per period
...... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
...... period ΣC 0..1 decimal The duration to which the frequency applies. I.e. Event occurs frequency times per period
...... periodMax ΣC 0..1 decimal Upper limit of period (3-4 hours)
...... periodUnit ΣC 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
...... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay ΣC 0..* time Time of day for action
...... when SΣC 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real-world event relating to the schedule.
...... offset ΣC 0..1 unsignedInt Minutes from event (before or after)
..... code Σ 0..1 CodeableConcept C | BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
.... asNeeded SΣC 1..1 boolean Take "as needed"
.... asNeededFor ΣC 0..* CodeableConcept 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.
.... site Σ 0..1 CodeableConcept Body site to administer to
Binding: SNOMEDCTAnatomicalStructureAdministrationSites (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 SΣ 0..1 Element Amount of medication administered, to be administered or typical amount to be 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.
..... Slices for dose[x] Σ 1..1 SimpleQuantity(5.0.0) Amount of medication per dose
Slice: Unordered, Closed by type:$this
...... dose[x]:doseQuantity SΣ 1..1 SimpleQuantity Amount of medication per dose
..... rate[x] Σ 0..1 Amount of medication per unit of time
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
.... maxDosePerPeriod Σ 0..* Ratio Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantity(5.0.0) Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantity(5.0.0) Upper limit on medication per lifetime of the patient

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationStatement.​language Base required All Languages 📍5.0.0 FHIR Std.
MedicationStatement.​status Base required MedicationStatement Status Codes 📍5.0.0 FHIR Std.
MedicationStatement.​category Base example medicationRequest Administration Location Codes 📍5.0.0 FHIR Std.
MedicationStatement.​medication Base example SNOMED CT Medication Codes 📍5.0.0 FHIR Std.
MedicationStatement.​reason Base extensible https://dev.termx.org/api/fhir/ValueSet/ccm-meds-reason--1.0.0 Not State Unknown
MedicationStatement.​dosage.additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​durationUnit Base required UnitsOfTime 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​periodUnit Base required UnitsOfTime 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​dayOfWeek Base required Days Of Week 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​when Base required EventTiming 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.timing.code Base preferred TimingAbbreviation 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.asNeededFor Base example SNOMED CT Medication As Needed Reason Codes 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.site Base example SNOMED CT Anatomical Structure for Administration Site Codes 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.route Base example SNOMED CT Route Codes 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.method Base example SNOMED CT Administration Method Codes 📍5.0.0 FHIR Std.
MedicationStatement.​dosage.doseAndRate.type Base example DoseAndRateType 📦1.0.0 THO v7.0
MedicationStatement.​adherence.code Base example MedicationStatement Adherence Codes 📍5.0.0 FHIR Std.
MedicationStatement.​adherence.reason Base example SNOMED CT Drug Therapy Status codes 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
tim-1 error MedicationStatement.dosage.timing.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error MedicationStatement.dosage.timing.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error MedicationStatement.dosage.timing.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error MedicationStatement.dosage.timing.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error MedicationStatement.dosage.timing.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error MedicationStatement.dosage.timing.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error MedicationStatement.dosage.timing.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error MedicationStatement.dosage.timing.repeat If there's an offset, there must be a when (and not C, CM, CD, CV) offset.empty() or (when.exists() and when.select($this in ('C' | 'CM' | 'CD' | 'CV')).allFalse())
tim-10 error MedicationStatement.dosage.timing.repeat If there's a timeOfDay, there cannot be a when, or vice versa timeOfDay.empty() or when.empty()

This structure is derived from MedicationStatement

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Must-Support: 13 elements
Prohibited: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationStatement.effective[x]
  • The element 1 is sliced based on the value of MedicationStatement.dosage.doseAndRate.dose[x]

 

Other representations of profile: CSV, Excel, Schematron