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 EHDSImagingReportHeader logical model.
Guidance on how to interpret the contents of this table can be found here
0. EHDSImagingReportHeader | |
Definition | A.1 - EHDS refined base model for Imaging Report header data elements |
Short | Imging Report header (model) |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. EHDSImagingReportHeader.subject | |
Definition | Patient/subject information |
Short | A.1.1 - Subject |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient |
4. EHDSImagingReportHeader.healthInsuranceAndPaymentInformation | |
Definition | Health insurance information (Health insurance information is not always required, however, in some jurisdictions, the insurance number is also used as the patient identifier. It is necessary not just for identification but also forms access to funding for care.) |
Short | A.1.4 - Health insurance and payment information |
Control | 0..1 |
Type | BackboneElement |
6. EHDSImagingReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceCode | |
Definition | Unique health insurance company identification code |
Short | A.1.4.1 - Health insurance code |
Control | 0..1 |
Type | Identifier |
8. EHDSImagingReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceName | |
Definition | Full, official name of the healthcare insurance provider. |
Short | A.1.4.2 - Health insurance name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. EHDSImagingReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceNumber | |
Definition | Number or code under which the insured person is registered at the insurance provider. |
Short | A.1.4.3 - Health insurance number |
Control | 0..1 |
Type | Identifier |
12. EHDSImagingReportHeader.intendedRecipient | |
Definition | Information recipient (intended recipient or recipients of the report, additional recipients might be identified by the ordering party, e.g. GP, other specialist), if applicable |
Short | A.1.5 - Intended recipient |
Control | 0..* |
Type | Reference(Patient (model), Related person (model), Health professional (model), Organization (model), Health professional role (model), Device (model)) |
14. EHDSImagingReportHeader.author | |
Definition | Author by whom the document was/were authored. Multiple authors could be provided. |
Short | A.1.6 - Author |
Control | 1..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessionalRole |
16. EHDSImagingReportHeader.attester | |
Definition | Attester who validated the document. Mulitple attesters could be provided. |
Short | A.1.7 - Attester |
Control | 0..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessionalRole |
18. EHDSImagingReportHeader.legalAuthenticator | |
Definition | The person taking responsibility for the medical content of the document |
Short | A.1.8 - Legal authenticator |
Control | 0..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessionalRole |
20. EHDSImagingReportHeader.documentMetadata | |
Definition | Data relevent to document type and its content for administrative and searching purposes. |
Short | A.1.9 - Document metadata |
Control | 1..1 |
Type | BackboneElement |
22. EHDSImagingReportHeader.documentMetadata.documentId | |
Definition | Unique identifier of the document |
Short | A.1.9.1 - Document ID |
Control | 1..1 |
Type | Identifier |
24. EHDSImagingReportHeader.documentMetadata.documentType | |
Definition | Identifies the type of document at hand, e.g. Hospital discharge report. |
Short | A.1.9.2 - Document type |
Control | 1..1 |
Binding | LOINC |
Type | CodeableConcept |
26. EHDSImagingReportHeader.documentMetadata.documentStatus | |
Definition | The status of the Hospital discharge report. E.g., preliminary, final. |
Short | A.1.9.3 - Document status |
Control | 1..1 |
Binding | hl7:CompositionStatus |
Type | CodeableConcept |
28. EHDSImagingReportHeader.documentMetadata.period | |
Definition | Time of service that is being documented |
Short | A.1.9.4 - Period |
Control | 0..1 |
Type | Period |
30. EHDSImagingReportHeader.documentMetadata.reportDateAndTime | |
Definition | Date and time of the report creation. |
Short | A.1.9.5 - Report date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
32. EHDSImagingReportHeader.documentMetadata.documentTitle | |
Definition | Document title, such as "Hospital discharge report", "Laboratory Result Report" etc.. |
Short | A.1.9.6 - Document title |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
34. EHDSImagingReportHeader.documentMetadata.eventType | |
Definition | Categorization of an "event" covered by the document (e.g. laboratory study types, imaging study types including modality, etc.). Selection of event types depends on the use case and agreement betwen data sharing parties. This meta-data element serves primarily for searching and filtering purpuses. |
Short | A.1.9.7 - Event type |
Control | 0..* |
Binding | LOINC, SNOMED CT, dicom-cid-33-Modality |
Type | CodeableConcept |
36. EHDSImagingReportHeader.documentMetadata.specialty | |
Definition | Additional details about where the content was created (e.g. clinical specialty) |
Short | A.1.9.8 - Specialty |
Control | 0..* |
Binding | SNOMED CT |
Type | CodeableConcept |
38. EHDSImagingReportHeader.documentMetadata.reportCustodian | |
Definition | Organisation that is in charge of maintaining the report [this element will include organisation ID, name, address etc., as other elements describing organisations]. |
Short | A.1.9.9 - Report custodian |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization |
40. EHDSImagingReportHeader.documentMetadata.documentFormat | |
Definition | An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. |
Short | A.1.9.10 - Document format |
Control | 0..1 |
Binding | HL7 Document Format Codes |
Type | CodeableConcept |
42. EHDSImagingReportHeader.documentMetadata.confidentiality | |
Definition | Level of confidentiality of the document. Implicit value is normal. |
Short | A.1.9.11 - Confidentiality |
Control | 0..1 |
Binding | hl7:Confidentiality |
Type | CodeableConcept |
44. EHDSImagingReportHeader.documentMetadata.language | |
Definition | Language in which the document is written. Language is expressed by the ISO language code. |
Short | A.1.9.12 - Language |
Control | 0..1 |
Binding | ISO 639 |
Type | CodeableConcept |
46. EHDSImagingReportHeader.documentMetadata.version | |
Definition | Version of the document |
Short | A.1.9.13 - Version |
Note | This is a business version Id, not a resource version Id (see discussion) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
48. EHDSImagingReportHeader.documentMetadata.studyInstanceUid | |
Definition | Unique global identifier(s) that identifies an imaging study upon which the imaging report is based.An identifier that links an imaging report to one or more imaging studies. This element is relevant for the interactive selection of the available studies. |
Short | A.1.9.14 - Study Instance UID |
Control | 0..* |
Binding | OID |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
50. EHDSImagingReportHeader.documentMetadata.accessionNumber | |
Definition | This is an identifier, managed by the RIS at the local level, which usually uniquely identifies an imaging procedure request, and links it to imaging study(ies) and related imaging report(s). As it is prefixed by the registration authority it is a globally unique ID, usable both nationally and cross-border. |
Short | A.1.9.15 - Accession number |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
52. EHDSImagingReportHeader.presentedForm | |
Definition | Entire report as issued pdf format recommended |
Short | A.1.10 - Presented form |
Control | 0..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAttachment |
54. EHDSImagingReportHeader.media[x] | |
Definition | Media attachments. |
Short | A.1.11 - Media |
Control | 0..* |
Type | Choice of: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAttachment, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedia |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Guidance on how to interpret the contents of this table can be found here
0. EHDSImagingReportHeader | |
Definition | A.1 - EHDS refined base model for Imaging Report header data elements Base definition for all types defined in FHIR type system. |
Short | Imging Report header (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. EHDSImagingReportHeader.subject | |
Definition | Patient/subject information |
Short | A.1.1 - Subject |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient |
4. EHDSImagingReportHeader.healthInsuranceAndPaymentInformation | |
Definition | Health insurance information (Health insurance information is not always required, however, in some jurisdictions, the insurance number is also used as the patient identifier. It is necessary not just for identification but also forms access to funding for care.) |
Short | A.1.4 - Health insurance and payment information |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
6. EHDSImagingReportHeader.healthInsuranceAndPaymentInformation.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()) |
8. EHDSImagingReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceCode | |
Definition | Unique health insurance company identification code |
Short | A.1.4.1 - Health insurance code |
Control | 0..1 |
Type | Identifier |
10. EHDSImagingReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceName | |
Definition | Full, official name of the healthcare insurance provider. |
Short | A.1.4.2 - Health insurance name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. EHDSImagingReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceNumber | |
Definition | Number or code under which the insured person is registered at the insurance provider. |
Short | A.1.4.3 - Health insurance number |
Control | 0..1 |
Type | Identifier |
14. EHDSImagingReportHeader.intendedRecipient | |
Definition | Information recipient (intended recipient or recipients of the report, additional recipients might be identified by the ordering party, e.g. GP, other specialist), if applicable |
Short | A.1.5 - Intended recipient |
Control | 0..* |
Type | Reference(Patient (model), Related person (model), Health professional (model), Organization (model), Health professional role (model), Device (model)) |
16. EHDSImagingReportHeader.author | |
Definition | Author by whom the document was/were authored. Multiple authors could be provided. |
Short | A.1.6 - Author |
Control | 1..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessionalRole |
18. EHDSImagingReportHeader.attester | |
Definition | Attester who validated the document. Mulitple attesters could be provided. |
Short | A.1.7 - Attester |
Control | 0..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessionalRole |
20. EHDSImagingReportHeader.legalAuthenticator | |
Definition | The person taking responsibility for the medical content of the document |
Short | A.1.8 - Legal authenticator |
Control | 0..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessionalRole |
22. EHDSImagingReportHeader.documentMetadata | |
Definition | Data relevent to document type and its content for administrative and searching purposes. |
Short | A.1.9 - Document metadata |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
24. EHDSImagingReportHeader.documentMetadata.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()) |
26. EHDSImagingReportHeader.documentMetadata.documentId | |
Definition | Unique identifier of the document |
Short | A.1.9.1 - Document ID |
Control | 1..1 |
Type | Identifier |
28. EHDSImagingReportHeader.documentMetadata.documentType | |
Definition | Identifies the type of document at hand, e.g. Hospital discharge report. |
Short | A.1.9.2 - Document type |
Control | 1..1 |
Binding | LOINC |
Type | CodeableConcept |
30. EHDSImagingReportHeader.documentMetadata.documentStatus | |
Definition | The status of the Hospital discharge report. E.g., preliminary, final. |
Short | A.1.9.3 - Document status |
Control | 1..1 |
Binding | hl7:CompositionStatus |
Type | CodeableConcept |
32. EHDSImagingReportHeader.documentMetadata.period | |
Definition | Time of service that is being documented |
Short | A.1.9.4 - Period |
Control | 0..1 |
Type | Period |
34. EHDSImagingReportHeader.documentMetadata.reportDateAndTime | |
Definition | Date and time of the report creation. |
Short | A.1.9.5 - Report date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
36. EHDSImagingReportHeader.documentMetadata.documentTitle | |
Definition | Document title, such as "Hospital discharge report", "Laboratory Result Report" etc.. |
Short | A.1.9.6 - Document title |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. EHDSImagingReportHeader.documentMetadata.eventType | |
Definition | Categorization of an "event" covered by the document (e.g. laboratory study types, imaging study types including modality, etc.). Selection of event types depends on the use case and agreement betwen data sharing parties. This meta-data element serves primarily for searching and filtering purpuses. |
Short | A.1.9.7 - Event type |
Control | 0..* |
Binding | LOINC, SNOMED CT, dicom-cid-33-Modality |
Type | CodeableConcept |
40. EHDSImagingReportHeader.documentMetadata.specialty | |
Definition | Additional details about where the content was created (e.g. clinical specialty) |
Short | A.1.9.8 - Specialty |
Control | 0..* |
Binding | SNOMED CT |
Type | CodeableConcept |
42. EHDSImagingReportHeader.documentMetadata.reportCustodian | |
Definition | Organisation that is in charge of maintaining the report [this element will include organisation ID, name, address etc., as other elements describing organisations]. |
Short | A.1.9.9 - Report custodian |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization |
44. EHDSImagingReportHeader.documentMetadata.documentFormat | |
Definition | An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. |
Short | A.1.9.10 - Document format |
Control | 0..1 |
Binding | HL7 Document Format Codes |
Type | CodeableConcept |
46. EHDSImagingReportHeader.documentMetadata.confidentiality | |
Definition | Level of confidentiality of the document. Implicit value is normal. |
Short | A.1.9.11 - Confidentiality |
Control | 0..1 |
Binding | hl7:Confidentiality |
Type | CodeableConcept |
48. EHDSImagingReportHeader.documentMetadata.language | |
Definition | Language in which the document is written. Language is expressed by the ISO language code. |
Short | A.1.9.12 - Language |
Control | 0..1 |
Binding | ISO 639 |
Type | CodeableConcept |
50. EHDSImagingReportHeader.documentMetadata.version | |
Definition | Version of the document |
Short | A.1.9.13 - Version |
Note | This is a business version Id, not a resource version Id (see discussion) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
52. EHDSImagingReportHeader.documentMetadata.studyInstanceUid | |
Definition | Unique global identifier(s) that identifies an imaging study upon which the imaging report is based.An identifier that links an imaging report to one or more imaging studies. This element is relevant for the interactive selection of the available studies. |
Short | A.1.9.14 - Study Instance UID |
Control | 0..* |
Binding | OID |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
54. EHDSImagingReportHeader.documentMetadata.accessionNumber | |
Definition | This is an identifier, managed by the RIS at the local level, which usually uniquely identifies an imaging procedure request, and links it to imaging study(ies) and related imaging report(s). As it is prefixed by the registration authority it is a globally unique ID, usable both nationally and cross-border. |
Short | A.1.9.15 - Accession number |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
56. EHDSImagingReportHeader.presentedForm | |
Definition | Entire report as issued pdf format recommended |
Short | A.1.10 - Presented form |
Control | 0..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAttachment |
58. EHDSImagingReportHeader.media[x] | |
Definition | Media attachments. |
Short | A.1.11 - Media |
Control | 0..* |
Type | Choice of: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAttachment, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedia |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Guidance on how to interpret the contents of this table can be found here
0. EHDSImagingReportHeader | |
Definition | A.1 - EHDS refined base model for Imaging Report header data elements |
Short | Imging Report header (model) |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. EHDSImagingReportHeader.subject | |
Definition | Patient/subject information |
Short | A.1.1 - Subject |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient |
4. EHDSImagingReportHeader.healthInsuranceAndPaymentInformation | |
Definition | Health insurance information (Health insurance information is not always required, however, in some jurisdictions, the insurance number is also used as the patient identifier. It is necessary not just for identification but also forms access to funding for care.) |
Short | A.1.4 - Health insurance and payment information |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
6. EHDSImagingReportHeader.healthInsuranceAndPaymentInformation.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 |
8. EHDSImagingReportHeader.healthInsuranceAndPaymentInformation.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 EHDSImagingReportHeader.healthInsuranceAndPaymentInformation.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
10. EHDSImagingReportHeader.healthInsuranceAndPaymentInformation.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. EHDSImagingReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceCode | |
Definition | Unique health insurance company identification code |
Short | A.1.4.1 - Health insurance code |
Control | 0..1 |
Type | Identifier |
14. EHDSImagingReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceName | |
Definition | Full, official name of the healthcare insurance provider. |
Short | A.1.4.2 - Health insurance name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
16. EHDSImagingReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceNumber | |
Definition | Number or code under which the insured person is registered at the insurance provider. |
Short | A.1.4.3 - Health insurance number |
Control | 0..1 |
Type | Identifier |
18. EHDSImagingReportHeader.intendedRecipient | |
Definition | Information recipient (intended recipient or recipients of the report, additional recipients might be identified by the ordering party, e.g. GP, other specialist), if applicable |
Short | A.1.5 - Intended recipient |
Control | 0..* |
Type | Reference(Patient (model), Related person (model), Health professional (model), Organization (model), Health professional role (model), Device (model)) |
20. EHDSImagingReportHeader.author | |
Definition | Author by whom the document was/were authored. Multiple authors could be provided. |
Short | A.1.6 - Author |
Control | 1..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessionalRole |
22. EHDSImagingReportHeader.attester | |
Definition | Attester who validated the document. Mulitple attesters could be provided. |
Short | A.1.7 - Attester |
Control | 0..* |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessionalRole |
24. EHDSImagingReportHeader.legalAuthenticator | |
Definition | The person taking responsibility for the medical content of the document |
Short | A.1.8 - Legal authenticator |
Control | 0..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessionalRole |
26. EHDSImagingReportHeader.documentMetadata | |
Definition | Data relevent to document type and its content for administrative and searching purposes. |
Short | A.1.9 - Document metadata |
Control | 1..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
28. EHDSImagingReportHeader.documentMetadata.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 |
30. EHDSImagingReportHeader.documentMetadata.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 EHDSImagingReportHeader.documentMetadata.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
32. EHDSImagingReportHeader.documentMetadata.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() ) |
34. EHDSImagingReportHeader.documentMetadata.documentId | |
Definition | Unique identifier of the document |
Short | A.1.9.1 - Document ID |
Control | 1..1 |
Type | Identifier |
36. EHDSImagingReportHeader.documentMetadata.documentType | |
Definition | Identifies the type of document at hand, e.g. Hospital discharge report. |
Short | A.1.9.2 - Document type |
Control | 1..1 |
Binding | LOINC |
Type | CodeableConcept |
38. EHDSImagingReportHeader.documentMetadata.documentStatus | |
Definition | The status of the Hospital discharge report. E.g., preliminary, final. |
Short | A.1.9.3 - Document status |
Control | 1..1 |
Binding | hl7:CompositionStatus |
Type | CodeableConcept |
40. EHDSImagingReportHeader.documentMetadata.period | |
Definition | Time of service that is being documented |
Short | A.1.9.4 - Period |
Control | 0..1 |
Type | Period |
42. EHDSImagingReportHeader.documentMetadata.reportDateAndTime | |
Definition | Date and time of the report creation. |
Short | A.1.9.5 - Report date and time |
Control | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
44. EHDSImagingReportHeader.documentMetadata.documentTitle | |
Definition | Document title, such as "Hospital discharge report", "Laboratory Result Report" etc.. |
Short | A.1.9.6 - Document title |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
46. EHDSImagingReportHeader.documentMetadata.eventType | |
Definition | Categorization of an "event" covered by the document (e.g. laboratory study types, imaging study types including modality, etc.). Selection of event types depends on the use case and agreement betwen data sharing parties. This meta-data element serves primarily for searching and filtering purpuses. |
Short | A.1.9.7 - Event type |
Control | 0..* |
Binding | LOINC, SNOMED CT, dicom-cid-33-Modality |
Type | CodeableConcept |
48. EHDSImagingReportHeader.documentMetadata.specialty | |
Definition | Additional details about where the content was created (e.g. clinical specialty) |
Short | A.1.9.8 - Specialty |
Control | 0..* |
Binding | SNOMED CT |
Type | CodeableConcept |
50. EHDSImagingReportHeader.documentMetadata.reportCustodian | |
Definition | Organisation that is in charge of maintaining the report [this element will include organisation ID, name, address etc., as other elements describing organisations]. |
Short | A.1.9.9 - Report custodian |
Control | 1..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization |
52. EHDSImagingReportHeader.documentMetadata.documentFormat | |
Definition | An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. |
Short | A.1.9.10 - Document format |
Control | 0..1 |
Binding | HL7 Document Format Codes |
Type | CodeableConcept |
54. EHDSImagingReportHeader.documentMetadata.confidentiality | |
Definition | Level of confidentiality of the document. Implicit value is normal. |
Short | A.1.9.11 - Confidentiality |
Control | 0..1 |
Binding | hl7:Confidentiality |
Type | CodeableConcept |
56. EHDSImagingReportHeader.documentMetadata.language | |
Definition | Language in which the document is written. Language is expressed by the ISO language code. |
Short | A.1.9.12 - Language |
Control | 0..1 |
Binding | ISO 639 |
Type | CodeableConcept |
58. EHDSImagingReportHeader.documentMetadata.version | |
Definition | Version of the document |
Short | A.1.9.13 - Version |
Note | This is a business version Id, not a resource version Id (see discussion) |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
60. EHDSImagingReportHeader.documentMetadata.studyInstanceUid | |
Definition | Unique global identifier(s) that identifies an imaging study upon which the imaging report is based.An identifier that links an imaging report to one or more imaging studies. This element is relevant for the interactive selection of the available studies. |
Short | A.1.9.14 - Study Instance UID |
Control | 0..* |
Binding | OID |
Type | uri |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
62. EHDSImagingReportHeader.documentMetadata.accessionNumber | |
Definition | This is an identifier, managed by the RIS at the local level, which usually uniquely identifies an imaging procedure request, and links it to imaging study(ies) and related imaging report(s). As it is prefixed by the registration authority it is a globally unique ID, usable both nationally and cross-border. |
Short | A.1.9.15 - Accession number |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
64. EHDSImagingReportHeader.presentedForm | |
Definition | Entire report as issued pdf format recommended |
Short | A.1.10 - Presented form |
Control | 0..1 |
Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAttachment |
66. EHDSImagingReportHeader.media[x] | |
Definition | Media attachments. |
Short | A.1.11 - Media |
Control | 0..* |
Type | Choice of: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAttachment, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedia |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |