HL7 BE Laboratory WG Implementation Guide
1.0.1 - STU

HL7 BE Laboratory WG Implementation Guide, published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/lab/ and changes regularly. See the Directory of published versions

## Resource Profile: BeLaboratoryReport

Official URL: https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-laboratory-report | Version: 1.0.1
Draft as of 2020-09-07 | Maturity Level: 1 | Computable Name: BeLaboratoryReport

Belgian profile for a laboratory report

Usages:

- Refer to this Profile: BeLaboratoryreportComposition

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
DiagnosticReport |  | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:note | S | 0..* | Annotation | BeExtNote URL: https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-ext-note
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | Business identifier for report Slice: Unordered, Open by value:system
identifier:DRID | Σ | 1..1 | Identifier | Business identifier for report
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/lab-report/diagnostic-report-id
value | Σ | 1..1 | string | The value that is unique Example General: 123456
basedOn | S | 1..1 | Reference(ServiceRequest) | A reference to a ServiceRequest SHALL be given here that minimally includes the time of prescription.
status | ?!S Σ | 1..1 | code | Status of the report: consult the HL7 list of permitted values Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
category | S Σ | 1..* | CodeableConcept | The subject of this specialty, expressed in a LOINC code. Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code
coding:All Slices |  |  |  | Content/Rules for all slices
system | Σ | 1..1 | uri | Identity of the terminology system
code | Σ | 1..1 | code | Symbol in syntax defined by the system
display | Σ | 1..1 | string | Representation defined by the system
coding:LABREPORT | Σ | 1..1 | Coding | Code defined by a terminology system
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LAB
display | Σ | 1..1 | string | Representation defined by the system Fixed Value: Laboratory
code | S Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
subject | S Σ | 1..1 | Reference(Patient core BE profile | Group | Device | Location) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient.
effective[x] | S Σ | 0..1 |  | Time of the specimen collection - is overruled when collection time is given in .specimen element.
effectiveDateTime |  |  | dateTime |
effectivePeriod |  |  | Period |
issued | S Σ | 1..1 | instant | DateTime this version was made
performer | S Σ | 1..* | Reference(Organisation core BE profile | Practitioner core BE profile | CareTeam | Practitioner role core BE profile) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BeOrganization.
resultsInterpreter | S Σ | 1..* | Reference(Practitioner core BE profile | Practitioner role core BE profile | Organisation core BE profile | CareTeam) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePractitioner.
specimen | S | 0..* | Reference(BeSpecimenLaboratory) | Specimens this report is based on
result | S | 0..* | Reference(BeObservationLaboratory) | Observations
media | S Σ | 0..* | BackboneElement | Key images associated with this report
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 1..1 | Reference(Media) | Reference to the image source
conclusion | S | 0..1 | string | Clinical conclusion (interpretation) of test results
conclusionCode | S | 0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report.
presentedForm | S | 0..* | Attachment | Entire report as issued
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
DiagnosticReport.identifier:DRID.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
DiagnosticReport.status | Base | required | DiagnosticReportStatus | 📍4.0.1 | FHIR Std.
DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍4.0.1 | FHIR Std.
DiagnosticReport.code | Base | preferred | LOINC Diagnostic Report Codes | 📍4.0.1 | FHIR Std.
DiagnosticReport.conclusionCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
DiagnosticReport |  | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
text |  |  |  |
status |  | 1..1 | code | generated | extensions | additional | empty Required Pattern: empty
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:note | S | 0..* | Annotation | BeExtNote URL: https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-ext-note
Slices for identifier | S | 1..* | Identifier | Business identifier for report Slice: Unordered, Open by value:system
identifier:DRID |  | 1..1 | Identifier | Business identifier for report
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/lab-report/diagnostic-report-id
value |  | 1..1 | string | The value that is unique
basedOn | S | 1..1 | Reference(ServiceRequest) | A reference to a ServiceRequest SHALL be given here that minimally includes the time of prescription.
status | S | 1..1 | code | Status of the report: consult the HL7 list of permitted values
category | S | 1..* | CodeableConcept | The subject of this specialty, expressed in a LOINC code.
Slices for coding |  | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code
coding:All Slices |  |  |  | Content/Rules for all slices
system |  | 1..1 | uri | Identity of the terminology system
code |  | 1..1 | code | Symbol in syntax defined by the system
display |  | 1..1 | string | Representation defined by the system
coding:LABREPORT |  | 1..1 | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LAB
display |  | 1..1 | string | Representation defined by the system Fixed Value: Laboratory
code | S | 1..1 | CodeableConcept | Name/Code for this diagnostic report
subject | S | 1..1 | Reference(Patient core BE profile | Group | Device | Location) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient.
effective[x] | S | 0..1 | dateTime, Period | Time of the specimen collection - is overruled when collection time is given in .specimen element.
issued | S | 1..1 | instant | DateTime this version was made
performer | S | 1..* | Reference(Organisation core BE profile | Practitioner core BE profile | CareTeam | Practitioner role core BE profile) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BeOrganization.
resultsInterpreter | S | 1..* | Reference(Practitioner core BE profile | Practitioner role core BE profile | Organisation core BE profile | CareTeam) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePractitioner.
specimen | S | 0..* | Reference(BeSpecimenLaboratory) | Specimens this report is based on
result | S | 0..* | Reference(BeObservationLaboratory) | Observations
media | S | 0..* | BackboneElement | Key images associated with this report
conclusion | S | 0..1 | string | Clinical conclusion (interpretation) of test results
conclusionCode | S | 0..* | CodeableConcept | Codes for the clinical conclusion of test results
presentedForm | S | 0..* | Attachment | Entire report as issued
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
DiagnosticReport |  | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
status |  | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. Required Pattern: empty
div | C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:note | S | 0..* | Annotation | BeExtNote URL: https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-ext-note
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | Business identifier for report Slice: Unordered, Open by value:system
identifier:DRID | Σ | 1..1 | Identifier | Business identifier for report
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/lab-report/diagnostic-report-id
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
basedOn | S | 1..1 | Reference(ServiceRequest) | A reference to a ServiceRequest SHALL be given here that minimally includes the time of prescription.
status | ?!S Σ | 1..1 | code | Status of the report: consult the HL7 list of permitted values Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
category | S Σ | 1..* | CodeableConcept | The subject of this specialty, expressed in a LOINC code. Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code
coding:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system
display | Σ | 1..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
coding:LABREPORT | Σ | 1..1 | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LAB
display | Σ | 1..1 | string | Representation defined by the system Fixed Value: Laboratory
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
code | S Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
subject | S Σ | 1..1 | Reference(Patient core BE profile | Group | Device | Location) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient.
encounter | Σ | 0..1 | Reference(Encounter) | Health care event when test ordered
effective[x] | S Σ | 0..1 |  | Time of the specimen collection - is overruled when collection time is given in .specimen element.
effectiveDateTime |  |  | dateTime |
effectivePeriod |  |  | Period |
issued | S Σ | 1..1 | instant | DateTime this version was made
performer | S Σ | 1..* | Reference(Organisation core BE profile | Practitioner core BE profile | CareTeam | Practitioner role core BE profile) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BeOrganization.
resultsInterpreter | S Σ | 1..* | Reference(Practitioner core BE profile | Practitioner role core BE profile | Organisation core BE profile | CareTeam) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePractitioner.
specimen | S | 0..* | Reference(BeSpecimenLaboratory) | Specimens this report is based on
result | S | 0..* | Reference(BeObservationLaboratory) | Observations
imagingStudy |  | 0..* | Reference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report
media | S Σ | 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 | S | 0..1 | string | Clinical conclusion (interpretation) of test results
conclusionCode | S | 0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report.
presentedForm | S | 0..* | Attachment | Entire report as issued
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
DiagnosticReport.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
DiagnosticReport.text.​status | Base | required | NarrativeStatus | 📍4.0.1 | FHIR Std.
DiagnosticReport.identifier:DRID.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
DiagnosticReport.identifier:DRID.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
DiagnosticReport.status | Base | required | DiagnosticReportStatus | 📍4.0.1 | FHIR Std.
DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍4.0.1 | FHIR Std.
DiagnosticReport.code | Base | preferred | LOINC Diagnostic Report Codes | 📍4.0.1 | FHIR Std.
DiagnosticReport.conclusionCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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()`
txt-1 | error | DiagnosticReport.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes | `htmlChecks()`
txt-2 | error | DiagnosticReport.text.div | The narrative SHALL have some non-whitespace content | `htmlChecks()`

This structure is derived from DiagnosticReport

Summary

Mandatory: 15 elements
Must-Support: 17 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

- Patient core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient)
- Organisation core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-organization)
- Practitioner core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner)
- Practitioner role core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitionerrole)
- BeSpecimenLaboratory (https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-specimen-laboratory)
- BeObservationLaboratory (https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-observation-laboratory)

Extensions

This structure refers to these extensions:

- https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-ext-note

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of DiagnosticReport.identifier
- The element 1 is sliced based on the value of DiagnosticReport.category.coding

Maturity: 1

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
DiagnosticReport |  | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:note | S | 0..* | Annotation | BeExtNote URL: https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-ext-note
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | Business identifier for report Slice: Unordered, Open by value:system
identifier:DRID | Σ | 1..1 | Identifier | Business identifier for report
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/lab-report/diagnostic-report-id
value | Σ | 1..1 | string | The value that is unique Example General: 123456
basedOn | S | 1..1 | Reference(ServiceRequest) | A reference to a ServiceRequest SHALL be given here that minimally includes the time of prescription.
status | ?!S Σ | 1..1 | code | Status of the report: consult the HL7 list of permitted values Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
category | S Σ | 1..* | CodeableConcept | The subject of this specialty, expressed in a LOINC code. Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code
coding:All Slices |  |  |  | Content/Rules for all slices
system | Σ | 1..1 | uri | Identity of the terminology system
code | Σ | 1..1 | code | Symbol in syntax defined by the system
display | Σ | 1..1 | string | Representation defined by the system
coding:LABREPORT | Σ | 1..1 | Coding | Code defined by a terminology system
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LAB
display | Σ | 1..1 | string | Representation defined by the system Fixed Value: Laboratory
code | S Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
subject | S Σ | 1..1 | Reference(Patient core BE profile | Group | Device | Location) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient.
effective[x] | S Σ | 0..1 |  | Time of the specimen collection - is overruled when collection time is given in .specimen element.
effectiveDateTime |  |  | dateTime |
effectivePeriod |  |  | Period |
issued | S Σ | 1..1 | instant | DateTime this version was made
performer | S Σ | 1..* | Reference(Organisation core BE profile | Practitioner core BE profile | CareTeam | Practitioner role core BE profile) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BeOrganization.
resultsInterpreter | S Σ | 1..* | Reference(Practitioner core BE profile | Practitioner role core BE profile | Organisation core BE profile | CareTeam) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePractitioner.
specimen | S | 0..* | Reference(BeSpecimenLaboratory) | Specimens this report is based on
result | S | 0..* | Reference(BeObservationLaboratory) | Observations
media | S Σ | 0..* | BackboneElement | Key images associated with this report
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 1..1 | Reference(Media) | Reference to the image source
conclusion | S | 0..1 | string | Clinical conclusion (interpretation) of test results
conclusionCode | S | 0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report.
presentedForm | S | 0..* | Attachment | Entire report as issued
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
DiagnosticReport.identifier:DRID.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
DiagnosticReport.status | Base | required | DiagnosticReportStatus | 📍4.0.1 | FHIR Std.
DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍4.0.1 | FHIR Std.
DiagnosticReport.code | Base | preferred | LOINC Diagnostic Report Codes | 📍4.0.1 | FHIR Std.
DiagnosticReport.conclusionCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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()`

Differential View

This structure is derived from DiagnosticReport

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
DiagnosticReport |  | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
text |  |  |  |
status |  | 1..1 | code | generated | extensions | additional | empty Required Pattern: empty
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:note | S | 0..* | Annotation | BeExtNote URL: https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-ext-note
Slices for identifier | S | 1..* | Identifier | Business identifier for report Slice: Unordered, Open by value:system
identifier:DRID |  | 1..1 | Identifier | Business identifier for report
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/lab-report/diagnostic-report-id
value |  | 1..1 | string | The value that is unique
basedOn | S | 1..1 | Reference(ServiceRequest) | A reference to a ServiceRequest SHALL be given here that minimally includes the time of prescription.
status | S | 1..1 | code | Status of the report: consult the HL7 list of permitted values
category | S | 1..* | CodeableConcept | The subject of this specialty, expressed in a LOINC code.
Slices for coding |  | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code
coding:All Slices |  |  |  | Content/Rules for all slices
system |  | 1..1 | uri | Identity of the terminology system
code |  | 1..1 | code | Symbol in syntax defined by the system
display |  | 1..1 | string | Representation defined by the system
coding:LABREPORT |  | 1..1 | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LAB
display |  | 1..1 | string | Representation defined by the system Fixed Value: Laboratory
code | S | 1..1 | CodeableConcept | Name/Code for this diagnostic report
subject | S | 1..1 | Reference(Patient core BE profile | Group | Device | Location) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient.
effective[x] | S | 0..1 | dateTime, Period | Time of the specimen collection - is overruled when collection time is given in .specimen element.
issued | S | 1..1 | instant | DateTime this version was made
performer | S | 1..* | Reference(Organisation core BE profile | Practitioner core BE profile | CareTeam | Practitioner role core BE profile) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BeOrganization.
resultsInterpreter | S | 1..* | Reference(Practitioner core BE profile | Practitioner role core BE profile | Organisation core BE profile | CareTeam) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePractitioner.
specimen | S | 0..* | Reference(BeSpecimenLaboratory) | Specimens this report is based on
result | S | 0..* | Reference(BeObservationLaboratory) | Observations
media | S | 0..* | BackboneElement | Key images associated with this report
conclusion | S | 0..1 | string | Clinical conclusion (interpretation) of test results
conclusionCode | S | 0..* | CodeableConcept | Codes for the clinical conclusion of test results
presentedForm | S | 0..* | Attachment | Entire report as issued
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
DiagnosticReport |  | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
status |  | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. Required Pattern: empty
div | C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:note | S | 0..* | Annotation | BeExtNote URL: https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-ext-note
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | S Σ | 1..* | Identifier | Business identifier for report Slice: Unordered, Open by value:system
identifier:DRID | Σ | 1..1 | Identifier | Business identifier for report
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/lab-report/diagnostic-report-id
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
basedOn | S | 1..1 | Reference(ServiceRequest) | A reference to a ServiceRequest SHALL be given here that minimally includes the time of prescription.
status | ?!S Σ | 1..1 | code | Status of the report: consult the HL7 list of permitted values Binding: DiagnosticReportStatus (required): The status of the diagnostic report.
category | S Σ | 1..* | CodeableConcept | The subject of this specialty, expressed in a LOINC code. Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code
coding:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system
display | Σ | 1..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
coding:LABREPORT | Σ | 1..1 | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LAB
display | Σ | 1..1 | string | Representation defined by the system Fixed Value: Laboratory
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
code | S Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.
subject | S Σ | 1..1 | Reference(Patient core BE profile | Group | Device | Location) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient.
encounter | Σ | 0..1 | Reference(Encounter) | Health care event when test ordered
effective[x] | S Σ | 0..1 |  | Time of the specimen collection - is overruled when collection time is given in .specimen element.
effectiveDateTime |  |  | dateTime |
effectivePeriod |  |  | Period |
issued | S Σ | 1..1 | instant | DateTime this version was made
performer | S Σ | 1..* | Reference(Organisation core BE profile | Practitioner core BE profile | CareTeam | Practitioner role core BE profile) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BeOrganization.
resultsInterpreter | S Σ | 1..* | Reference(Practitioner core BE profile | Practitioner role core BE profile | Organisation core BE profile | CareTeam) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePractitioner.
specimen | S | 0..* | Reference(BeSpecimenLaboratory) | Specimens this report is based on
result | S | 0..* | Reference(BeObservationLaboratory) | Observations
imagingStudy |  | 0..* | Reference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report
media | S Σ | 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 | S | 0..1 | string | Clinical conclusion (interpretation) of test results
conclusionCode | S | 0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report.
presentedForm | S | 0..* | Attachment | Entire report as issued
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
DiagnosticReport.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
DiagnosticReport.text.​status | Base | required | NarrativeStatus | 📍4.0.1 | FHIR Std.
DiagnosticReport.identifier:DRID.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
DiagnosticReport.identifier:DRID.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
DiagnosticReport.status | Base | required | DiagnosticReportStatus | 📍4.0.1 | FHIR Std.
DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍4.0.1 | FHIR Std.
DiagnosticReport.code | Base | preferred | LOINC Diagnostic Report Codes | 📍4.0.1 | FHIR Std.
DiagnosticReport.conclusionCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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()`
txt-1 | error | DiagnosticReport.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes | `htmlChecks()`
txt-2 | error | DiagnosticReport.text.div | The narrative SHALL have some non-whitespace content | `htmlChecks()`

This structure is derived from DiagnosticReport

Summary

Mandatory: 15 elements
Must-Support: 17 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

- Patient core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient)
- Organisation core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-organization)
- Practitioner core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner)
- Practitioner role core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitionerrole)
- BeSpecimenLaboratory (https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-specimen-laboratory)
- BeObservationLaboratory (https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-observation-laboratory)

Extensions

This structure refers to these extensions:

- https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-ext-note

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of DiagnosticReport.identifier
- The element 1 is sliced based on the value of DiagnosticReport.category.coding

Maturity: 1

Other representations of profile: CSV, Excel, Schematron