0.1.0 - ci-build

kenyaClaimsIG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: DiagnosticReportLabProfile

Official URL: https://shr.tiberbuapps.com/fhir/StructureDefinition/DiagnosticReportLabProfile Version: 0.1.0
Draft as of 2024-09-06 Computable Name: DiagnosticReportLabProfile

A profile for lab diagnostic reports

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
... status 1..1 code Always 'final'
Binding: http://hl7.org/fhir/diagnostic-report-status (required)
Required Pattern: final
... category 1..1 CodeableConcept Always 'laboratory'
Binding: http://terminology.hl7.org/CodeSystem/v2-0074 (required)
.... coding
..... system 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0074
..... code 0..1 code Symbol in syntax defined by the system
Required Pattern: LAB
..... display 0..1 string Representation defined by the system
Required Pattern: Laboratory
.... text 0..1 string Plain text representation of the concept
Required Pattern: Laboratory
... code 1..1 CodeableConcept Name/Code for this diagnostic report
Binding: http://terminology.hl7.org/CodeSystem/condition-clinical (required)
... Slices for effective[x] 1..1 dateTime Clinically relevant time/time-period for report
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime 1..1 dateTime Clinically relevant time/time-period for report
... performer 1..* Reference(Practitioner | Organization) Who perfomed the investigation
... specimen 0..1 Reference(Specimen) Specimens this report is based on
... result 1..1 Reference(ObservationLabResultsProfile) Provide references to the lab result obs

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
DiagnosticReport.statusrequiredPattern: final
http://hl7.org/fhir/diagnostic-report-status
DiagnosticReport.categoryrequiredhttp://terminology.hl7.org/CodeSystem/v2-0074
http://terminology.hl7.org/CodeSystem/v2-0074
DiagnosticReport.coderequiredhttp://terminology.hl7.org/CodeSystem/condition-clinical
http://terminology.hl7.org/CodeSystem/condition-clinical
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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code Always 'final'
Binding: http://hl7.org/fhir/diagnostic-report-status (required)
Required Pattern: final
.... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Laboratory
... code Σ 1..1 CodeableConcept Name/Code for this diagnostic report
Binding: http://terminology.hl7.org/CodeSystem/condition-clinical (required)
... subject Σ 1..1 Reference(SHAPatient) The subject of the report - usually, but not always, the patient
... Slices for effective[x] Σ 1..1 dateTime Clinically relevant time/time-period for report
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime Σ 1..1 dateTime Clinically relevant time/time-period for report
... performer Σ 1..* Reference(Practitioner | Organization) Who perfomed the investigation
... specimen 0..1 Reference(Specimen) Specimens this report is based on
... result 1..1 Reference(ObservationLabResultsProfile) Provide references to the lab result obs

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.statusrequiredPattern: final
http://hl7.org/fhir/diagnostic-report-status
DiagnosticReport.categoryrequiredhttp://terminology.hl7.org/CodeSystem/v2-0074
http://terminology.hl7.org/CodeSystem/v2-0074
DiagnosticReport.coderequiredhttp://terminology.hl7.org/CodeSystem/condition-clinical
http://terminology.hl7.org/CodeSystem/condition-clinical

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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for report
... basedOn 0..* Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) What was requested
... status ?!Σ 1..1 code Always 'final'
Binding: http://hl7.org/fhir/diagnostic-report-status (required)
Required Pattern: final
... category Σ 1..1 CodeableConcept Always 'laboratory'
Binding: http://terminology.hl7.org/CodeSystem/v2-0074 (required)
.... 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: 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
Required Pattern: LAB
..... display Σ 0..1 string Representation defined by the system
Required Pattern: Laboratory
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Laboratory
... code Σ 1..1 CodeableConcept Name/Code for this diagnostic report
Binding: http://terminology.hl7.org/CodeSystem/condition-clinical (required)
... subject Σ 1..1 Reference(SHAPatient) The subject of the report - usually, but not always, the patient
... encounter Σ 0..1 Reference(Encounter) Health care event when test ordered
... Slices for effective[x] Σ 1..1 dateTime Clinically relevant time/time-period for report
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime Σ 1..1 dateTime Clinically relevant time/time-period for report
... issued Σ 0..1 instant DateTime this version was made
... performer Σ 1..* Reference(Practitioner | Organization) Who perfomed the investigation
... resultsInterpreter Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam) Primary result interpreter
... specimen 0..1 Reference(Specimen) Specimens this report is based on
... result 1..1 Reference(ObservationLabResultsProfile) Provide references to the lab result obs
... 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 0..1 string Clinical conclusion (interpretation) of test results
... conclusionCode 0..* CodeableConcept Codes for the clinical conclusion of test results
Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report.


... presentedForm 0..* Attachment Entire report as issued

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.statusrequiredPattern: final
http://hl7.org/fhir/diagnostic-report-status
DiagnosticReport.categoryrequiredhttp://terminology.hl7.org/CodeSystem/v2-0074
http://terminology.hl7.org/CodeSystem/v2-0074
DiagnosticReport.coderequiredhttp://terminology.hl7.org/CodeSystem/condition-clinical
http://terminology.hl7.org/CodeSystem/condition-clinical
DiagnosticReport.conclusionCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
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()

This structure is derived from DiagnosticReport

Summary

Mandatory: 6 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DiagnosticReport.effective[x]

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
... status 1..1 code Always 'final'
Binding: http://hl7.org/fhir/diagnostic-report-status (required)
Required Pattern: final
... category 1..1 CodeableConcept Always 'laboratory'
Binding: http://terminology.hl7.org/CodeSystem/v2-0074 (required)
.... coding
..... system 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0074
..... code 0..1 code Symbol in syntax defined by the system
Required Pattern: LAB
..... display 0..1 string Representation defined by the system
Required Pattern: Laboratory
.... text 0..1 string Plain text representation of the concept
Required Pattern: Laboratory
... code 1..1 CodeableConcept Name/Code for this diagnostic report
Binding: http://terminology.hl7.org/CodeSystem/condition-clinical (required)
... Slices for effective[x] 1..1 dateTime Clinically relevant time/time-period for report
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime 1..1 dateTime Clinically relevant time/time-period for report
... performer 1..* Reference(Practitioner | Organization) Who perfomed the investigation
... specimen 0..1 Reference(Specimen) Specimens this report is based on
... result 1..1 Reference(ObservationLabResultsProfile) Provide references to the lab result obs

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
DiagnosticReport.statusrequiredPattern: final
http://hl7.org/fhir/diagnostic-report-status
DiagnosticReport.categoryrequiredhttp://terminology.hl7.org/CodeSystem/v2-0074
http://terminology.hl7.org/CodeSystem/v2-0074
DiagnosticReport.coderequiredhttp://terminology.hl7.org/CodeSystem/condition-clinical
http://terminology.hl7.org/CodeSystem/condition-clinical

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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code Always 'final'
Binding: http://hl7.org/fhir/diagnostic-report-status (required)
Required Pattern: final
.... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Laboratory
... code Σ 1..1 CodeableConcept Name/Code for this diagnostic report
Binding: http://terminology.hl7.org/CodeSystem/condition-clinical (required)
... subject Σ 1..1 Reference(SHAPatient) The subject of the report - usually, but not always, the patient
... Slices for effective[x] Σ 1..1 dateTime Clinically relevant time/time-period for report
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime Σ 1..1 dateTime Clinically relevant time/time-period for report
... performer Σ 1..* Reference(Practitioner | Organization) Who perfomed the investigation
... specimen 0..1 Reference(Specimen) Specimens this report is based on
... result 1..1 Reference(ObservationLabResultsProfile) Provide references to the lab result obs

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.statusrequiredPattern: final
http://hl7.org/fhir/diagnostic-report-status
DiagnosticReport.categoryrequiredhttp://terminology.hl7.org/CodeSystem/v2-0074
http://terminology.hl7.org/CodeSystem/v2-0074
DiagnosticReport.coderequiredhttp://terminology.hl7.org/CodeSystem/condition-clinical
http://terminology.hl7.org/CodeSystem/condition-clinical

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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for report
... basedOn 0..* Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) What was requested
... status ?!Σ 1..1 code Always 'final'
Binding: http://hl7.org/fhir/diagnostic-report-status (required)
Required Pattern: final
... category Σ 1..1 CodeableConcept Always 'laboratory'
Binding: http://terminology.hl7.org/CodeSystem/v2-0074 (required)
.... 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: 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
Required Pattern: LAB
..... display Σ 0..1 string Representation defined by the system
Required Pattern: Laboratory
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Laboratory
... code Σ 1..1 CodeableConcept Name/Code for this diagnostic report
Binding: http://terminology.hl7.org/CodeSystem/condition-clinical (required)
... subject Σ 1..1 Reference(SHAPatient) The subject of the report - usually, but not always, the patient
... encounter Σ 0..1 Reference(Encounter) Health care event when test ordered
... Slices for effective[x] Σ 1..1 dateTime Clinically relevant time/time-period for report
Slice: Unordered, Closed by type:$this
.... effective[x]:effectiveDateTime Σ 1..1 dateTime Clinically relevant time/time-period for report
... issued Σ 0..1 instant DateTime this version was made
... performer Σ 1..* Reference(Practitioner | Organization) Who perfomed the investigation
... resultsInterpreter Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam) Primary result interpreter
... specimen 0..1 Reference(Specimen) Specimens this report is based on
... result 1..1 Reference(ObservationLabResultsProfile) Provide references to the lab result obs
... 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 0..1 string Clinical conclusion (interpretation) of test results
... conclusionCode 0..* CodeableConcept Codes for the clinical conclusion of test results
Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report.


... presentedForm 0..* Attachment Entire report as issued

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.statusrequiredPattern: final
http://hl7.org/fhir/diagnostic-report-status
DiagnosticReport.categoryrequiredhttp://terminology.hl7.org/CodeSystem/v2-0074
http://terminology.hl7.org/CodeSystem/v2-0074
DiagnosticReport.coderequiredhttp://terminology.hl7.org/CodeSystem/condition-clinical
http://terminology.hl7.org/CodeSystem/condition-clinical
DiagnosticReport.conclusionCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
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()

This structure is derived from DiagnosticReport

Summary

Mandatory: 6 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DiagnosticReport.effective[x]

 

Other representations of profile: CSV, Excel, Schematron