HL7 FHIR Implementation Guide: Transversal Clinical Core
1.2.0 - STU1 Belgium flag

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

Resource Profile: BeDiagnosticReportDiabetes

Official URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-diagnostic-report-diabetes Version: 1.2.0
Draft as of 2024-08-02 Computable Name: BeDiagnosticReportDiabetes

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from DiagnosticReport

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 0..* DiagnosticReport A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... recorded-date S 0..1 dateTime BeExtRecordedDate
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorded-date
.... recorder S 1..1 Reference(BePatient | BePractitioner | BeOrganization | BePractitionerRole) BeExtRecorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
.... device S 0..1 (Complex) BeExtCodeableReference
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference
..... Slices for extension Content/Rules for all slices
...... extension:concept 0..1 Extension Extension
....... value[x] S 1..1 CodeableConcept Value of extension
........ coding
......... system 0..1 uri Identity of the terminology system
Required Pattern: https://www.ehealth.fgov.be/standards/fhir/core-clinical/NamingSystem/be-ns-nihdi-diagnostic-observation-device
.... note S 0..* Annotation BeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
.... supportingInfo S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo
... Slices for identifier 1..* Identifier Business identifier for report
Slice: Unordered, Open by value:system
.... identifier:UUID S 1..1 Identifier Business identifier for report
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://www.ehealth.fgov.be/standards/fhir/core-clinical/NamingSystem/be-ns-diagnostic-report-diabetes
... status S 1..1 code registered | partial | preliminary | final +
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 1..1 string Version of the system - if relevant
Fixed Value: http://snomed.info/sct/11000172109
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 394483002
... code S 1..1 CodeableConcept Name/Code for this diagnostic report
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 1..1 string Version of the system - if relevant
Fixed Value: http://snomed.info/sct/11000172109
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 243860001
... effective[x] S 0..1 Period Clinically relevant time/time-period for report
.... start S 1..1 dateTime Starting time with inclusive boundary
.... end S 1..1 dateTime End time with inclusive boundary, if not ongoing
... resultsInterpreter S 0..1 Reference(BePractitionerRole | BePractitioner) Primary result interpreter
... result S 0..* Reference(BeObservation) Observations
Slice: Unordered, Open by value:reference.resolve().code
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... presentedForm S 0..* Attachment Entire report as issued
.... contentType 0..1 code Mime type of the content, with charset etc.
Required Pattern: application/pdf

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 1..* Extension Extension
Slice: Unordered, Open by value:url
.... recorded-date S 0..1 dateTime BeExtRecordedDate
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorded-date
.... recorder S 1..1 Reference(BePatient | BePractitioner | BeOrganization | BePractitionerRole) BeExtRecorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
.... device S 0..1 (Complex) BeExtCodeableReference
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference
..... Slices for extension Content/Rules for all slices
...... extension:reference 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "reference"
...... extension:concept 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "concept"
....... value[x] S 1..1 CodeableConcept Value of extension
..... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference"
.... note S 0..* Annotation BeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
.... supportingInfo S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:UUID SΣ 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
Required Pattern: http://www.ehealth.fgov.be/standards/fhir/core-clinical/NamingSystem/be-ns-diagnostic-report-diabetes
... status ?!SΣ 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.

... category SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.



Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 1..1 string Version of the system - if relevant
Fixed Value: http://snomed.info/sct/11000172109
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 394483002
... code SΣ 1..1 CodeableConcept Name/Code for this diagnostic report
Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.


Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 1..1 string Version of the system - if relevant
Fixed Value: http://snomed.info/sct/11000172109
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 243860001
... effective[x] SΣ 0..1 Period Clinically relevant time/time-period for report
.... start SΣC 1..1 dateTime Starting time with inclusive boundary
.... end SΣC 1..1 dateTime End time with inclusive boundary, if not ongoing
... resultsInterpreter SΣ 0..1 Reference(BePractitionerRole | BePractitioner) Primary result interpreter
... result S 0..* Reference(BeObservation) Observations
Slice: Unordered, Open by value:reference.resolve().code
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... presentedForm S 0..* Attachment Entire report as issued
.... contentType Σ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Required Pattern: application/pdf

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.identifier:UUID.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1
from the FHIR Standard
DiagnosticReport.categoryexamplePattern: SNOMED-CT Code 394483002
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codepreferredPattern: SNOMED-CT Code 243860001
http://hl7.org/fhir/ValueSet/report-codes
from the FHIR Standard
DiagnosticReport.presentedForm.contentTyperequiredPattern: application/pdf
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDiagnosticReportIf 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-4errorDiagnosticReportIf 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-5errorDiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDiagnosticReportA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... recorded-date S 0..1 dateTime BeExtRecordedDate
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorded-date
.... recorder S 1..1 Reference(BePatient | BePractitioner | BeOrganization | BePractitionerRole) BeExtRecorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
.... device S 0..1 (Complex) BeExtCodeableReference
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:reference 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "reference"
....... value[x] 0..1 Reference() Value of extension
...... extension:concept 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "concept"
....... value[x] S 1..1 CodeableConcept Value of extension
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 0..* 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
Required Pattern: https://www.ehealth.fgov.be/standards/fhir/core-clinical/NamingSystem/be-ns-nihdi-diagnostic-observation-device
......... version Σ 0..1 string Version of the system - if relevant
......... code Σ 0..1 code Symbol in syntax defined by the system
......... display Σ 0..1 string Representation defined by the system
......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
........ text Σ 0..1 string Plain text representation of the concept
..... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference"
.... note S 0..* Annotation BeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
.... supportingInfo S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier Business identifier for report
Slice: Unordered, Open by value:system
.... identifier:UUID SΣ 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
Required Pattern: http://www.ehealth.fgov.be/standards/fhir/core-clinical/NamingSystem/be-ns-diagnostic-report-diabetes
..... value Σ 0..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 0..* Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) What was requested
... status ?!SΣ 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.

... category SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.



Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 1..1 string Version of the system - if relevant
Fixed Value: http://snomed.info/sct/11000172109
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 394483002
..... display 0..1 string Representation defined by the system
..... 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.


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 1..1 string Version of the system - if relevant
Fixed Value: http://snomed.info/sct/11000172109
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 243860001
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject Σ 0..1 Reference(Patient | Group | Device | Location) The subject of the report - usually, but not always, the patient
... encounter Σ 0..1 Reference(Encounter) Health care event when test ordered
... effective[x] SΣ 0..1 Period Clinically relevant time/time-period 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
.... start SΣC 1..1 dateTime Starting time with inclusive boundary
.... end SΣC 1..1 dateTime End time with inclusive boundary, if not ongoing
... issued Σ 0..1 instant DateTime this version was made
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam) Responsible Diagnostic Service
... resultsInterpreter SΣ 0..1 Reference(BePractitionerRole | BePractitioner) Primary result interpreter
... specimen 0..* Reference(Specimen) Specimens this report is based on
... result S 0..* Reference(BeObservation) Observations
Slice: Unordered, Open by value:reference.resolve().code
... imagingStudy 0..* Reference(ImagingStudy) Reference to full details of imaging associated with the diagnostic report
... media Σ 0..* BackboneElement Key images associated with this report
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... comment 0..1 string Comment about the image (e.g. explanation)
.... link Σ 1..1 Reference(Media) Reference to the image source
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... conclusionCode 0..* CodeableConcept Codes for the clinical conclusion of test results
Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report.


... presentedForm S 0..* Attachment Entire report as issued
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType Σ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Required Pattern: application/pdf
.... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
.... data 0..1 base64Binary Data inline, base64ed
.... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation Σ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DiagnosticReport.identifier:UUID.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:UUID.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1
from the FHIR Standard
DiagnosticReport.categoryexamplePattern: SNOMED-CT Code 394483002
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codepreferredPattern: SNOMED-CT Code 243860001
http://hl7.org/fhir/ValueSet/report-codes
from the FHIR Standard
DiagnosticReport.conclusionCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
DiagnosticReport.presentedForm.contentTyperequiredPattern: application/pdf
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DiagnosticReport.presentedForm.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDiagnosticReportIf 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-4errorDiagnosticReportIf 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-5errorDiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDiagnosticReportA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from DiagnosticReport

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 0..* DiagnosticReport A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... recorded-date S 0..1 dateTime BeExtRecordedDate
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorded-date
.... recorder S 1..1 Reference(BePatient | BePractitioner | BeOrganization | BePractitionerRole) BeExtRecorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
.... device S 0..1 (Complex) BeExtCodeableReference
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference
..... Slices for extension Content/Rules for all slices
...... extension:concept 0..1 Extension Extension
....... value[x] S 1..1 CodeableConcept Value of extension
........ coding
......... system 0..1 uri Identity of the terminology system
Required Pattern: https://www.ehealth.fgov.be/standards/fhir/core-clinical/NamingSystem/be-ns-nihdi-diagnostic-observation-device
.... note S 0..* Annotation BeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
.... supportingInfo S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo
... Slices for identifier 1..* Identifier Business identifier for report
Slice: Unordered, Open by value:system
.... identifier:UUID S 1..1 Identifier Business identifier for report
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://www.ehealth.fgov.be/standards/fhir/core-clinical/NamingSystem/be-ns-diagnostic-report-diabetes
... status S 1..1 code registered | partial | preliminary | final +
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 1..1 string Version of the system - if relevant
Fixed Value: http://snomed.info/sct/11000172109
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 394483002
... code S 1..1 CodeableConcept Name/Code for this diagnostic report
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 1..1 string Version of the system - if relevant
Fixed Value: http://snomed.info/sct/11000172109
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 243860001
... effective[x] S 0..1 Period Clinically relevant time/time-period for report
.... start S 1..1 dateTime Starting time with inclusive boundary
.... end S 1..1 dateTime End time with inclusive boundary, if not ongoing
... resultsInterpreter S 0..1 Reference(BePractitionerRole | BePractitioner) Primary result interpreter
... result S 0..* Reference(BeObservation) Observations
Slice: Unordered, Open by value:reference.resolve().code
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... presentedForm S 0..* Attachment Entire report as issued
.... contentType 0..1 code Mime type of the content, with charset etc.
Required Pattern: application/pdf

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 1..* Extension Extension
Slice: Unordered, Open by value:url
.... recorded-date S 0..1 dateTime BeExtRecordedDate
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorded-date
.... recorder S 1..1 Reference(BePatient | BePractitioner | BeOrganization | BePractitionerRole) BeExtRecorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
.... device S 0..1 (Complex) BeExtCodeableReference
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference
..... Slices for extension Content/Rules for all slices
...... extension:reference 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "reference"
...... extension:concept 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "concept"
....... value[x] S 1..1 CodeableConcept Value of extension
..... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference"
.... note S 0..* Annotation BeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
.... supportingInfo S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:UUID SΣ 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
Required Pattern: http://www.ehealth.fgov.be/standards/fhir/core-clinical/NamingSystem/be-ns-diagnostic-report-diabetes
... status ?!SΣ 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.

... category SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.



Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 1..1 string Version of the system - if relevant
Fixed Value: http://snomed.info/sct/11000172109
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 394483002
... code SΣ 1..1 CodeableConcept Name/Code for this diagnostic report
Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports.


Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 1..1 string Version of the system - if relevant
Fixed Value: http://snomed.info/sct/11000172109
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 243860001
... effective[x] SΣ 0..1 Period Clinically relevant time/time-period for report
.... start SΣC 1..1 dateTime Starting time with inclusive boundary
.... end SΣC 1..1 dateTime End time with inclusive boundary, if not ongoing
... resultsInterpreter SΣ 0..1 Reference(BePractitionerRole | BePractitioner) Primary result interpreter
... result S 0..* Reference(BeObservation) Observations
Slice: Unordered, Open by value:reference.resolve().code
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... presentedForm S 0..* Attachment Entire report as issued
.... contentType Σ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Required Pattern: application/pdf

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.identifier:UUID.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1
from the FHIR Standard
DiagnosticReport.categoryexamplePattern: SNOMED-CT Code 394483002
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codepreferredPattern: SNOMED-CT Code 243860001
http://hl7.org/fhir/ValueSet/report-codes
from the FHIR Standard
DiagnosticReport.presentedForm.contentTyperequiredPattern: application/pdf
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDiagnosticReportIf 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-4errorDiagnosticReportIf 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-5errorDiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDiagnosticReportA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... recorded-date S 0..1 dateTime BeExtRecordedDate
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorded-date
.... recorder S 1..1 Reference(BePatient | BePractitioner | BeOrganization | BePractitionerRole) BeExtRecorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
.... device S 0..1 (Complex) BeExtCodeableReference
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:reference 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "reference"
....... value[x] 0..1 Reference() Value of extension
...... extension:concept 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "concept"
....... value[x] S 1..1 CodeableConcept Value of extension
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ coding Σ 0..* 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
Required Pattern: https://www.ehealth.fgov.be/standards/fhir/core-clinical/NamingSystem/be-ns-nihdi-diagnostic-observation-device
......... version Σ 0..1 string Version of the system - if relevant
......... code Σ 0..1 code Symbol in syntax defined by the system
......... display Σ 0..1 string Representation defined by the system
......... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
........ text Σ 0..1 string Plain text representation of the concept
..... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference"
.... note S 0..* Annotation BeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-simple-note
.... supportingInfo S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier Business identifier for report
Slice: Unordered, Open by value:system
.... identifier:UUID SΣ 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
Required Pattern: http://www.ehealth.fgov.be/standards/fhir/core-clinical/NamingSystem/be-ns-diagnostic-report-diabetes
..... value Σ 0..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 0..* Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) What was requested
... status ?!SΣ 1..1 code registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required): The status of the diagnostic report.

... category SΣ 1..1 CodeableConcept Service category
Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections.



Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 1..1 string Version of the system - if relevant
Fixed Value: http://snomed.info/sct/11000172109
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 394483002
..... display 0..1 string Representation defined by the system
..... 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.


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 1..1 string Version of the system - if relevant
Fixed Value: http://snomed.info/sct/11000172109
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 243860001
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject Σ 0..1 Reference(Patient | Group | Device | Location) The subject of the report - usually, but not always, the patient
... encounter Σ 0..1 Reference(Encounter) Health care event when test ordered
... effective[x] SΣ 0..1 Period Clinically relevant time/time-period 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
.... start SΣC 1..1 dateTime Starting time with inclusive boundary
.... end SΣC 1..1 dateTime End time with inclusive boundary, if not ongoing
... issued Σ 0..1 instant DateTime this version was made
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam) Responsible Diagnostic Service
... resultsInterpreter SΣ 0..1 Reference(BePractitionerRole | BePractitioner) Primary result interpreter
... specimen 0..* Reference(Specimen) Specimens this report is based on
... result S 0..* Reference(BeObservation) Observations
Slice: Unordered, Open by value:reference.resolve().code
... imagingStudy 0..* Reference(ImagingStudy) Reference to full details of imaging associated with the diagnostic report
... media Σ 0..* BackboneElement Key images associated with this report
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... comment 0..1 string Comment about the image (e.g. explanation)
.... link Σ 1..1 Reference(Media) Reference to the image source
... conclusion S 0..1 string Clinical conclusion (interpretation) of test results
... conclusionCode 0..* CodeableConcept Codes for the clinical conclusion of test results
Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report.


... presentedForm S 0..* Attachment Entire report as issued
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType Σ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Required Pattern: application/pdf
.... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
.... data 0..1 base64Binary Data inline, base64ed
.... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation Σ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DiagnosticReport.identifier:UUID.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DiagnosticReport.identifier:UUID.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1
from the FHIR Standard
DiagnosticReport.categoryexamplePattern: SNOMED-CT Code 394483002
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codepreferredPattern: SNOMED-CT Code 243860001
http://hl7.org/fhir/ValueSet/report-codes
from the FHIR Standard
DiagnosticReport.conclusionCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
DiagnosticReport.presentedForm.contentTyperequiredPattern: application/pdf
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DiagnosticReport.presentedForm.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDiagnosticReportIf 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-4errorDiagnosticReportIf 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-5errorDiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDiagnosticReportA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron