HL7 Europe Laboratory Report
0.1.0-ballot - ballot
150
HL7 Europe Laboratory Report
0.1.0-ballot - ballot
150
This page is part of the HL7 Europe Laboratory Report (v0.1.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 0.1.1. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.eu/fhir/laboratory/StructureDefinition/DiagnosticReport-eu-lab | Version: 0.1.0-ballot | |||
| Standards status: Draft | Maturity Level: 1 | Computable Name: DiagnosticReportLabEu | ||
Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License |
||||
DiagnosticReport used to represent an entry of a Laboratory Report, including its context, for the scope of the HL7 Europe project.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DiagnosticReport
| Path | Conformance | ValueSet |
| DiagnosticReport.category:studyType | required | LabStudyTypesEuVs |
| DiagnosticReport.category:specialty | required | LabSpecialtyEuVs |
| DiagnosticReport.code | preferred | LabReportTypesEuVs |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DiagnosticReport | 0..* | DiagnosticReport | Laboratory Report DiagnosticReport | |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
  DiagnosticReportCompositionR5 | 1..1 | Reference(Composition) | Associated Lab Report Composition URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | |
  extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" | |
  value[x] | 1..1 | Reference(Composition: Laboratory Report) | Value of extension | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | Σ | 0..* | Identifier | Report identifier |
| basedOn | 0..* | Reference(ServiceRequest: Laboratory Order) | What was requested | |
| status | ?!Σ | 1..1 | code | Status of the Report Binding: DiagnosticReportStatus (required): The status of the diagnostic report. |
 Slices for category | Σ | 0..* | CodeableConceptIPS | Report Category Slice: Unordered, Open by pattern:$this Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. |
 category:studyType | Σ | 0..* | CodeableConcept | Service category Binding: Laboratory Study Types (required) |
 category:specialty | Σ | 0..* | CodeableConcept | Service category Binding: Laboratory Specialty (required) |
| code | 1..1 | CodeableConceptIPS | Type of (Laboratory) Report Binding: Laboratory Report Types (preferred) | |
| subject | Σ | 1..1 | Reference(Patient: Person | Patient: Animal | Group | Location | Device) | Who and/or what this report is about |
| encounter | Σ | 0..1 | Reference(Encounter) | The healthcare event which this Laboratory Report is about (when test ordered). |
 effective[x] | Σ | 0..1 | Clinically relevant time/time-period for report. | |
| effectiveDateTime | dateTime | |||
 effectivePeriod | Period | |||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service. |
| resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter |
| specimen | 0..* | Reference(Specimen: Laboratory) | Specimens this report is based on. | |
| result | 0..* | Reference(Observation Results: laboratory) | results | |
| presentedForm | 0..* | Attachment | Entire report as issued (pdf recommended) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| DiagnosticReport.status | required | DiagnosticReportStatus |
| DiagnosticReport.category | example | DiagnosticServiceSectionCodes |
| DiagnosticReport.category:studyType | required | LabStudyTypesEuVs |
| DiagnosticReport.category:specialty | required | LabSpecialtyEuVs |
| DiagnosticReport.code | preferred | LabReportTypesEuVs |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DiagnosticReport | 0..* | DiagnosticReport | Laboratory Report DiagnosticReport | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| DiagnosticReportCompositionR5 | 1..1 | Reference(Composition) | Associated Lab Report Composition URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" | |||||
| value[x] | 1..1 | Reference(Composition: Laboratory Report) | Value of extension | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Report identifier | ||||
| basedOn | 0..* | Reference(ServiceRequest: Laboratory Order) | What was requested | |||||
| status | ?!Σ | 1..1 | code | Status of the Report Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | ||||
| Slices for category | Σ | 0..* | CodeableConceptIPS | Report Category Slice: Unordered, Open by pattern:$this Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
| category:studyType | Σ | 0..* | CodeableConcept | Service category Binding: Laboratory Study Types (required) | ||||
| category:specialty | Σ | 0..* | CodeableConcept | Service category Binding: Laboratory Specialty (required) | ||||
| code | 1..1 | CodeableConceptIPS | Type of (Laboratory) Report Binding: Laboratory Report Types (preferred) | |||||
| subject | Σ | 1..1 | Reference(Patient: Person | Patient: Animal | Group | Location | Device) | Who and/or what this report is about | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | The healthcare event which this Laboratory Report is about (when test ordered). | ||||
| effective[x] | Σ | 0..1 | Clinically relevant time/time-period for report. | |||||
| effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| issued | Σ | 0..1 | instant | DateTime this version was made | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service. | ||||
| resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
| specimen | 0..* | Reference(Specimen: Laboratory) | Specimens this report is based on. | |||||
| result | 0..* | Reference(Observation Results: laboratory) | results | |||||
| media | Σ | 0..* | BackboneElement | Key images associated with this report | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| comment | 0..1 | string | Comment about the image (e.g. explanation) | |||||
| link | Σ | 1..1 | Reference(Media) | Reference to the image source | ||||
| conclusion | 0..1 | string | Clinical conclusion (interpretation) of test results | |||||
| conclusionCode | 0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report. | |||||
| presentedForm | 0..* | Attachment | Entire report as issued (pdf recommended) | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| DiagnosticReport.language | preferred | CommonLanguages
| ||||
| DiagnosticReport.status | required | DiagnosticReportStatus | ||||
| DiagnosticReport.category | example | DiagnosticServiceSectionCodes | ||||
| DiagnosticReport.category:studyType | required | LabStudyTypesEuVs | ||||
| DiagnosticReport.category:specialty | required | LabSpecialtyEuVs | ||||
| DiagnosticReport.code | preferred | LabReportTypesEuVs | ||||
| DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindings |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from DiagnosticReport
Summary
Mandatory: 4 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Differential View
This structure is derived from DiagnosticReport
| Path | Conformance | ValueSet |
| DiagnosticReport.category:studyType | required | LabStudyTypesEuVs |
| DiagnosticReport.category:specialty | required | LabSpecialtyEuVs |
| DiagnosticReport.code | preferred | LabReportTypesEuVs |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport | 0..* | DiagnosticReport | Laboratory Report DiagnosticReport | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| DiagnosticReportCompositionR5 | 1..1 | Reference(Composition) | Associated Lab Report Composition URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" | |
| value[x] | 1..1 | Reference(Composition: Laboratory Report) | Value of extension | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Report identifier |
| basedOn | 0..* | Reference(ServiceRequest: Laboratory Order) | What was requested | |
| status | ?!Σ | 1..1 | code | Status of the Report Binding: DiagnosticReportStatus (required): The status of the diagnostic report. |
| Slices for category | Σ | 0..* | CodeableConceptIPS | Report Category Slice: Unordered, Open by pattern:$this Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. |
| category:studyType | Σ | 0..* | CodeableConcept | Service category Binding: Laboratory Study Types (required) |
| category:specialty | Σ | 0..* | CodeableConcept | Service category Binding: Laboratory Specialty (required) |
| code | 1..1 | CodeableConceptIPS | Type of (Laboratory) Report Binding: Laboratory Report Types (preferred) | |
| subject | Σ | 1..1 | Reference(Patient: Person | Patient: Animal | Group | Location | Device) | Who and/or what this report is about |
| encounter | Σ | 0..1 | Reference(Encounter) | The healthcare event which this Laboratory Report is about (when test ordered). |
| effective[x] | Σ | 0..1 | Clinically relevant time/time-period for report. | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service. |
| resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter |
| specimen | 0..* | Reference(Specimen: Laboratory) | Specimens this report is based on. | |
| result | 0..* | Reference(Observation Results: laboratory) | results | |
| presentedForm | 0..* | Attachment | Entire report as issued (pdf recommended) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| DiagnosticReport.status | required | DiagnosticReportStatus |
| DiagnosticReport.category | example | DiagnosticServiceSectionCodes |
| DiagnosticReport.category:studyType | required | LabStudyTypesEuVs |
| DiagnosticReport.category:specialty | required | LabSpecialtyEuVs |
| DiagnosticReport.code | preferred | LabReportTypesEuVs |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DiagnosticReport | 0..* | DiagnosticReport | Laboratory Report DiagnosticReport | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| DiagnosticReportCompositionR5 | 1..1 | Reference(Composition) | Associated Lab Report Composition URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" | |||||
| value[x] | 1..1 | Reference(Composition: Laboratory Report) | Value of extension | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Report identifier | ||||
| basedOn | 0..* | Reference(ServiceRequest: Laboratory Order) | What was requested | |||||
| status | ?!Σ | 1..1 | code | Status of the Report Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | ||||
| Slices for category | Σ | 0..* | CodeableConceptIPS | Report Category Slice: Unordered, Open by pattern:$this Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
| category:studyType | Σ | 0..* | CodeableConcept | Service category Binding: Laboratory Study Types (required) | ||||
| category:specialty | Σ | 0..* | CodeableConcept | Service category Binding: Laboratory Specialty (required) | ||||
| code | 1..1 | CodeableConceptIPS | Type of (Laboratory) Report Binding: Laboratory Report Types (preferred) | |||||
| subject | Σ | 1..1 | Reference(Patient: Person | Patient: Animal | Group | Location | Device) | Who and/or what this report is about | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | The healthcare event which this Laboratory Report is about (when test ordered). | ||||
| effective[x] | Σ | 0..1 | Clinically relevant time/time-period for report. | |||||
| effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| issued | Σ | 0..1 | instant | DateTime this version was made | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service. | ||||
| resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
| specimen | 0..* | Reference(Specimen: Laboratory) | Specimens this report is based on. | |||||
| result | 0..* | Reference(Observation Results: laboratory) | results | |||||
| media | Σ | 0..* | BackboneElement | Key images associated with this report | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| comment | 0..1 | string | Comment about the image (e.g. explanation) | |||||
| link | Σ | 1..1 | Reference(Media) | Reference to the image source | ||||
| conclusion | 0..1 | string | Clinical conclusion (interpretation) of test results | |||||
| conclusionCode | 0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report. | |||||
| presentedForm | 0..* | Attachment | Entire report as issued (pdf recommended) | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| DiagnosticReport.language | preferred | CommonLanguages
| ||||
| DiagnosticReport.status | required | DiagnosticReportStatus | ||||
| DiagnosticReport.category | example | DiagnosticServiceSectionCodes | ||||
| DiagnosticReport.category:studyType | required | LabStudyTypesEuVs | ||||
| DiagnosticReport.category:specialty | required | LabSpecialtyEuVs | ||||
| DiagnosticReport.code | preferred | LabReportTypesEuVs | ||||
| DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindings |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from DiagnosticReport
Summary
Mandatory: 4 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 Europe. Package hl7.fhir.eu.laboratory#0.1.0-ballot based on FHIR 4.0.1. Generated 2023-10-22
