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
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
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DiagnosticReport
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | DiagnosticReport | |||
text | ||||
status | 1..1 | code | generated | extensions | additional | empty Required Pattern: empty | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
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 | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074 | |
code | 0..1 | code | Symbol in syntax defined by the system Fixed Value: LAB | |
display | 0..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 |
---|---|---|---|---|
DiagnosticReport | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
note | S | 0..* | Annotation | BeExtNote URL: https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-ext-note ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
Slices for identifier | SΣ | 1..* | Identifier | Business identifier for report Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
identifier:DRID | Σ | 1..1 | Identifier | Business identifier for report ele-1: All FHIR elements must have a @value or children |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://www.ehealth.fgov.be/lab-report/diagnostic-report-id |
value | Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children |
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. ele-1: All FHIR elements must have a @value or children |
category | SΣ | 1..* | CodeableConcept | The subject of this specialty, expressed in a LOINC code. Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. ele-1: All FHIR elements must have a @value or children |
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code ele-1: All FHIR elements must have a @value or children |
coding:All Slices | Content/Rules for all slices | |||
system | Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
code | Σ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
display | Σ | 1..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
coding:LABREPORT | Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
system | Σ | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074 |
code | Σ | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Fixed Value: LAB |
display | Σ | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children Fixed Value: Laboratory |
code | SΣ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. ele-1: All FHIR elements must have a @value or children |
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. ele-1: All FHIR elements must have a @value or children |
effective[x] | SΣ | 0..1 | Time of the specimen collection - is overruled when collection time is given in .specimen element. ele-1: All FHIR elements must have a @value or children | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
issued | SΣ | 1..1 | instant | DateTime this version was made ele-1: All FHIR elements must have a @value or children |
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. ele-1: All FHIR elements must have a @value or children |
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. ele-1: All FHIR elements must have a @value or children |
specimen | S | 0..* | Reference(BeSpecimenLaboratory) | Specimens this report is based on ele-1: All FHIR elements must have a @value or children |
result | S | 0..* | Reference(BeObservationLaboratory) | Observations ele-1: All FHIR elements must have a @value or children |
media | SΣ | 0..* | BackboneElement | Key images associated with this report ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
link | Σ | 1..1 | Reference(Media) | Reference to the image source ele-1: All FHIR elements must have a @value or children |
conclusion | S | 0..1 | string | Clinical conclusion (interpretation) of test results ele-1: All FHIR elements must have a @value or children |
conclusionCode | S | 0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report. ele-1: All FHIR elements must have a @value or children |
presentedForm | S | 0..* | Attachment | Entire report as issued ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DiagnosticReport.identifier:DRID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 from the FHIR Standard | |
DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | |
DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/report-codes from the FHIR Standard | |
DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard |
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 | 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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
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 txt-1: 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 txt-2: The narrative SHALL have some non-whitespace content | ||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
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 | Σ | 0..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 | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: LAB | ||||
display | Σ | 0..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 |
Path | Conformance | ValueSet / Code | URI | |||
DiagnosticReport.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
DiagnosticReport.text.status | required | Pattern: emptyhttp://hl7.org/fhir/ValueSet/narrative-status|4.0.1 from the FHIR Standard | ||||
DiagnosticReport.identifier:DRID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
DiagnosticReport.identifier:DRID.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 from the FHIR Standard | ||||
DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | ||||
DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/report-codes from the FHIR Standard | ||||
DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard |
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() | |
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:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Differential View
This structure is derived from DiagnosticReport
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | DiagnosticReport | |||
text | ||||
status | 1..1 | code | generated | extensions | additional | empty Required Pattern: empty | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
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 | 0..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074 | |
code | 0..1 | code | Symbol in syntax defined by the system Fixed Value: LAB | |
display | 0..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 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
note | S | 0..* | Annotation | BeExtNote URL: https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-ext-note ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
Slices for identifier | SΣ | 1..* | Identifier | Business identifier for report Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
identifier:DRID | Σ | 1..1 | Identifier | Business identifier for report ele-1: All FHIR elements must have a @value or children |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://www.ehealth.fgov.be/lab-report/diagnostic-report-id |
value | Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children |
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. ele-1: All FHIR elements must have a @value or children |
category | SΣ | 1..* | CodeableConcept | The subject of this specialty, expressed in a LOINC code. Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. ele-1: All FHIR elements must have a @value or children |
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code ele-1: All FHIR elements must have a @value or children |
coding:All Slices | Content/Rules for all slices | |||
system | Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
code | Σ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
display | Σ | 1..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
coding:LABREPORT | Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
system | Σ | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0074 |
code | Σ | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Fixed Value: LAB |
display | Σ | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children Fixed Value: Laboratory |
code | SΣ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. ele-1: All FHIR elements must have a @value or children |
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. ele-1: All FHIR elements must have a @value or children |
effective[x] | SΣ | 0..1 | Time of the specimen collection - is overruled when collection time is given in .specimen element. ele-1: All FHIR elements must have a @value or children | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
issued | SΣ | 1..1 | instant | DateTime this version was made ele-1: All FHIR elements must have a @value or children |
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. ele-1: All FHIR elements must have a @value or children |
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. ele-1: All FHIR elements must have a @value or children |
specimen | S | 0..* | Reference(BeSpecimenLaboratory) | Specimens this report is based on ele-1: All FHIR elements must have a @value or children |
result | S | 0..* | Reference(BeObservationLaboratory) | Observations ele-1: All FHIR elements must have a @value or children |
media | SΣ | 0..* | BackboneElement | Key images associated with this report ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
link | Σ | 1..1 | Reference(Media) | Reference to the image source ele-1: All FHIR elements must have a @value or children |
conclusion | S | 0..1 | string | Clinical conclusion (interpretation) of test results ele-1: All FHIR elements must have a @value or children |
conclusionCode | S | 0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report. ele-1: All FHIR elements must have a @value or children |
presentedForm | S | 0..* | Attachment | Entire report as issued ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DiagnosticReport.identifier:DRID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 from the FHIR Standard | |
DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | |
DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/report-codes from the FHIR Standard | |
DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard |
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 | 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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
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 txt-1: 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 txt-2: The narrative SHALL have some non-whitespace content | ||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
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 | Σ | 0..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 | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: LAB | ||||
display | Σ | 0..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 |
Path | Conformance | ValueSet / Code | URI | |||
DiagnosticReport.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
DiagnosticReport.text.status | required | Pattern: emptyhttp://hl7.org/fhir/ValueSet/narrative-status|4.0.1 from the FHIR Standard | ||||
DiagnosticReport.identifier:DRID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
DiagnosticReport.identifier:DRID.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 from the FHIR Standard | ||||
DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | ||||
DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/report-codes from the FHIR Standard | ||||
DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard |
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() | |
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:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron