- This version of the UK Core is a development copy.
- This contains BREAKING CHANGES as a result of the C&TA Sprint 7 Review, and STU2 Sequence ballot reconciliation.
- This version is not yet reviewed for implementation. Other versions are available on the UK Core Version History Guide
- Please follow the guidance on the Contact Us page if you need any assistance.
- A summary of changes is available on the STU3 Sequence Change Log
StructureDefinition UKCore-DiagnosticReport
Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport | active | 2.5.0 | 2024-06-07 | This profile defines the UK constraints and extensions on the International FHIR resource DiagnosticReport. |
Profile_Purpose |
---|
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. |
Detailed Descriptions
DiagnosticReport | |
Definition | The findings and interpretation of diagnostic tests performed on patients, groups of patients, 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. |
Cardinality | 0...* |
Alias | Report, Test, Result, Results, Labs, Laboratory |
Comments | This is intended to capture a single report and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing. |
Invariants |
|
Mappings |
|
DiagnosticReport.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
DiagnosticReport.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
DiagnosticReport.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
DiagnosticReport.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
DiagnosticReport.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
DiagnosticReport.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
DiagnosticReport.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:compositionReferenceR5 | |
Definition | A Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport. |
Cardinality | 0...1 |
Type | Extension(Reference(Composition)) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:compositionReferenceR5.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DiagnosticReport.extension:compositionReferenceR5.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:compositionReferenceR5.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition |
Mappings |
|
DiagnosticReport.extension:compositionReferenceR5.value[x] | |
Definition | Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport. |
Cardinality | 1...1 |
Type | Reference(Composition) |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:mediaR5 | |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 1...* |
Type | Extension(Complex) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:mediaR5.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DiagnosticReport.extension:mediaR5.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 1...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:mediaR5.extension:comment | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:mediaR5.extension:comment.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DiagnosticReport.extension:mediaR5.extension:comment.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:mediaR5.extension:comment.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | comment |
Mappings |
|
DiagnosticReport.extension:mediaR5.extension:comment.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:mediaR5.extension:link | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 1...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:mediaR5.extension:link.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DiagnosticReport.extension:mediaR5.extension:link.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:mediaR5.extension:link.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | link |
Mappings |
|
DiagnosticReport.extension:mediaR5.extension:link.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Reference(UKCoreDocumentReference) |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:mediaR5.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.media.link |
Mappings |
|
DiagnosticReport.extension:mediaR5.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...0 |
Type | base64Binary |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:noteR5 | |
Definition | May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation. |
Cardinality | 0...* |
Type | Extension(Annotation) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:noteR5.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DiagnosticReport.extension:noteR5.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:noteR5.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note |
Mappings |
|
DiagnosticReport.extension:noteR5.value[x] | |
Definition | May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation. |
Cardinality | 1...1 |
Type | Annotation |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:supportingInfoR5 | |
Definition | This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report. |
Cardinality | 0...* |
Type | Extension(Complex) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:supportingInfoR5.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DiagnosticReport.extension:supportingInfoR5.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 2...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:supportingInfoR5.extension:type | |
Definition | The code value for the role of the supporting information in the diagnostic report. |
Cardinality | 1...1 |
Type | Extension |
Binding | http://terminology.hl7.org/ValueSet/v2-0936 (example) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:supportingInfoR5.extension:type.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DiagnosticReport.extension:supportingInfoR5.extension:type.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:supportingInfoR5.extension:type.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | type |
Mappings |
|
DiagnosticReport.extension:supportingInfoR5.extension:type.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | CodeableConcept |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:supportingInfoR5.extension:reference | |
Definition | The reference for the supporting information in the diagnostic report. |
Cardinality | 1...1 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:supportingInfoR5.extension:reference.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DiagnosticReport.extension:supportingInfoR5.extension:reference.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:supportingInfoR5.extension:reference.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | reference |
Mappings |
|
DiagnosticReport.extension:supportingInfoR5.extension:reference.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Reference(Procedure | Observation | DiagnosticReport) |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:supportingInfoR5.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo |
Mappings |
|
DiagnosticReport.extension:supportingInfoR5.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...0 |
Type | base64Binary |
Invariants |
|
Mappings |
|
DiagnosticReport.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DiagnosticReport.identifier | |
Definition | Identifiers assigned to this report by the performer or other systems. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Alias | ReportID, Filler ID, Placer ID |
Requirements | Need to know what identifier to use when making queries about this report from the source laboratory, and for linking to the report outside FHIR context. |
Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). |
Invariants |
|
Mappings |
|
DiagnosticReport.basedOn | |
Definition | Details concerning a service requested. |
Cardinality | 0...* |
Type | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) |
Alias | Request |
Requirements | This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon. |
Comments | Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single test result resource. Note that there are also cases where one request leads to multiple reports. |
Invariants |
|
Mappings |
|
DiagnosticReport.status | |
Definition | The status of the diagnostic report. |
Cardinality | 1...1 |
Type | code |
Binding | The status of the diagnostic report. |
Must Support | True |
Modifier | True |
Summary | True |
Requirements | Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
DiagnosticReport.category | |
Definition | A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes for diagnostic service sections. |
Must Support | True |
Summary | True |
Alias | Department, Sub-department, Service, Discipline |
Comments | Multiple categories are allowed using various categorization schemes. The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in DiagnosticReport.code. |
Invariants |
|
Mappings |
|
DiagnosticReport.code | |
Definition | A code or name that describes this diagnostic report. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Codes that describe Diagnostic Reports. |
Must Support | True |
Summary | True |
Alias | Type |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
DiagnosticReport.subject | |
Definition | The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources. |
Cardinality | 0...1 |
Type | Reference(Patient | Group | Device | Location) |
Must Support | True |
Summary | True |
Alias | Patient |
Requirements | SHALL know the subject context. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
DiagnosticReport.encounter | |
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. |
Cardinality | 0...1 |
Type | Reference(Encounter) |
Must Support | True |
Summary | True |
Alias | Context |
Requirements | Links the request to the Encounter context. |
Comments | This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests). |
Invariants |
|
Mappings |
|
DiagnosticReport.effective[x] | |
Definition | The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Alias | Observation time, Effective Time, Occurrence |
Requirements | Need to know where in the patient history to file/present this report. |
Comments | If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic. |
Invariants |
|
Mappings |
|
DiagnosticReport.issued | |
Definition | The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified. |
Cardinality | 0...1 |
Type | instant |
Must Support | True |
Summary | True |
Alias | Date published, Date Issued, Date Verified |
Requirements | Clinicians need to be able to check the date that the report was released. |
Comments | May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report. |
Invariants |
|
Mappings |
|
DiagnosticReport.performer | |
Definition | The diagnostic service that is responsible for issuing the report. |
Cardinality | 0...* |
Type | Reference(Practitioner | PractitionerRole | Organization | CareTeam) |
Summary | True |
Alias | Laboratory, Service, Practitioner, Department, Company, Authorized by, Director |
Requirements | Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis. |
Comments | This is not necessarily the source of the atomic data items or the entity that interpreted the results. It is the entity that takes responsibility for the clinical report. |
Invariants |
|
Mappings |
|
DiagnosticReport.performer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DiagnosticReport.performer.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DiagnosticReport.performer.extension:deviceReference | |
Definition | An additional Device reference for a DiagnosticReport, to allow Software as a Medical Device to perform / interpret a DiagnosticReport |
Cardinality | 0...1 |
Type | Extension(Reference(Device)) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DiagnosticReport.performer.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
DiagnosticReport.performer.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
DiagnosticReport.performer.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
DiagnosticReport.performer.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
DiagnosticReport.resultsInterpreter | |
Definition | The practitioner or organization that is responsible for the report's conclusions and interpretations. |
Cardinality | 0...* |
Type | Reference(Practitioner | PractitionerRole | Organization | CareTeam) |
Summary | True |
Alias | Analyzed by, Reported by |
Requirements | Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis. |
Comments | Might not be the same entity that takes responsibility for the clinical report. |
Invariants |
|
Mappings |
|
DiagnosticReport.resultsInterpreter.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DiagnosticReport.resultsInterpreter.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DiagnosticReport.resultsInterpreter.extension:deviceReference | |
Definition | An additional Device reference for a DiagnosticReport, to allow Software as a Medical Device to perform / interpret a DiagnosticReport |
Cardinality | 0...* |
Type | Extension(Reference(Device)) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DiagnosticReport.resultsInterpreter.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
DiagnosticReport.resultsInterpreter.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
DiagnosticReport.resultsInterpreter.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
DiagnosticReport.resultsInterpreter.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
DiagnosticReport.specimen | |
Definition | Details about the specimens on which this diagnostic report is based. |
Cardinality | 0...* |
Type | Reference(Specimen) |
Requirements | Need to be able to report information about the collected specimens on which the report is based. |
Comments | If the specimen is sufficiently specified with a code in the test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per observation or group. |
Invariants |
|
Mappings |
|
DiagnosticReport.result | |
Definition | [Observations](observation.html) that are part of this diagnostic report. |
Cardinality | 0...* |
Type | Reference(Observation) |
Must Support | True |
Alias | Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer |
Requirements | Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. |
Comments | Observations can contain observations. |
Invariants |
|
Mappings |
|
DiagnosticReport.imagingStudy | |
Definition | One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. |
Cardinality | 0...* |
Type | Reference(ImagingStudy) |
Comments | ImagingStudy and the image element are somewhat overlapping - typically, the list of image references in the image element will also be found in one of the imaging study resources. However, each caters to different types of displays for different types of purposes. Neither, either, or both may be provided. |
Invariants |
|
Mappings |
|
DiagnosticReport.media | |
Definition | A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest). |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Alias | DICOM, Slides, Scans |
Requirements | Many diagnostic services include images in the report as part of their service. |
Invariants |
|
Mappings |
|
DiagnosticReport.media.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DiagnosticReport.media.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DiagnosticReport.media.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DiagnosticReport.media.comment | |
Definition | A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features. |
Cardinality | 0...1 |
Type | string |
Requirements | The provider of the report should make a comment about each image included in the report. |
Comments | The comment should be displayed with the image. It would be common for the report to include additional discussion of the image contents in other sections such as the conclusion. |
Invariants |
|
Mappings |
|
DiagnosticReport.media.link | |
Definition | Reference to the image source. |
Cardinality | 1...1 |
Type | Reference(Media) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
DiagnosticReport.conclusion | |
Definition | Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report. |
Cardinality | 0...1 |
Type | string |
Alias | Report |
Requirements | Need to be able to provide a conclusion that is not lost among the basic result data. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
DiagnosticReport.conclusionCode | |
Definition | One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Diagnosis codes provided as adjuncts to the report. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
DiagnosticReport.presentedForm | |
Definition | Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. |
Cardinality | 0...* |
Type | Attachment |
Requirements | Gives laboratory the ability to provide its own fully formatted report for clinical fidelity. |
Comments | "application/pdf" is recommended as the most reliable and interoperable in this context. |
Invariants |
|
Mappings |
|
Table View
DiagnosticReport | .. | |
DiagnosticReport.extension | Extension | ..1 |
DiagnosticReport.extension.value[x] | .. | |
DiagnosticReport.extension | Extension | .. |
DiagnosticReport.extension.extension | 1.. | |
DiagnosticReport.extension.extension | 1.. | |
DiagnosticReport.extension | Extension | .. |
DiagnosticReport.extension.value[x] | .. | |
DiagnosticReport.extension | Extension | .. |
DiagnosticReport.extension.extension | 2.. | |
DiagnosticReport.status | .. | |
DiagnosticReport.category | .. | |
DiagnosticReport.code | .. | |
DiagnosticReport.subject | .. | |
DiagnosticReport.encounter | .. | |
DiagnosticReport.issued | .. | |
DiagnosticReport.performer | .. | |
DiagnosticReport.performer.extension | Extension | ..1 |
DiagnosticReport.resultsInterpreter | .. | |
DiagnosticReport.resultsInterpreter.extension | Extension | .. |
DiagnosticReport.result | .. | |
DiagnosticReport.conclusionCode | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-DiagnosticReport" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport" /> <version value="2.5.0" /> <name value="UKCoreDiagnosticReport" /> <title value="UK Core Diagnostic Report" /> <status value="active" /> <date value="2024-06-07" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="ukcore@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="This profile defines the UK constraints and extensions on the International FHIR resource [DiagnosticReport](https://hl7.org/fhir/R4/DiagnosticReport.html)." /> <purpose value="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.\n\nNote: this profile SHALL NOT be used where a more specific UK Core profile exists." /> <copyright value="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." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="DiagnosticReport" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DiagnosticReport" /> <derivation value="constraint" /> <differential> <element id="DiagnosticReport.extension:compositionReferenceR5"> <path value="DiagnosticReport.extension" /> <sliceName value="compositionReferenceR5" /> <short value="A Composition reference for a DiagnosticReport. This is a R5 backport." /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" /> </type> <isModifier value="false" /> </element> <element id="DiagnosticReport.extension:compositionReferenceR5.value[x]"> <path value="DiagnosticReport.extension.value[x]" /> <short value="Reference to a Composition resource." /> <definition value="Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport." /> </element> <element id="DiagnosticReport.extension:mediaR5"> <path value="DiagnosticReport.extension" /> <sliceName value="mediaR5" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.media.link" /> </type> <isModifier value="false" /> </element> <element id="DiagnosticReport.extension:mediaR5.extension"> <path value="DiagnosticReport.extension.extension" /> <min value="1" /> </element> <element id="DiagnosticReport.extension:mediaR5.extension:link"> <path value="DiagnosticReport.extension.extension" /> <sliceName value="link" /> <min value="1" /> </element> <element id="DiagnosticReport.extension:noteR5"> <path value="DiagnosticReport.extension" /> <sliceName value="noteR5" /> <short value="Comments about the diagnostic report. This is a R5 backport." /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note" /> </type> <isModifier value="false" /> </element> <element id="DiagnosticReport.extension:noteR5.value[x]"> <path value="DiagnosticReport.extension.value[x]" /> <definition value="May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation." /> </element> <element id="DiagnosticReport.extension:supportingInfoR5"> <path value="DiagnosticReport.extension" /> <sliceName value="supportingInfoR5" /> <short value="Additional info supporting the diagnostic report. This is a R5 backport." /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo" /> </type> <isModifier value="false" /> </element> <element id="DiagnosticReport.extension:supportingInfoR5.extension"> <path value="DiagnosticReport.extension.extension" /> <min value="2" /> </element> <element id="DiagnosticReport.status"> <path value="DiagnosticReport.status" /> <short value="The status of the diagnostic report." /> <mustSupport value="true" /> </element> <element id="DiagnosticReport.category"> <path value="DiagnosticReport.category" /> <short value="A code that classifies the clinical discipline, department or diagnostic service that created the report." /> <mustSupport value="true" /> </element> <element id="DiagnosticReport.code"> <path value="DiagnosticReport.code" /> <short value="A code or name that describes this diagnostic report." /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ReportCode" /> </binding> </element> <element id="DiagnosticReport.subject"> <path value="DiagnosticReport.subject" /> <short value="The subject of the report - usually, but not always, the patient." /> <mustSupport value="true" /> </element> <element id="DiagnosticReport.encounter"> <path value="DiagnosticReport.encounter" /> <short value="Health care event when test ordered." /> <mustSupport value="true" /> </element> <element id="DiagnosticReport.issued"> <path value="DiagnosticReport.issued" /> <short value="Clinically relevant time / time-period for report." /> <mustSupport value="true" /> </element> <element id="DiagnosticReport.performer.extension:deviceReference"> <path value="DiagnosticReport.performer.extension" /> <sliceName value="deviceReference" /> <short value="A reference to a Device which interprets / performs the results of the DiagnosticReport." /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference" /> </type> <isModifier value="false" /> </element> <element id="DiagnosticReport.resultsInterpreter.extension:deviceReference"> <path value="DiagnosticReport.resultsInterpreter.extension" /> <sliceName value="deviceReference" /> <short value="A reference to a Device which interprets / performs the results of the DiagnosticReport." /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference" /> </type> <isModifier value="false" /> </element> <element id="DiagnosticReport.result"> <path value="DiagnosticReport.result" /> <short value="Observations that are part of this diagnostic report." /> <mustSupport value="true" /> </element> <element id="DiagnosticReport.conclusionCode"> <path value="DiagnosticReport.conclusionCode" /> <binding> <strength value="preferred" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "UKCore-DiagnosticReport", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport", "version": "2.5.0", "name": "UKCoreDiagnosticReport", "title": "UK Core Diagnostic Report", "status": "active", "date": "2024-06-07", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [DiagnosticReport](https://hl7.org/fhir/R4/DiagnosticReport.html).", "purpose": "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.\n\nNote: this profile SHALL NOT be used where a more specific UK Core profile exists.", "copyright": "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.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "DiagnosticReport", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "derivation": "constraint", "differential": { "element": [ { "id": "DiagnosticReport.extension:compositionReferenceR5", "path": "DiagnosticReport.extension", "sliceName": "compositionReferenceR5", "short": "A Composition reference for a DiagnosticReport. This is a R5 backport.", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" ] } ], "isModifier": false }, { "id": "DiagnosticReport.extension:compositionReferenceR5.value[x]", "path": "DiagnosticReport.extension.value[x]", "short": "Reference to a Composition resource.", "definition": "Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport." }, { "id": "DiagnosticReport.extension:mediaR5", "path": "DiagnosticReport.extension", "sliceName": "mediaR5", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.media.link" ] } ], "isModifier": false }, { "id": "DiagnosticReport.extension:mediaR5.extension", "path": "DiagnosticReport.extension.extension", "min": 1 }, { "id": "DiagnosticReport.extension:mediaR5.extension:link", "path": "DiagnosticReport.extension.extension", "sliceName": "link", "min": 1 }, { "id": "DiagnosticReport.extension:noteR5", "path": "DiagnosticReport.extension", "sliceName": "noteR5", "short": "Comments about the diagnostic report. This is a R5 backport.", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note" ] } ], "isModifier": false }, { "id": "DiagnosticReport.extension:noteR5.value[x]", "path": "DiagnosticReport.extension.value[x]", "definition": "May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation." }, { "id": "DiagnosticReport.extension:supportingInfoR5", "path": "DiagnosticReport.extension", "sliceName": "supportingInfoR5", "short": "Additional info supporting the diagnostic report. This is a R5 backport.", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo" ] } ], "isModifier": false }, { "id": "DiagnosticReport.extension:supportingInfoR5.extension", "path": "DiagnosticReport.extension.extension", "min": 2 }, { "id": "DiagnosticReport.status", "path": "DiagnosticReport.status", "short": "The status of the diagnostic report.", "mustSupport": true }, { "id": "DiagnosticReport.category", "path": "DiagnosticReport.category", "short": "A code that classifies the clinical discipline, department or diagnostic service that created the report.", "mustSupport": true }, { "id": "DiagnosticReport.code", "path": "DiagnosticReport.code", "short": "A code or name that describes this diagnostic report.", "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ReportCode" } }, { "id": "DiagnosticReport.subject", "path": "DiagnosticReport.subject", "short": "The subject of the report - usually, but not always, the patient.", "mustSupport": true }, { "id": "DiagnosticReport.encounter", "path": "DiagnosticReport.encounter", "short": "Health care event when test ordered.", "mustSupport": true }, { "id": "DiagnosticReport.issued", "path": "DiagnosticReport.issued", "short": "Clinically relevant time / time-period for report.", "mustSupport": true }, { "id": "DiagnosticReport.performer.extension:deviceReference", "path": "DiagnosticReport.performer.extension", "sliceName": "deviceReference", "short": "A reference to a Device which interprets / performs the results of the DiagnosticReport.", "max": "1", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference" ] } ], "isModifier": false }, { "id": "DiagnosticReport.resultsInterpreter.extension:deviceReference", "path": "DiagnosticReport.resultsInterpreter.extension", "sliceName": "deviceReference", "short": "A reference to a Device which interprets / performs the results of the DiagnosticReport.", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference" ] } ], "isModifier": false }, { "id": "DiagnosticReport.result", "path": "DiagnosticReport.result", "short": "Observations that are part of this diagnostic report.", "mustSupport": true }, { "id": "DiagnosticReport.conclusionCode", "path": "DiagnosticReport.conclusionCode", "binding": { "strength": "preferred" } } ] } }
Feedback
Click here to:Report issue for UKCore-DiagnosticReport, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Examples
Composition Reference - An example to illustrate the pre-adopted R5 element via an extension, which is used to send a composition resource with a diagnostic report.Example UKCore-Extension-CompositionReference
CT Chest Scan Report - An example to illustrate a diagnostic report containing an imaging study for a patient.
Example UKCore-DiagnosticReport-CTChestScan
NOTE: The above example references Example UKCore-ImagingStudy-CTChestScan
Diagnostic Report Note - An example to illustrate the pre-adopted R5 element via an extension, which is used to add notes and annotations to a diagnostic report.
Example UKCore-Extension-Note
Diagnostic Studies Report - An example to illustrate a diagnostic studies report containing a specimen and observation for a patient.
Example UKCore-DiagnosticReport-Lab-DiagnosticStudiesReport
Device Reference - An example to illustrate the extension which is used to indicate the performer of a Diagnostic Report was a device.
Example UKCore-Extension-DeviceReference
NOTE: The above example references Example UKCore-Device-SoftwareAsAMedicalDevice
ECG Report - An example to illustrate a diagnostic report presented in pdf, for an ECG.
Example UKCore-DiagnosticReport-ECG
Example Usage Scenarios
The following are example usage scenarios for the UK Core DiagnosticReport profile:
- Query for a specific patient test result
- Query for recent test results
- Record or update a test result
Services that should consider using the UK Core DiagnosticReport profile are:
- Pathology
- Genomics
- Lab Result
Profile Specific Implementation Guidance:
Mandatory and Must Support Data Elements
The following elements are identified as MustSupport, and it is expected that consumers and suppliers SHALL support these as per the MustSupport Guidance.
Element | Reason |
---|---|
DiagnosticReport.status | The status of the diagnostic report. |
DiagnosticReport.category | A code that classifies the clinical discipline, department or diagnostic service that created the report. |
DiagnosticReport.code | A code or name that describes this diagnostic report. |
DiagnosticReport.subject | The subject of the report - usually, but not always, the patient. |
DiagnosticReport.encounter | Health care event when test ordered. |
DiagnosticReport.issued | Clinically relevant time / time-period for report. |
DiagnosticReport.result | Observations that are part of this diagnostic report. |
Extensions
More information about the extensions on the UKCore-DiagnosticReport
profile can be found using the links below.
Extension | Context | Link | Comment |
---|---|---|---|
compositionReferenceR5 | DiagnosticReport.extension | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | A Composition reference for a DiagnosticReport. This is a R5 backport. |
mediaR5 | DiagnosticReport.extension | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.media.link | |
noteR5 | DiagnosticReport.extension | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note | Comments about the diagnostic report. This is a R5 backport. |
supportingInfoR5 | DiagnosticReport.extension | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo | Additional info supporting the diagnostic report. This is a R5 backport. |
deviceReference | DiagnosticReport.performer.extension | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference | A reference to a Device which interprets / performs the results of the DiagnosticReport. |
deviceReference | DiagnosticReport.resultsInterpreter.extension | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference | A reference to a Device which interprets / performs the results of the DiagnosticReport. |
Bindings (differential)
More information about the bindings to UK Core ValueSets can be found below.
Context | Strength | Link |
---|---|---|
DiagnosticReport.code | preferred | https://fhir.hl7.org.uk/ValueSet/UKCore-ReportCode |
Extension:compositionReferenceR5
This is a backport from R5 to allow referencing to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport.
Note that the R5 element has the following rule that SHOULD be followed:
Key | Severity | Expression | Human Description |
---|---|---|---|
dgr-1 | error | composition.exists() implies (composition.resolve().section.entry.reference.where(resolve() is Observation) in (result.reference|result.reference.resolve().hasMember.reference)) | When a Composition is referenced in Diagnostic.composition , all Observation resources referenced in Composition.entry must also be referenced in Diagnostic.entry or in the references Observations in Observation.hasMember . |
basedOn
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
- UKCore-CarePlan (draft)
- ImmunizationRecommendation Resource
- Profile UKCore-MedicationRequest
- NutritionOrder Resource
- Profile UKCore-ServiceRequest
subject
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
encounter
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Encounter.
performer
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
- UKCore-CareTeam (draft)
- Profile UKCore-Organization
- Profile UKCore-Practitioner
- Profile UKCore-PractitionerRole
In addition, a UKCore-Device (draft) can be referenced via the Extension UKCore-DeviceReference as deviceReference
.
resultsInterpreter
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
- UKCore-CareTeam (draft)
- Profile UKCore-Organization
- Profile UKCore-Practitioner
- Profile UKCore-PractitionerRole
In addition, a UKCore-Device (draft) can be referenced via the Extension UKCore-DeviceReference as deviceReference
.
specimen
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Specimen.
result
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Observation.
imagingStudy
Where possible, it is expected that the resource being referenced SHOULD conform to UKCore-ImagingStudy (draft).