MyHealth@Eu Patient Summary
1.0.0-poc - qa-preview 150

MyHealth@Eu Patient Summary - Downloaded Version 1.0.0-poc See the Directory of published versions

Resource Profile: MedicationStatement: MyHealth@EU EPS

Official URL: http://fhir.ehdsi.eu/eps/StructureDefinition/medicationStatement-myhealtheu-eps Version: 1.0.0-poc
Standards status: Draft Maturity Level: 1 Computable Name: MedicationStatementMyHealthEuEps

Copyright/Legal: Copyright European Union, represented by the European Commission - DG SANTE. Licenced under CC-BY-4.0.

This profile constrains the MedicationStatement resource for the purpose of the MyHealth@EU EPS.

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..* MedicationStatementMyHealthCore Record of medication being taken by a patient
This profile also imposes the profile MedicationStatement (EPS)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:adherence 0..1 (Complex) R5: Indicates whether the medication is or is not being consumed or administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationStatement.adherence
Constraints: ext-1
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... Slices for extension Content/Rules for all slices
...... extension:code 1..1 Extension Type of adherence.
Constraints: ext-1
....... url 1..1 uri "code"
....... value[x] 1..1 CodeableConcept Type of adherence
Binding: R5MedicationStatementAdherenceForR4 (0.1.0) (example)
...... extension:reason 0..1 Extension R5: Details of the reason for the current use of the medication (new)
Constraints: ext-1
....... url 1..1 uri "reason"
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationStatement.adherence"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... medication[x] OΣ 1..1 What medication was taken
Binding: Medications - IPS (example)
ObligationsActorSource
SHALL:handle MyHealth@EU Handler from MedicationStatement (Core)
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication: MyHealth@EU EPS)
... subject Σ 1..1 Reference(Patient: MyHealth@EU EPS) Who is/was taking the medication
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for effective[x] OΣ 1..1 The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Closed by type:$this
ObligationsActor
SHOULD:handle MyHealth@EU Handler
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectivePeriod Σ 0..1 Period Period when the medication is/was or should be used.
... informationSource 0..1 Reference(Patient: MyHealth@EU EPS | Practitioner: MyHealth@EU EPS | PractitionerRole: MyHealth@EU EPS | Organization: MyHealth@EU EPS | RelatedPerson) Person or organization that provided the information about the taking of this medication
... dosage O 0..* Dosage Details of how medication is/was taken or should be taken.
ObligationsActor
SHOULD:handle MyHealth@EU Handler
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseAndRate OΣ 0..* Element Amount of medication administered
ObligationsActor
SHOULD:handle MyHealth@EU Handler
..... Slices for dose[x] Σ 0..1 Amount of medication per dose
Slice: Unordered, Open by type:$this
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
...... dose[x]:doseQuantity Σ 0..1 SimpleQuantityMyHealth Amount of medication per dose
..... Slices for rate[x] Σ 0..1 Amount of medication per unit of time
Slice: Unordered, Open by type:$this
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
...... rate[x]:rateRatio Σ 0..1 RatioMyHealth Amount of medication per unit of time
...... rate[x]:rateQuantity Σ 0..1 SimpleQuantityMyHealth Amount of medication per unit of time

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationStatement.​extension:adherence.​extension:code.value[x] Base example Cross-version ValueSet R5.MedicationStatementAdherenceCodes for use in FHIR R4 📍0.1.0 Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1
MedicationStatement.​status Base required Medication status codes 📍4.0.1 FHIR Std.
MedicationStatement.​medication[x] Base example Medications - IPS 📦2.0.0 International Patient Summary Implementation Guide v2.0

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 MedicationStatement.extension:adherence, MedicationStatement.extension:adherence.extension, MedicationStatement.extension:adherence.extension:code, MedicationStatement.extension:adherence.extension:reason, MedicationStatement.modifierExtension, MedicationStatement.dosage.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from MedicationStatementMyHealthCore

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationStatement MedicationStatementMyHealthCore This profile also imposes the profile MedicationStatement (EPS)
... medication[x] 1..1 What medication was taken
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication: MyHealth@EU EPS)
... subject 1..1 Reference(Patient: MyHealth@EU EPS) Who is/was taking the medication
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... effective[x] O 1..1 dateTime, Period The date/time or interval when the medication is/was/will be taken
ObligationsActor
SHOULD:handle MyHealth@EU Handler
... dosage O 0..* Dosage Details of how medication is/was taken or should be taken.
ObligationsActor
SHOULD:handle MyHealth@EU Handler
.... timing
..... repeat O 0..1 Element When the event is to occur
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... bounds[x] O 0..1 Duration, Range, Period Length/Range of lengths, or (Start and/or end) limits
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... duration O 0..1 decimal How long when it happens
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... frequency O 0..1 positiveInt Event occurs frequency times per period
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... period O 0..1 decimal Event occurs frequency times per period
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... periodUnit O 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
ObligationsActor
SHOULD:handle MyHealth@EU Handler
.... doseAndRate O 0..* Element Amount of medication administered
ObligationsActor
SHOULD:handle MyHealth@EU Handler

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationStatement 0..* MedicationStatementMyHealthCore Record of medication being taken by a patient
This profile also imposes the profile MedicationStatement (EPS)
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:adherence 0..1 (Complex) R5: Indicates whether the medication is or is not being consumed or administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationStatement.adherence
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... Slices for extension Content/Rules for all slices
...... extension:code 1..1 Extension Type of adherence.
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "code"
....... value[x] 1..1 CodeableConcept Type of adherence
Binding: R5MedicationStatementAdherenceForR4 (0.1.0) (example)
...... extension:reason 0..1 Extension R5: Details of the reason for the current use of the medication (new)
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "reason"
....... value[x] 0..1 CodeableConcept Details of the reason for the current use of the medication
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationStatement.adherence"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Medication Statement 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 ?!OΣ 1..1 code State of the medication
Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.
ObligationsActorSource
SHALL:handle MyHealth@EU Handler from MedicationStatement (Core)
... statusReason 0..* CodeableConcept Reason for the 'exception' statuses of the medication
Binding: eHDSI Medication Status Reason With Exceptions (required)
... category Σ 0..1 CodeableConcept Type of intended use
Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.
Additional BindingsPurpose
Medication Intended Use Preferred
... medication[x] OΣ 1..1 What medication was taken
Binding: Medications - IPS (example)
ObligationsActorSource
SHALL:handle MyHealth@EU Handler from MedicationStatement (Core)
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication: MyHealth@EU EPS)
... subject Σ 1..1 Reference(Patient: MyHealth@EU EPS) Who is/was taking the medication
.... 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 ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... 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] OΣ 1..1 The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Closed by type:$this
ObligationsActor
SHOULD:handle MyHealth@EU Handler
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectivePeriod Σ 0..1 Period Period when the medication is/was or should be used.
... dateAsserted Σ 0..1 dateTime When the statement was asserted?
... informationSource 0..1 Reference(Patient: MyHealth@EU EPS | Practitioner: MyHealth@EU EPS | PractitionerRole: MyHealth@EU EPS | Organization: MyHealth@EU EPS | RelatedPerson) Person or organization that provided the information about the taking of this medication
... derivedFrom 0..* Reference(Resource) The reference to the source of the statement
... reasonCode 0..* CodeableConcept Coded reason for use
Binding: eHDSI Medication Reason With Exceptions (required)
... 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown Textual note about the statement
... dosage O 0..* Dosage Details of how medication is/was taken or should be taken.
ObligationsActor
SHOULD:handle MyHealth@EU Handler
.... 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 Σ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
.... patientInstruction Σ 0..1 string Patient or consumer oriented instructions
.... timing Σ 0..1 Timing When medication should be administered
..... 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
..... event Σ 0..* dateTime When the event occurs
..... repeat OΣ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
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... 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] OΣ 0..1 Length/Range of lengths, or (Start and/or end) limits
ObligationsActor
SHOULD:handle MyHealth@EU Handler
....... boundsDuration Duration
....... boundsRange Range
....... boundsPeriod Period
...... count Σ 0..1 positiveInt Number of times to repeat
...... countMax Σ 0..1 positiveInt Maximum number of times to repeat
...... duration OΣ 0..1 decimal How long when it happens
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... durationMax Σ 0..1 decimal How long when it happens (Max)
...... durationUnit Σ 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 OΣ 0..1 positiveInt Event occurs frequency times per period
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
...... period OΣ 0..1 decimal Event occurs frequency times per period
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... periodMax Σ 0..1 decimal Upper limit of period (3-4 hours)
...... periodUnit OΣ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay Σ 0..* time Time of day for action
...... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.
...... offset Σ 0..1 unsignedInt Minutes from event (before or after)
..... code Σ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
.... 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: eHDSI Body Site With Exceptions (required)
.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: eHDSI Route of Administration (extensible)
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... doseAndRate OΣ 0..* Element Amount of medication administered
ObligationsActor
SHOULD:handle MyHealth@EU Handler
..... 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] Σ 0..1 Amount of medication per dose
Slice: Unordered, Open by type:$this
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
...... dose[x]:doseQuantity Σ 0..1 SimpleQuantityMyHealth Amount of medication per dose
..... Slices for rate[x] Σ 0..1 Amount of medication per unit of time
Slice: Unordered, Open by type:$this
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
...... rate[x]:rateRatio Σ 0..1 RatioMyHealth Amount of medication per unit of time
...... rate[x]:rateQuantity Σ 0..1 SimpleQuantityMyHealth Amount of medication per unit of time
.... maxDosePerPeriod Σ 0..1 RatioMyHealth Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantityMyHealth Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantityMyHealth 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 eHDSI Language 📦9.1.0 MyHealthEu MVC package v9.1
MedicationStatement.​extension:adherence.​extension:code.value[x] Base example Cross-version ValueSet R5.MedicationStatementAdherenceCodes for use in FHIR R4 📍0.1.0 Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1
MedicationStatement.​status Base required Medication status codes 📍4.0.1 FHIR Std.
MedicationStatement.​statusReason Base required eHDSI Medication Status Reason With Exceptions 📦1.0.0 MyHealth@EU Core v1.0
MedicationStatement.​category Base preferred Medication usage category codes 📦4.0.1 FHIR Std.
MedicationStatement.​medication[x] Base example Medications - IPS 📦2.0.0 International Patient Summary Implementation Guide v2.0
MedicationStatement.​subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
MedicationStatement.​reasonCode Base required eHDSI Medication Reason With Exceptions 📦1.0.0 MyHealth@EU Core v1.0
MedicationStatement.​dosage.additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​durationUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​periodUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​dayOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​when Base required EventTiming 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.code Base preferred TimingAbbreviation 📍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 required eHDSI Body Site With Exceptions 📦1.0.0 MyHealth@EU Core v1.0
MedicationStatement.​dosage.route Base extensible eHDSI Route of Administration 📦9.1.0 MyHealthEu MVC package v9.1
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()
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 in ('C' | 'CM' | 'CD' | 'CV')).not()))
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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationStatement 0..* MedicationStatementMyHealthCore Record of medication being taken by a patient
This profile also imposes the profile MedicationStatement (EPS)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:adherence 0..1 (Complex) R5: Indicates whether the medication is or is not being consumed or administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationStatement.adherence
Constraints: ext-1
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... Slices for extension Content/Rules for all slices
...... extension:code 1..1 Extension Type of adherence.
Constraints: ext-1
....... url 1..1 uri "code"
....... value[x] 1..1 CodeableConcept Type of adherence
Binding: R5MedicationStatementAdherenceForR4 (0.1.0) (example)
...... extension:reason 0..1 Extension R5: Details of the reason for the current use of the medication (new)
Constraints: ext-1
....... url 1..1 uri "reason"
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationStatement.adherence"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... medication[x] OΣ 1..1 What medication was taken
Binding: Medications - IPS (example)
ObligationsActorSource
SHALL:handle MyHealth@EU Handler from MedicationStatement (Core)
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication: MyHealth@EU EPS)
... subject Σ 1..1 Reference(Patient: MyHealth@EU EPS) Who is/was taking the medication
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for effective[x] OΣ 1..1 The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Closed by type:$this
ObligationsActor
SHOULD:handle MyHealth@EU Handler
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectivePeriod Σ 0..1 Period Period when the medication is/was or should be used.
... informationSource 0..1 Reference(Patient: MyHealth@EU EPS | Practitioner: MyHealth@EU EPS | PractitionerRole: MyHealth@EU EPS | Organization: MyHealth@EU EPS | RelatedPerson) Person or organization that provided the information about the taking of this medication
... dosage O 0..* Dosage Details of how medication is/was taken or should be taken.
ObligationsActor
SHOULD:handle MyHealth@EU Handler
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseAndRate OΣ 0..* Element Amount of medication administered
ObligationsActor
SHOULD:handle MyHealth@EU Handler
..... Slices for dose[x] Σ 0..1 Amount of medication per dose
Slice: Unordered, Open by type:$this
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
...... dose[x]:doseQuantity Σ 0..1 SimpleQuantityMyHealth Amount of medication per dose
..... Slices for rate[x] Σ 0..1 Amount of medication per unit of time
Slice: Unordered, Open by type:$this
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
...... rate[x]:rateRatio Σ 0..1 RatioMyHealth Amount of medication per unit of time
...... rate[x]:rateQuantity Σ 0..1 SimpleQuantityMyHealth Amount of medication per unit of time

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationStatement.​extension:adherence.​extension:code.value[x] Base example Cross-version ValueSet R5.MedicationStatementAdherenceCodes for use in FHIR R4 📍0.1.0 Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1
MedicationStatement.​status Base required Medication status codes 📍4.0.1 FHIR Std.
MedicationStatement.​medication[x] Base example Medications - IPS 📦2.0.0 International Patient Summary Implementation Guide v2.0

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 MedicationStatement.extension:adherence, MedicationStatement.extension:adherence.extension, MedicationStatement.extension:adherence.extension:code, MedicationStatement.extension:adherence.extension:reason, MedicationStatement.modifierExtension, MedicationStatement.dosage.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from MedicationStatementMyHealthCore

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationStatement MedicationStatementMyHealthCore This profile also imposes the profile MedicationStatement (EPS)
... medication[x] 1..1 What medication was taken
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication: MyHealth@EU EPS)
... subject 1..1 Reference(Patient: MyHealth@EU EPS) Who is/was taking the medication
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... effective[x] O 1..1 dateTime, Period The date/time or interval when the medication is/was/will be taken
ObligationsActor
SHOULD:handle MyHealth@EU Handler
... dosage O 0..* Dosage Details of how medication is/was taken or should be taken.
ObligationsActor
SHOULD:handle MyHealth@EU Handler
.... timing
..... repeat O 0..1 Element When the event is to occur
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... bounds[x] O 0..1 Duration, Range, Period Length/Range of lengths, or (Start and/or end) limits
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... duration O 0..1 decimal How long when it happens
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... frequency O 0..1 positiveInt Event occurs frequency times per period
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... period O 0..1 decimal Event occurs frequency times per period
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... periodUnit O 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
ObligationsActor
SHOULD:handle MyHealth@EU Handler
.... doseAndRate O 0..* Element Amount of medication administered
ObligationsActor
SHOULD:handle MyHealth@EU Handler

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationStatement 0..* MedicationStatementMyHealthCore Record of medication being taken by a patient
This profile also imposes the profile MedicationStatement (EPS)
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:adherence 0..1 (Complex) R5: Indicates whether the medication is or is not being consumed or administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationStatement.adherence
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... Slices for extension Content/Rules for all slices
...... extension:code 1..1 Extension Type of adherence.
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "code"
....... value[x] 1..1 CodeableConcept Type of adherence
Binding: R5MedicationStatementAdherenceForR4 (0.1.0) (example)
...... extension:reason 0..1 Extension R5: Details of the reason for the current use of the medication (new)
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "reason"
....... value[x] 0..1 CodeableConcept Details of the reason for the current use of the medication
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-MedicationStatement.adherence"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Medication Statement 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 ?!OΣ 1..1 code State of the medication
Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement.
ObligationsActorSource
SHALL:handle MyHealth@EU Handler from MedicationStatement (Core)
... statusReason 0..* CodeableConcept Reason for the 'exception' statuses of the medication
Binding: eHDSI Medication Status Reason With Exceptions (required)
... category Σ 0..1 CodeableConcept Type of intended use
Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.
Additional BindingsPurpose
Medication Intended Use Preferred
... medication[x] OΣ 1..1 What medication was taken
Binding: Medications - IPS (example)
ObligationsActorSource
SHALL:handle MyHealth@EU Handler from MedicationStatement (Core)
.... medicationCodeableConcept CodeableConcept
.... medicationReference Reference(Medication: MyHealth@EU EPS)
... subject Σ 1..1 Reference(Patient: MyHealth@EU EPS) Who is/was taking the medication
.... 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 ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... 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] OΣ 1..1 The date/time or interval when the medication is/was/will be taken
Slice: Unordered, Closed by type:$this
ObligationsActor
SHOULD:handle MyHealth@EU Handler
.... effectiveDateTime dateTime
.... effectivePeriod Period
.... effective[x]:effectivePeriod Σ 0..1 Period Period when the medication is/was or should be used.
... dateAsserted Σ 0..1 dateTime When the statement was asserted?
... informationSource 0..1 Reference(Patient: MyHealth@EU EPS | Practitioner: MyHealth@EU EPS | PractitionerRole: MyHealth@EU EPS | Organization: MyHealth@EU EPS | RelatedPerson) Person or organization that provided the information about the taking of this medication
... derivedFrom 0..* Reference(Resource) The reference to the source of the statement
... reasonCode 0..* CodeableConcept Coded reason for use
Binding: eHDSI Medication Reason With Exceptions (required)
... 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown Textual note about the statement
... dosage O 0..* Dosage Details of how medication is/was taken or should be taken.
ObligationsActor
SHOULD:handle MyHealth@EU Handler
.... 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 Σ 0..1 string Free text dosage instructions e.g. SIG
.... additionalInstruction Σ 0..* CodeableConcept Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example): A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
.... patientInstruction Σ 0..1 string Patient or consumer oriented instructions
.... timing Σ 0..1 Timing When medication should be administered
..... 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
..... event Σ 0..* dateTime When the event occurs
..... repeat OΣ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
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... 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] OΣ 0..1 Length/Range of lengths, or (Start and/or end) limits
ObligationsActor
SHOULD:handle MyHealth@EU Handler
....... boundsDuration Duration
....... boundsRange Range
....... boundsPeriod Period
...... count Σ 0..1 positiveInt Number of times to repeat
...... countMax Σ 0..1 positiveInt Maximum number of times to repeat
...... duration OΣ 0..1 decimal How long when it happens
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... durationMax Σ 0..1 decimal How long when it happens (Max)
...... durationUnit Σ 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 OΣ 0..1 positiveInt Event occurs frequency times per period
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
...... period OΣ 0..1 decimal Event occurs frequency times per period
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... periodMax Σ 0..1 decimal Upper limit of period (3-4 hours)
...... periodUnit OΣ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
ObligationsActor
SHOULD:handle MyHealth@EU Handler
...... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay Σ 0..* time Time of day for action
...... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.
...... offset Σ 0..1 unsignedInt Minutes from event (before or after)
..... code Σ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
.... 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: eHDSI Body Site With Exceptions (required)
.... route Σ 0..1 CodeableConcept How drug should enter body
Binding: eHDSI Route of Administration (extensible)
.... method Σ 0..1 CodeableConcept Technique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered.
.... doseAndRate OΣ 0..* Element Amount of medication administered
ObligationsActor
SHOULD:handle MyHealth@EU Handler
..... 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] Σ 0..1 Amount of medication per dose
Slice: Unordered, Open by type:$this
...... doseRange Range
...... doseQuantity Quantity(SimpleQuantity)
...... dose[x]:doseQuantity Σ 0..1 SimpleQuantityMyHealth Amount of medication per dose
..... Slices for rate[x] Σ 0..1 Amount of medication per unit of time
Slice: Unordered, Open by type:$this
...... rateRatio Ratio
...... rateRange Range
...... rateQuantity Quantity(SimpleQuantity)
...... rate[x]:rateRatio Σ 0..1 RatioMyHealth Amount of medication per unit of time
...... rate[x]:rateQuantity Σ 0..1 SimpleQuantityMyHealth Amount of medication per unit of time
.... maxDosePerPeriod Σ 0..1 RatioMyHealth Upper limit on medication per unit of time
.... maxDosePerAdministration Σ 0..1 SimpleQuantityMyHealth Upper limit on medication per administration
.... maxDosePerLifetime Σ 0..1 SimpleQuantityMyHealth 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 eHDSI Language 📦9.1.0 MyHealthEu MVC package v9.1
MedicationStatement.​extension:adherence.​extension:code.value[x] Base example Cross-version ValueSet R5.MedicationStatementAdherenceCodes for use in FHIR R4 📍0.1.0 Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1
MedicationStatement.​status Base required Medication status codes 📍4.0.1 FHIR Std.
MedicationStatement.​statusReason Base required eHDSI Medication Status Reason With Exceptions 📦1.0.0 MyHealth@EU Core v1.0
MedicationStatement.​category Base preferred Medication usage category codes 📦4.0.1 FHIR Std.
MedicationStatement.​medication[x] Base example Medications - IPS 📦2.0.0 International Patient Summary Implementation Guide v2.0
MedicationStatement.​subject.type Base extensible ResourceType 📍4.0.1 FHIR Std.
MedicationStatement.​reasonCode Base required eHDSI Medication Reason With Exceptions 📦1.0.0 MyHealth@EU Core v1.0
MedicationStatement.​dosage.additionalInstruction Base example SNOMED CT Additional Dosage Instructions 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​durationUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​periodUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​dayOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.repeat.​when Base required EventTiming 📍4.0.1 FHIR Std.
MedicationStatement.​dosage.timing.code Base preferred TimingAbbreviation 📍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 required eHDSI Body Site With Exceptions 📦1.0.0 MyHealth@EU Core v1.0
MedicationStatement.​dosage.route Base extensible eHDSI Route of Administration 📦9.1.0 MyHealthEu MVC package v9.1
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()
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 in ('C' | 'CM' | 'CD' | 'CV')).not()))
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()

 

Other representations of profile: CSV, Excel, Schematron