| CareConnect-GPC-MedicationStatement-1 (MedicationStatement) | C | | MedicationStatement | There are no (further) constraints on this element Element idMedicationStatement Short descriptionRecord of medication being taken by a patient DefinitionA 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.
CommentsWhen 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.
Data typeMedicationStatement Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty() - mst-1: Reason not taken is only permitted if Taken is No
reasonNotTaken.exists().not() or (taken = 'n') Mappings- rim: Entity. Role, or Act
- workflow: ..Event
- rim: SubstanceAdministration
- w5: clinical.medication
|
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idMedicationStatement.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data typeid ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idMedicationStatement.meta Short descriptionMetadata about the resource DefinitionThe 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.
Data typeMeta ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.meta.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.meta.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idMedicationStatement.meta.versionId Short descriptionVersion specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.
CommentsThe server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
Data typeid ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idMedicationStatement.meta.lastUpdated Short descriptionWhen the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed.
CommentsThis 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.
Data typeinstant ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| profile | Σ | 1..* | uri | There are no (further) constraints on this element Element idMedicationStatement.meta.profile Short descriptionProfiles this resource claims to conform to DefinitionCommentsIt 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.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idMedicationStatement.meta.security Short descriptionSecurity Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
CommentsThe 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.
Data typeCoding BindingSecurity Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idMedicationStatement.meta.tag Short descriptionTags applied to this resource DefinitionTags 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.
CommentsThe 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.
Data typeCoding BindingCodes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" Common Tags (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idMedicationStatement.implicitRules Short descriptionA set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
CommentsAsserting 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.
This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedicationStatement.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
CommentsLanguage 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).
Data typecode BindingA human language. Common Languages (extensible) Binding extensionsConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idMedicationStatement.text Short descriptionText summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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.
CommentsContained 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 in formation is added later.
Data typeNarrative ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, dom-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- rim: N/A
- rim: Act.text?
|
| contained | | 0..* | Resource | There are no (further) constraints on this element Element idMedicationStatement.contained Short descriptionContained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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.
CommentsThis 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.
Data typeResource Mappings- rim: Entity. Role, or Act
- rim: N/A
|
| extension | C | 1..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| lastIssueDate | S C | 0..1 | Extension(dateTime) | There are no (further) constraints on this element Element idMedicationStatement.extension:lastIssueDate Short descriptionThe date a prescription was last issued Alternate namesextensions, user content DefinitionThe date a prescription was last issued.
CommentsThere 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.
Data typeExtension(dateTime) Extension URLhttps://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-MedicationStatementLastIssueDate-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.extension:lastIssueDate.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:lastIssueDate.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idMedicationStatement.extension:lastIssueDate.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Fixed valuehttps://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-MedicationStatementLastIssueDate-1 Mappings |
| valueDateTime | | 0..1 | dateTime | There are no (further) constraints on this element Element idMedicationStatement.extension:lastIssueDate.value[x]:valueDateTime Short descriptionThe date a prescription was last issued DefinitionThe date a prescription was last issued.
Data typedateTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.extension:lastIssueDate.value[x]:valueDateTime.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:lastIssueDate.value[x]:valueDateTime.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| value | | 0..1 | | There are no (further) constraints on this element Element idMedicationStatement.extension:lastIssueDate.value[x]:valueDateTime.value Short descriptionPrimitive value for dateTime DefinitionPrimitive value for dateTime
|
| changeSummary | C | 0..1 | Extension(Complex) | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary Short descriptionOptional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources.
CommentsThere 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.
Data typeExtension(Complex) Extension URLhttps://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-MedicationChangeSummary-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| status | C | 0..1 | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:status Short descriptionThe change status of a medication Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:status.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:status.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:status.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Fixed valuestatus Mappings |
| valueCode | | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:status.value[x]:valueCode Short descriptionThe change status of a medication. DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Data typecode BindingA ValueSet to identify the change status of a medication. Care Connect Medication Change Status (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:status.value[x]:valueCode.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:status.value[x]:valueCode.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| value | | 0..1 | | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:status.value[x]:valueCode.value Short descriptionPrimitive value for code DefinitionMaximum string length1048576 |
| indicationForChange | C | 0..1 | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:indicationForChange Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:indicationForChange.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:indicationForChange.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:indicationForChange.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Fixed valueindicationForChange Mappings |
| valueCodeableConcept | | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:indicationForChange.value[x]:valueCodeableConcept Short descriptionValue of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Data typeCodeableConcept ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:indicationForChange.value[x]:valueCodeableConcept.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:indicationForChange.value[x]:valueCodeableConcept.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:indicationForChange.value[x]:valueCodeableConcept.coding Short descriptionCode defined by a terminology system DefinitionA reference to a code defined by a terminology system.
RequirementsAllows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
CommentsCodes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Data typeCoding ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
- v2: C*E.1-8, C*E.10-22
- rim: union(., ./translation)
- orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:indicationForChange.value[x]:valueCodeableConcept.text Short descriptionPlain text representation of the concept DefinitionA 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.
RequirementsThe 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.
CommentsVery often the text is the same as a displayName of one of the codings.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: C*E.9. But note many systems use C*E.2 for this
- rim: ./originalText[mediaType/code="text/plain"]/data
- orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
|
| dateChanged | C | 0..1 | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:dateChanged Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:dateChanged.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:dateChanged.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:dateChanged.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Fixed valuedateChanged Mappings |
| valueDateTime | | 0..1 | dateTime | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:dateChanged.value[x]:valueDateTime Short descriptionValue of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Data typedateTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:dateChanged.value[x]:valueDateTime.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:dateChanged.value[x]:valueDateTime.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| value | | 0..1 | | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:dateChanged.value[x]:valueDateTime.value Short descriptionPrimitive value for dateTime DefinitionPrimitive value for dateTime
|
| detailsOfAmendment | C | 0..1 | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:detailsOfAmendment Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:detailsOfAmendment.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:detailsOfAmendment.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:detailsOfAmendment.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Fixed valuedetailsOfAmendment Mappings |
| valueString | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:detailsOfAmendment.value[x]:valueString Short descriptionValue of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:detailsOfAmendment.value[x]:valueString.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:detailsOfAmendment.value[x]:valueString.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| value | | 0..1 | | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.extension:detailsOfAmendment.value[x]:valueString.value Short descriptionPrimitive value for string DefinitionPrimitive value for string
Maximum string length1048576 |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Fixed valuehttps://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-MedicationChangeSummary-1 Mappings |
| value[x] | | 0..0 | | There are no (further) constraints on this element Element idMedicationStatement.extension:changeSummary.value[x] Short descriptionValue of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| prescribingAgency | C | 1..1 | Extension(CodeableConcept) | There are no (further) constraints on this element Element idMedicationStatement.extension:prescribingAgency Short descriptionThe type of organisation/setting responsible for authorising and issuing the medication Alternate namesextensions, user content DefinitionThe type of organisation/setting responsible for authorising and issuing the medication.
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-PrescribingAgency-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.extension:prescribingAgency.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:prescribingAgency.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idMedicationStatement.extension:prescribingAgency.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Fixed valuehttps://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-PrescribingAgency-1 Mappings |
| valueCodeableConcept | | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationStatement.extension:prescribingAgency.value[x]:valueCodeableConcept Short descriptionThe type of organisation/setting responsible for authorising and issuing medication outside of a GP system DefinitionThe type of organisation/setting responsible for authorising and issuing medication outside of a GP system.
Data typeCodeableConcept BindingCare Connect Prescribing Agency (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.extension:prescribingAgency.value[x]:valueCodeableConcept.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:prescribingAgency.value[x]:valueCodeableConcept.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idMedicationStatement.extension:prescribingAgency.value[x]:valueCodeableConcept.coding Short descriptionCode defined by a terminology system DefinitionA reference to a code defined by a terminology system.
RequirementsAllows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
CommentsCodes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Data typeCoding ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
- v2: C*E.1-8, C*E.10-22
- rim: union(., ./translation)
- orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.extension:prescribingAgency.value[x]:valueCodeableConcept.text Short descriptionPlain text representation of the concept DefinitionA 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.
RequirementsThe 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.
CommentsVery often the text is the same as a displayName of one of the codings.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: C*E.9. But note many systems use C*E.2 for this
- rim: ./originalText[mediaType/code="text/plain"]/data
- orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
|
| dosageLastChanged | C | 0..1 | Extension(dateTime) | There are no (further) constraints on this element Element idMedicationStatement.extension:dosageLastChanged Short descriptionThe date when the dosage instructions were last changed Alternate namesextensions, user content DefinitionOnly populate where the dosage instructions have been changed during the lifetime of the Medication/Medical Device plan.
Set to the date when the dosage instructions were last changed.
CommentsThere 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.
Data typeExtension(dateTime) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationDosageLastChanged-1 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.extension:dosageLastChanged.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.extension:dosageLastChanged.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idMedicationStatement.extension:dosageLastChanged.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Fixed valuehttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationDosageLastChanged-1 Mappings |
| value[x] | | 0..1 | | There are no (further) constraints on this element Element idMedicationStatement.extension:dosageLastChanged.value[x] Short descriptionValue of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| valueAddress | | | Address | There are no (further) constraints on this element Data typeAddress |
| valueAge | | | Age | There are no (further) constraints on this element Data typeAge |
| valueAnnotation | | | Annotation | There are no (further) constraints on this element Data typeAnnotation |
| valueAttachment | | | Attachment | There are no (further) constraints on this element Data typeAttachment |
| valueBase64Binary | | | base64Binary | There are no (further) constraints on this element Data typebase64Binary |
| valueBoolean | | | boolean | There are no (further) constraints on this element Data typeboolean |
| valueCode | | | code | There are no (further) constraints on this element Data typecode |
| valueCodeableConcept | | | CodeableConcept | There are no (further) constraints on this element Data typeCodeableConcept |
| valueCoding | | | Coding | There are no (further) constraints on this element Data typeCoding |
| valueContactPoint | | | ContactPoint | There are no (further) constraints on this element Data typeContactPoint |
| valueCount | | | Count | There are no (further) constraints on this element Data typeCount |
| valueDate | | | date | There are no (further) constraints on this element Data typedate |
| valueDateTime | | | dateTime | There are no (further) constraints on this element Data typedateTime |
| valueDecimal | | | decimal | There are no (further) constraints on this element Data typedecimal |
| valueDistance | | | Distance | There are no (further) constraints on this element Data typeDistance |
| valueDuration | | | Duration | There are no (further) constraints on this element Data typeDuration |
| valueHumanName | | | HumanName | There are no (further) constraints on this element Data typeHumanName |
| valueId | | | id | There are no (further) constraints on this element Data typeid |
| valueIdentifier | | | Identifier | There are no (further) constraints on this element Data typeIdentifier |
| valueInstant | | | instant | There are no (further) constraints on this element Data typeinstant |
| valueInteger | | | integer | There are no (further) constraints on this element Data typeinteger |
| valueMarkdown | | | markdown | There are no (further) constraints on this element Data typemarkdown |
| valueMeta | | | Meta | There are no (further) constraints on this element Data typeMeta |
| valueMoney | | | Money | There are no (further) constraints on this element Data typeMoney |
| valueOid | | | oid | There are no (further) constraints on this element Data typeoid |
| valuePeriod | | | Period | There are no (further) constraints on this element Data typePeriod |
| valuePositiveInt | | | positiveInt | There are no (further) constraints on this element Data typepositiveInt |
| valueQuantity | | | Quantity | There are no (further) constraints on this element Data typeQuantity |
| valueRange | | | Range | There are no (further) constraints on this element Data typeRange |
| valueRatio | | | Ratio | There are no (further) constraints on this element Data typeRatio |
| valueReference | | | Reference | There are no (further) constraints on this element Data typeReference |
| valueSampledData | | | SampledData | There are no (further) constraints on this element Data typeSampledData |
| valueSignature | | | Signature | There are no (further) constraints on this element Data typeSignature |
| valueString | | | string | There are no (further) constraints on this element Data typestring |
| valueTime | | | time | There are no (further) constraints on this element Data typetime |
| valueTiming | | | Timing | There are no (further) constraints on this element Data typeTiming |
| valueUnsignedInt | | | unsignedInt | There are no (further) constraints on this element Data typeunsignedInt |
| valueUri | | | uri | There are no (further) constraints on this element Data typeuri |
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| identifier | Σ | 1..* | Identifier | There are no (further) constraints on this element Element idMedicationStatement.identifier Short descriptionExternal identifier DefinitionExternal identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.
Data typeIdentifier ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim: II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd: Identifier
- workflow: …identifer
- rim: .id
- w5: id
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.identifier.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.identifier.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idMedicationStatement.identifier.use Short descriptionusual | official | temp | secondary (If known) DefinitionThe purpose of this identifier.
RequirementsAllows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
CommentsThis 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.
Data typecode BindingIdentifies the purpose for this identifier, if known . IdentifierUse (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: N/A
- rim: Role.code or implied by context
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationStatement.identifier.type Short descriptionDescription of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
RequirementsAllows users to make use of identifiers when the identifier system is not known.
CommentsThis 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.
Data typeCodeableConcept BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2: CX.5
- rim: Role.code or implied by context
|
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idMedicationStatement.identifier.system Short descriptionThe namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.
RequirementsThere are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Commentssee http://en.wikipedia.org/wiki/Uniform_resource_identifier
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Examples Generalhttp://www.acme.com/identifiers/patient Mappings- rim: n/a
- v2: CX.4 / EI-2-4
- rim: II.root or Role.id.root
- servd: ./IdentifierType
|
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idMedicationStatement.identifier.value Short descriptionThe value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
CommentsIf the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Examples General123456 Mappings- rim: n/a
- v2: CX.1 / EI.1
- rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd: ./Value
|
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idMedicationStatement.identifier.period Short descriptionTime period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
CommentsThis 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.
Data typePeriod ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end) Mappings- rim: n/a
- v2: DR
- rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2: CX.7 + CX.8
- rim: Role.effectiveTime or implied by context
- servd: ./StartDate and ./EndDate
|
| assigner | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idMedicationStatement.identifier.assigner Short descriptionOrganization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier.
CommentsThe Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data typeReference(Organization) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (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 %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: CX.4 / (CX.4,CX.9,CX.10)
- rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd: ./IdentifierIssuingAuthority
|
| basedOn | Σ C | 0..1 | Reference(CarePlan | ProcedureRequest | ReferralRequest | CareConnect-GPC-MedicationRequest-1) | There are no (further) constraints on this element Element idMedicationStatement.basedOn Short descriptionFulfils plan, proposal or order DefinitionA plan, proposal or order that is fulfilled in whole or in part by this event.
RequirementsAllows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.
CommentsReferences 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.
Data typeReference(CarePlan | ProcedureRequest | ReferralRequest | CareConnect-GPC-MedicationRequest-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (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 %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow: …basedOn
- rim: .outboundRelationship[typeCode=FLFS].target[classCode=SBADM or PROC or PCPR or OBS, moodCode=RQO orPLAN or PRP]
|
| partOf | Σ C | 0..* | Reference(MedicationAdministration | MedicationDispense | CareConnect-Observation-1 | CareConnect-Procedure-1 | CareConnect-GPC-MedicationStatement-1) | There are no (further) constraints on this element Element idMedicationStatement.partOf Short descriptionPart of referenced event DefinitionA larger event of which this particular event is a component or step.
RequirementsThis 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.
CommentsReferences 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.
Data typeReference(MedicationAdministration | MedicationDispense | CareConnect-Observation-1 | CareConnect-Procedure-1 | CareConnect-GPC-MedicationStatement-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (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 %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow: …part of
- rim: .outboundRelationship[typeCode=COMP]/target[classCode=SPLY or SBADM or PROC or OBS,moodCode=EVN]
|
| context | S Σ C | 0..1 | Reference(EpisodeOfCare | CareConnect-Encounter-1) | There are no (further) constraints on this element Element idMedicationStatement.context Short descriptionEncounter / Episode associated with MedicationStatement DefinitionThe encounter or episode of care that establishes the context for this MedicationStatement.
CommentsReferences 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.
Data typeReference(EpisodeOfCare | CareConnect-Encounter-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (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 %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow: …context
- rim: .inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code="type of encounter or episode"]
|
| status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idMedicationStatement.status Short descriptionactive | completed | entered-in-error | intended | stopped | on-hold DefinitionA 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.
CommentsMedicationStatement 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.
Data typecode BindingA coded concept indicating the current status of a MedicationStatement. MedicationStatementStatus (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- workflow: …status
- rim: .statusCode
- w5: status
|
| category | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idMedicationStatement.category Short descriptionType of medication usage DefinitionIndicates where type of medication statement and where the medication is expected to be consumed or administered.
CommentsNot all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data typeCodeableConcept BindingA coded concept identifying where the medication included in the medicationstatement is expected to be consumed or administered MedicationStatementCategory (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim: .inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code="type of medication usage"].value
- w5: class
|
| medication[x] | Σ | 1..1 | | There are no (further) constraints on this element Element idMedicationStatement.medication[x] Short descriptionWhat medication was taken DefinitionIdentifies 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.
CommentsIf 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. .
BindingA coded concept identifying the substance or product being taken. SNOMED CT Medication Codes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- workflow: …code
- rim: .participation[typeCode=CSM].role[classCode=ADMM or MANU]
- w5: what
|
| medicationCodeableConcept | | | CodeableConcept | There are no (further) constraints on this element Data typeCodeableConcept |
| medicationReference | | | Reference(CareConnect-GPC-Medication-1) | There are no (further) constraints on this element Data typeReference(CareConnect-GPC-Medication-1) |
| effective[x] | S Σ | 0..1 | | There are no (further) constraints on this element Element idMedicationStatement.effective[x] Short descriptionThe date/time or interval when the medication was taken DefinitionThe 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).
CommentsThis 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.
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- workflow: …occurrence[x]
- rim: .effectiveTime
- w5: when.done
|
| effectiveDateTime | | | dateTime | There are no (further) constraints on this element Data typedateTime |
| effectivePeriod | | | Period | There are no (further) constraints on this element Data typePeriod |
| dateAsserted | Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idMedicationStatement.dateAsserted Short descriptionWhen the statement was asserted? DefinitionThe date when the medication statement was asserted by the information source.
Data typedateTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- rim: .participation[typeCode=AUT].time
- w5: when.recorded
|
| informationSource | C | 0..1 | Reference(RelatedPerson | CareConnect-GPC-Organization-1 | CareConnect-GPC-Patient-1 | CareConnect-GPC-Practitioner-1) | There are no (further) constraints on this element Element idMedicationStatement.informationSource Short descriptionPerson or organization that provided the information about the taking of this medication DefinitionThe 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.
CommentsReferences 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.
Data typeReference(RelatedPerson | CareConnect-GPC-Organization-1 | CareConnect-GPC-Patient-1 | CareConnect-GPC-Practitioner-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (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 %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- rim: .participation[typeCode=INF].role[classCode=PAT, or codes for Practioner or Related Person (if PAT is the informer, then syntax for self-reported =true)
- w5: who.source
|
| subject | Σ C | 1..1 | Reference(Group | CareConnect-GPC-Patient-1) | There are no (further) constraints on this element Element idMedicationStatement.subject Short descriptionWho is/was taking the medication DefinitionThe person, animal or group who is/was taking the medication.
CommentsReferences 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.
Data typeReference(Group | CareConnect-GPC-Patient-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (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 %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow: …subject
- v2: PID-3-Patient ID List
- rim: .participation[typeCode=SBJ].role[classCode=PAT]
- w5: who
|
| derivedFrom | C | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idMedicationStatement.derivedFrom Short descriptionAdditional supporting information DefinitionAllows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.
CommentsLikely references would be to MedicationRequest, MedicationDispense, Claim, Observation or QuestionnaireAnswers. The most common use cases for deriving a MedicationStatement comes from creating a MedicationStatement from a MedicationRequest or from a lab observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the MedicationStatement from.
Data typeReference(Resource) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (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 %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- rim: .outboundRelationship[typeCode=SPRT]/target[classCode=ACT,moodCode=EVN]
|
| taken | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idMedicationStatement.taken Short descriptiony | n | unk | na DefinitionIndicator of the certainty of whether the medication was taken by the patient.
CommentsThis element is labeled as a modifier because it indicates that the medication was not taken.
Data typecode BindingA coded concept identifying level of certainty if patient has taken or has not taken the medication MedicationStatementTaken (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- workflow: …notDone
- rim: .actionNegationInd
|
| reasonNotTaken | C | 0..* | CodeableConcept | There are no (further) constraints on this element Element idMedicationStatement.reasonNotTaken Short descriptionTrue if asserting medication was not given DefinitionA code indicating why the medication was not taken.
CommentsNot all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data typeCodeableConcept BindingA coded concept indicating the reason why the medication was not taken SNOMED CT Drugs not taken/completed Codes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, mst-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim: .outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code="reason not taken"].value
|
| reasonCode | | 0..* | CodeableConcept | There are no (further) constraints on this element Element idMedicationStatement.reasonCode Short descriptionReason for why the medication is being/was taken DefinitionA reason for why the medication is being/was taken.
CommentsThis could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference.
Data typeCodeableConcept BindingA coded concept identifying why the medication is being taken. Condition/Problem/Diagnosis Codes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow: …reasoneCodeableConcept
- rim: .reasonCode
- w5: why
|
| reasonReference | C | 0..* | Reference(CareConnect-Condition-1 | CareConnect-Observation-1) | There are no (further) constraints on this element Element idMedicationStatement.reasonReference Short descriptionCondition or observation that supports why the medication is being/was taken DefinitionCondition or observation that supports why the medication is being/was taken.
CommentsThis is a reference to a condition that is the reason why the medication is being/was taken. If only a code exists, use reasonForUseCode.
Data typeReference(CareConnect-Condition-1 | CareConnect-Observation-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (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 %resource.contained.id.trace('ids')) Mappings- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow: …reasonReference
- rim: .outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code="reason for use"].value
- w5: why
|
| note | S | 0..* | Annotation | There are no (further) constraints on this element Element idMedicationStatement.note Short descriptionFurther information about the statement DefinitionProvides extra information about the medication statement that is not conveyed by the other attributes.
CommentsFor systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
Data typeAnnotation ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: N/A
- rim: Act
- workflow: …note
- rim: .inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code="annotation"].value
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.note.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.note.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| author[x] | Σ | 0..1 | | There are no (further) constraints on this element Element idMedicationStatement.note.author[x] Short descriptionIndividual responsible for the annotation DefinitionThe individual responsible for making the annotation.
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: N/A
- rim: Act.participant[typeCode=AUT].role
|
| authorReference | | | Reference(RelatedPerson | CareConnect-GPC-Patient-1 | CareConnect-GPC-Practitioner-1) | There are no (further) constraints on this element Data typeReference(RelatedPerson | CareConnect-GPC-Patient-1 | CareConnect-GPC-Practitioner-1) |
| authorString | | | string | There are no (further) constraints on this element Data typestring |
| time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idMedicationStatement.note.time Short descriptionWhen the annotation was made DefinitionIndicates when this particular annotation was made.
Data typedateTime ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: N/A
- rim: Act.effectiveTime
|
| text | | 1..1 | string | There are no (further) constraints on this element Element idMedicationStatement.note.text Short descriptionThe annotation - text content DefinitionThe text of the annotation.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: N/A
- rim: Act.text
|
| dosage | | 1..* | Dosage | There are no (further) constraints on this element Element idMedicationStatement.dosage Short descriptionDetails of how medication is/was taken or should be taken DefinitionIndicates how the medication is/was or should be taken by the patient.
CommentsThe dates included in the dosage on a Medication Statement reflect the dates for a given dose. For example, "from November 1, 2016 to November 3, 2016, take one tablet daily and from November 4, 2016 to November 7, 2016, take two tablets daily." It is expected that this specificity may only be populated where the patient brings in their labeled container or where the Medication Statement is derived from a MedicationRequest.
Data typeDosage ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- rim: .outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]
- rim: refer dosageInstruction mapping
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.dosage.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.dosage.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| sequence | Σ | 0..1 | integer | There are no (further) constraints on this element Element idMedicationStatement.dosage.sequence Short descriptionThe order of the dosage instructions DefinitionIndicates the order in which the dosage instructions should be applied or interpreted.
RequirementsIf 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.
Comments32 bit number; for values larger than this, use decimal
Data typeinteger ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| text | Σ | 1..1 | string | There are no (further) constraints on this element Element idMedicationStatement.dosage.text Short descriptionFree text dosage instructions e.g. SIG DefinitionFree text dosage instructions e.g. SIG.
RequirementsFree 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.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| additionalInstruction | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idMedicationStatement.dosage.additionalInstruction Short descriptionSupplemental instruction - e.g. "with meals" DefinitionSupplemental instruction - e.g. "with meals".
RequirementsAdditional instruction such as "Swallow with plenty of water" which may or may not be coded.
CommentsNot all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data typeCodeableConcept BindingA coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". SNOMED CT Additional Dosage Instructions (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim: .text
|
| patientInstruction | S Σ | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.dosage.patientInstruction Short descriptionPatient or consumer oriented instructions DefinitionInstructions in terms that are understood by the patient or consumer.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| timing | Σ | 0..1 | Timing | There are no (further) constraints on this element Element idMedicationStatement.dosage.timing Short descriptionWhen medication should be administered DefinitionWhen medication should be administered.
RequirementsThe 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". 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.
CommentsThis attribute may not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing.
Data typeTiming ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: N/A
- rim: QSET<TS> (GTS)
- rim: .effectiveTime
|
| asNeeded[x] | Σ | 0..1 | | There are no (further) constraints on this element Element idMedicationStatement.dosage.asNeeded[x] Short descriptionTake "as needed" (for x) DefinitionIndicates 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).
CommentsCan 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".
BindingA 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. SNOMED CT Medication As Needed Reason Codes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- rim: .outboundRelationship[typeCode=PRCN].target[classCode=OBS, moodCode=EVN, code="as needed"].value=boolean or codable concept
|
| asNeededBoolean | | | boolean | There are no (further) constraints on this element Data typeboolean |
| asNeededCodeableConcept | | | CodeableConcept | There are no (further) constraints on this element Data typeCodeableConcept |
| site | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idMedicationStatement.dosage.site Short descriptionBody site to administer to DefinitionBody site to administer to.
RequirementsA coded specification of the anatomic site where the medication first enters the body.
CommentsIf the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension body-site-instance. May be a summary code, or a reference to a very precise definition of the location, or both.
Data typeCodeableConcept BindingA coded concept describing the site location the medicine enters into or onto the body. SNOMED CT Anatomical Structure for Administration Site Codes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim: .approachSiteCode
|
| route | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idMedicationStatement.dosage.route Short descriptionHow drug should enter body DefinitionHow drug should enter body.
RequirementsA code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.
CommentsNot all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Data typeCodeableConcept BindingA coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. SNOMED CT Route Codes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim: .routeCode
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding Short descriptionCode defined by a terminology system DefinitionA reference to a code defined by a terminology system.
RequirementsAllows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
CommentsCodes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Data typeCoding SlicingUnordered, Open, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
- v2: C*E.1-8, C*E.10-22
- rim: union(., ./translation)
- orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
| snomedCT | Σ | 0..1 | Coding | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT Short descriptionCode defined by a terminology system DefinitionA reference to a code defined by a terminology system.
RequirementsAllows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
CommentsCodes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Data typeCoding BindingA code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration. Care Connect Medication Dosage Route (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
- rim: CV
- orim: fhir:Coding rdfs:subClassOf dt:CDCoding
- v2: C*E.1-8, C*E.10-22
- rim: union(., ./translation)
- orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| snomedCTDescriptionID | C | 0..1 | Extension(Complex) | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID Short descriptionThe SNOMED CT Description ID for the display Alternate namesextensions, user content DefinitionThe SNOMED CT Description ID for the display.
CommentsThere 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.
Data typeExtension(Complex) Extension URLhttps://fhir.nhs.uk/STU3/StructureDefinition/Extension-coding-sctdescid ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 1..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| descriptionId | C | 1..1 | Extension | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId Short descriptionThe SNOMED CT Description ID Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Fixed valuedescriptionId Mappings |
| valueId | | 0..1 | id | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.value[x]:valueId Short descriptionThe SNOMED CT Description ID DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Data typeid ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.value[x]:valueId.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.value[x]:valueId.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| value | | 0..1 | | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.value[x]:valueId.value Short descriptionPrimitive value for id DefinitionMaximum string length1048576 |
| descriptionDisplay | C | 0..1 | Extension | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay Short descriptionThe SNOMED CT display for the description ID Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Fixed valuedescriptionDisplay Mappings |
| valueString | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.value[x]:valueString Short descriptionThe SNOMED CT display for the description ID DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.value[x]:valueString.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.value[x]:valueString.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
| value | | 0..1 | | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.value[x]:valueString.value Short descriptionPrimitive value for string DefinitionPrimitive value for string
Maximum string length1048576 |
| url | | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Fixed valuehttps://fhir.nhs.uk/STU3/StructureDefinition/Extension-coding-sctdescid Mappings |
| value[x] | | 0..0 | | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.extension:snomedCTDescriptionID.value[x] Short descriptionValue of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings |
| system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.system Short descriptionIdentity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
RequirementsNeed to be unambiguous about the source of the definition of the symbol.
CommentsThe 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.
Data typeuri ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Fixed valuehttp://snomed.info/sct Mappings- rim: n/a
- v2: C*E.3
- rim: ./codeSystem
- orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
|
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.version Short descriptionVersion of the system - if relevant DefinitionThe 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.
CommentsWhere the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: C*E.7
- rim: ./codeSystemVersion
- orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
|
| code | Σ | 1..1 | code | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.code Short descriptionSymbol in syntax defined by the system DefinitionA 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).
RequirementsNeed to refer to a particular code in the system.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typecode ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: C*E.1
- rim: ./code
- orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
|
| display | Σ | 1..1 | string | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.display Short descriptionRepresentation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system.
RequirementsNeed to be able to carry a human-readable meaning of the code for readers that do not know the system.
CommentsNote that FHIR strings may not exceed 1MB in size
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: C*E.2 - but note this is not well followed
- rim: CV.displayName
- orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
|
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.coding:snomedCT.userSelected Short descriptionIf this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
RequirementsThis 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.
CommentsAmongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Data typeboolean ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: Sometimes implied by being first
- rim: CD.codingRationale
- orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idMedicationStatement.dosage.route.text Short descriptionPlain text representation of the concept DefinitionA 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.
RequirementsThe 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.
CommentsVery often the text is the same as a displayName of one of the codings.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: C*E.9. But note many systems use C*E.2 for this
- rim: ./originalText[mediaType/code="text/plain"]/data
- orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
|
| method | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idMedicationStatement.dosage.method Short descriptionTechnique for administering medication DefinitionTechnique for administering medication.
RequirementsA 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.
CommentsTerminologies used often pre-coordinate this term with the route and or form of administration.
Data typeCodeableConcept BindingA coded concept describing the technique by which the medicine is administered. SNOMED CT Administration Method Codes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim: .doseQuantity
|
| dose[x] | Σ | 0..1 | | There are no (further) constraints on this element Element idMedicationStatement.dosage.dose[x] Short descriptionAmount of medication per dose DefinitionAmount of medication per dose.
RequirementsThe amount of therapeutic or other substance given at one administration event.
CommentsNote 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.
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- rim: .doseQuantity
|
| doseQuantity | | | SimpleQuantity | There are no (further) constraints on this element Data typeSimpleQuantity |
| doseRange | | | Range | There are no (further) constraints on this element Data typeRange |
| maxDosePerPeriod | Σ C | 0..1 | Ratio | There are no (further) constraints on this element Element idMedicationStatement.dosage.maxDosePerPeriod Short descriptionUpper limit on medication per unit of time DefinitionUpper limit on medication per unit of time.
RequirementsThe 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.
CommentsThis is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day".
Data typeRatio ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) - rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) Mappings- rim: n/a
- v2: N/A
- rim: RTO
- rim: .maxDoseQuantity
|
| maxDosePerAdministration | Σ C | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idMedicationStatement.dosage.maxDosePerAdministration Short descriptionUpper limit on medication per administration DefinitionUpper limit on medication per administration.
RequirementsThe maximum total quantity of a therapeutic substance that may be administered to a subject per administration.
CommentsThis is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg.
Data typeSimpleQuantity ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (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() Mappings- rim: n/a
- v2: SN (see also Range) or CQ
- rim: PQ, IVL<PQ>, MO, CO, depending on the values
- rim: not supported
|
| maxDosePerLifetime | Σ C | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idMedicationStatement.dosage.maxDosePerLifetime Short descriptionUpper limit on medication per lifetime of the patient DefinitionUpper limit on medication per lifetime of the patient.
RequirementsThe maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject.
CommentsThe context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
Data typeSimpleQuantity ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (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() Mappings- rim: n/a
- v2: SN (see also Range) or CQ
- rim: PQ, IVL<PQ>, MO, CO, depending on the values
- rim: not supported
|
| rate[x] | Σ | 0..1 | | There are no (further) constraints on this element Element idMedicationStatement.dosage.rate[x] Short descriptionAmount of medication per unit of time DefinitionAmount of medication per unit of time.
RequirementsIdentifies 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.
CommentsIt 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.
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count()) Mappings- rim: n/a
- rim: .rateQuantity
|
| rateQuantity | | | SimpleQuantity | There are no (further) constraints on this element Data typeSimpleQuantity |
| rateRange | | | Range | There are no (further) constraints on this element Data typeRange |
| rateRatio | | | Ratio | There are no (further) constraints on this element Data typeRatio |