MII IG Onkologie DE v2025

There are no (further) constraints on this element

Element id

MedicationStatement.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

category

S Σ

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

MedicationStatement.category

Short description

Kategorie

Definition

Eine Kategorie, die dem Medikationseintrag zugeordnet ist.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Data type

Medication usage category codes (preferred)

Binding

A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
rim: .inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code="type of medication usage"].value

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.category.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.category.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.category.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Data type

Slicing

Unordered, Open, by $this(Pattern)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

usageCategory

0..*

CodingBindingPattern

There are no (further) constraints on this element

Element id

MedicationStatement.category.coding:usageCategory

Short description

Kategorie Anwendungsbereich

Definition

Kategorie, die den Anwendungsbereich des Medikationseintrags beschreibt.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Medication usage category codes (required)

Binding

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://terminology.hl7.org/CodeSystem/medication-statement-category"
}

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

contextCode

0..1

CodingBindingPattern

There are no (further) constraints on this element

Element id

MedicationStatement.category.coding:contextCode

Short description

Kategorie Kontext

Definition

ambulanter Kontakt | stationärer Aufenthalt | stationäre Aufnahme | stationäre Entlassung

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

MII_VS_Medikation_Fallkontext (required)

Binding

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://ihe-d.de/CodeSystems/FallkontextBeiDokumentenerstellung"
}

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

text

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.category.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

SNOMEDCTMedicationCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

medication[x]

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]

Short description

Medikation

Definition

Das Medikament, welches Gegenstand des Eintrags ist. Code oder Referenz auf Medication-Objekt.

Comments

If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource.

Slicing

Unordered, Open, by $this(Type)

Binding

A coded concept identifying the substance or product being taken.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.code
w5: FiveWs.what[x]
rim: .participation[typeCode=CSM].role[classCode=ADMM or MANU]

medicationReference

S Σ

0..1

Reference(MII_PR_Medikation_Medication)

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationReference

Short description

Medikation Referenz

Definition

Referenz auf ein Medication-Ressource.

Comments

Data type

Reference(MII_PR_Medikation_Medication)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.code
w5: FiveWs.what[x]
rim: .participation[typeCode=CSM].role[classCode=ADMM or MANU]

medicationCodeableConcept

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept

Short description

Medikation Code

Definition

Code für das Medikament, welches Gegenstand des Eintrags ist.

Comments

Data type

SNOMEDCTMedicationCodes (example)

Binding

A coded concept identifying the substance or product being taken.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.code
w5: FiveWs.what[x]
rim: .participation[typeCode=CSM].role[classCode=ADMM or MANU]

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

S Σ

1..*

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding

Short description

Wirkstoff der systemischen Medikation

Definition

Wirkstoff der systemischen onkologischen Medikation. Nach Möglichkeit als ATC-kodiert anzugeben. Wirkstoffe sind einzeln zu kodieren. Kombinationstherapien können über MedicationStatement.partOf in übergeordneten MedicationStatements gruppiert werden - in diesem Fall ist bei jedem Wirkstoff unter MedicationStatement.note.text das Kürzel des (z.B. chemotherapeutischen) Protokolls zu hinterlegen.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Slicing

Unordered, Open, by $this(Pattern)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

(All Slices)

The requirements in this element apply to all slices

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding.version

Short description

Version of the system - if relevant

Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
oBDS: 16.4

display

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

Pharmazentralnummer

S Σ

0..*

CodingBindingPattern

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer

Short description

PZN Code

Definition

Ein Verweis auf einen von der Pharmazentralnummer (PZN) definierten Code

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Binding

PZN (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://fhir.de/CodeSystem/ifa/pzn"
}

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

S Σ

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://fhir.de/CodeSystem/ifa/pzn

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

atcClassDe

S Σ

0..*

CodingBindingPattern

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe

Short description

ATC Klassifikation deutsche Version

Definition

ATC-Codes für Fertigarzneimittel bspw. von Kombiprodukten

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Binding

ATC (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://fhir.de/CodeSystem/bfarm/atc"
}

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

S Σ

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://fhir.de/CodeSystem/bfarm/atc

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

atcClassEn

S Σ

0..*

CodingPattern

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn

Short description

Anatomical Therapeutic Chemical Classification System

Definition

ATC Classification International WHO Version

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://www.whocc.no/atc"
}

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

S Σ

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://www.whocc.no/atc

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.medication[x]:medicationCodeableConcept.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

subject

S Σ C

1..1

Reference(Patient)

Element id

MedicationStatement.subject

Short description

Who is/was taking the medication

Definition

The person, animal or group who is/was taking the medication.

Comments

Data type

Reference(Patient)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.subject
w5: FiveWs.subject[x]
v2: PID-3-Patient ID List
rim: .participation[typeCode=SBJ].role[classCode=PAT]
w5: FiveWs.subject

context

S Σ C

0..1

Reference(Encounter | EpisodeOfCare)

There are no (further) constraints on this element

Element id

MedicationStatement.context

Short description

Kontext

Definition

Fall oder Kontakt in Verbindung mit dem Medikationseintrag

Comments

Data type

Reference(Encounter | EpisodeOfCare)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.context
rim: .inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code="type of encounter or episode"]

effective[x]

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.effective[x]

Short description

Zeitpunkt oder Zeitraum

Definition

Die Zeitspanne, in der angegeben wird, dass der Patient das Medikament eingenommen hat oder einnehmen wird.

Comments

This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken at the time the statement is recorded, the "end" date will be omitted. The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text.

Slicing

Unordered, Open, by $this(Type)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.occurrence[x]
w5: FiveWs.done[x]
rim: .effectiveTime

effectiveDateTime

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.effective[x]:effectiveDateTime

Short description

Zeitpunkt

Definition

Der Zeitpunkt, an dem der Patient das Medikament eingenommen hat oder einnehmen wird.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.occurrence[x]
w5: FiveWs.done[x]
rim: .effectiveTime

effectivePeriod

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.effective[x]:effectivePeriod

Short description

Zeitraum

Definition

Der Zeitraum, in dem der Patient das Medikament eingenommen hat oder einnehmen wird.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.occurrence[x]
w5: FiveWs.done[x]
rim: .effectiveTime

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.effective[x]:effectivePeriod.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.effective[x]:effectivePeriod.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

start

S Σ C

0..1

Element id

MedicationStatement.effective[x]:effectivePeriod.start

Short description

Startdatum der systemischen Medikation

Definition

Startdatum der systemischen Medikation gemäß 16.7 oBDS 2021.

Comments

If the low element is missing, the meaning is that the low boundary is not known.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: DR.1
rim: ./low

end

S Σ C

0..1

Element id

MedicationStatement.effective[x]:effectivePeriod.end

Short description

Enddatum der systemischen Medikation

Definition

Enddatum der systemischen Medikation gemäß 16.9 oBDS 2021.

Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: DR.2
rim: ./high

dateAsserted

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dateAsserted

Short description

Datum Bestätigung

Definition

Das Datum, an dem der Medikationseintrag von der Informationsquelle bestätigt wurde.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.recorded
rim: .participation[typeCode=AUT].time

informationSource

S C

0..1

Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

There are no (further) constraints on this element

Element id

MedicationStatement.informationSource

Short description

Informationsquelle

Definition

Die Person oder Organisation, die die Information über die Einnahme dieses Medikaments bereitgestellt hat.

Comments

Data type

Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.source
rim: .participation[typeCode=INF].role[classCode=PAT, or codes for Practioner or Related Person (if PAT is the informer, then syntax for self-reported =true)

derivedFrom

0..*

Reference(Resource)

There are no (further) constraints on this element

Element id

MedicationStatement.derivedFrom

Short description

Additional supporting information

Definition

Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.

Comments

Likely references would be to MedicationRequest, MedicationDispense, Claim, Observation or QuestionnaireAnswers. The most common use cases for deriving a MedicationStatement comes from creating a MedicationStatement from a MedicationRequest or from a lab observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the MedicationStatement from.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[typeCode=SPRT]/target[classCode=ACT,moodCode=EVN]

reasonCode

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.reasonCode

Short description

Grund Code

Definition

Grund für den Medikationseintrag als Code.

Comments

This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference.

Data type

Condition/Problem/DiagnosisCodes (example)

Binding

A coded concept identifying why the medication is being taken.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.reasonCode
w5: FiveWs.why[x]
rim: .reasonCode

reasonReference

S C

0..*

Reference(Condition | DiagnosticReport | Observation)

There are no (further) constraints on this element

Element id

MedicationStatement.reasonReference

Short description

Grund Referenz

Definition

Grund für den Medikationseintrag als Referenz auf Condition- oder Observation-Ressource.

Comments

This is a reference to a condition that is the reason why the medication is being/was taken. If only a code exists, use reasonForUseCode.

Data type

Reference(Condition | DiagnosticReport | Observation)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.reasonReference
w5: FiveWs.why[x]
rim: .outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code="reason for use"].value

note

0..*

Annotation

There are no (further) constraints on this element

Element id

MedicationStatement.note

Short description

Hinweis

Definition

Zusätzliche Informationen zum Medikationseintrag als Freitext.

Comments

For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).

Data type

Annotation

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act
workflow: Event.note
rim: .inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code="annotation"].value

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.note.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.note.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

author[x]

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.note.author[x]

Short description

Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.participant[typeCode=AUT].role

authorReference

Reference(Organization | Patient | Practitioner | RelatedPerson)

There are no (further) constraints on this element

Data type

Reference(Organization | Patient | Practitioner | RelatedPerson)

authorString

There are no (further) constraints on this element

Data type

time

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.note.time

Short description

When the annotation was made

Definition

Indicates when this particular annotation was made.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.effectiveTime

text

S Σ

1..1

markdown

Element id

MedicationStatement.note.text

Short description

Protokoll

Definition

Protokoll der systemischen Medikation. Bei Angabe eines Schemas sind alle Wirkstoffe in einzelnen Ressourcen unter MedicationStatement.medication[x] gesondert zu kodieren

Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

Data type

markdown

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.text
oBDS: 16.6

dosage

S C

0..*

Dosage

There are no (further) constraints on this element

Element id

MedicationStatement.dosage

Short description

Dosierung

Definition

Details zur Dosierung des Medikamentes.

Comments

The dates included in the dosage on a Medication Statement reflect the dates for a given dose. For example, "from November 1, 2016 to November 3, 2016, take one tablet daily and from November 4, 2016 to November 7, 2016, take two tablets daily." It is expected that this specificity may only be populated where the patient brings in their labeled container or where the Medication Statement is derived from a MedicationRequest.

Data type

Dosage

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
dsg-1: If present, dosage must include free text or structured data
text.exists() or doseAndRate.exists()

Mappings

rim: n/a
rim: .outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]
rim: refer dosageInstruction mapping

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

sequence

S Σ

0..1

integer

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.sequence

Short description

The order of the dosage instructions

Definition

Indicates the order in which the dosage instructions should be applied or interpreted.

Requirements

If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential.

Comments

32 bit number; for values larger than this, use decimal

Data type

integer

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: TQ1-1
rim: .text

text

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.text

Short description

Free text dosage instructions e.g. SIG

Definition

Free text dosage instructions e.g. SIG.

Requirements

Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: RXO-6; RXE-21
rim: .text

additionalInstruction

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.additionalInstruction

Short description

Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"

Definition

Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps").

Requirements

Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, "Swallow with plenty of water" which might or might not be coded.

Comments

Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or "immediately following drug x") should be populated in dosage.text.

Data type

SNOMEDCTAdditionalDosageInstructions (example)

Binding

A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery".

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXO-7
rim: .text

patientInstruction

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.patientInstruction

Short description

Patient or consumer oriented instructions

Definition

Instructions in terms that are understood by the patient or consumer.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: RXO-7
rim: .text

timing

S Σ

0..1

Timing

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing

Short description

When medication should be administered

Definition

When medication should be administered.

Requirements

The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.

Comments

This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing.

Data type

Timing

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: QSET<TS> (GTS)
rim: .effectiveTime

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

event

S Σ

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.event

Short description

When the event occurs

Definition

Identifies specific times when the event occurs.

Requirements

In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: QLIST<TS>

repeat

S Σ C

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat

Short description

When the event is to occur

Definition

A set of rules that describe when the event is scheduled.

Requirements

Many timing schedules are determined by regular repetitions.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
tim-9: 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-5: period SHALL be a non-negative value
period.exists() implies period >= 0
tim-6: If there's a periodMax, there must be a period
periodMax.empty() or period.exists()
tim-7: If there's a durationMax, there must be a duration
durationMax.empty() or duration.exists()
tim-8: If there's a countMax, there must be a count
countMax.empty() or count.exists()
tim-1: if there's a duration, there needs to be duration units
duration.empty() or durationUnit.exists()
tim-10: If there's a timeOfDay, there cannot be a when, or vice versa
timeOfDay.empty() or when.empty()
tim-2: if there's a period, there needs to be period units
period.empty() or periodUnit.exists()
tim-4: duration SHALL be a non-negative value
duration.exists() implies duration >= 0

Mappings

rim: n/a
rim: Implies PIVL or EIVL

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

bounds[x]

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]

Short description

Length/Range of lengths, or (Start and/or end) limits

Definition

Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.

Slicing

Unordered, Open, by $this(Type)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: IVL(TS) used in a QSI

boundsDuration

S Σ

0..1

DurationPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration

Short description

Length/Range of lengths, or (Start and/or end) limits

Definition

Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.

Data type

Duration

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://unitsofmeasure.org"
}

Mappings

rim: n/a
rim: IVL(TS) used in a QSI

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

value

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

comparator

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

unit

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

system

S Σ C

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, qty-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://unitsofmeasure.org

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

boundsRange

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange

Short description

Length/Range of lengths, or (Start and/or end) limits

Definition

Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: IVL(TS) used in a QSI

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

low

S Σ C

0..1

SimpleQuantityPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low

Short description

Low limit

Definition

The low limit. The boundary is inclusive.

Comments

If the low element is missing, the low boundary is not known.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Pattern

{
  "system": "http://unitsofmeasure.org"
}

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: NR.1
rim: ./low

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

value

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

comparator

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

Not allowed to be used in this context

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

unit

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

system

S Σ C

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, qty-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://unitsofmeasure.org

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

high

S Σ C

0..1

SimpleQuantityPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high

Short description

High limit

Definition

The high limit. The boundary is inclusive.

Comments

If the high element is missing, the high boundary is not known.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Pattern

{
  "system": "http://unitsofmeasure.org"
}

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: NR.2
rim: ./high

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

value

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

comparator

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

Not allowed to be used in this context

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

unit

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

system

S Σ C

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, qty-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://unitsofmeasure.org

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

boundsPeriod

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsPeriod

Short description

Length/Range of lengths, or (Start and/or end) limits

Definition

Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: IVL(TS) used in a QSI

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsPeriod.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsPeriod.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

start

S Σ C

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsPeriod.start

Short description

Starting time with inclusive boundary

Definition

The start of the period. The boundary is inclusive.

Comments

If the low element is missing, the meaning is that the low boundary is not known.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: DR.1
rim: ./low

end

S Σ C

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.bounds[x]:boundsPeriod.end

Short description

End time with inclusive boundary, if not ongoing

Definition

The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: DR.2
rim: ./high

count

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.count

Short description

Number of times to repeat

Definition

A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values.

Requirements

Repetitions may be limited by end time or total occurrences.

Comments

If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: PIVL.count

countMax

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.countMax

Short description

Maximum number of times to repeat

Definition

If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times.

Comments

32 bit number; for values larger than this, use decimal

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: PIVL.count

duration

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.duration

Short description

How long when it happens

Definition

How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration.

Requirements

Some activities are not instantaneous and need to be maintained for a period of time.

Comments

For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: PIVL.phase

durationMax

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.durationMax

Short description

How long when it happens (Max)

Definition

If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length.

Requirements

Some activities are not instantaneous and need to be maintained for a period of time.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: PIVL.phase

durationUnit

S Σ

0..1

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.durationUnit

Short description

s | min | h | d | wk | mo | a - unit of time (UCUM)

Definition

The units of time for the duration, in UCUM units.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Binding

A unit of time (units from UCUM).

UnitsOfTime (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: PIVL.phase.unit

frequency

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.frequency

Short description

Event occurs frequency times per period

Definition

The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.

Comments

32 bit number; for values larger than this, use decimal

Meaning when missing

If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: PIVL.phase

frequencyMax

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.frequencyMax

Short description

Event occurs up to frequencyMax times per period

Definition

If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.

Comments

32 bit number; for values larger than this, use decimal

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: PIVL.phase

period

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.period

Short description

Event occurs frequency times per period

Definition

Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.

Comments

Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: PIVL.phase

periodMax

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.periodMax

Short description

Upper limit of period (3-4 hours)

Definition

If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.

Comments

Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: PIVL.phase

periodUnit

S Σ

0..1

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.periodUnit

Short description

s | min | h | d | wk | mo | a - unit of time (UCUM)

Definition

The units of time for the period in UCUM units.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Binding

A unit of time (units from UCUM).

UnitsOfTime (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: PIVL.phase.unit

dayOfWeek

S Σ

0..*

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.dayOfWeek

Short description

mon | tue | wed | thu | fri | sat | sun

Definition

If one or more days of week is provided, then the action happens only on the specified day(s).

Comments

If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek.

Data type

Binding

DaysOfWeek (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

timeOfDay

S Σ

0..*

time

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.timeOfDay

Short description

Time of day for action

Definition

Specified time of day for action to take place.

Comments

When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay.

Data type

time

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

when

S Σ

0..*

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.when

Short description

Code for time period of occurrence

Definition

An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.

Requirements

Timings are frequently determined by occurrences such as waking, eating and sleep.

Comments

When more than one event is listed, the event is tied to the union of the specified events.

Data type

Binding

Real world event relating to the schedule.

EventTiming (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: EIVL.event

offset

S Σ

0..1

unsignedInt

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.repeat.offset

Short description

Minutes from event (before or after)

Definition

The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.

Comments

32 bit number; for values larger than this, use decimal

Data type

unsignedInt

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: EIVL.offset

code

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.timing.code

Short description

BID | TID | QID | AM | PM | QD | QOD | +

Definition

A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).

Comments

BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times).

Data type

TimingAbbreviation (preferred)

Binding

Code for a known / defined timing pattern.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: QSC.code

asNeeded[x]

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.asNeeded[x]

Short description

Take "as needed" (for x)

Definition

Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).

Comments

Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed".

Slicing

Unordered, Open, by $this(Type)

Binding

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.

SNOMEDCTMedicationAsNeededReasonCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: TQ1-9
rim: .outboundRelationship[typeCode=PRCN].target[classCode=OBS, moodCode=EVN, code="as needed"].value=boolean or codable concept

asNeededBoolean

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.asNeeded[x]:asNeededBoolean

Short description

Take "as needed" (for x)

Definition

Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: TQ1-9
rim: .outboundRelationship[typeCode=PRCN].target[classCode=OBS, moodCode=EVN, code="as needed"].value=boolean or codable concept

asNeededCodeableConcept

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.asNeeded[x]:asNeededCodeableConcept

Short description

Take "as needed" (for x)

Definition

Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).

Comments

Data type

SNOMEDCTMedicationAsNeededReasonCodes (example)

Binding

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: TQ1-9
rim: .outboundRelationship[typeCode=PRCN].target[classCode=OBS, moodCode=EVN, code="as needed"].value=boolean or codable concept

site

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.site

Short description

Verabreichungsort

Definition

Körperstelle, an der das Medikament verabreicht wurde/wird oder werden soll.

Requirements

A coded specification of the anatomic site where the medication first enters the body.

Comments

If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both.

Data type

SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)

Binding

A coded concept describing the site location the medicine enters into or onto the body.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXR-2
rim: .approachSiteCode

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.site.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.site.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

S Σ

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.site.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Slicing

Unordered, Open, by $this(Pattern)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

SNOMED

S Σ

0..*

CodingPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.site.coding:SNOMED

Short description

SNOMED CT Code

Definition

Ein Verweis auf einen von SNOMED CT definierten Code

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Binding

target site IPS

TargetSiteUvIps (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://snomed.info/sct"
}

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.site.coding:SNOMED.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.site.coding:SNOMED.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

S Σ

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.site.coding:SNOMED.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://snomed.info/sct

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.site.coding:SNOMED.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.site.coding:SNOMED.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.site.coding:SNOMED.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.site.coding:SNOMED.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.site.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

route

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route

Short description

Verabreichungsweg

Definition

Der Weg, auf dem das Medikament verabreicht wurde/wird oder werden soll.

Requirements

A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.

Comments

Data type

Binding

A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

SNOMEDCTRouteCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXR-1
rim: .routeCode

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

S Σ

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Slicing

Unordered, Open, by $this(Pattern)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

EDQM

S Σ

0..1

CodingBindingPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.coding:EDQM

Short description

EDQM Code

Definition

Ein Verweis auf einen durch EDQM Standard Terms definierten Code

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

MedicineRouteOfAdministrationUvIps (preferred)

Binding

EDQM Standard Terms

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://standardterms.edqm.eu"
}

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.coding:EDQM.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.coding:EDQM.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

S Σ

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.coding:EDQM.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://standardterms.edqm.eu

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.coding:EDQM.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.coding:EDQM.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.coding:EDQM.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.coding:EDQM.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

SNOMED

S Σ

0..1

CodingPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.coding:SNOMED

Short description

SNOMED CT Code

Definition

Ein Verweis auf einen von SNOMED CT definierten Code

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

{
  "system": "http://snomed.info/sct"
}

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.coding:SNOMED.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.coding:SNOMED.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

S Σ

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.coding:SNOMED.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://snomed.info/sct

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.coding:SNOMED.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.coding:SNOMED.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.coding:SNOMED.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.coding:SNOMED.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.route.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

method

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.method

Short description

Technique for administering medication

Definition

Technique for administering medication.

Requirements

A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV.

Comments

Terminologies used often pre-coordinate this term with the route and or form of administration.

Data type

SNOMEDCTAdministrationMethodCodes (example)

Binding

A coded concept describing the technique by which the medicine is administered.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXR-4
rim: .doseQuantity

doseAndRate

S Σ

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate

Short description

Amount of medication administered

Definition

The amount of medication administered.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: TQ1-2

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

type

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.type

Short description

The kind of dose or rate specified

Definition

The kind of dose or rate specified, for example, ordered or calculated.

Requirements

If the type is not populated, assume to be "ordered".

Comments

Data type

Binding

The kind of dose or rate specified.

DoseAndRateType (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXO-21; RXE-23

dose[x]

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]

Short description

Amount of medication per dose

Definition

Amount of medication per dose.

Requirements

The amount of therapeutic or other substance given at one administration event.

Comments

Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.

Slicing

Unordered, Open, by $this(Type)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: RXO-2, RXE-3
rim: .doseQuantity

doseRange

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange

Short description

Amount of medication per dose

Definition

Amount of medication per dose.

Requirements

The amount of therapeutic or other substance given at one administration event.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: RXO-2, RXE-3
rim: .doseQuantity

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

low

S Σ C

0..1

SimpleQuantityPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low

Short description

Low limit

Definition

The low limit. The boundary is inclusive.

Comments

If the low element is missing, the low boundary is not known.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Pattern

{
  "system": "http://unitsofmeasure.org"
}

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: NR.1
rim: ./low

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

value

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

comparator

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

Not allowed to be used in this context

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

unit

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

system

S Σ C

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, qty-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://unitsofmeasure.org

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

high

Σ C

0..1

SimpleQuantityPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high

Short description

High limit

Definition

The high limit. The boundary is inclusive.

Comments

If the high element is missing, the high boundary is not known.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Pattern

{
  "system": "http://unitsofmeasure.org"
}

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: NR.2
rim: ./high

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

value

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

comparator

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

Not allowed to be used in this context

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

unit

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

system

S Σ C

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, qty-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://unitsofmeasure.org

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

doseQuantity

S Σ C

0..1

SimpleQuantityPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity

Short description

A fixed quantity (no comparator)

Definition

The comparator is not used on a SimpleQuantity

Requirements

The amount of therapeutic or other substance given at one administration event.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Pattern

{
  "system": "http://unitsofmeasure.org"
}

Mappings

rim: n/a
v2: RXO-2, RXE-3
rim: .doseQuantity
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

value

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

comparator

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

Not allowed to be used in this context

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

unit

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

system

S Σ C

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, qty-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://unitsofmeasure.org

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

rate[x]

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]

Short description

Amount of medication per unit of time

Definition

Amount of medication per unit of time.

Requirements

Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.

Comments

It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate.

It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammer where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour.

Slicing

Unordered, Open, by $this(Type)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: RXE22, RXE23, RXE-24
rim: .rateQuantity

rateRatio

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio

Short description

Amount of medication per unit of time

Definition

Amount of medication per unit of time.

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: RXE22, RXE23, RXE-24
rim: .rateQuantity

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

numerator

S Σ C

0..1

QuantityPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator

Short description

Numerator value

Definition

The value of the numerator.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()

Pattern

{
  "system": "http://unitsofmeasure.org"
}

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
rim: .numerator

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

value

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

comparator

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

unit

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

system

S Σ C

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, qty-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://unitsofmeasure.org

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

denominator

S Σ C

0..1

QuantityPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator

Short description

Denominator value

Definition

The value of the denominator.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()

Pattern

{
  "system": "http://unitsofmeasure.org"
}

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
rim: .denominator

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

value

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

comparator

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

unit

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

system

S Σ C

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, qty-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://unitsofmeasure.org

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

rateRange

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange

Short description

Amount of medication per unit of time

Definition

Amount of medication per unit of time.

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: RXE22, RXE23, RXE-24
rim: .rateQuantity

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

low

S Σ C

0..1

SimpleQuantityPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low

Short description

Low limit

Definition

The low limit. The boundary is inclusive.

Comments

If the low element is missing, the low boundary is not known.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Pattern

{
  "system": "http://unitsofmeasure.org"
}

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: NR.1
rim: ./low

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

value

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

comparator

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

Not allowed to be used in this context

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

unit

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

system

S Σ C

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, qty-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://unitsofmeasure.org

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

high

S Σ C

0..1

SimpleQuantityPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high

Short description

High limit

Definition

The high limit. The boundary is inclusive.

Comments

If the high element is missing, the high boundary is not known.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Pattern

{
  "system": "http://unitsofmeasure.org"
}

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: NR.2
rim: ./high

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

value

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

comparator

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

Not allowed to be used in this context

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

unit

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

system

S Σ C

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, qty-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://unitsofmeasure.org

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

rateQuantity

S Σ C

0..1

SimpleQuantityPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity

Short description

A fixed quantity (no comparator)

Definition

The comparator is not used on a SimpleQuantity

Requirements

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Pattern

{
  "system": "http://unitsofmeasure.org"
}

Mappings

rim: n/a
v2: RXE22, RXE23, RXE-24
rim: .rateQuantity
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

value

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

comparator

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

Not allowed to be used in this context

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

unit

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

system

S Σ C

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, qty-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://unitsofmeasure.org

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

maxDosePerPeriod

S Σ C

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod

Short description

Upper limit on medication per unit of time

Definition

Upper limit on medication per unit of time.

Requirements

The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.

Comments

This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day".

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())

Mappings

rim: n/a
v2: N/A
rim: RTO
v2: RXO-23, RXE-19
rim: .maxDoseQuantity

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

numerator

S Σ C

0..1

QuantityPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.numerator

Short description

Numerator value

Definition

The value of the numerator.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()

Pattern

{
  "system": "http://unitsofmeasure.org"
}

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
rim: .numerator

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.numerator.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.numerator.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

value

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.numerator.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

comparator

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.numerator.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

unit

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.numerator.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

system

S Σ C

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.numerator.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, qty-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://unitsofmeasure.org

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.numerator.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

denominator

S Σ C

0..1

QuantityPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.denominator

Short description

Denominator value

Definition

The value of the denominator.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()

Pattern

{
  "system": "http://unitsofmeasure.org"
}

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
rim: .denominator

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.denominator.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.denominator.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

value

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.denominator.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

comparator

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.denominator.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

unit

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.denominator.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

system

S Σ C

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.denominator.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, qty-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://unitsofmeasure.org

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerPeriod.denominator.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

maxDosePerAdministration

S Σ C

0..1

SimpleQuantityPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerAdministration

Short description

Upper limit on medication per administration

Definition

Upper limit on medication per administration.

Requirements

The maximum total quantity of a therapeutic substance that may be administered to a subject per administration.

Comments

This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Pattern

{
  "system": "http://unitsofmeasure.org"
}

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
rim: not supported

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerAdministration.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerAdministration.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

value

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerAdministration.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value

comparator

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerAdministration.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

Not allowed to be used in this context

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

unit

S Σ

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerAdministration.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit

system

S Σ C

1..1

uriPattern

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerAdministration.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, qty-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Pattern

http://unitsofmeasure.org

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

S Σ

1..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerAdministration.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

maxDosePerLifetime

Σ C

0..1

There are no (further) constraints on this element

Element id

MedicationStatement.dosage.maxDosePerLifetime

Short description

Upper limit on medication per lifetime of the patient

Definition

Upper limit on medication per lifetime of the patient.

Requirements

The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type