QI-Core Implementation Guide
7.0.0 - STU7 United States of America flag

QI-Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 7.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-qi-core/ and changes regularly. See the Directory of published versions

Resource Profile: QICore DiagnosticReport Profile for Laboratory Results Reporting

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-diagnosticreport-lab Version: 7.0.0
Active as of 2023-08-01 Computable Name: QICoreDiagnosticReportLab

Profile of DiagnosticReport for laboratory results for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

Must Have:
  • status: registered | partial | preliminary | final +
  • category: (QI) Service category
  • category: (QI) Service category
  • code: US Core Laboratory Report Order Code
  • subject: (QI) The subject of the report - usually, but not always, the patient
QI Elements:
  • basedOn: What was requested
  • effective[x]: (QI) Diagnostically relevant time (typically the time of specimen collection)
  • performer: (QI) Responsible Diagnostic Service
  • result: (QI) Observations
Primary code path: code
(PCPath) This element is the primary code path for this resource CQL Retrieve


NOTE TO BALLOT REVIEWERS:
  • US Core 7.0, and thus QI-Core 7.0, has a new approach to USCDI requirements.
    • As noted in the US Core 7.0 Must Support section, US Core 7.0 no longer highlights mandatory (cardinality 1..* or 1..1) and Must Support elements with a (USCDI) indicator as such items must be supported for interoperability.
    • Those USCDI elements that are not mandatory or Must Support now include an indicator (ADDITIONAL USCDI) in US Core. QI-Core 7.0 does not reference USCDI elements; rather, users should access US Core 7.0 to understand its implementation of USCDI version 4.
  • We invite comments about the approach and suggestions for other options that would also avoid unnecessary noise or reading load to the QI-Core profile representation.
  • Further, QI-Core 7.0 does not discuss USCDI+Quality because at the time of ballot preparation, no published version of USCDI+Quality is available. We seek reviewer advice regarding how QI-Core might address future USCDI+Quality.

Usage

See the patterns page for implementation and usage patterns.

Examples

Blood Panel Example

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 USCoreDiagnosticReportProfileLaboratoryReporting

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 0..* USCoreDiagnosticReportProfileLaboratoryReporting A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
... basedOn 0..* Reference(QICore CarePlan | QICore ImmunizationRecommendation | QICore MedicationRequest | QICore NutritionOrder | QICore ServiceRequest) What was requested
... status ?!SΣC 1..1 code (QI)registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... Slices for category Σ 1..* CodeableConcept (QI) Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (preferred): Codes for diagnostic service sections.

.... category:LaboratorySlice Σ 1..1 CodeableConcept (QI) Service category
Binding: DiagnosticServiceSectionCodes (preferred): 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://terminology.hl7.org/CodeSystem/v2-0074
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LAB
... subject 1..1 Reference(QICore Patient) (QI) The subject of the report - usually, but not always, the patient
... encounter 0..1 Reference(QICore Encounter) (QI) Encounter associated with DiagnosticReport
... effective[x] Σ 0..1 (QI) Diagnostically relevant time (typically the time of specimen collection)
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued SΣC 0..1 instant (QI) DateTime this version was made
... performer 0..* Reference(QICore Practitioner | QICore PractitionerRole | QICore Organization) (QI) Responsible Diagnostic Service
... result 0..* Reference(QICore Laboratory Result Observation) (QI) Observations

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status
from the FHIR Standard
DiagnosticReport.categorypreferredDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:LaboratorySlicepreferredPattern: LAB
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codeextensibleUSCoreLaboratoryTestCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* USCoreDiagnosticReportProfileLaboratoryReporting A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
us-core-8: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
us-core-9: issued SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
... meta SΣ 0..1 Meta Metadata about the resource
.... lastUpdated SΣ 0..1 instant When the resource last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣC 1..1 code (QI)registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... Slices for category SΣ 1..* CodeableConcept (QI) Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (preferred): Codes for diagnostic service sections.


.... category:LaboratorySlice SΣ 1..1 CodeableConcept (QI) Service category
Binding: DiagnosticServiceSectionCodes (preferred): 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://terminology.hl7.org/CodeSystem/v2-0074
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LAB
... code SΣ 1..1 CodeableConcept (QI) US Core Laboratory Report Order Code
Binding: US Core Laboratory Test Codes (extensible): LOINC codes

... subject SΣ 1..1 Reference(QICore Patient) (QI) The subject of the report - usually, but not always, the patient
... encounter SΣ 0..1 Reference(QICore Encounter) (QI) Encounter associated with DiagnosticReport
... effective[x] SΣC 0..1 (QI) Diagnostically relevant time (typically the time of specimen collection)
.... effectiveDateTime dateTime
... issued SΣC 0..1 instant (QI) DateTime this version was made
... performer SΣ 0..* Reference(QICore Practitioner | QICore PractitionerRole | QICore Organization) (QI) Responsible Diagnostic Service
... result S 0..* Reference(QICore Laboratory Result Observation) (QI) Observations

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status
from the FHIR Standard
DiagnosticReport.categorypreferredDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:LaboratorySlicepreferredPattern: LAB
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codeextensibleUSCoreLaboratoryTestCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes

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()
us-core-8errorDiagnosticReporteffective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
: (status='partial' or status='preliminary' or status='final' or status='amended' or status='corrected' or status='appended' ) implies effective.exists()
us-core-9errorDiagnosticReportissued SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
: (status='partial' or status='preliminary' or status='final' or status='amended' or status='corrected' or status='appended' ) implies issued.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* USCoreDiagnosticReportProfileLaboratoryReporting A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
us-core-8: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
us-core-9: issued SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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(QICore CarePlan | QICore ImmunizationRecommendation | QICore MedicationRequest | QICore NutritionOrder | QICore ServiceRequest) What was requested
... status ?!SΣC 1..1 code (QI)registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... Slices for category SΣ 1..* CodeableConcept (QI) Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (preferred): Codes for diagnostic service sections.


.... category:LaboratorySlice SΣ 1..1 CodeableConcept (QI) Service category
Binding: DiagnosticServiceSectionCodes (preferred): 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://terminology.hl7.org/CodeSystem/v2-0074
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LAB
...... display 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 (QI) US Core Laboratory Report Order Code
Binding: US Core Laboratory Test Codes (extensible): LOINC codes

... subject SΣ 1..1 Reference(QICore Patient) (QI) The subject of the report - usually, but not always, the patient
... encounter SΣ 0..1 Reference(QICore Encounter) (QI) Encounter associated with DiagnosticReport
... effective[x] SΣC 0..1 (QI) Diagnostically relevant time (typically the time of specimen collection)
.... effectiveDateTime dateTime S
.... effectivePeriod Period
... issued SΣC 0..1 instant (QI) DateTime this version was made
... performer SΣ 0..* Reference(QICore Practitioner | QICore PractitionerRole | QICore Organization) (QI) Responsible Diagnostic Service
... resultsInterpreter Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam) Primary result interpreter
... specimen 0..* Reference(Specimen) Specimens this report is based on
... result S 0..* Reference(QICore Laboratory Result Observation) (QI) Observations
... 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.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DiagnosticReport.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
DiagnosticReport.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status
from the FHIR Standard
DiagnosticReport.categorypreferredDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:LaboratorySlicepreferredPattern: LAB
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codeextensibleUSCoreLaboratoryTestCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes
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()
us-core-8errorDiagnosticReporteffective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
: (status='partial' or status='preliminary' or status='final' or status='amended' or status='corrected' or status='appended' ) implies effective.exists()
us-core-9errorDiagnosticReportissued SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
: (status='partial' or status='preliminary' or status='final' or status='amended' or status='corrected' or status='appended' ) implies issued.exists()

Differential View

This structure is derived from USCoreDiagnosticReportProfileLaboratoryReporting

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport 0..* USCoreDiagnosticReportProfileLaboratoryReporting A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
... basedOn 0..* Reference(QICore CarePlan | QICore ImmunizationRecommendation | QICore MedicationRequest | QICore NutritionOrder | QICore ServiceRequest) What was requested
... status ?!SΣC 1..1 code (QI)registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... Slices for category Σ 1..* CodeableConcept (QI) Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (preferred): Codes for diagnostic service sections.

.... category:LaboratorySlice Σ 1..1 CodeableConcept (QI) Service category
Binding: DiagnosticServiceSectionCodes (preferred): 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://terminology.hl7.org/CodeSystem/v2-0074
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LAB
... subject 1..1 Reference(QICore Patient) (QI) The subject of the report - usually, but not always, the patient
... encounter 0..1 Reference(QICore Encounter) (QI) Encounter associated with DiagnosticReport
... effective[x] Σ 0..1 (QI) Diagnostically relevant time (typically the time of specimen collection)
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued SΣC 0..1 instant (QI) DateTime this version was made
... performer 0..* Reference(QICore Practitioner | QICore PractitionerRole | QICore Organization) (QI) Responsible Diagnostic Service
... result 0..* Reference(QICore Laboratory Result Observation) (QI) Observations

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status
from the FHIR Standard
DiagnosticReport.categorypreferredDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:LaboratorySlicepreferredPattern: LAB
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codeextensibleUSCoreLaboratoryTestCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* USCoreDiagnosticReportProfileLaboratoryReporting A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
us-core-8: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
us-core-9: issued SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
... meta SΣ 0..1 Meta Metadata about the resource
.... lastUpdated SΣ 0..1 instant When the resource last changed
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣC 1..1 code (QI)registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... Slices for category SΣ 1..* CodeableConcept (QI) Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (preferred): Codes for diagnostic service sections.


.... category:LaboratorySlice SΣ 1..1 CodeableConcept (QI) Service category
Binding: DiagnosticServiceSectionCodes (preferred): 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://terminology.hl7.org/CodeSystem/v2-0074
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LAB
... code SΣ 1..1 CodeableConcept (QI) US Core Laboratory Report Order Code
Binding: US Core Laboratory Test Codes (extensible): LOINC codes

... subject SΣ 1..1 Reference(QICore Patient) (QI) The subject of the report - usually, but not always, the patient
... encounter SΣ 0..1 Reference(QICore Encounter) (QI) Encounter associated with DiagnosticReport
... effective[x] SΣC 0..1 (QI) Diagnostically relevant time (typically the time of specimen collection)
.... effectiveDateTime dateTime
... issued SΣC 0..1 instant (QI) DateTime this version was made
... performer SΣ 0..* Reference(QICore Practitioner | QICore PractitionerRole | QICore Organization) (QI) Responsible Diagnostic Service
... result S 0..* Reference(QICore Laboratory Result Observation) (QI) Observations

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status
from the FHIR Standard
DiagnosticReport.categorypreferredDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:LaboratorySlicepreferredPattern: LAB
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codeextensibleUSCoreLaboratoryTestCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes

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()
us-core-8errorDiagnosticReporteffective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
: (status='partial' or status='preliminary' or status='final' or status='amended' or status='corrected' or status='appended' ) implies effective.exists()
us-core-9errorDiagnosticReportissued SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
: (status='partial' or status='preliminary' or status='final' or status='amended' or status='corrected' or status='appended' ) implies issued.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport C 0..* USCoreDiagnosticReportProfileLaboratoryReporting A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
us-core-8: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
us-core-9: issued SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant When the resource last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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(QICore CarePlan | QICore ImmunizationRecommendation | QICore MedicationRequest | QICore NutritionOrder | QICore ServiceRequest) What was requested
... status ?!SΣC 1..1 code (QI)registered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... Slices for category SΣ 1..* CodeableConcept (QI) Service category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (preferred): Codes for diagnostic service sections.


.... category:LaboratorySlice SΣ 1..1 CodeableConcept (QI) Service category
Binding: DiagnosticServiceSectionCodes (preferred): 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://terminology.hl7.org/CodeSystem/v2-0074
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: LAB
...... display 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 (QI) US Core Laboratory Report Order Code
Binding: US Core Laboratory Test Codes (extensible): LOINC codes

... subject SΣ 1..1 Reference(QICore Patient) (QI) The subject of the report - usually, but not always, the patient
... encounter SΣ 0..1 Reference(QICore Encounter) (QI) Encounter associated with DiagnosticReport
... effective[x] SΣC 0..1 (QI) Diagnostically relevant time (typically the time of specimen collection)
.... effectiveDateTime dateTime S
.... effectivePeriod Period
... issued SΣC 0..1 instant (QI) DateTime this version was made
... performer SΣ 0..* Reference(QICore Practitioner | QICore PractitionerRole | QICore Organization) (QI) Responsible Diagnostic Service
... resultsInterpreter Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam) Primary result interpreter
... specimen 0..* Reference(Specimen) Specimens this report is based on
... result S 0..* Reference(QICore Laboratory Result Observation) (QI) Observations
... 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.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DiagnosticReport.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
DiagnosticReport.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DiagnosticReport.statusrequiredDiagnosticReportStatus
http://hl7.org/fhir/ValueSet/diagnostic-report-status
from the FHIR Standard
DiagnosticReport.categorypreferredDiagnosticServiceSectionCodes
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.category:LaboratorySlicepreferredPattern: LAB
http://hl7.org/fhir/ValueSet/diagnostic-service-sections
from the FHIR Standard
DiagnosticReport.codeextensibleUSCoreLaboratoryTestCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes
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()
us-core-8errorDiagnosticReporteffective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
: (status='partial' or status='preliminary' or status='final' or status='amended' or status='corrected' or status='appended' ) implies effective.exists()
us-core-9errorDiagnosticReportissued SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended'
: (status='partial' or status='preliminary' or status='final' or status='amended' or status='corrected' or status='appended' ) implies issued.exists()

 

Other representations of profile: CSV, Excel, Schematron