DCH-MedicationStatement-1
MedicationStatement | |
Definition | |
Control | 0..* |
Comments | |
MedicationStatement.id | |
Definition |
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 ? |
Type | Id |
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. Bundles always have an id, though it is usually a generated UUID. |
MedicationStatement.meta | |
Definition |
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 ? |
Type | Meta |
Comments | |
MedicationStatement.implicitRules | |
Definition |
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 ? |
Type | Uri |
Is Modifier | True |
Comments |
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible. |
MedicationStatement.language | |
Definition |
The base language in which the resource is written. |
Control | 0..1 ? |
Binding |
A human language. The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | Code |
Comments |
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
MedicationStatement.text | |
Definition |
A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 ? |
Type | Narrative |
Aliases | narrative, html, xhtml, display |
Comments |
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. |
MedicationStatement.contained | |
Definition |
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Aliases | inline resources, anonymous resources, contained resources |
Comments |
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
MedicationStatement.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the resource. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.modifierExtension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.identifier | |
Definition | |
Control | 1..1 |
Comments | |
MedicationStatement.identifier.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.identifier.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.identifier.use | |
Definition |
The purpose of this identifier. |
Control | 0..1 ? |
Binding |
Identifies the purpose for this identifier, if known . The codes SHALL be taken from http://hl7.org/fhir/ValueSet/identifier-use |
Type | Code |
Is Modifier | True |
Requirements |
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments |
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
MedicationStatement.identifier.type | |
Definition |
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Control | 0..1 ? |
Binding |
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. The codes SHALL be taken from the following if appropriate, otherwise an alternate coding may be included instead. http://hl7.org/fhir/ValueSet/identifier-type |
Type | CodeableConcept |
Requirements |
Allows users to make use of identifiers when the identifier system is not known. |
Comments |
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
MedicationStatement.identifier.type.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.identifier.type.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.identifier.type.coding | |
Definition |
A reference to a code defined by a terminology system. |
Control | 0..* ? |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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 labelled as UserSelected = true. |
MedicationStatement.identifier.type.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.identifier.type.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.identifier.type.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 0..1 ? |
Type | Uri |
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 de-reference to some definition that establish the system clearly and unambiguously. |
MedicationStatement.identifier.type.coding.version | |
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. |
Control | 0..1 ? |
Type | String |
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. |
MedicationStatement.identifier.type.coding.code | |
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). |
Control | 0..1 ? |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
MedicationStatement.identifier.type.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 ? |
Type | String |
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 may not exceed 1MB in size |
MedicationStatement.identifier.type.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
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. |
MedicationStatement.identifier.type.text | |
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. |
Control | 0..1 ? |
Type | String |
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. |
MedicationStatement.identifier.system | |
Definition | |
Control | 1..* |
Comments | |
MedicationStatement.identifier.value | |
Definition | |
Control | 1..* |
Comments | |
MedicationStatement.identifier.period | |
Definition |
Time period during which identifier is/was valid for use. |
Control | 0..1 ? |
Type | Period |
Comments |
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
MedicationStatement.identifier.period.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.identifier.period.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.identifier.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 0..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
MedicationStatement.identifier.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. 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. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
MedicationStatement.identifier.assigner | |
Definition |
Organization that issued/manages the identifier. |
Control | 0..1 ? |
Type | Organization |
Comments |
The reference may be just a text description of the assigner. |
MedicationStatement.identifier.assigner.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.identifier.assigner.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.identifier.assigner.reference | |
Definition |
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 ? |
Type | String |
Comments |
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
MedicationStatement.identifier.assigner.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
MedicationStatement.patient | |
Definition | |
Control | 0..* |
Type | https://fhir.nhs.uk/StructureDefinition/CareConnect-DCH-Patient-1 |
Comments | |
MedicationStatement.patient.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.patient.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.patient.reference | |
Definition |
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 ? |
Type | String |
Comments |
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
MedicationStatement.patient.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
MedicationStatement.informationSource | |
Definition | |
Control | 0..* |
Type | Choice of: |
Comments | |
MedicationStatement.informationSource.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.informationSource.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.informationSource.reference | |
Definition |
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 ? |
Type | String |
Comments |
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
MedicationStatement.informationSource.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
MedicationStatement.dateAsserted | |
Definition |
The date when the medication statement was asserted by the information source. |
Control | 0..1 ? |
Type | DateTime |
Comments | |
MedicationStatement.status | |
Definition |
A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally this will be active or completed. |
Control | 1..1 ? |
Binding |
A set of codes indicating the current status of a MedicationStatement. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/medication-statement-status |
Type | Code |
Is Modifier | True |
Comments |
Note that FHIR strings may not exceed 1MB in size |
MedicationStatement.wasNotTaken | |
Definition |
Set this to true if the record is saying that the medication was NOT taken. |
Control | 0..1 ? |
Type | Boolean |
Is Modifier | True |
Comments | |
MedicationStatement.reasonNotTaken | |
Definition |
A code indicating why the medication was not taken. |
Control | 0..* ? |
Binding |
A set of codes indicating the reason why the MedicationAdministration is negated. For example codes, see http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes ; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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. |
MedicationStatement.reasonNotTaken.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.reasonNotTaken.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.reasonNotTaken.coding | |
Definition |
A reference to a code defined by a terminology system. |
Control | 0..* ? |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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 labelled as UserSelected = true. |
MedicationStatement.reasonNotTaken.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.reasonNotTaken.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.reasonNotTaken.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 0..1 ? |
Type | Uri |
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 de-reference to some definition that establish the system clearly and unambiguously. |
MedicationStatement.reasonNotTaken.coding.version | |
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. |
Control | 0..1 ? |
Type | String |
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. |
MedicationStatement.reasonNotTaken.coding.code | |
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). |
Control | 0..1 ? |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
MedicationStatement.reasonNotTaken.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 ? |
Type | String |
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 may not exceed 1MB in size |
MedicationStatement.reasonNotTaken.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
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. |
MedicationStatement.reasonNotTaken.text | |
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. |
Control | 0..1 ? |
Type | String |
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. |
MedicationStatement.reasonForUse[x] | |
Definition |
A reason for why the medication is being/was taken. |
Control | 0..1 ? |
Binding |
Codes identifying why the medication is being taken. For example codes, see http://hl7.org/fhir/ValueSet/condition-code ; other codes may be used where these codes are not suitable |
Type | Choice of: |
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. |
MedicationStatement.effective[x] | |
Definition |
The interval of time during which it is being asserted that the patient was taking the medication (or was not taking, when the wasNotGiven element is true). |
Control | 0..1 ? |
Type | Choice of: |
Comments |
If the medication is still being taken at the time the statement is recorded, the "end" date will be omitted. |
MedicationStatement.note | |
Definition |
Provides extra information about the medication statement that is not conveyed by the other attributes. |
Control | 0..1 ? |
Type | String |
Comments |
Note that FHIR strings may not exceed 1MB in size |
MedicationStatement.supportingInformation | |
Definition |
Allows linking the MedicationStatement to the underlying MedicationOrder, or to other information that supports the MedicationStatement. |
Control | 0..* ? |
Type | Resource |
Comments |
Likely references would be to MedicationOrder, MedicationDispense, Claim, Observation or QuestionnaireAnswers. |
MedicationStatement.supportingInformation.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.supportingInformation.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.supportingInformation.reference | |
Definition |
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 ? |
Type | String |
Comments |
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
MedicationStatement.supportingInformation.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
MedicationStatement.medication[x] | |
Definition | |
Control | 0..* |
Type | Choice of: |
Comments | |
MedicationStatement.dosage | |
Definition |
Indicates how the medication is/was used by the patient. |
Control | 0..* ? |
Type | BackboneElement |
Comments | |
MedicationStatement.dosage.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.dosage.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.dosage.modifierExtension | |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.dosage.text | |
Definition |
Free text dosage information as reported about a patient's medication use. When coded dosage information is present, the free text may still be present for display to humans. |
Control | 0..1 ? |
Type | String |
Comments |
Note that FHIR strings may not exceed 1MB in size |
MedicationStatement.dosage.timing | |
Definition |
The timing schedule for giving the medication to the patient. The Schedule 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". |
Control | 0..1 ? |
Type | Timing |
Comments |
A timing schedule can be either a list of events - intervals on which the event occurs, or a single event with repeating criteria or just repeating criteria with no actual event. When both event and a repeating specification are provided, the list of events should be understood as an interpretation of the information in the repeat structure. |
MedicationStatement.dosage.timing.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.dosage.timing.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.dosage.timing.event | |
Definition |
Identifies specific times when the event occurs. |
Control | 0..* ? |
Type | DateTime |
Requirements |
In an MAR, for instance, you need to take a general specification, and turn it into a precise specification. |
Comments | |
MedicationStatement.dosage.timing.repeat | |
Definition |
A set of rules that describe when the event should occur. |
Control | 0..1 ? |
Type | Element |
Requirements |
Many timing schedules are determined by regular repetitions. |
Comments | |
MedicationStatement.dosage.timing.repeat.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.dosage.timing.repeat.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.dosage.timing.repeat.bounds[x](Duration) | |
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. |
Control | 0..1 ? |
Type | Choice of: |
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. |
MedicationStatement.dosage.timing.repeat.count | |
Definition |
A total count of the desired number of repetitions. |
Control | 0..1 ? |
Type | Integer |
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. |
MedicationStatement.dosage.timing.repeat.duration | |
Definition |
How long this thing happens for when it happens. |
Control | 0..1 ? |
Type | Decimal |
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). |
MedicationStatement.dosage.timing.repeat.durationMax | |
Definition |
The upper limit of how long this thing happens for when it happens. |
Control | 0..1 ? |
Type | Decimal |
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). |
MedicationStatement.dosage.timing.repeat.durationUnits | |
Definition |
The units of time for the duration, in UCUM units. |
Control | 0..1 ? |
Binding |
A unit of time (units from UCUM). The codes SHALL be taken from http://hl7.org/fhir/ValueSet/units-of-time |
Type | Code |
Comments |
Note that FHIR strings may not exceed 1MB in size |
MedicationStatement.dosage.timing.repeat.frequency | |
Definition |
The number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided). |
Control | 0..1 ? |
Type | Integer |
Comments |
32 bit number; for values larger than this, use decimal |
Default Value | 1 |
MedicationStatement.dosage.timing.repeat.frequencyMax | |
Definition |
If present, indicates that the frequency is a range - so repeat between [frequency] and [frequencyMax] times within the period or period range. |
Control | 0..1 ? |
Type | Integer |
Comments |
32 bit number; for values larger than this, use decimal |
MedicationStatement.dosage.timing.repeat.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. |
Control | 0..1 ? |
Type | Decimal |
Comments |
Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
MedicationStatement.dosage.timing.repeat.periodMax | |
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. |
Control | 0..1 ? |
Type | Decimal |
Comments |
Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
MedicationStatement.dosage.timing.repeat.periodUnits | |
Definition |
The units of time for the period in UCUM units. |
Control | 0..1 ? |
Binding |
A unit of time (units from UCUM). The codes SHALL be taken from http://hl7.org/fhir/ValueSet/units-of-time |
Type | Code |
Comments |
Note that FHIR strings may not exceed 1MB in size |
MedicationStatement.dosage.timing.repeat.when | |
Definition |
A real world event that the occurrence of the event should be tied to. |
Control | 0..1 ? |
Binding |
Real world event that the relating to the schedule. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/event-timing |
Type | Code |
Requirements |
Timings are frequently determined by occurrences such as waking, eating and sleep. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
MedicationStatement.dosage.timing.code | |
Definition |
A code for the timing pattern. Some codes such as BID are ubiquitous, but many institutions define their own additional codes. |
Control | 0..1 ? |
Binding |
Code for a known / defined timing pattern. The codes SHOULD be taken from http://hl7.org/fhir/ValueSet/timing-abbreviation ; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Comments |
A repeat should always be defined except for the common codes BID, TID, QID, AM and PM, which all systems are required to understand. |
MedicationStatement.dosage.timing.code.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.dosage.timing.code.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.dosage.timing.code.coding | |
Definition |
A reference to a code defined by a terminology system. |
Control | 0..* ? |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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 labelled as UserSelected = true. |
MedicationStatement.dosage.timing.code.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.dosage.timing.code.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.dosage.timing.code.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 0..1 ? |
Type | Uri |
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 de-reference to some definition that establish the system clearly and unambiguously. |
MedicationStatement.dosage.timing.code.coding.version | |
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. |
Control | 0..1 ? |
Type | String |
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. |
MedicationStatement.dosage.timing.code.coding.code | |
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). |
Control | 0..1 ? |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
MedicationStatement.dosage.timing.code.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 ? |
Type | String |
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 may not exceed 1MB in size |
MedicationStatement.dosage.timing.code.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
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. |
MedicationStatement.dosage.timing.code.text | |
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. |
Control | 0..1 ? |
Type | String |
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. |
MedicationStatement.dosage.asNeeded[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). Specifically if 'boolean' datatype is selected, then the following logic applies: If set to True, this indicates that the medication is only taken when needed, within the specified schedule. |
Control | 0..1 ? |
Binding | None Specified |
Type | Choice of: |
Comments | |
MedicationStatement.dosage.site[x] | |
Definition |
A coded specification of or a reference to the anatomic site where the medication first enters the body. |
Control | 0..1 ? |
Binding |
A coded concept describing the site location the medicine enters into or onto the body. For example codes, see http://hl7.org/fhir/ValueSet/approach-site-codes ; other codes may be used where these codes are not suitable |
Type | Choice of: |
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. |
MedicationStatement.dosage.route | |
Definition |
A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject. |
Control | 0..1 ? |
Binding |
A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. For example codes, see http://hl7.org/fhir/ValueSet/route-codes ; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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. |
MedicationStatement.dosage.route.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.dosage.route.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.dosage.route.coding | |
Definition |
A reference to a code defined by a terminology system. |
Control | 0..* ? |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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 labelled as UserSelected = true. |
MedicationStatement.dosage.route.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.dosage.route.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.dosage.route.coding.system | |
Definition | |
Control | 0..* |
Comments | |
Fixed Value | http://snomed.info/sct |
MedicationStatement.dosage.route.coding.version | |
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. |
Control | 0..1 ? |
Type | String |
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. |
MedicationStatement.dosage.route.coding.code | |
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). |
Control | 0..1 ? |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
MedicationStatement.dosage.route.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 ? |
Type | String |
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 may not exceed 1MB in size |
MedicationStatement.dosage.route.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
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. |
MedicationStatement.dosage.route.text | |
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. |
Control | 0..1 ? |
Type | String |
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. |
MedicationStatement.dosage.method | |
Definition |
A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV. |
Control | 0..1 ? |
Binding | None Specified |
Type | CodeableConcept |
Comments |
One of the reasons this attribute is not used often, is that the method is often pre-coordinated with the route and/or form of administration. This means the codes used in route or form may pre-coordinate the method in the route code or the form code. The implementation decision about what coding system to use for route or form code will determine how frequently the method code will be populated e.g. if route or form code pre-coordinate method code, then this attribute will not be populated often; if there is no pre-coordination then method code may be used frequently. |
MedicationStatement.dosage.method.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.dosage.method.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.dosage.method.coding | |
Definition |
A reference to a code defined by a terminology system. |
Control | 0..* ? |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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 labelled as UserSelected = true. |
MedicationStatement.dosage.method.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.dosage.method.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.dosage.method.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 0..1 ? |
Type | Uri |
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 de-reference to some definition that establish the system clearly and unambiguously. |
MedicationStatement.dosage.method.coding.version | |
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. |
Control | 0..1 ? |
Type | String |
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. |
MedicationStatement.dosage.method.coding.code | |
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). |
Control | 0..1 ? |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
MedicationStatement.dosage.method.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 ? |
Type | String |
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 may not exceed 1MB in size |
MedicationStatement.dosage.method.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
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. |
MedicationStatement.dosage.method.text | |
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. |
Control | 0..1 ? |
Type | String |
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. |
MedicationStatement.dosage.quantity[x](SimpleQuantity) | |
Definition |
The amount of therapeutic or other substance given at one administration event. |
Control | 0..1 ? |
Type | Choice of: |
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. |
MedicationStatement.dosage.rate[x] | |
Definition |
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. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. |
Control | 0..1 ? |
Type | Choice of: |
Comments | |
MedicationStatement.dosage.maxDosePerPeriod | |
Definition |
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. |
Control | 0..1 ? |
Type | Ratio |
Comments | |
MedicationStatement.dosage.maxDosePerPeriod.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.dosage.maxDosePerPeriod.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.dosage.maxDosePerPeriod.numerator | |
Definition |
The value of the numerator. |
Control | 0..1 ? |
Type | Quantity |
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. |
MedicationStatement.dosage.maxDosePerPeriod.numerator.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.dosage.maxDosePerPeriod.numerator.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.dosage.maxDosePerPeriod.numerator.value | |
Definition |
The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Control | 0..1 ? |
Type | Decimal |
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). |
MedicationStatement.dosage.maxDosePerPeriod.numerator.comparator | |
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. |
Control | 0..1 ? |
Binding |
How the Quantity should be understood and represented. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/quantity-comparator |
Type | Code |
Is Modifier | True |
Requirements |
Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Comments |
This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
MedicationStatement.dosage.maxDosePerPeriod.numerator.unit | |
Definition |
A human-readable form of the unit. |
Control | 0..1 ? |
Type | String |
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 may not exceed 1MB in size |
MedicationStatement.dosage.maxDosePerPeriod.numerator.system | |
Definition |
The identification of the system that provides the coded form of the unit. |
Control | 0..1 ? |
Type | Uri |
Requirements |
Need to know the system that defines the coded form of the unit. |
Comments |
see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
MedicationStatement.dosage.maxDosePerPeriod.numerator.code | |
Definition |
A computer processable form of the unit in some unit representation system. |
Control | 0..1 ? |
Type | Code |
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. |
MedicationStatement.dosage.maxDosePerPeriod.denominator | |
Definition |
The value of the denominator. |
Control | 0..1 ? |
Type | Quantity |
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. |
MedicationStatement.dosage.maxDosePerPeriod.denominator.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MedicationStatement.dosage.maxDosePerPeriod.denominator.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
MedicationStatement.dosage.maxDosePerPeriod.denominator.value | |
Definition |
The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Control | 0..1 ? |
Type | Decimal |
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). |
MedicationStatement.dosage.maxDosePerPeriod.denominator.comparator | |
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. |
Control | 0..1 ? |
Binding |
How the Quantity should be understood and represented. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/quantity-comparator |
Type | Code |
Is Modifier | True |
Requirements |
Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Comments |
This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
MedicationStatement.dosage.maxDosePerPeriod.denominator.unit | |
Definition |
A human-readable form of the unit. |
Control | 0..1 ? |
Type | String |
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 may not exceed 1MB in size |
MedicationStatement.dosage.maxDosePerPeriod.denominator.system | |
Definition |
The identification of the system that provides the coded form of the unit. |
Control | 0..1 ? |
Type | Uri |
Requirements |
Need to know the system that defines the coded form of the unit. |
Comments |
see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
MedicationStatement.dosage.maxDosePerPeriod.denominator.code | |
Definition |
A computer processable form of the unit in some unit representation system. |
Control | 0..1 ? |
Type | Code |
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. |