German Oncological Data Standard (GOLD)
0.1.0 - CI Build
German Oncological Data Standard (GOLD) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://www.vision-zero-oncology.de/fhir/StructureDefinition/medication-statement | Version: 0.1.0 | |||
Draft as of 2023-12-13 | Computable Name: PR_MedicationStatement | |||
Copyright/Legal: CC-BY-SA-4.0 |
Profile to capture a record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationStatement
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
id | S | 0..1 | id | Logical id of this artifact |
meta | S | 0..1 | Meta | Metadata about the resource |
source | S | 0..1 | uri | Identifies where the resource comes from |
profile | S | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
identifier | S | 0..* | Identifier | External identifier |
basedOn | S | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order |
partOf | S | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event |
status | S | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken |
category | S | 0..1 | CodeableConcept | Type of medication usage |
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |
coding:usageCategory | 0..* | Coding | Code defined by a terminology system Binding: Medication usage category codes (required) Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medication-statement-category | |
Slices for medication[x] | S | 1..1 | CodeableConcept, Reference(Medication) | What medication was taken Slice: Unordered, Open by type:$this |
medication[x]:medicationReference | S | 0..1 | Reference(Medication) | What medication was taken |
medication[x]:medicationCodeableConcept | S | 0..1 | CodeableConcept | What medication was taken |
Slices for coding | S | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
coding:Pharmazentralnummer | S | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/ifa/pzn | |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
coding:atcClassDe | S | 0..* | Coding | ATC Klassifikation deutsche Version Binding: ATC (required) Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/bfarm/atc | |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
coding:atcClassEn | S | 0..* | Coding | Anatomical Therapeutic Chemical Classification System Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.whocc.no/atc | |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
text | S | 0..1 | string | Plain text representation of the concept |
subject | S | 1..1 | Reference(Patient | Group) | Who is/was taking the medication |
context | S | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement |
Slices for effective[x] | S | 1..1 | dateTime, Period | The date/time or interval when the medication is/was/will be taken Slice: Unordered, Open by type:$this |
effective[x]:effectiveDateTime | S | 0..1 | dateTime | The date/time or interval when the medication is/was/will be taken |
effective[x]:effectivePeriod | S | 0..1 | Period | The date/time or interval when the medication is/was/will be taken |
dateAsserted | S | 0..1 | dateTime | When the statement was asserted? |
informationSource | S | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Person or organization that provided the information about the taking of this medication |
derivedFrom | S | 0..* | Reference(Profile Tumor) | Additional supporting information |
reasonCode | S | 0..* | CodeableConcept | Reason for why the medication is being/was taken |
reasonReference | S | 0..* | Reference(Profile Tumor Disorder) | Condition or observation that supports why the medication is being/was taken |
note | S | 0..* | Annotation | Further information about the statement |
dosage | SC | 0..* | Dosage | Details of how medication is/was taken or should be taken dsg-1: If present, dosage must include free text or structured data |
sequence | S | 0..1 | integer | The order of the dosage instructions |
text | S | 0..1 | string | Free text dosage instructions e.g. SIG |
timing | S | 0..1 | Timing | When medication should be administered |
event | S | 0..* | dateTime | When the event occurs |
repeat | S | 0..1 | Element | When the event is to occur |
Slices for bounds[x] | 0..1 | Duration, Range, Period | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
bounds[x]:boundsDuration | S | 0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
bounds[x]:boundsRange | S | 0..1 | Range | Length/Range of lengths, or (Start and/or end) limits |
low | S | 0..1 | SimpleQuantity | Low limit Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
high | S | 0..1 | SimpleQuantity | High limit Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
bounds[x]:boundsPeriod | S | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits |
start | S | 0..1 | dateTime | Starting time with inclusive boundary |
end | S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
count | S | 0..1 | positiveInt | Number of times to repeat |
countMax | S | 0..1 | positiveInt | Maximum number of times to repeat |
duration | S | 0..1 | decimal | How long when it happens |
durationMax | S | 0..1 | decimal | How long when it happens (Max) |
durationUnit | S | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) |
frequency | S | 0..1 | positiveInt | Event occurs frequency times per period |
frequencyMax | S | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
period | S | 0..1 | decimal | Event occurs frequency times per period |
periodMax | S | 0..1 | decimal | Upper limit of period (3-4 hours) |
periodUnit | S | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) |
dayOfWeek | S | 0..* | code | mon | tue | wed | thu | fri | sat | sun |
timeOfDay | S | 0..* | time | Time of day for action |
when | S | 0..* | code | Code for time period of occurrence |
offset | S | 0..1 | unsignedInt | Minutes from event (before or after) |
Slices for asNeeded[x] | S | 0..1 | boolean, CodeableConcept | Take "as needed" (for x) Slice: Unordered, Open by type:$this |
asNeeded[x]:asNeededBoolean | S | 0..1 | boolean | Take "as needed" (for x) |
asNeeded[x]:asNeededCodeableConcept | S | 0..1 | CodeableConcept | Take "as needed" (for x) |
site | S | 0..1 | CodeableConcept | Body site to administer to |
Slices for coding | S | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
coding:SNOMED | S | 0..* | Coding | Code defined by a terminology system Binding: Target Site - IPS (example): target site IPS Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
route | S | 0..1 | CodeableConcept | How drug should enter body |
Slices for coding | S | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
coding:EDQM | S | 0..1 | Coding | Code defined by a terminology system Binding: Medicine Route of Administration - IPS (preferred): EDQM Standard Terms Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://standardterms.edqm.eu | |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
coding:SNOMED | S | 0..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
doseAndRate | S | 0..* | Element | Amount of medication administered |
Slices for dose[x] | S | 0..1 | Range, SimpleQuantity | Amount of medication per dose Slice: Unordered, Open by type:$this |
dose[x]:doseRange | S | 0..1 | Range | Amount of medication per dose |
low | S | 0..1 | SimpleQuantity | Low limit Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
high | 0..1 | SimpleQuantity | High limit Required Pattern: At least the following | |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
dose[x]:doseQuantity | S | 0..1 | SimpleQuantity | A fixed quantity (no comparator) Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
Slices for rate[x] | S | 0..1 | Ratio, Range, SimpleQuantity | Amount of medication per unit of time Slice: Unordered, Open by type:$this |
rate[x]:rateRatio | S | 0..1 | Ratio | Amount of medication per unit of time |
numerator | S | 0..1 | Quantity | Numerator value Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
denominator | S | 0..1 | Quantity | Denominator value Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
rate[x]:rateRange | S | 0..1 | Range | Amount of medication per unit of time |
low | S | 0..1 | SimpleQuantity | Low limit Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
high | S | 0..1 | SimpleQuantity | High limit Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
rate[x]:rateQuantity | S | 0..1 | SimpleQuantity | A fixed quantity (no comparator) Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
maxDosePerPeriod | S | 0..1 | Ratio | Upper limit on medication per unit of time |
numerator | S | 0..1 | Quantity | Numerator value Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
denominator | S | 0..1 | Quantity | Denominator value Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
maxDosePerAdministration | S | 0..1 | SimpleQuantity | Upper limit on medication per administration Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form |
code | S | 1..1 | code | Coded form of the unit |
Documentation for this format |
Path | Conformance | ValueSet / Code |
MedicationStatement.category.coding:usageCategory | required | Pattern: null |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe | required | Pattern: null |
MedicationStatement.dosage.site.coding:SNOMED | example | Pattern: SNOMED CT code null |
MedicationStatement.dosage.route.coding:EDQM | preferred | Pattern: null |
Id | Grade | Path(s) | Details | Requirements |
dsg-1 | error | MedicationStatement.dosage | If present, dosage must include free text or structured data : text.exists() or doseAndRate.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
id | SΣ | 0..1 | id | Logical id of this artifact |
meta | SΣ | 0..1 | Meta | Metadata about the resource |
source | SΣ | 0..1 | uri | Identifies where the resource comes from |
profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | External identifier |
basedOn | SΣ | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order |
partOf | SΣ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event |
status | ?!SΣ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. |
category | SΣ | 0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. |
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
coding:usageCategory | Σ | 0..* | Coding | Code defined by a terminology system Binding: Medication usage category codes (required) Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medication-statement-category | |
Slices for medication[x] | SΣ | 1..1 | What medication was taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | |
medicationCodeableConcept | CodeableConcept | |||
medicationReference | Reference(Medication) | |||
medication[x]:medicationReference | SΣ | 0..1 | Reference(Medication) | What medication was taken |
medication[x]:medicationCodeableConcept | SΣ | 0..1 | CodeableConcept | What medication was taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. |
Slices for coding | SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
coding:Pharmazentralnummer | SΣ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/ifa/pzn | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
coding:atcClassDe | SΣ | 0..* | Coding | ATC Klassifikation deutsche Version Binding: ATC (required) Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/bfarm/atc | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
coding:atcClassEn | SΣ | 0..* | Coding | Anatomical Therapeutic Chemical Classification System Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.whocc.no/atc | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
text | SΣ | 0..1 | string | Plain text representation of the concept |
subject | SΣ | 1..1 | Reference(Patient | Group) | Who is/was taking the medication |
context | SΣ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement |
Slices for effective[x] | SΣ | 1..1 | The date/time or interval when the medication is/was/will be taken Slice: Unordered, Closed by type:$this | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effective[x]:effectiveDateTime | SΣ | 0..1 | dateTime | The date/time or interval when the medication is/was/will be taken |
effective[x]:effectivePeriod | SΣ | 0..1 | Period | The date/time or interval when the medication is/was/will be taken |
dateAsserted | SΣ | 0..1 | dateTime | When the statement was asserted? |
informationSource | S | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Person or organization that provided the information about the taking of this medication |
derivedFrom | S | 0..* | Reference(Profile Tumor) | Additional supporting information |
reasonCode | S | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. |
reasonReference | S | 0..* | Reference(Profile Tumor Disorder) | Condition or observation that supports why the medication is being/was taken |
note | S | 0..* | Annotation | Further information about the statement |
dosage | SC | 0..* | Dosage | Details of how medication is/was taken or should be taken dsg-1: If present, dosage must include free text or structured data |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
sequence | SΣ | 0..1 | integer | The order of the dosage instructions |
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 |
event | SΣ | 0..* | dateTime | When the event occurs |
repeat | SΣC | 0..1 | Element | When the event is to occur |
Slices for bounds[x] | Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Closed by type:$this | |
boundsDuration | Duration | |||
boundsRange | Range | |||
boundsPeriod | Period | |||
bounds[x]:boundsDuration | SΣ | 0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
bounds[x]:boundsRange | SΣ | 0..1 | Range | Length/Range of lengths, or (Start and/or end) limits |
low | SΣ | 0..1 | SimpleQuantity | Low limit Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
high | SΣ | 0..1 | SimpleQuantity | High limit Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
bounds[x]:boundsPeriod | SΣ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits |
start | SΣC | 0..1 | dateTime | Starting time with inclusive boundary |
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
count | SΣ | 0..1 | positiveInt | Number of times to repeat |
countMax | SΣ | 0..1 | positiveInt | Maximum number of times to repeat |
duration | SΣ | 0..1 | decimal | How long when it happens |
durationMax | SΣ | 0..1 | decimal | How long when it happens (Max) |
durationUnit | SΣ | 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 | SΣ | 0..1 | positiveInt | Event occurs frequency times per period |
frequencyMax | SΣ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period |
period | SΣ | 0..1 | decimal | Event occurs frequency times per period |
periodMax | SΣ | 0..1 | decimal | Upper limit of period (3-4 hours) |
periodUnit | SΣ | 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 | SΣ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) |
timeOfDay | SΣ | 0..* | time | Time of day for action |
when | SΣ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
offset | SΣ | 0..1 | unsignedInt | Minutes from event (before or after) |
Slices for asNeeded[x] | SΣ | 0..1 | Take "as needed" (for x) Slice: Unordered, Closed by type:$this 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 | |||
asNeeded[x]:asNeededBoolean | SΣ | 0..1 | boolean | Take "as needed" (for x) |
asNeeded[x]:asNeededCodeableConcept | SΣ | 0..1 | 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 | SΣ | 0..1 | CodeableConcept | Body site to administer to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. |
Slices for coding | SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
coding:SNOMED | SΣ | 0..* | Coding | Code defined by a terminology system Binding: Target Site - IPS (example): target site IPS Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
route | SΣ | 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. |
Slices for coding | SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
coding:EDQM | SΣ | 0..1 | Coding | Code defined by a terminology system Binding: Medicine Route of Administration - IPS (preferred): EDQM Standard Terms Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://standardterms.edqm.eu | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
coding:SNOMED | SΣ | 0..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
doseAndRate | SΣ | 0..* | Element | Amount of medication administered |
Slices for dose[x] | SΣ | 0..1 | Amount of medication per dose Slice: Unordered, Closed by type:$this | |
doseRange | Range | |||
doseQuantity | Quantity(SimpleQuantity) | |||
dose[x]:doseRange | SΣ | 0..1 | Range | Amount of medication per dose |
low | SΣ | 0..1 | SimpleQuantity | Low limit Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
high | Σ | 0..1 | SimpleQuantity | High limit Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
dose[x]:doseQuantity | SC | 0..1 | SimpleQuantity | A fixed quantity (no comparator) Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
Slices for rate[x] | SΣ | 0..1 | Amount of medication per unit of time Slice: Unordered, Closed by type:$this | |
rateRatio | Ratio | |||
rateRange | Range | |||
rateQuantity | Quantity(SimpleQuantity) | |||
rate[x]:rateRatio | SΣ | 0..1 | Ratio | Amount of medication per unit of time |
numerator | SΣ | 0..1 | Quantity | Numerator value Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
denominator | SΣ | 0..1 | Quantity | Denominator value Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
rate[x]:rateRange | SΣ | 0..1 | Range | Amount of medication per unit of time |
low | SΣ | 0..1 | SimpleQuantity | Low limit Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
high | SΣ | 0..1 | SimpleQuantity | High limit Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
rate[x]:rateQuantity | SC | 0..1 | SimpleQuantity | A fixed quantity (no comparator) Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
maxDosePerPeriod | SΣ | 0..1 | Ratio | Upper limit on medication per unit of time |
numerator | SΣ | 0..1 | Quantity | Numerator value Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
denominator | SΣ | 0..1 | Quantity | Denominator value Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
maxDosePerAdministration | SΣ | 0..1 | SimpleQuantity | Upper limit on medication per administration Required Pattern: At least the following |
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
unit | SΣ | 0..1 | string | Unit representation |
system | SΣC | 1..1 | uri | System that defines coded unit form |
code | SΣ | 1..1 | code | Coded form of the unit |
Documentation for this format |
Path | Conformance | ValueSet / Code |
MedicationStatement.status | required | Medication Status Codes |
MedicationStatement.category | preferred | Medication usage category codes |
MedicationStatement.category.coding:usageCategory | required | Pattern: null |
MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodes |
MedicationStatement.medication[x]:medicationCodeableConcept | example | SNOMEDCTMedicationCodes |
MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe | required | Pattern: null |
MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodes |
MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.comparator | required | QuantityComparator |
MedicationStatement.dosage.timing.repeat.durationUnit | required | UnitsOfTime |
MedicationStatement.dosage.timing.repeat.periodUnit | required | UnitsOfTime |
MedicationStatement.dosage.timing.repeat.dayOfWeek | required | DaysOfWeek |
MedicationStatement.dosage.timing.repeat.when | required | EventTiming |
MedicationStatement.dosage.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes |
MedicationStatement.dosage.asNeeded[x]:asNeededCodeableConcept | example | SNOMEDCTMedicationAsNeededReasonCodes |
MedicationStatement.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodes |
MedicationStatement.dosage.site.coding:SNOMED | example | Pattern: SNOMED CT code null |
MedicationStatement.dosage.route | example | SNOMEDCTRouteCodes |
MedicationStatement.dosage.route.coding:EDQM | preferred | Pattern: null |
MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.comparator | required | QuantityComparator |
MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.comparator | required | QuantityComparator |
MedicationStatement.dosage.maxDosePerPeriod.numerator.comparator | required | QuantityComparator |
MedicationStatement.dosage.maxDosePerPeriod.denominator.comparator | required | QuantityComparator |
Id | Grade | Path(s) | Details | Requirements |
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() | |
dsg-1 | error | MedicationStatement.dosage | If present, dosage must include free text or structured data : text.exists() or doseAndRate.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() | |
qty-3 | error | MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity, MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | error | MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity, MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() | |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | SΣ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | SΣ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | External identifier | ||||
basedOn | SΣ | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order | ||||
partOf | SΣ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. | ||||
statusReason | 0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | |||||
category | SΣ | 0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||
coding:usageCategory | Σ | 0..* | Coding | Code defined by a terminology system Binding: Medication usage category codes (required) Required Pattern: At least the following | ||||
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/medication-statement-category | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 0..1 | code | Symbol in syntax defined by the system | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
Slices for medication[x] | SΣ | 1..1 | What medication was taken Slice: Unordered, Closed by type:$this Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | |||||
medicationCodeableConcept | CodeableConcept | |||||||
medicationReference | Reference(Medication) | |||||||
medication[x]:medicationReference | SΣ | 0..1 | Reference(Medication) | What medication was taken | ||||
medication[x]:medicationCodeableConcept | SΣ | 0..1 | CodeableConcept | What medication was taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||
coding:Pharmazentralnummer | SΣ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
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://fhir.de/CodeSystem/ifa/pzn | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 0..1 | code | Symbol in syntax defined by the system | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:atcClassDe | SΣ | 0..* | Coding | ATC Klassifikation deutsche Version Binding: ATC (required) Required Pattern: At least the following | ||||
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://fhir.de/CodeSystem/bfarm/atc | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 0..1 | code | Symbol in syntax defined by the system | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:atcClassEn | SΣ | 0..* | Coding | Anatomical Therapeutic Chemical Classification System Required Pattern: At least the following | ||||
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://www.whocc.no/atc | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 0..1 | code | Symbol in syntax defined by the system | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code |