UPTIS FHIR PoC Test Implementation Guide
1.0.0 - draft Estonia flag

UPTIS FHIR PoC Test Implementation Guide, published by TEHIK. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TEHIK-EE/FHIR-PoC/ and changes regularly. See the Directory of published versions

Logical Model: MedicationOverviewTJT - Detailed Descriptions

Draft as of 2024-10-28

Definitions for the MedicationOverviewTJT logical model.

Guidance on how to interpret the contents of this table can be found here

0. MedicationOverviewTJT
Definition

A model for the whole medication overview (medication schema)

ShortMedication Overview TJT - logical model
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. MedicationOverviewTJT.patient
Definition

Patsient

ShortPatient
Control1..1
TypeReference(Patient TJT - logical model)
4. MedicationOverviewTJT.medicationTreatmentLine
Definition

Ravimiskeemi rida

ShortList item in the list of all current medication based treatments. Each line can be verified or unverified.
Control0..*
TypeReference(Medication TreatmentLine TJT - logical model)
6. MedicationOverviewTJT.verification
Definition

Ravimiskeemi kinnitamine

ShortVerification of overview
Control0..1
TypeBackboneElement(Class)
8. MedicationOverviewTJT.verification.practicioner
Definition

HCP verifying the treatments/overview

ShortHCP verifying the treatments/overview
Control1..1
TypeReference(Practitioner TJT - logical model)
10. MedicationOverviewTJT.verification.verificationTime
Definition

Kinnitamise aeg

ShortTime of the verification of the overview
Control1..1
TypeElement(DT)
12. MedicationOverviewTJT.comment
Definition

Kommentaar kogu ravimiskeemile

ShortComment on the full overview
Control0..*
TypeBackboneElement(Class)
14. MedicationOverviewTJT.comment.author
Definition

Kommentaari autor

ShortAuthor of the comment (pharmacist, doctor, social carer)
Control1..1
TypeReference
16. MedicationOverviewTJT.comment.date
Definition

Kommentaari aeg

ShortTime of comment
Control1..1
TypeElement(DT)
18. MedicationOverviewTJT.comment.commentText
Definition

Kommentaari sisu

ShortContent of the comment
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. MedicationOverviewTJT
Definition

A model for the whole medication overview (medication schema)


Base definition for all types defined in FHIR type system.

ShortMedication Overview TJT - logical modelBase for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. MedicationOverviewTJT.patient
Definition

Patsient

ShortPatient
Control1..1
TypeReference(Patient TJT - logical model)
4. MedicationOverviewTJT.medicationTreatmentLine
Definition

Ravimiskeemi rida

ShortList item in the list of all current medication based treatments. Each line can be verified or unverified.
Control0..*
TypeReference(Medication TreatmentLine TJT - logical model)
6. MedicationOverviewTJT.verification
Definition

Ravimiskeemi kinnitamine

ShortVerification of overview
Control0..1
TypeBackboneElement(Class)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. MedicationOverviewTJT.verification.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. MedicationOverviewTJT.verification.practicioner
Definition

HCP verifying the treatments/overview

ShortHCP verifying the treatments/overview
Control1..1
TypeReference(Practitioner TJT - logical model)
12. MedicationOverviewTJT.verification.verificationTime
Definition

Kinnitamise aeg

ShortTime of the verification of the overview
Control1..1
TypeElement(DT)
14. MedicationOverviewTJT.comment
Definition

Kommentaar kogu ravimiskeemile

ShortComment on the full overview
Control0..*
TypeBackboneElement(Class)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. MedicationOverviewTJT.comment.modifierExtension
Definition

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

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. MedicationOverviewTJT.comment.author
Definition

Kommentaari autor

ShortAuthor of the comment (pharmacist, doctor, social carer)
Control1..1
TypeReference
20. MedicationOverviewTJT.comment.date
Definition

Kommentaari aeg

ShortTime of comment
Control1..1
TypeElement(DT)
22. MedicationOverviewTJT.comment.commentText
Definition

Kommentaari sisu

ShortContent of the comment
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. MedicationOverviewTJT
Definition

A model for the whole medication overview (medication schema)

ShortMedication Overview TJT - logical model
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. MedicationOverviewTJT.patient
Definition

Patsient

ShortPatient
Control1..1
TypeReference(Patient TJT - logical model)
4. MedicationOverviewTJT.medicationTreatmentLine
Definition

Ravimiskeemi rida

ShortList item in the list of all current medication based treatments. Each line can be verified or unverified.
Control0..*
TypeReference(Medication TreatmentLine TJT - logical model)
6. MedicationOverviewTJT.verification
Definition

Ravimiskeemi kinnitamine

ShortVerification of overview
Control0..1
TypeBackboneElement(Class)
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. MedicationOverviewTJT.verification.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
10. MedicationOverviewTJT.verification.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MedicationOverviewTJT.verification.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 12. MedicationOverviewTJT.verification.modifierExtension
    Definition

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

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

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. MedicationOverviewTJT.verification.practicioner
    Definition

    HCP verifying the treatments/overview

    ShortHCP verifying the treatments/overview
    Control1..1
    TypeReference(Practitioner TJT - logical model)
    16. MedicationOverviewTJT.verification.verificationTime
    Definition

    Kinnitamise aeg

    ShortTime of the verification of the overview
    Control1..1
    TypeElement(DT)
    18. MedicationOverviewTJT.comment
    Definition

    Kommentaar kogu ravimiskeemile

    ShortComment on the full overview
    Control0..*
    TypeBackboneElement(Class)
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. MedicationOverviewTJT.comment.id
    Definition

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

    ShortUnique id for inter-element referencing
    Control0..1
    This element is affected by the following invariants: ele-1
    Typeid
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    22. MedicationOverviewTJT.comment.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on MedicationOverviewTJT.comment.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 24. MedicationOverviewTJT.comment.modifierExtension
      Definition

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

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

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      26. MedicationOverviewTJT.comment.author
      Definition

      Kommentaari autor

      ShortAuthor of the comment (pharmacist, doctor, social carer)
      Control1..1
      TypeReference
      28. MedicationOverviewTJT.comment.date
      Definition

      Kommentaari aeg

      ShortTime of comment
      Control1..1
      TypeElement(DT)
      30. MedicationOverviewTJT.comment.commentText
      Definition

      Kommentaari sisu

      ShortContent of the comment
      Control1..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension