NAPKON Pediatrics Module
1.0.0 - trial-use
NAPKON Pediatrics Module - Local Development build (v1.0.0). See the Directory of published versions
Definitions for the immunosuppresive-permanent-medication resource profile.
1. MedicationStatement | |
Definition | A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information. |
Control | 0..* |
Comments | When interpreting a medicationStatement, the value of the status and NotTaken needed to be considered: MedicationStatement.status + MedicationStatement.wasNotTaken Status=Active + NotTaken=T = Not currently taking Status=Completed + NotTaken=T = Not taken in the past Status=Intended + NotTaken=T = No intention of taking Status=Active + NotTaken=F = Taking, but not as prescribed Status=Active + NotTaken=F = Taking Status=Intended +NotTaken= F = Will be taking (not started) Status=Completed + NotTaken=F = Taken in past Status=In Error + NotTaken=N/A = In Error. |
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) |
2. 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 | string |
Must Support | true |
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. |
3. MedicationStatement.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Meta |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
4. MedicationStatement.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
5. MedicationStatement.meta.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Alternate Names | 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. |
Invariants | Defined on this element 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()) |
Slicing | This element introduces a set of slices on MedicationStatement.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
6. MedicationStatement.meta.versionId | |
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
7. MedicationStatement.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | instant |
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
8. MedicationStatement.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Must Support | true |
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
9. MedicationStatement.meta.profile | |
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | canonical(StructureDefinition) |
Must Support | true |
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
10. MedicationStatement.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System. |
Type | Coding |
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
11. MedicationStatement.meta.tag | |
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Binding | For example codes, see CommonTags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Type | Coding |
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
12. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Control | 0..1 This element is affected by the following invariants: ele-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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
13. MedicationStatement.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHOULD be taken from CommonLanguages Max Binding: AllLanguages A human language. |
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). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
14. MedicationStatement.text | |
Definition | A human-readable narrative that contains a summary of the resource and can 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 This element is affected by the following invariants: ele-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
15. 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 |
Alternate Names | 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
16. MedicationStatement.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Alternate Names | 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. |
Invariants | Defined on this element 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()) |
Slicing | This element introduces a set of slices on MedicationStatement.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
17. 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 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 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | 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. |
Invariants | Defined on this element 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()) |
Slicing | This element introduces a set of slices on MedicationStatement.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
18. MedicationStatement.identifier | |
Definition | Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Identifier |
Comments | This is a business identifier, not a resource identifier. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
19. MedicationStatement.basedOn | |
Definition | A plan, proposal or order that is fulfilled in whole or in part by this event. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Reference(MedicationRequest | CarePlan | ServiceRequest) |
Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants | Defined on this element 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'))) |
20. MedicationStatement.partOf | |
Definition | A larger event of which this particular event is a component or step. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Requirements | This should not be used when indicating which resource a MedicationStatement has been derived from. If that is the use case, then MedicationStatement.derivedFrom should be used. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants | Defined on this element 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'))) |
21. 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 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from Medication Status Codes A coded concept indicating the current status of a MedicationStatement. |
Type | code |
Is Modifier | true |
Must Support | true |
Comments | MedicationStatement is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for MedicationStatement.status contains codes that assert the status of the use of the medication by the patient (for example, stopped or on hold) as well as codes that assert the status of the medication statement itself (for example, entered in error). This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
22. MedicationStatement.statusReason | |
Definition | Captures the reason for the current state of the MedicationStatement. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Binding | For example codes, see SNOMEDCTDrugTherapyStatusCodes A coded concept indicating the reason for the status of the statement. |
Type | CodeableConcept |
Comments | This is generally only used for "exception" statuses such as "not-taken", "on-hold", "cancelled" or "entered-in-error". The reason for performing the event at all is captured in reasonCode, not here. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
23. MedicationStatement.category | |
Definition | Indicates where the medication is expected to be consumed or administered. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | The codes SHOULD be taken from Medication usage category codes A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
24. MedicationStatement.medication[x] | |
Definition | Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Binding | For example codes, see SNOMEDCTMedicationCodes A coded concept identifying the substance or product being taken. |
Type | CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on MedicationStatement.medication[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
25. MedicationStatement.medication[x]:medicationCodeableConcept | |
SliceName | medicationCodeableConcept |
Definition | Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | For example codes, see SNOMEDCTMedicationCodes A coded concept identifying the substance or product being taken. |
Type | CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
26. MedicationStatement.medication[x]:medicationCodeableConcept.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
27. MedicationStatement.medication[x]:medicationCodeableConcept.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* |
Type | Extension |
Alternate Names | 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. |
Invariants | Defined on this element 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()) |
Slicing | This element introduces a set of slices on MedicationStatement.medication[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
28. MedicationStatement.medication[x]:medicationCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on MedicationStatement.medication[x].coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
29. MedicationStatement.medication[x]:medicationCodeableConcept.coding:sct | |
SliceName | sct |
Definition | A reference to a code defined by a terminology system. |
Control | 0..1 |
Binding | The codes SHALL be taken from Immunosuppressive Permanent Medications |
Type | Coding |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
30. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atc | |
SliceName | atc |
Definition | A reference to a code defined by a terminology system. |
Control | 0..1 |
Binding | The codes SHALL be taken from Immunosuppressive Permanent Medications ATC |
Type | Coding |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
31. MedicationStatement.medication[x]:medicationCodeableConcept.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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
32. MedicationStatement.subject | |
Definition | A reference from one resource to another. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Reference(MII-Reference)(Patient | Group) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) mii-reference-1: Either reference.reference OR reference.identifier exists (: ($this.reference.exists() or ($this.identifier.value.exists() and $this.identifier.system.exists())) xor $this.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()) 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'))) |
33. MedicationStatement.context | |
Definition | The encounter or episode of care that establishes the context for this MedicationStatement. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Reference(Encounter | EpisodeOfCare) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants | Defined on this element 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'))) |
34. MedicationStatement.effective[x] | |
Definition | The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No). |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Choice of: dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
35. MedicationStatement.dateAsserted | |
Definition | The date when the medication statement was asserted by the information source. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | dateTime |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
36. MedicationStatement.informationSource | |
Definition | The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants | Defined on this element 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'))) |
37. MedicationStatement.derivedFrom | |
Definition | Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Reference(Resource) |
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. |
Invariants | Defined on this element 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'))) |
38. MedicationStatement.reasonCode | |
Definition | A reason for why the medication is being/was taken. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Binding | For example codes, see Condition/Problem/DiagnosisCodes A coded concept identifying why the medication is being taken. |
Type | CodeableConcept |
Comments | This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
39. MedicationStatement.reasonReference | |
Definition | Condition or observation that supports why the medication is being/was taken. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Reference(Condition | Observation | DiagnosticReport) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
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. |
Invariants | Defined on this element 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'))) |
40. MedicationStatement.note | |
Definition | Provides extra information about the medication statement that is not conveyed by the other attributes. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Annotation |
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). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
41. MedicationStatement.dosage | |
Definition | Indicates how the medication is/was or should be taken by the patient. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Dosage |
Must Support | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
42. MedicationStatement.dosage.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
43. MedicationStatement.dosage.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Alternate Names | 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. |
Invariants | Defined on this element 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()) |
Slicing | This element introduces a set of slices on MedicationStatement.dosage.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
44. 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 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). |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | 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. |
Invariants | Defined on this element 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()) |
45. MedicationStatement.dosage.sequence | |
Definition | Indicates the order in which the dosage instructions should be applied or interpreted. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | integer |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
46. MedicationStatement.dosage.text | |
Definition | Free text dosage instructions e.g. SIG. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Must Support | true |
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 |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
47. MedicationStatement.dosage.additionalInstruction | |
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"). |
Control | 0..* This element is affected by the following invariants: ele-1 |
Binding | For example codes, see SNOMEDCTAdditionalDosageInstructions A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". |
Type | CodeableConcept |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
48. MedicationStatement.dosage.patientInstruction | |
Definition | Instructions in terms that are understood by the patient or consumer. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
49. MedicationStatement.dosage.timing | |
Definition | When medication should be administered. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Timing |
Must Support | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
50. 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). |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | For example codes, see SNOMEDCTMedicationAsNeededReasonCodes 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. |
Type | Choice of: boolean, CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
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". |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
51. MedicationStatement.dosage.site | |
Definition | Body site to administer to. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | For example codes, see SNOMEDCTAnatomicalStructureForAdministrationSiteCodes A coded concept describing the site location the medicine enters into or onto the body. |
Type | CodeableConcept |
Must Support | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
52. MedicationStatement.dosage.site.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
53. MedicationStatement.dosage.site.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Alternate Names | 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. |
Invariants | Defined on this element 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()) |
Slicing | This element introduces a set of slices on MedicationStatement.dosage.site.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
54. MedicationStatement.dosage.site.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Coding |
Must Support | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on MedicationStatement.dosage.site.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
55. MedicationStatement.dosage.site.coding:SNOMED | |
SliceName | SNOMED |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Binding | For example codes, see Target Site - IPS target site IPS |
Type | Coding |
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. |
Pattern Value | <valueCoding xmlns="http://hl7.org/fhir"> <system value="http://snomed.info/sct"/> </valueCoding> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
56. MedicationStatement.dosage.site.coding:SNOMED.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
57. MedicationStatement.dosage.site.coding:SNOMED.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Alternate Names | 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. |
Invariants | Defined on this element 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()) |
Slicing | This element introduces a set of slices on MedicationStatement.dosage.site.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
58. MedicationStatement.dosage.site.coding:SNOMED.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Must Support | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
59. MedicationStatement.dosage.site.coding:SNOMED.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. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 This element is affected by the following invariants: ele-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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
60. MedicationStatement.dosage.site.coding:SNOMED.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 | 1..1 This element is affected by the following invariants: ele-1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
61. MedicationStatement.dosage.site.coding:SNOMED.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 This element is affected by the following invariants: ele-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 SHALL NOT exceed 1MB in size |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
62. MedicationStatement.dosage.site.coding:SNOMED.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 This element is affected by the following invariants: ele-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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
63. MedicationStatement.dosage.site.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 This element is affected by the following invariants: ele-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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
64. MedicationStatement.dosage.route | |
Definition | How drug should enter body. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | For example codes, see SNOMEDCTRouteCodes A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. |
Type | CodeableConcept |
Must Support | true |
Requirements | A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
65. MedicationStatement.dosage.route.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
66. MedicationStatement.dosage.route.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Alternate Names | 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. |
Invariants | Defined on this element 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()) |
Slicing | This element introduces a set of slices on MedicationStatement.dosage.route.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
67. MedicationStatement.dosage.route.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Coding |
Must Support | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on MedicationStatement.dosage.route.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
68. MedicationStatement.dosage.route.coding:EDQM | |
SliceName | EDQM |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Binding | The codes SHOULD be taken from Medicine Route of Administration - IPS EDQM Standard Terms |
Type | Coding |
Must Support | true |
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. |
Pattern Value | <valueCoding xmlns="http://hl7.org/fhir"> <system value="http://standardterms.edqm.eu"/> </valueCoding> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
69. MedicationStatement.dosage.route.coding:EDQM.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
70. MedicationStatement.dosage.route.coding:EDQM.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Alternate Names | 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. |
Invariants | Defined on this element 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()) |
Slicing | This element introduces a set of slices on MedicationStatement.dosage.route.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
71. MedicationStatement.dosage.route.coding:EDQM.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Must Support | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
72. MedicationStatement.dosage.route.coding:EDQM.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. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 This element is affected by the following invariants: ele-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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
73. MedicationStatement.dosage.route.coding:EDQM.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 | 1..1 This element is affected by the following invariants: ele-1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
74. MedicationStatement.dosage.route.coding:EDQM.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 This element is affected by the following invariants: ele-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 SHALL NOT exceed 1MB in size |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
75. MedicationStatement.dosage.route.coding:EDQM.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 This element is affected by the following invariants: ele-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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
76. MedicationStatement.dosage.route.coding:SNOMED | |
SliceName | SNOMED |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Coding |
Must Support | true |
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. |
Pattern Value | <valueCoding xmlns="http://hl7.org/fhir"> <system value="http://snomed.info/sct"/> </valueCoding> |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
77. MedicationStatement.dosage.route.coding:SNOMED.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
78. MedicationStatement.dosage.route.coding:SNOMED.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Alternate Names | 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. |
Invariants | Defined on this element 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()) |
Slicing | This element introduces a set of slices on MedicationStatement.dosage.route.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
79. MedicationStatement.dosage.route.coding:SNOMED.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | uri |
Must Support | true |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
80. MedicationStatement.dosage.route.coding:SNOMED.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. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 This element is affected by the following invariants: ele-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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
81. MedicationStatement.dosage.route.coding:SNOMED.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 | 1..1 This element is affected by the following invariants: ele-1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
82. MedicationStatement.dosage.route.coding:SNOMED.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 This element is affected by the following invariants: ele-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 SHALL NOT exceed 1MB in size |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
83. MedicationStatement.dosage.route.coding:SNOMED.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Control | 0..1 This element is affected by the following invariants: ele-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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
84. 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 This element is affected by the following invariants: ele-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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
85. MedicationStatement.dosage.method | |
Definition | Technique for administering medication. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | For example codes, see SNOMEDCTAdministrationMethodCodes A coded concept describing the technique by which the medicine is administered. |
Type | CodeableConcept |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
86. MedicationStatement.dosage.doseAndRate | |
Definition | The amount of medication administered. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Element |
Must Support | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
87. MedicationStatement.dosage.doseAndRate.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
88. MedicationStatement.dosage.doseAndRate.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
Alternate Names | 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. |
Invariants | Defined on this element 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()) |
Slicing | This element introduces a set of slices on MedicationStatement.dosage.doseAndRate.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
89. MedicationStatement.dosage.doseAndRate.type | |
Definition | The kind of dose or rate specified, for example, ordered or calculated. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Binding | For example codes, see DoseAndRateType The kind of dose or rate specified. |
Type | CodeableConcept |
Requirements | If the type is not populated, assume to be "ordered". |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
90. MedicationStatement.dosage.doseAndRate.dose[x] | |
Definition | Amount of medication per dose. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Choice of: Range, Quantity(SimpleQuantity) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) rng-2: If present, low SHALL have a lower value than high (: low.empty() or high.empty() or (low <= high)) |
91. MedicationStatement.dosage.doseAndRate.rate[x] | |
Definition | Amount of medication per unit of time. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Choice of: Ratio, Range, Quantity(SimpleQuantity) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
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. |
Invariants | Defined on this element 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())) |
92. MedicationStatement.dosage.maxDosePerPeriod | |
Definition | Upper limit on medication per unit of time. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Ratio |
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". |
Invariants | Defined on this element 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())) |
93. MedicationStatement.dosage.maxDosePerAdministration | |
Definition | Upper limit on medication per administration. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Quantity(SimpleQuantity) |
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. |
Invariants | Defined on this element 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()) |
94. MedicationStatement.dosage.maxDosePerLifetime | |
Definition | Upper limit on medication per lifetime of the patient. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Quantity(SimpleQuantity) |
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. |
Invariants | Defined on this element 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()) |