QI-Core Implementation Guide
7.0.0 - STU 7
QI-Core Implementation Guide
7.0.0 - STU 7
This page is part of the Quality Improvement Core Framework (v7.0.0: STU7 (v7.0.0)) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-diagnosticreport-lab | Version: 7.0.0 | |||
| Standards status: Trial-use | Maturity Level: 4 | 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.
| Blood Panel Example |
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  DiagnosticReport |
C | 0..* | USCoreDiagnosticReportProfileLaboratoryReporting | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Constraints: us-core-8, us-core-9 |
  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 |
 basedOn |
0..* | Reference(QICore CarePlan | QICore ImmunizationRecommendation | QICore MedicationRequest | QICore NutritionOrder | QICore ServiceRequest) | (QI) 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 |
| result |
S | 0..* | Reference(QICore Laboratory Result Observation) | (QI) Observations |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-statusFrom the FHIR Standard | |
| DiagnosticReport.category | preferred | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsFrom the FHIR Standard | |
| DiagnosticReport.category:LaboratorySlice | preferred | Pattern Value: LABhttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsFrom the FHIR Standard | |
| DiagnosticReport.code | extensible | USCoreLaboratoryTestCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| us-core-8 | error | DiagnosticReport | effective[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-9 | error | DiagnosticReport | issued 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() |
This structure is derived from USCoreDiagnosticReportProfileLaboratoryReporting
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DiagnosticReport |
USCoreDiagnosticReportProfileLaboratoryReporting | |||
| basedOn |
0..* | Reference(QICore CarePlan | QICore ImmunizationRecommendation | QICore MedicationRequest | QICore NutritionOrder | QICore ServiceRequest) | (QI) 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 | |
| code |
SΣ | 1..1 | CodeableConcept | (QI) US Core Laboratory Report Order Code Binding: US Core Laboratory Test Codes (extensible): LOINC codes |
| 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 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-statusFrom the FHIR Standard | |
| DiagnosticReport.category | preferred | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsFrom the FHIR Standard | |
| DiagnosticReport.category:LaboratorySlice | preferred | Pattern Value: LABhttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsFrom the FHIR Standard | |
| DiagnosticReport.code | extensible | USCoreLaboratoryTestCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
C | 0..* | USCoreDiagnosticReportProfileLaboratoryReporting | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Constraints: us-core-8, us-core-9 | ||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| 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) | (QI) 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| DiagnosticReport.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| DiagnosticReport.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| DiagnosticReport.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-statusFrom the FHIR Standard | ||||
| DiagnosticReport.category | preferred | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsFrom the FHIR Standard | ||||
| DiagnosticReport.category:LaboratorySlice | preferred | Pattern Value: LABhttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsFrom the FHIR Standard | ||||
| DiagnosticReport.code | extensible | USCoreLaboratoryTestCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes | ||||
| DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| us-core-8 | error | DiagnosticReport | effective[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-9 | error | DiagnosticReport | issued 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() |
This structure is derived from USCoreDiagnosticReportProfileLaboratoryReporting
Summary
Mandatory: 2 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 4
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DiagnosticReport |
C | 0..* | USCoreDiagnosticReportProfileLaboratoryReporting | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Constraints: us-core-8, us-core-9 |
| 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 |
| basedOn |
0..* | Reference(QICore CarePlan | QICore ImmunizationRecommendation | QICore MedicationRequest | QICore NutritionOrder | QICore ServiceRequest) | (QI) 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 |
| result |
S | 0..* | Reference(QICore Laboratory Result Observation) | (QI) Observations |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-statusFrom the FHIR Standard | |
| DiagnosticReport.category | preferred | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsFrom the FHIR Standard | |
| DiagnosticReport.category:LaboratorySlice | preferred | Pattern Value: LABhttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsFrom the FHIR Standard | |
| DiagnosticReport.code | extensible | USCoreLaboratoryTestCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| us-core-8 | error | DiagnosticReport | effective[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-9 | error | DiagnosticReport | issued 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DiagnosticReport |
USCoreDiagnosticReportProfileLaboratoryReporting | |||
| basedOn |
0..* | Reference(QICore CarePlan | QICore ImmunizationRecommendation | QICore MedicationRequest | QICore NutritionOrder | QICore ServiceRequest) | (QI) 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 | |
| code |
SΣ | 1..1 | CodeableConcept | (QI) US Core Laboratory Report Order Code Binding: US Core Laboratory Test Codes (extensible): LOINC codes |
| 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 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-statusFrom the FHIR Standard | |
| DiagnosticReport.category | preferred | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsFrom the FHIR Standard | |
| DiagnosticReport.category:LaboratorySlice | preferred | Pattern Value: LABhttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsFrom the FHIR Standard | |
| DiagnosticReport.code | extensible | USCoreLaboratoryTestCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
C | 0..* | USCoreDiagnosticReportProfileLaboratoryReporting | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Constraints: us-core-8, us-core-9 | ||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| 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) | (QI) 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| DiagnosticReport.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| DiagnosticReport.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| DiagnosticReport.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-statusFrom the FHIR Standard | ||||
| DiagnosticReport.category | preferred | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsFrom the FHIR Standard | ||||
| DiagnosticReport.category:LaboratorySlice | preferred | Pattern Value: LABhttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsFrom the FHIR Standard | ||||
| DiagnosticReport.code | extensible | USCoreLaboratoryTestCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes | ||||
| DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| us-core-8 | error | DiagnosticReport | effective[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-9 | error | DiagnosticReport | issued 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() |
This structure is derived from USCoreDiagnosticReportProfileLaboratoryReporting
Summary
Mandatory: 2 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron
IG © 2019+ HL7 International / Clinical Quality Information. Package hl7.fhir.us.qicore#7.0.0 based on FHIR 4.0.1. Generated 2025-06-18
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change