HL7 Laboratory Report
1.0.0-ballot - STU 1 Ballot
HL7 Laboratory Report
1.0.0-ballot - STU 1 Ballot
HL7 Laboratory Report, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/uv-lab-rep-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/DiagnosticReport-uv-lab | Version: 1.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: DiagnosticReportUvLab | ||
DiagnosticReport used to represent an entry of a Laboratory Report, including its context, for the scope of the HL7 Uv Lab project.
Previous results
This version of the guide uses the supportingInfo extension to the Observation lab results, for conveying the previous.
Implementers are invited to provide their feedback about the possible adoption of the supportingInfo extension to this DiagnosticReport profile
In some cases it is requested to include PDF, images or other kind of additional data in a Diagnostic Report.
If the PDF to be added is the representation of the entire Laboratory report, then this will be recorded in the optional element presentedForm
In case of images or other kinds of additional data (that can be a pdf document) used as support for the interpretation of the report, this is realized by using the optional element media.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DiagnosticReport
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DiagnosticReport |
0..* | DiagnosticReport | Laboratory Report DiagnosticReport | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   DiagnosticReportCompositionR5 |
0..1 | (Complex) | Associated Lab Report Composition URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | |
   value[x] |
1..1 | Reference(Composition: Laboratory Report) | Value of extension | |
  identifier |
0..* | Identifier | Report identifier | |
| basedOn |
0..* | Reference(ServiceRequest: Laboratory Order) | What was requested | |
| status |
1..1 | code | Status of the Report | |
 Slices for category |
0..* | CodeableConceptIPS | Report Category Slice: Unordered, Open by pattern:$this | |
 category:studyType |
0..* | CodeableConcept | The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.) Binding: Laboratory Study Types (required) | |
 category:specialty |
0..* | CodeableConcept | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) Binding: Laboratory Specialty (required) | |
 code |
1..1 | CodeableConceptIPS | Type of (Laboratory) Report Binding: Laboratory Report Types (preferred) | |
| subject |
1..1 | Reference(Patient: Person | Patient: Animal | Group | Location | Device) | Who and/or what this report is about | |
| encounter |
0..1 | Reference(Encounter) | The healthcare event which this Laboratory Report is about (when test ordered). | |
| effective[x] |
0..1 | dateTime, Period | Clinically relevant time/time-period for report. | |
| performer |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service. | |
| resultsInterpreter |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | |
| specimen |
0..* | Reference(Specimen: Laboratory) | Specimens this report is based on. | |
| result |
0..* | Reference(Observation Results: laboratory) | results | |
| imagingStudy |
0..0 | |||
 presentedForm |
0..* | Attachment | Entire report as issued (pdf recommended) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DiagnosticReport.category:studyType | required | LabStudyTypesVshttp://hl7.org/fhir/uv/lab-report/ValueSet/studyType-uv-labfrom this IG | |
| DiagnosticReport.category:specialty | required | LabSpecialtyVshttp://hl7.org/fhir/uv/lab-report/ValueSet/specialty-uv-labfrom this IG | |
| DiagnosticReport.code | preferred | LabReportTypesVshttp://hl7.org/fhir/uv/lab-report/ValueSet/reportType-uv-labfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | Laboratory Report DiagnosticReport | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| DiagnosticReportCompositionR5 |
0..1 | (Complex) | Associated Lab Report Composition URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | |
 extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" | |
| value[x] |
1..1 | Reference(Composition: Laboratory Report) | Value of extension | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
Σ | 0..* | Identifier | Report identifier |
| basedOn |
0..* | Reference(ServiceRequest: Laboratory Order) | What was requested | |
| status |
?!Σ | 1..1 | code | Status of the Report Binding: DiagnosticReportStatus (required): The status of the diagnostic report. |
| Slices for category |
Σ | 0..* | CodeableConceptIPS | Report Category Slice: Unordered, Open by pattern:$this Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. |
| category:studyType |
Σ | 0..* | CodeableConcept | The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.) Binding: Laboratory Study Types (required) |
| category:specialty |
Σ | 0..* | CodeableConcept | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) Binding: Laboratory Specialty (required) |
| code |
1..1 | CodeableConceptIPS | Type of (Laboratory) Report Binding: Laboratory Report Types (preferred) | |
| subject |
Σ | 1..1 | Reference(Patient: Person | Patient: Animal | Group | Location | Device) | Who and/or what this report is about |
| encounter |
Σ | 0..1 | Reference(Encounter) | The healthcare event which this Laboratory Report is about (when test ordered). |
 effective[x] |
Σ | 0..1 | Clinically relevant time/time-period for report. | |
| effectiveDateTime |
dateTime | |||
| effectivePeriod |
Period | |||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service. |
| resultsInterpreter |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter |
| specimen |
0..* | Reference(Specimen: Laboratory) | Specimens this report is based on. | |
| result |
0..* | Reference(Observation Results: laboratory) | results | |
| presentedForm |
0..* | Attachment | Entire report as issued (pdf recommended) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1from the FHIR Standard | |
| DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsfrom the FHIR Standard | |
| DiagnosticReport.category:studyType | required | LabStudyTypesVshttp://hl7.org/fhir/uv/lab-report/ValueSet/studyType-uv-labfrom this IG | |
| DiagnosticReport.category:specialty | required | LabSpecialtyVshttp://hl7.org/fhir/uv/lab-report/ValueSet/specialty-uv-labfrom this IG | |
| DiagnosticReport.code | preferred | LabReportTypesVshttp://hl7.org/fhir/uv/lab-report/ValueSet/reportType-uv-labfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | Laboratory Report DiagnosticReport | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| DiagnosticReportCompositionR5 |
0..1 | (Complex) | Associated Lab Report Composition URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" | |||||
| value[x] |
1..1 | Reference(Composition: Laboratory Report) | Value of extension | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Report identifier | ||||
| basedOn |
0..* | Reference(ServiceRequest: Laboratory Order) | What was requested | |||||
| status |
?!Σ | 1..1 | code | Status of the Report Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | ||||
| Slices for category |
Σ | 0..* | CodeableConceptIPS | Report Category Slice: Unordered, Open by pattern:$this Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
| category:studyType |
Σ | 0..* | CodeableConcept | The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.) Binding: Laboratory Study Types (required) | ||||
| category:specialty |
Σ | 0..* | CodeableConcept | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) Binding: Laboratory Specialty (required) | ||||
| code |
1..1 | CodeableConceptIPS | Type of (Laboratory) Report Binding: Laboratory Report Types (preferred) | |||||
| subject |
Σ | 1..1 | Reference(Patient: Person | Patient: Animal | Group | Location | Device) | Who and/or what this report is about | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | The healthcare event which this Laboratory Report is about (when test ordered). | ||||
| effective[x] |
Σ | 0..1 | Clinically relevant time/time-period for report. | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| issued |
Σ | 0..1 | instant | DateTime this version was made | ||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service. | ||||
| resultsInterpreter |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
| specimen |
0..* | Reference(Specimen: Laboratory) | Specimens this report is based on. | |||||
| result |
0..* | Reference(Observation Results: laboratory) | results | |||||
| 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 (pdf recommended) | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| DiagnosticReport.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1from the FHIR Standard | ||||
| DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsfrom the FHIR Standard | ||||
| DiagnosticReport.category:studyType | required | LabStudyTypesVshttp://hl7.org/fhir/uv/lab-report/ValueSet/studyType-uv-labfrom this IG | ||||
| DiagnosticReport.category:specialty | required | LabSpecialtyVshttp://hl7.org/fhir/uv/lab-report/ValueSet/specialty-uv-labfrom this IG | ||||
| DiagnosticReport.code | preferred | LabReportTypesVshttp://hl7.org/fhir/uv/lab-report/ValueSet/reportType-uv-labfrom this IG | ||||
| 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() |
This structure is derived from DiagnosticReport
Summary
Mandatory: 1 element(1 nested mandatory element)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 2
Differential View
This structure is derived from DiagnosticReport
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | Laboratory Report DiagnosticReport | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| DiagnosticReportCompositionR5 |
0..1 | (Complex) | Associated Lab Report Composition URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | |
| value[x] |
1..1 | Reference(Composition: Laboratory Report) | Value of extension | |
| identifier |
0..* | Identifier | Report identifier | |
| basedOn |
0..* | Reference(ServiceRequest: Laboratory Order) | What was requested | |
| status |
1..1 | code | Status of the Report | |
| Slices for category |
0..* | CodeableConceptIPS | Report Category Slice: Unordered, Open by pattern:$this | |
| category:studyType |
0..* | CodeableConcept | The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.) Binding: Laboratory Study Types (required) | |
| category:specialty |
0..* | CodeableConcept | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) Binding: Laboratory Specialty (required) | |
| code |
1..1 | CodeableConceptIPS | Type of (Laboratory) Report Binding: Laboratory Report Types (preferred) | |
| subject |
1..1 | Reference(Patient: Person | Patient: Animal | Group | Location | Device) | Who and/or what this report is about | |
| encounter |
0..1 | Reference(Encounter) | The healthcare event which this Laboratory Report is about (when test ordered). | |
| effective[x] |
0..1 | dateTime, Period | Clinically relevant time/time-period for report. | |
| performer |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service. | |
| resultsInterpreter |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | |
| specimen |
0..* | Reference(Specimen: Laboratory) | Specimens this report is based on. | |
| result |
0..* | Reference(Observation Results: laboratory) | results | |
| imagingStudy |
0..0 | |||
| presentedForm |
0..* | Attachment | Entire report as issued (pdf recommended) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DiagnosticReport.category:studyType | required | LabStudyTypesVshttp://hl7.org/fhir/uv/lab-report/ValueSet/studyType-uv-labfrom this IG | |
| DiagnosticReport.category:specialty | required | LabSpecialtyVshttp://hl7.org/fhir/uv/lab-report/ValueSet/specialty-uv-labfrom this IG | |
| DiagnosticReport.code | preferred | LabReportTypesVshttp://hl7.org/fhir/uv/lab-report/ValueSet/reportType-uv-labfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | Laboratory Report DiagnosticReport | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| DiagnosticReportCompositionR5 |
0..1 | (Complex) | Associated Lab Report Composition URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" | |
| value[x] |
1..1 | Reference(Composition: Laboratory Report) | Value of extension | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
Σ | 0..* | Identifier | Report identifier |
| basedOn |
0..* | Reference(ServiceRequest: Laboratory Order) | What was requested | |
| status |
?!Σ | 1..1 | code | Status of the Report Binding: DiagnosticReportStatus (required): The status of the diagnostic report. |
| Slices for category |
Σ | 0..* | CodeableConceptIPS | Report Category Slice: Unordered, Open by pattern:$this Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. |
| category:studyType |
Σ | 0..* | CodeableConcept | The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.) Binding: Laboratory Study Types (required) |
| category:specialty |
Σ | 0..* | CodeableConcept | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) Binding: Laboratory Specialty (required) |
| code |
1..1 | CodeableConceptIPS | Type of (Laboratory) Report Binding: Laboratory Report Types (preferred) | |
| subject |
Σ | 1..1 | Reference(Patient: Person | Patient: Animal | Group | Location | Device) | Who and/or what this report is about |
| encounter |
Σ | 0..1 | Reference(Encounter) | The healthcare event which this Laboratory Report is about (when test ordered). |
| effective[x] |
Σ | 0..1 | Clinically relevant time/time-period for report. | |
| effectiveDateTime |
dateTime | |||
| effectivePeriod |
Period | |||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service. |
| resultsInterpreter |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter |
| specimen |
0..* | Reference(Specimen: Laboratory) | Specimens this report is based on. | |
| result |
0..* | Reference(Observation Results: laboratory) | results | |
| presentedForm |
0..* | Attachment | Entire report as issued (pdf recommended) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1from the FHIR Standard | |
| DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsfrom the FHIR Standard | |
| DiagnosticReport.category:studyType | required | LabStudyTypesVshttp://hl7.org/fhir/uv/lab-report/ValueSet/studyType-uv-labfrom this IG | |
| DiagnosticReport.category:specialty | required | LabSpecialtyVshttp://hl7.org/fhir/uv/lab-report/ValueSet/specialty-uv-labfrom this IG | |
| DiagnosticReport.code | preferred | LabReportTypesVshttp://hl7.org/fhir/uv/lab-report/ValueSet/reportType-uv-labfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | Laboratory Report DiagnosticReport | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| DiagnosticReportCompositionR5 |
0..1 | (Complex) | Associated Lab Report Composition URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" | |||||
| value[x] |
1..1 | Reference(Composition: Laboratory Report) | Value of extension | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Report identifier | ||||
| basedOn |
0..* | Reference(ServiceRequest: Laboratory Order) | What was requested | |||||
| status |
?!Σ | 1..1 | code | Status of the Report Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | ||||
| Slices for category |
Σ | 0..* | CodeableConceptIPS | Report Category Slice: Unordered, Open by pattern:$this Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
| category:studyType |
Σ | 0..* | CodeableConcept | The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.) Binding: Laboratory Study Types (required) | ||||
| category:specialty |
Σ | 0..* | CodeableConcept | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) Binding: Laboratory Specialty (required) | ||||
| code |
1..1 | CodeableConceptIPS | Type of (Laboratory) Report Binding: Laboratory Report Types (preferred) | |||||
| subject |
Σ | 1..1 | Reference(Patient: Person | Patient: Animal | Group | Location | Device) | Who and/or what this report is about | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | The healthcare event which this Laboratory Report is about (when test ordered). | ||||
| effective[x] |
Σ | 0..1 | Clinically relevant time/time-period for report. | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| issued |
Σ | 0..1 | instant | DateTime this version was made | ||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service. | ||||
| resultsInterpreter |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
| specimen |
0..* | Reference(Specimen: Laboratory) | Specimens this report is based on. | |||||
| result |
0..* | Reference(Observation Results: laboratory) | results | |||||
| 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 (pdf recommended) | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| DiagnosticReport.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1from the FHIR Standard | ||||
| DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsfrom the FHIR Standard | ||||
| DiagnosticReport.category:studyType | required | LabStudyTypesVshttp://hl7.org/fhir/uv/lab-report/ValueSet/studyType-uv-labfrom this IG | ||||
| DiagnosticReport.category:specialty | required | LabSpecialtyVshttp://hl7.org/fhir/uv/lab-report/ValueSet/specialty-uv-labfrom this IG | ||||
| DiagnosticReport.code | preferred | LabReportTypesVshttp://hl7.org/fhir/uv/lab-report/ValueSet/reportType-uv-labfrom this IG | ||||
| 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() |
This structure is derived from DiagnosticReport
Summary
Mandatory: 1 element(1 nested mandatory element)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Orders and Observations. Package hl7.fhir.uv.lab-report#1.0.0-ballot based on FHIR 4.0.1. Generated 2024-10-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change