Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.
| Official URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/UKCore-DiagnosticReport | Version: 2.4.0 | |||
| Active as of 2023-12-12 | Computable Name: UKCoreDiagnosticReport | |||
Copyright/Legal: Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
||||
This profile defines the UK constraints and extensions on the International FHIR resource DiagnosticReport.
This profile allows exchange of the findings and interpretation of diagnostic tests performed on individuals, groups of individuals, devices and locations and/or specimens derived from these. The report includes clinical context such as requesting and provider information and some mix of atomic results, images, textual and coded interpretations and formatted representation of diagnostic reports.
Note: this profile SHALL NOT be used where a more specific UK Core profile exists.
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 | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   compositionReferenceR5 |
0..1 | (Complex) | A Composition reference for a DiagnosticReport. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | |
   value[x] |
1..1 | Reference(Composition) | Reference to a Composition resource. | |
| noteR5 |
0..* | (Complex) | Comments about the diagnostic report. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note | |
| value[x] |
1..1 | Annotation | Comments about the diagnostic report. | |
 supportingInfoR5 |
0..* | (Complex) | Additional info supporting the diagnostic report. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo | |
 status |
S | 1..1 | code | The status of the diagnostic report. |
| category |
S | 0..* | CodeableConcept | A code that classifies the clinical discipline, department or diagnostic service that created the report. |
| code |
S | 1..1 | CodeableConcept | A code or name that describes this diagnostic report. Binding: UK Core Report Code (preferred) |
| subject |
S | 0..1 | Reference(Patient | Group | Device | Location) | The subject of the report - usually, but not always, the patient. |
| encounter |
S | 0..1 | Reference(Encounter) | Health care event when test ordered. |
| issued |
S | 0..1 | instant | Clinically relevant time / time-period for report. |
| performer |
||||
  Slices for extension |
Content/Rules for all slices | |||
 deviceReference |
0..1 | Reference(Device) | A reference to a Device which interprets / performs the results of the DiagnosticReport. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference | |
| resultsInterpreter |
||||
| Slices for extension |
Content/Rules for all slices | |||
| deviceReference |
0..1 | Reference(Device) | A reference to a Device which interprets / performs the results of the DiagnosticReport. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference | |
| result |
S | 0..* | Reference(Observation) | Observations that are part of this diagnostic report. |
 conclusionCode |
0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (preferred): Diagnosis codes provided as adjuncts to the report. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DiagnosticReport.code | preferred | UKCoreReportCodehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/UKCore-ReportCodefrom this IG | |
| DiagnosticReport.conclusionCode | preferred | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| compositionReferenceR5 |
0..1 | (Complex) | A Composition reference for a DiagnosticReport. This is a R5 backport. 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) | Reference to a Composition resource. | |
| noteR5 |
0..* | (Complex) | Comments about the diagnostic report. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note" | |
 value[x] |
1..1 | Annotation | Comments about the diagnostic report. | |
| supportingInfoR5 |
0..* | (Complex) | Additional info supporting the diagnostic report. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | The status of the diagnostic report. Binding: DiagnosticReportStatus (required): The status of the diagnostic report. |
| category |
SΣ | 0..* | CodeableConcept | A code that classifies the clinical discipline, department or diagnostic service that created the report. Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. |
| code |
SΣ | 1..1 | CodeableConcept | A code or name that describes this diagnostic report. Binding: UK Core Report Code (preferred) |
| subject |
SΣ | 0..1 | Reference(Patient | Group | Device | Location) | The subject of the report - usually, but not always, the patient. |
| encounter |
SΣ | 0..1 | Reference(Encounter) | Health care event when test ordered. |
| issued |
SΣ | 0..1 | instant | Clinically relevant time / time-period for report. |
| result |
S | 0..* | Reference(Observation) | Observations that are part of this diagnostic report. |
| conclusionCode |
0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (preferred): Diagnosis codes provided as adjuncts to the report. | |
| 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.code | preferred | UKCoreReportCodehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/UKCore-ReportCodefrom this IG | |
| DiagnosticReport.conclusionCode | preferred | 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| 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 | |||||
| compositionReferenceR5 |
0..1 | (Complex) | A Composition reference for a DiagnosticReport. This is a R5 backport. 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) | Reference to a Composition resource. | |||||
| noteR5 |
0..* | (Complex) | Comments about the diagnostic report. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note | |||||
| 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.note" | |||||
| value[x] |
1..1 | Annotation | Comments about the diagnostic report. | |||||
| supportingInfoR5 |
0..* | (Complex) | Additional info supporting the diagnostic report. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier for report | ||||
| basedOn |
0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested | |||||
| status |
?!SΣ | 1..1 | code | The status of the diagnostic report. Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | ||||
| category |
SΣ | 0..* | CodeableConcept | A code that classifies the clinical discipline, department or diagnostic service that created the report. Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
| code |
SΣ | 1..1 | CodeableConcept | A code or name that describes this diagnostic report. Binding: UK Core Report Code (preferred) | ||||
| subject |
SΣ | 0..1 | Reference(Patient | Group | Device | Location) | The subject of the report - usually, but not always, the patient. | ||||
| encounter |
SΣ | 0..1 | Reference(Encounter) | Health care event when test ordered. | ||||
 effective[x] |
Σ | 0..1 | Clinically relevant time/time-period for report | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| issued |
SΣ | 0..1 | instant | Clinically relevant time / time-period for report. | ||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| deviceReference |
0..1 | Reference(Device) | A reference to a Device which interprets / performs the results of the DiagnosticReport. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| resultsInterpreter |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| deviceReference |
0..1 | Reference(Device) | A reference to a Device which interprets / performs the results of the DiagnosticReport. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| specimen |
0..* | Reference(Specimen) | Specimens this report is based on | |||||
| result |
S | 0..* | Reference(Observation) | Observations that are part of this diagnostic report. | ||||
| 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 (preferred): Diagnosis codes provided as adjuncts to the report. | |||||
| presentedForm |
0..* | Attachment | Entire report as issued | |||||
| 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.code | preferred | UKCoreReportCodehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/UKCore-ReportCodefrom this IG | ||||
| DiagnosticReport.performer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| DiagnosticReport.resultsInterpreter.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| DiagnosticReport.conclusionCode | preferred | 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
Must-Support: 7 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from DiagnosticReport
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| compositionReferenceR5 |
0..1 | (Complex) | A Composition reference for a DiagnosticReport. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | |
| value[x] |
1..1 | Reference(Composition) | Reference to a Composition resource. | |
| noteR5 |
0..* | (Complex) | Comments about the diagnostic report. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note | |
| value[x] |
1..1 | Annotation | Comments about the diagnostic report. | |
| supportingInfoR5 |
0..* | (Complex) | Additional info supporting the diagnostic report. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo | |
| status |
S | 1..1 | code | The status of the diagnostic report. |
| category |
S | 0..* | CodeableConcept | A code that classifies the clinical discipline, department or diagnostic service that created the report. |
| code |
S | 1..1 | CodeableConcept | A code or name that describes this diagnostic report. Binding: UK Core Report Code (preferred) |
| subject |
S | 0..1 | Reference(Patient | Group | Device | Location) | The subject of the report - usually, but not always, the patient. |
| encounter |
S | 0..1 | Reference(Encounter) | Health care event when test ordered. |
| issued |
S | 0..1 | instant | Clinically relevant time / time-period for report. |
| performer |
||||
| Slices for extension |
Content/Rules for all slices | |||
| deviceReference |
0..1 | Reference(Device) | A reference to a Device which interprets / performs the results of the DiagnosticReport. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference | |
| resultsInterpreter |
||||
| Slices for extension |
Content/Rules for all slices | |||
| deviceReference |
0..1 | Reference(Device) | A reference to a Device which interprets / performs the results of the DiagnosticReport. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference | |
| result |
S | 0..* | Reference(Observation) | Observations that are part of this diagnostic report. |
| conclusionCode |
0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (preferred): Diagnosis codes provided as adjuncts to the report. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DiagnosticReport.code | preferred | UKCoreReportCodehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/UKCore-ReportCodefrom this IG | |
| DiagnosticReport.conclusionCode | preferred | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| compositionReferenceR5 |
0..1 | (Complex) | A Composition reference for a DiagnosticReport. This is a R5 backport. 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) | Reference to a Composition resource. | |
| noteR5 |
0..* | (Complex) | Comments about the diagnostic report. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note" | |
| value[x] |
1..1 | Annotation | Comments about the diagnostic report. | |
| supportingInfoR5 |
0..* | (Complex) | Additional info supporting the diagnostic report. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | The status of the diagnostic report. Binding: DiagnosticReportStatus (required): The status of the diagnostic report. |
| category |
SΣ | 0..* | CodeableConcept | A code that classifies the clinical discipline, department or diagnostic service that created the report. Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. |
| code |
SΣ | 1..1 | CodeableConcept | A code or name that describes this diagnostic report. Binding: UK Core Report Code (preferred) |
| subject |
SΣ | 0..1 | Reference(Patient | Group | Device | Location) | The subject of the report - usually, but not always, the patient. |
| encounter |
SΣ | 0..1 | Reference(Encounter) | Health care event when test ordered. |
| issued |
SΣ | 0..1 | instant | Clinically relevant time / time-period for report. |
| result |
S | 0..* | Reference(Observation) | Observations that are part of this diagnostic report. |
| conclusionCode |
0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (preferred): Diagnosis codes provided as adjuncts to the report. | |
| 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.code | preferred | UKCoreReportCodehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/UKCore-ReportCodefrom this IG | |
| DiagnosticReport.conclusionCode | preferred | 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| 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 | |||||
| compositionReferenceR5 |
0..1 | (Complex) | A Composition reference for a DiagnosticReport. This is a R5 backport. 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) | Reference to a Composition resource. | |||||
| noteR5 |
0..* | (Complex) | Comments about the diagnostic report. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note | |||||
| 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.note" | |||||
| value[x] |
1..1 | Annotation | Comments about the diagnostic report. | |||||
| supportingInfoR5 |
0..* | (Complex) | Additional info supporting the diagnostic report. This is a R5 backport. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier for report | ||||
| basedOn |
0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested | |||||
| status |
?!SΣ | 1..1 | code | The status of the diagnostic report. Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | ||||
| category |
SΣ | 0..* | CodeableConcept | A code that classifies the clinical discipline, department or diagnostic service that created the report. Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
| code |
SΣ | 1..1 | CodeableConcept | A code or name that describes this diagnostic report. Binding: UK Core Report Code (preferred) | ||||
| subject |
SΣ | 0..1 | Reference(Patient | Group | Device | Location) | The subject of the report - usually, but not always, the patient. | ||||
| encounter |
SΣ | 0..1 | Reference(Encounter) | Health care event when test ordered. | ||||
| effective[x] |
Σ | 0..1 | Clinically relevant time/time-period for report | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| issued |
SΣ | 0..1 | instant | Clinically relevant time / time-period for report. | ||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| deviceReference |
0..1 | Reference(Device) | A reference to a Device which interprets / performs the results of the DiagnosticReport. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| resultsInterpreter |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| deviceReference |
0..1 | Reference(Device) | A reference to a Device which interprets / performs the results of the DiagnosticReport. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| specimen |
0..* | Reference(Specimen) | Specimens this report is based on | |||||
| result |
S | 0..* | Reference(Observation) | Observations that are part of this diagnostic report. | ||||
| 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 (preferred): Diagnosis codes provided as adjuncts to the report. | |||||
| presentedForm |
0..* | Attachment | Entire report as issued | |||||
| 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.code | preferred | UKCoreReportCodehttps://fhir.interweavedigital.nhs.uk/R4/ValueSet/UKCore-ReportCodefrom this IG | ||||
| DiagnosticReport.performer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| DiagnosticReport.resultsInterpreter.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| DiagnosticReport.conclusionCode | preferred | 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
Must-Support: 7 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron