Notice
- Important: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
- This Implementation Guide is currently in Draft and SHOULD NOT be used for development or active implementation without express direction from the NHS England Genomics Unit.
StructureDefinition UKCore-DiagnosticReport
The requirements of a specific Genomics DiagnosticReport is currently under review.
The draft profile is provided below for completeness.
Currently, only requirements for initial Pathology reports, provided with a test order, have been reviewed. DiagnosticReports containing the results of genomic testing are expected to be attached/provided as PDF documents during the alpha phase of the GMS development programme.
It is expected structured DiagnosticReports will mimic the structure proposed within the HL7 International Genomic Reporting IG, though customizations for use within the UK still need to be investigated.
Genomic DiagnosticReports which have been updated post submission SHALL be accompanied by Provenance resources, referencing the DiagnosticReport which detail when the resource was changed, who made the change and why.
Profile url | FHIR Module | Normative Status |
---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport | UKCore | trial-use |
UKCoreDiagnosticReport (DiagnosticReport) | I | DiagnosticReport | There are no (further) constraints on this element Element idDiagnosticReport A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Alternate namesReport, Test, Result, Results, Labs, Laboratory DefinitionThe 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. 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.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idDiagnosticReport.meta Metadata about the resource DefinitionThe 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.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idDiagnosticReport.implicitRules A set of rules under which this content was created DefinitionA 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idDiagnosticReport.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idDiagnosticReport.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idDiagnosticReport.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
compositionReferenceR5 | I | 0..1 | Extension(Reference(Composition)) | Element idDiagnosticReport.extension:compositionReferenceR5 A Composition reference for a DiagnosticReport. This is a R5 backport. Alternate namesextensions, user content DefinitionA Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport. 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. Extension(Reference(Composition)) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.extension:compositionReferenceR5.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:compositionReferenceR5.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idDiagnosticReport.extension:compositionReferenceR5.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition
| |
value[x] | 1..1 | Element idDiagnosticReport.extension:compositionReferenceR5.value[x] Reference to a Composition resource. DefinitionReference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport.
| ||
valueReference | Reference(Composition) | There are no (further) constraints on this element Data type | ||
mediaR5 | I | 1..* | Extension(Complex) | Element idDiagnosticReport.extension:mediaR5 Reference to a DocumentReference resource. Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. Extension(Complex) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.media.link Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.extension:mediaR5.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 1..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:mediaR5.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
comment | I | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:mediaR5.extension:comment Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.extension:mediaR5.extension:comment.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:mediaR5.extension:comment.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idDiagnosticReport.extension:mediaR5.extension:comment.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. comment
| |
value[x] | 1..1 | There are no (further) constraints on this element Element idDiagnosticReport.extension:mediaR5.extension:comment.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
link | I | 1..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:mediaR5.extension:link Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.extension:mediaR5.extension:link.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:mediaR5.extension:link.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idDiagnosticReport.extension:mediaR5.extension:link.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. link
| |
value[x] | 1..1 | There are no (further) constraints on this element Element idDiagnosticReport.extension:mediaR5.extension:link.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueReference | Reference(UKCoreDocumentReference) | There are no (further) constraints on this element Data type | ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idDiagnosticReport.extension:mediaR5.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.media.link
| |
value[x] | 0..0 | There are no (further) constraints on this element Element idDiagnosticReport.extension:mediaR5.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
noteR5 | I | 0..* | Extension(Annotation) | Element idDiagnosticReport.extension:noteR5 Comments about the diagnostic report. This is a R5 backport. Alternate namesextensions, user content DefinitionMay 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. 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. http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.extension:noteR5.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:noteR5.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idDiagnosticReport.extension:noteR5.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note
| |
value[x] | 1..1 | Element idDiagnosticReport.extension:noteR5.value[x] Comments about the diagnostic report. DefinitionMay 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.
| ||
valueAnnotation | Annotation | There are no (further) constraints on this element Data type | ||
supportingInfoR5 | I | 0..* | Extension(Complex) | Element idDiagnosticReport.extension:supportingInfoR5 Additional info supporting the diagnostic report. This is a R5 backport. Alternate namesextensions, user content DefinitionThis backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report. 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. Extension(Complex) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 2..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
type | I | 1..1 | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:type Supporting information role code. Alternate namesextensions, user content DefinitionThe code value for the role of the supporting information in the diagnostic report. 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. http://terminology.hl7.org/ValueSet/v2-0936 (example) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:type.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:type.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:type.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. type
| |
value[x] | 1..1 | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:type.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
reference | I | 1..1 | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:reference Who or what participated in the activities related to the family member history. Alternate namesextensions, user content DefinitionThe reference for the supporting information in the diagnostic report. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:reference.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:reference.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:reference.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. reference
| |
value[x] | 1..1 | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.extension:reference.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueReference | Reference(Procedure | Observation | DiagnosticReport) | There are no (further) constraints on this element Data type | ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo
| |
value[x] | 0..0 | There are no (further) constraints on this element Element idDiagnosticReport.extension:supportingInfoR5.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idDiagnosticReport.identifier Business identifier for report Alternate namesReportID, Filler ID, Placer ID DefinitionIdentifiers assigned to this report by the performer or other systems. 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. Usually assigned by the Information System of the diagnostic service provider (filler id).
|
basedOn | I | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | There are no (further) constraints on this element Element idDiagnosticReport.basedOn What was requested Alternate namesRequest DefinitionDetails concerning a service requested. This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon. 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. Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Constraints
|
status | S Σ ?! | 1..1 | codeBinding | Element idDiagnosticReport.status The status of the diagnostic report. DefinitionThe status of the diagnostic report. Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports. Note that FHIR strings SHALL NOT exceed 1MB in size The status of the diagnostic report.
|
category | S Σ | 0..* | CodeableConcept | Element idDiagnosticReport.category A code that classifies the clinical discipline, department or diagnostic service that created the report. Alternate namesDepartment, Sub-department, Service, Discipline DefinitionA 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. 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. Codes for diagnostic service sections.
|
code | S Σ | 1..1 | CodeableConceptBinding | Element idDiagnosticReport.code A code or name that describes this diagnostic report. Alternate namesType DefinitionA code or name that describes this diagnostic report. 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. Codes that describe Diagnostic Reports.
|
subject | S Σ I | 0..1 | Reference(Patient | Group | Device | Location) | Element idDiagnosticReport.subject The subject of the report - usually, but not always, the patient. Alternate namesPatient DefinitionThe 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. SHALL know the subject context. 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. Reference(Patient | Group | Device | Location) Constraints
|
encounter | S Σ I | 0..1 | Reference(Encounter) | Element idDiagnosticReport.encounter Health care event when test ordered. Alternate namesContext DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. Links the request to the Encounter context. 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).
|
effective[x] | Σ | 0..1 | There are no (further) constraints on this element Element idDiagnosticReport.effective[x] Clinically relevant time/time-period for report Alternate namesObservation time, Effective Time, Occurrence DefinitionThe 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. Need to know where in the patient history to file/present this report. 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.
| |
effectiveDateTime | dateTime | There are no (further) constraints on this element Data type | ||
effectivePeriod | Period | There are no (further) constraints on this element Data type | ||
issued | S Σ | 0..1 | instant | Element idDiagnosticReport.issued Clinically relevant time / time-period for report. Alternate namesDate published, Date Issued, Date Verified DefinitionThe date and time that this version of the report was made available to providers, typically after the report was reviewed and verified. Clinicians need to be able to check the date that the report was released. 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.
|
performer | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | There are no (further) constraints on this element Element idDiagnosticReport.performer Responsible Diagnostic Service Alternate namesLaboratory, Service, Practitioner, Department, Company, Authorized by, Director DefinitionThe diagnostic service that is responsible for issuing the report. 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. 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. Reference(Practitioner | PractitionerRole | Organization | CareTeam) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.performer.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.performer.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
deviceReference | I | 0..1 | Extension(Reference(Device)) | Element idDiagnosticReport.performer.extension:deviceReference A reference to a Device which interprets / performs the results of the DiagnosticReport. Alternate namesextensions, user content DefinitionAn additional Device reference for a DiagnosticReport, to allow Software as a Medical Device to perform / interpret a DiagnosticReport 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference Constraints
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.performer.reference Literal reference, Relative, internal or absolute URL DefinitionA 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. 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.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idDiagnosticReport.performer.type Type the reference refers to (e.g. "Patient") DefinitionThe 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). 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. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idDiagnosticReport.performer.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.performer.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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.
|
resultsInterpreter | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | There are no (further) constraints on this element Element idDiagnosticReport.resultsInterpreter Primary result interpreter Alternate namesAnalyzed by, Reported by DefinitionThe practitioner or organization that is responsible for the report's conclusions and interpretations. 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. Might not be the same entity that takes responsibility for the clinical report. Reference(Practitioner | PractitionerRole | Organization | CareTeam) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.resultsInterpreter.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.resultsInterpreter.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
deviceReference | I | 0..* | Extension(Reference(Device)) | Element idDiagnosticReport.resultsInterpreter.extension:deviceReference A reference to a Device which interprets / performs the results of the DiagnosticReport. Alternate namesextensions, user content DefinitionAn additional Device reference for a DiagnosticReport, to allow Software as a Medical Device to perform / interpret a DiagnosticReport 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference Constraints
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.resultsInterpreter.reference Literal reference, Relative, internal or absolute URL DefinitionA 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. 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.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idDiagnosticReport.resultsInterpreter.type Type the reference refers to (e.g. "Patient") DefinitionThe 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). 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. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idDiagnosticReport.resultsInterpreter.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.resultsInterpreter.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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.
|
specimen | I | 0..* | Reference(Specimen) | There are no (further) constraints on this element Element idDiagnosticReport.specimen Specimens this report is based on DefinitionDetails about the specimens on which this diagnostic report is based. Need to be able to report information about the collected specimens on which the report is based. 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.
|
result | S I | 0..* | Reference(Observation) | Element idDiagnosticReport.result Observations that are part of this diagnostic report. Alternate namesData, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer DefinitionObservations that are part of this diagnostic report. Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. Observations can contain observations.
|
imagingStudy | I | 0..* | Reference(ImagingStudy) | There are no (further) constraints on this element Element idDiagnosticReport.imagingStudy Reference to full details of imaging associated with the diagnostic report DefinitionOne 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. 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.
|
media | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idDiagnosticReport.media Key images associated with this report Alternate namesDICOM, Slides, Scans DefinitionA 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). Many diagnostic services include images in the report as part of their service.
|
id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.media.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.media.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idDiagnosticReport.media.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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. 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.
|
comment | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.media.comment Comment about the image (e.g. explanation) DefinitionA 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. The provider of the report should make a comment about each image included in the report. 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.
| |
link | Σ I | 1..1 | Reference(Media) | There are no (further) constraints on this element Element idDiagnosticReport.media.link Reference to the image source DefinitionReference to the image source. 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.
|
conclusion | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.conclusion Clinical conclusion (interpretation) of test results Alternate namesReport DefinitionConcise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report. Need to be able to provide a conclusion that is not lost among the basic result data. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
conclusionCode | 0..* | CodeableConceptBinding | Element idDiagnosticReport.conclusionCode Codes for the clinical conclusion of test results DefinitionOne or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report. 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. Diagnosis codes provided as adjuncts to the report.
| |
presentedForm | I | 0..* | Attachment | There are no (further) constraints on this element Element idDiagnosticReport.presentedForm Entire report as issued DefinitionRich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. Gives laboratory the ability to provide its own fully formatted report for clinical fidelity. "application/pdf" is recommended as the most reliable and interoperable in this context.
|
FHIR | MDS | HL7v2 |
---|---|---|
DiagnosticReport | Previous Genomic Report, Previous Diagnostic Report | OBX |
DiagnosticReport.effectiveDateTime | PLCM activity - Date and time dataset created, PLCM activity - Turnaround time (calendar days), Previous genomic report - Test performed date, Previous non genomic report - Test performed date | Derived from OBR-7 in the ORU response message for the activity based on the OML request, OBX-19 |
DiagnosticReport.identifier | PLCM activity - Local report identifier, Previous genomic report - Report identifier, Previous non genomic report - Report identifier | OBR-3 for report |
DiagnosticReport.result | PLCM activity - Test outcome code (Many), Previous non genomic report - Test result value comparator, Previous non genomic report - Test result value unit of measure, Previous non genomic report - Test result reference range low, Previous non genomic report - Test result reference range high, Previous non genomic report - Test result test method, Previous non genomic report - Test result reference range text, Previous non genomic report - Test result clinical summary | OBX-3 elements for resulting report, OBX-5, OBX-6, OBX-7 (before operator), OBX-7 (after operator), OBX-17, OBX-7, OBX-8 |
DiagnosticReport.conclusion | Previous genomic report - Report referral summary, Previous non genomic report - Report referral summary | OBX-5 |
DiagnosticReport.presentedForm | Previous genomic report - Report file/link, Previous non genomic report - Report file/link | OBX-5 where OBX-2=ED or RP |
DiagnosticReport.subject | Previous genomic report - Patient's first name, Previous genomic report - Patient's surname, Previous genomic report - Patient's address, Previous genomic report - Patient's post code, Previous genomic report - Patient's country, Previous genomic report - Patient's date of birth, Previous genomic report - Patient's NHS number, Previous genomic report - Patient's alternative identifier, Previous genomic report - Patient's relationship to requesting patient, Previous genomic report - Patient's clinical genetics number, Previous genomic report - Patient's pedigree number | PID attached to Patient Prior |
DiagnosticReport.basedOn | Previous genomic report - Report lab test number, Previous genomic report - Original requester full name, Previous genomic report - Original requester organisation ODS code, Previous genomic report - Original requester reason for request, Previous non genomic report - Original requester full name, Previous non genomic report - Original requester organisation ODS code, Previous non genomic report - Original requester reason for request | ORC-2, ORC-12, ORC-21.10, ORC-16 |
DiagnosticReport.conclusionCode | Previous genomic report - Report of genetic analysis, Previous non genomic report - Report result | OBR-5 |
DiagnosticReport.performer | Previous genomic report - Report performer full name, Previous genomic report - Report performer organisation ODS code, Previous non genomic report - Report performer full name, Previous non genomic report - Report performer organisation ODS code | OBX-16, OBX-23.10 |
DiagnosticReport.code | Previous non genomic report - Test type | OBR-4 |
Additional Guidance
- extension:mediaR5
- extension:recommended-action
- extension:genomic-study
- extension:supporting-info
- extension:workflow-relatedArtifact
- basedOn
- status
- code
- subject
- performer
- resultsInterpreter
- specimen
- conclusionCode
- presentedForm
- result
extension:mediaR5
TBC. Only relevant for structured genomic reports. Reference to DocumentReference resources pointing to the Genomic Data Files used as the basis for the report. Usage of this field over extension:supporting-info is pending further investigation."extension" : [ { "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.media.link", "extension" : [ { "url" : "link", "valueReference": { "reference" : "DocumentReference/DocumentReference-PharmCAT-Example" } } ] } } ],
extension:recommended-action
TBC. Only relevant for structured genomic reports (included in the [Genomic Report Profile in the Genomics Reporting IG](https://build.fhir.org/ig/HL7/genomics-reporting/StructureDefinition-genomic-report.html)). Reference to Task resource indicating recommended action to take in response to the report's result/conclusion."extension" : [ { "url" : "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/recommended-action", "valueReference" : { "reference" : "Task/MedicationRecommendationExample1" } } ],
extension:genomic-study
TBC. Only relevant for structured genomic reports (included in the [Genomic Report Profile in the Genomics Reporting IG](https://build.fhir.org/ig/HL7/genomics-reporting/StructureDefinition-genomic-report.html)). Reference to Procedure resources indicating the analyses performed as part the genomic test order."extension" : [ { "url" : "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/genomic-study-reference", "valueReference" : { 🔗 "reference" : "Procedure/PGXGenomicStudy" } } ]
extension:supporting-info
TBC. Only relevant for structured genomic reports (included in the [Genomics Report IG Genomic Report Profile](https://build.fhir.org/ig/HL7/genomics-reporting/StructureDefinition-genomic-report.html)). Reference to the genomic data files analysed as part of the test order, forming the report. Reference to DocumentReference resource which links to the binary data file. ```json "extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo", "valueReference" : { "reference" : "DocumentReference/DocumentReference-PharmCAT-Example" } } ], ```extension:workflow-relatedArtifact
TBC. Only relevant for structured genomic reports (included in Genomic Report Profile in the Genomics Report IG) . A reference to the guidelines or other knowledge artifacts which were used to guide interpretation or recommended actions included within this DiagnosticReport.If entries constitute published papers, they SHOULD be referenced using a known citation style, e.g. Vancouver/Harvard. Alternatively for online texts, these MAY be referenced via URL only.
A fixed value of 'citation' is expected for the type element, though this recommendation is pending further use cases.
"extension" : [ { "url" : "http://hl7.org/fhir/StructureDefinition/workflow-relatedArtifact", "valueRelatedArtifact" : { "type" : "citation", "url" : "https://cpicpgx.org/guidelines/guideline-for-clopidogrel-and-cyp2c19)" } } ],
basedOn
SHOULD reference the originating ServiceRequest if this is an instance of a genomic diagnostic report resulting from a GMS test order."basedOn": [ { "reference": "ServiceRequest-SavedTestOrder-Example" } ],
status
SHALL use base HL7 codes for DiagnosticReport.status. A DiagnosticReport SHOULD only be marked as final if the report is complete and verified by an authorised person."status": "final",
code
SHOULD use a record artifact concept from SNOMED CT where an appropriate code exists, else text is preferred to indicate the document type."code": { "coding": [ { "system": "http://snomed.info/sct", "code": "4321000179101", "display": "Hematology report (record artifact)" } ] },
subject
SHALL be present. Reference to the associated Patient. This MAY be through a resource reference if the ID on the central service is known (or provided within the transaction bundle) or through NHS number where this is known and has been traced through PDS"subject": { "reference": "Patient/Patient-MeirLieberman-Example", "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9449307873" } },
performer
SHOULD reference the organization responsible for the testing, preferably by ODS code."performer": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "REP" } } ],
resultInterpreter
SHOULD reference the person responsible for interpreting the raw results, preferably by a recognised NHS identifier, such as SDS code."resultsInterpreter": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/sds-user-id", "value": "999999999999" } } ],
specimen
SHOULD reference the specimen used during testing to generate the report, if the document is a Genomic report."specimen": [ { "reference": "Specimen/Specimen-BloodEDTA-Example" } ],
conclusionCode
If possible, unstructured reports wrapped within DiagnosticReports, SHOULD contain a conclusionCode element indicating the coded finding from the report, to aid analytics."conclusionCode": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "738542003", "display": "Dihydropyrimidine dehydrogenase poor metabolizer (finding)" } ] } ],
presentedForm
Genomic reports SHALL include a presentedForm element either referencing the location of the PDF report (located and accessible on either the source/client system or via NRL using appropriate authentication) or include the PDF report as a base64 encoded attachment within the message payload.Note: this guidance may change in the future as work on Structured Reporting matures
"presentedForm": [ { "url": "https://example.com/GenomicReports/ExampleReport.pdf" } ]
result
Raw results included within the report, to aid interpretation. These SHOULD take the form of Observation references, if providing a structured report."result" : [ { "reference" : "Observation/TherapeuticImplicationExample1", "display" : "impact for high risk allele" }, { "reference" : "Observation/GenotypeExample1" }, { "reference" : "Observation/OverallInterpExample1" } ]