Xt-EHR Logical Models Implementation Guide
0.1.0 - ci-build
Xt-EHR Logical Models Implementation Guide, published by Xt-EHR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Xt-EHR/xt-ehr-common/ and changes regularly. See the Directory of published versions
Draft as of 2024-10-13 |
Definitions for the EHDSLaboratoryObservation logical model.
Guidance on how to interpret the contents of this table can be found here
0. EHDSLaboratoryObservation | |
Definition | C.11 - EHDS refined base model for Observation performed by laboratory |
Short | Laboratory observation (model) |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. EHDSLaboratoryObservation.observationCode | |
Binding | LOINC, NPU |
4. EHDSLaboratoryObservation.testKit | |
Definition | Laboratory test kit used during measurement. |
Short | C.11.2 - Test kit |
Control | 0..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDevice |
6. EHDSLaboratoryObservation.calibrator | |
Definition | Information about which end-user calibrator the laboratory has been used for the measurement to indicate the metrological traceability chain. |
Short | C.11.3 - Calibrator |
Control | 0..1 |
Type | Identifier |
8. EHDSLaboratoryObservation.accreditationStatu | |
Definition | Accreditation status of the laboratory for the particular observation. |
Short | C.11.4 - Accreditation status |
Control | 0..1 |
Binding | Code system to be specified |
Type | CodeableConcept |
10. EHDSLaboratoryObservation.previousResults | |
Definition | Previous results of the same observation |
Short | C.11.5 - Previous results |
Control | 0..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSLaboratoryObservation |
Guidance on how to interpret the contents of this table can be found here
0. EHDSLaboratoryObservation | |
Definition | C.11 - EHDS refined base model for Observation performed by laboratory Base definition for all types defined in FHIR type system. |
Short | Laboratory observation (model)Base for all types and resources |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. EHDSLaboratoryObservation.observationDate | |
Definition | Date and time of the observation |
Short | C.10.1 - Observation date |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
4. EHDSLaboratoryObservation.observationCode | |
Definition | Code representing the observation using the agreed code systems. |
Short | C.10.2 - Observation code |
Control | 1..1 |
Binding | LOINC, NPU |
Type | CodeableConcept |
6. EHDSLaboratoryObservation.observationName | |
Definition | Full name of the observation according to the used test coding standard. |
Short | C.10.3 - Observation name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. EHDSLaboratoryObservation.observationResult | |
Definition | Result of the observation including text, numeric and coded results of the measurement and measurement uncertainty. Content of the observation result will vary according to the type of the observation. |
Short | C.10.10 - Observation result |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
10. EHDSLaboratoryObservation.observationResult.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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
12. EHDSLaboratoryObservation.testKit | |
Definition | Laboratory test kit used during measurement. |
Short | C.11.2 - Test kit |
Control | 0..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDevice |
14. EHDSLaboratoryObservation.calibrator | |
Definition | Information about which end-user calibrator the laboratory has been used for the measurement to indicate the metrological traceability chain. |
Short | C.11.3 - Calibrator |
Control | 0..1 |
Type | Identifier |
16. EHDSLaboratoryObservation.accreditationStatu | |
Definition | Accreditation status of the laboratory for the particular observation. |
Short | C.11.4 - Accreditation status |
Control | 0..1 |
Binding | Code system to be specified |
Type | CodeableConcept |
18. EHDSLaboratoryObservation.previousResults | |
Definition | Previous results of the same observation |
Short | C.11.5 - Previous results |
Control | 0..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSLaboratoryObservation |
Guidance on how to interpret the contents of this table can be found here
0. EHDSLaboratoryObservation | |
Definition | C.11 - EHDS refined base model for Observation performed by laboratory |
Short | Laboratory observation (model) |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. EHDSLaboratoryObservation.observationDate | |
Definition | Date and time of the observation |
Short | C.10.1 - Observation date |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
4. EHDSLaboratoryObservation.observationCode | |
Definition | Code representing the observation using the agreed code systems. |
Short | C.10.2 - Observation code |
Control | 1..1 |
Binding | LOINC, NPU |
Type | CodeableConcept |
6. EHDSLaboratoryObservation.observationName | |
Definition | Full name of the observation according to the used test coding standard. |
Short | C.10.3 - Observation name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. EHDSLaboratoryObservation.observationOriginalName | |
Definition | Original (conventional) name of the observation |
Short | C.10.4 - Observation original name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. EHDSLaboratoryObservation.observationMethod | |
Definition | Observation method (measurement principle) to obtain the result. |
Short | C.10.5 - Observation method |
Control | 0..1 |
Binding | SNOMED CT |
Type | CodeableConcept |
12. EHDSLaboratoryObservation.observationDevice | |
Definition | Device (e.g. analyser) that generates the measurements |
Short | C.10.6 - Observation device |
Control | 0..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDevice |
14. EHDSLaboratoryObservation.order | |
Definition | Identifies order and order placer this observation belongs to. |
Short | C.10.7 - Order |
Control | 0..1 |
Type | Reference(Service request (model)) |
16. EHDSLaboratoryObservation.performer[x] | |
Definition | Identifies the originator/author and provides provenance information about the source of the results data that may have not originated with the source of the whole Laboratory Report document. |
Short | C.10.8 - Performer |
Control | 0..1 |
Type | Choice of: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessionalRole |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
18. EHDSLaboratoryObservation.reporter[x] | |
Definition | With certain observation results, e.g. there may also be an interpreter or a person responsible for validation. |
Short | C.10.9 - Reporter |
Control | 0..1 |
Type | Choice of: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessionalRole |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
20. EHDSLaboratoryObservation.observationResult | |
Definition | Result of the observation including text, numeric and coded results of the measurement and measurement uncertainty. Content of the observation result will vary according to the type of the observation. |
Short | C.10.10 - Observation result |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
22. EHDSLaboratoryObservation.observationResult.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
24. EHDSLaboratoryObservation.observationResult.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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on EHDSLaboratoryObservation.observationResult.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
26. EHDSLaboratoryObservation.observationResult.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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
28. EHDSLaboratoryObservation.observationResult.textualResult | |
Definition | Narrative text result |
Short | C.10.10.1 - Textual Result |
Control | 0..1 |
Type | Narrative |
30. EHDSLaboratoryObservation.observationResult.numericResult | |
Definition | A numeric value or interval (open or closed) of the result, result units of the measurement should be provided Measurement uncertainty interval are provided if needed. |
Short | C.10.10.2 - Numeric Result |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
32. EHDSLaboratoryObservation.observationResult.numericResult.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
34. EHDSLaboratoryObservation.observationResult.numericResult.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. |
Short | Additional 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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
Slicing | This element introduces a set of slices on EHDSLaboratoryObservation.observationResult.numericResult.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
36. EHDSLaboratoryObservation.observationResult.numericResult.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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
38. EHDSLaboratoryObservation.observationResult.numericResult.numericValue[x] | |
Definition | A numeric value or interval (open or closed) of the result |
Short | C.10.10.2.1 - Numeric value |
Control | 0..1 |
Type | Choice of: Quantity, Range |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
40. EHDSLaboratoryObservation.observationResult.numericResult.units | |
Definition | Result units of the measurement |
Short | C.10.10.2.2 - Units |
Control | 0..1 |
Binding | UCUM |
Type | CodeableConcept |
42. EHDSLaboratoryObservation.observationResult.numericResult.uncertainty | |
Definition | Measurement uncertainty type and interval should be provided if needed. |
Short | C.10.10.2.3 - Uncertainty |
Control | 0..1 |
Type | BackboneElement |
44. EHDSLaboratoryObservation.observationResult.codedResult | |
Definition | A coded result from a selected coding system(s). This could be a code describing bacteria or other microorganism identified, description of urinary concernment, code explaining technical reason why the test could not be done etc. |
Short | C.10.10.3 - Coded Result |
Control | 0..1 |
Binding | SNOMED CT (for ordinal or nominal scale results and result interpretation)UCUM (for units) |
Type | CodeableConcept |
46. EHDSLaboratoryObservation.dataabsentreason | |
Definition | Provides a reason why the expected value in the element Observation.value[x] is missing. |
Short | C.10.11 - dataAbsentReason |
Control | 0..1 |
Binding | HL7 Data absent reason |
Type | CodeableConcept |
48. EHDSLaboratoryObservation.referenceRange | |
Definition | Reference range, multilple reference ranges of different types culd by providedProvides guide for interpretation of result. Reference ranges are usually implied only for a numeric scale type. Use of the same units for reference range and value is implied. |
Short | C.10.12 - Reference range |
Control | 0..* |
Type | BackboneElement |
50. EHDSLaboratoryObservation.observationInterpretation | |
Definition | Information about reference intervals and result interpretation. |
Short | C.10.13 - Observation interpretation |
Control | 0..* |
Binding | SNOMED CT, HL7 ObservationInterpretation |
Type | CodeableConcept |
52. EHDSLaboratoryObservation.triggeredBy[x] | |
Definition | Identifies the observation(s) that triggered the performance of this observation. |
Short | C.10.14 - Triggered by |
Control | 0..* |
Type | Choice of: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSLaboratoryObservation, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSObservation |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
54. EHDSLaboratoryObservation.hasMember[x] | |
Definition | This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. |
Short | C.10.15 - Has member |
Control | 0..* |
Type | Choice of: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSLaboratoryObservation, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSObservation |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
56. EHDSLaboratoryObservation.resultDescription | |
Definition | Comments and narrative representation of the observation result and findings. |
Short | C.10.16 - Result description |
Control | 0..1 |
Type | Narrative |
58. EHDSLaboratoryObservation.anatomicLocation | |
Definition | Anatomic location and laterality where the observation should be or was performed. |
Short | C.10.17 - Anatomic location |
Control | 0..1 |
Binding | SNOMED CT |
Type | CodeableConcept |
60. EHDSLaboratoryObservation.testKit | |
Definition | Laboratory test kit used during measurement. |
Short | C.11.2 - Test kit |
Control | 0..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDevice |
62. EHDSLaboratoryObservation.calibrator | |
Definition | Information about which end-user calibrator the laboratory has been used for the measurement to indicate the metrological traceability chain. |
Short | C.11.3 - Calibrator |
Control | 0..1 |
Type | Identifier |
64. EHDSLaboratoryObservation.accreditationStatu | |
Definition | Accreditation status of the laboratory for the particular observation. |
Short | C.11.4 - Accreditation status |
Control | 0..1 |
Binding | Code system to be specified |
Type | CodeableConcept |
66. EHDSLaboratoryObservation.previousResults | |
Definition | Previous results of the same observation |
Short | C.11.5 - Previous results |
Control | 0..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSLaboratoryObservation |