England Pathology and Laboratory Medicine (PaLM) Technical Framework
0.1.0 - ci-build United Kingdom flag

England Pathology and Laboratory Medicine (PaLM) Technical Framework - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Laboratory Report - Detailed Descriptions

Draft as of 2026-11-04

Definitions for the LaboratoryReport resource profile

See the documentation on how to interpret the contents of this table

0. DiagnosticReport
Definition

Diagnostic Report EU core


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.

ShortDiagnostic Report EU coreA Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
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.

Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesReport, Test, Result, Results, Labs, Laboratory
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. 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.

ShortA set of rules under which this content was created
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.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. DiagnosticReport.extension:DiagnosticReportCompositionR5
Slice NameDiagnosticReportCompositionR5
Definition

This extension implements the R5 composition element. It allow to link this DiagnosticReport with the Composition documenting this Diagnostic Report.

ShortAssociated Composition
Comments

Element DiagnosticReport.composition has a context of DiagnosticReport based on following the parent source element upwards and mapping to DiagnosticReport. Element DiagnosticReport.composition has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The Composition provides structure to the content of the DiagnosticReport (and only contains contents referenced in the DiagnosticReport) - e.g., to order the sections of an anatomic pathology structured report.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(R5: Reference to a Composition resource for the DiagnosticReport structure (new)) (Extension Type: Reference(Cross-version Profile for R5.Composition for use in FHIR R4, Composition))
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. DiagnosticReport.extension:DiagnosticReportCompositionR5.extension
Definition

An Extension


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.

ShortExtensionAdditional content defined by implementations
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.

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DiagnosticReport.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
8. DiagnosticReport.extension:DiagnosticReportCompositionR5.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition"
}
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition"/>
10. DiagnosticReport.extension:DiagnosticReportCompositionR5.value[x]
Definition

Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport.


Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortReference to a Composition resource for the DiagnosticReport structureValue of extension
Comments

The Composition provides structure to the content of the DiagnosticReport (and only contains contents referenced in the DiagnosticReport) - e.g., to order the sections of an anatomic pathology structured report.

Control10..1
TypeReference(Composition (EU core)), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. DiagnosticReport.extension:note
Slice Namenote
Definition

R5: DiagnosticReport.note (new:Annotation)

ShortR5: Comments about the diagnostic report (new)
Comments

Element DiagnosticReport.note has a context of DiagnosticReport based on following the parent source element upwards and mapping to DiagnosticReport. Element DiagnosticReport.note has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(R5: Comments about the diagnostic report (new)) (Extension Type: Annotation)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. DiagnosticReport.extension:note.extension
Definition

An Extension


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.

ShortExtensionAdditional content defined by implementations
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.

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DiagnosticReport.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. DiagnosticReport.extension:note.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note"
}
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note"/>
18. 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).

ShortExtensions that cannot be ignored
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
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.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. DiagnosticReport.identifier
Definition

Identifiers assigned to this report by the performer or other systems.

ShortBusiness identifier for report
Comments

Usually assigned by the Information System of the diagnostic service provider for facilitating the Report search. The order id can be used as one of the Report identifier if only one report is produced for that order.


Usually assigned by the Information System of the diagnostic service provider (filler id).

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..*
TypeIdentifier(Correlation Identifier)
Is Modifierfalse
Must Supporttrue
Summarytrue
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.

Alternate NamesReportID, Filler ID, Placer ID
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on DiagnosticReport.identifier. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

22. DiagnosticReport.identifier:fillerOrderNumber
Slice NamefillerOrderNumber
Definition

Identifiers assigned to this report by the performer or other systems.

ShortReport (laboratory) number assigned by the Order Filler - HL7 v2 OBR-3, shared by the OBRs of the reportBusiness identifier for report
Comments

Usually assigned by the Information System of the diagnostic service provider for facilitating the Report search. The order id can be used as one of the Report identifier if only one report is produced for that order.


Usually assigned by the Information System of the diagnostic service provider (filler id).

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1*
TypeIdentifier(Report Identifier)
Is Modifierfalse
Must Supporttrue
Summarytrue
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.

Alternate NamesReportID, Filler ID, Placer ID
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. DiagnosticReport.basedOn
Definition

Details concerning a service requested.

ShortThe orders reported - one per OBR (HL7 v2 ORC-2 / OBR-2 Placer Order Number)What was requested
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.

Control0..*
TypeReference(Laboratory Order, CarePlan, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ServiceRequest)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon.

Alternate NamesRequest
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. DiagnosticReport.status
Definition

The status of the diagnostic report.

ShortHL7 v2 OBR-25 Result Status - see ConceptMap v2-0123 to DiagnosticReport.statusregistered | partial | preliminary | final +
Comments

DiagnosticReport.status and Composition.status shall be aligned

Control1..1
BindingThe codes SHALL be taken from DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1)

The status of the diagnostic report.

Typecode
Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. 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.

ShortLaboratory discipline (HL7 v2 OBR-24 Diagnostic Serv Sect ID)Service category
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.

Control10..*
BindingUnless not suitable, these codes SHALL be taken from For example codes, see DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections|4.0.1
(extensible to http://hl7.org/fhir/ValueSet/diagnostic-service-sections)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Alternate NamesDepartment, Sub-department, Service, Discipline
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. DiagnosticReport.code
Definition

Defines the document type, it is recommended to take this from the suggested LOINC set.


A code or name that describes this diagnostic report.

ShortReport type: SNOMED CT 721981007 Diagnostic studies report (NHS England), LOINC 11502-2 Laboratory report; or, for a report of one test, the PaLM requestable (OBR-4). The tests reported are also ServiceRequest.code and the result Observation.codeName/Code for this diagnostic report
Control1..1
BindingThe codes SHOULD be taken from LOINCDiagnosticReportCodeshttp://hl7.org/fhir/ValueSet/report-codes|4.0.1
(preferred to http://hl7.org/fhir/ValueSet/report-codes|4.0.1)

Codes that describe Diagnostic Reports.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Alternate NamesType
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. DiagnosticReport.code.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on DiagnosticReport.code.coding. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
34. DiagnosticReport.code.coding:snomedCT
Slice NamesnomedCT
Definition

A reference to a code defined by a terminology system.

ShortSNOMED CT: the PaLM requestable test reported (OBR-4) - as the Genomic Test Directory code in genomics and NICIP in imaging - and/or the report type 721981007 Diagnostic studies report (NHS England)Code defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control0..*
BindingThe codes SHOULD be taken from For codes, see Laboratory Report Codes (SNOMED CT)
(preferred to https://examplesihe.org.uk/ValueSet/laboratory-report-snomedct)
TypeCoding
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. DiagnosticReport.code.coding:snomedCT.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

ShortIdentity of the terminology system
Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Pattern Value
{
  "system" : "http://snomed.info/sct"
}
<system value="http://snomed.info/sct"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. DiagnosticReport.code.coding:snomedCT.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

ShortSymbol in syntax defined by the system
Control10..1
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to refer to a particular code in the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. DiagnosticReport.code.coding:loinc
Slice Nameloinc
Definition

A reference to a code defined by a terminology system.

ShortLOINC report type, 11502-2 Laboratory report (HL7 Europe Laboratory preferred binding)Code defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control0..1*
TypeCoding
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. DiagnosticReport.code.coding:loinc.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

ShortIdentity of the terminology system
Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Pattern Value
{
  "system" : "http://loinc.org"
}
<system value="http://loinc.org"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. DiagnosticReport.code.coding:loinc.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

ShortSymbol in syntax defined by the system
Control10..1
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to refer to a particular code in the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. DiagnosticReport.subject
Definition

Who or what this report is about. The report can be about a human patient, a living subject, a device (e.g. a machine), a location or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).


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.

ShortWho and/or what this report is aboutThe subject of the report - usually, but not always, the patient
Control10..1
TypeReference(Patient, Patient, Group, Device, Location)
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

SHALL know the subject context.

Alternate NamesPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. DiagnosticReport.encounter
Definition

The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.


The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.

ShortHL7 v2 PV1-19 Visit NumberHealth care event when test ordered
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).


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).

Control0..1
TypeReference(Encounter)
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Links the request to the Encounter context.

Alternate NamesContext
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. DiagnosticReport.encounter.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.

ShortLogical reference, when literal reference is not known
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).

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier(Visit Number)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. 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.

ShortSpecimen collection date/time (HL7 v2 OBR-7 Observation Date/Time)Clinically relevant time/time-period for 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.

Control10..1
TypeChoice of: dateTime, Period
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summarytrue
Requirements

Need to know where in the patient history to file/present this report.

Alternate NamesObservation time, Effective Time, Occurrence
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on DiagnosticReport.effective[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view

54. DiagnosticReport.effective[x]:effectivePeriod
Slice NameeffectivePeriod
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.

ShortEffective period of the reportClinically relevant time/time-period for 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.

Control0..1
TypePeriod, dateTime
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Requirements

Need to know where in the patient history to file/present this report.

Alternate NamesObservation time, Effective Time, Occurrence
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
57. 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.

ShortDate/time the report was released (HL7 v2 OBR-22 Results Rpt/Status Chng - Date/Time)DateTime this version was made
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.

Control10..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Clinicians need to be able to check the date that the report was released.

Alternate NamesDate published, Date Issued, Date Verified
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
59. DiagnosticReport.performer
Definition

The diagnostic service that is responsible for issuing the report.

ShortLaboratory responsible for the report (HL7 v2 OBX-23 Performing Organization Name, MSH-4)Responsible Diagnostic Service
Comments

If a DiagnosticReport.resultsInterpreter exists this is expected to be a Composition.author; otherwise a DiagnosticReport.performer should be an author.


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.

Control10..*
TypeReference(PractitionerRole (EU core), Practitioner (EU core), Organization (EU core), CareTeam, Practitioner, PractitionerRole, Organization, CareTeam)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summarytrue
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.

Alternate NamesLaboratory, Service, Practitioner, Department, Company, Authorized by, Director
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on DiagnosticReport.performer. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

61. DiagnosticReport.performer:organization
Slice Nameorganization
Definition

The organization responsible for producing this report. In case practitioners produce them in their private practices, they will be accounted as an organization for this purpose.


The diagnostic service that is responsible for issuing the report.

ShortThe organization producer of this reportResponsible Diagnostic Service
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.

Control0..*
TypeReference(Organization (EU core), Practitioner, PractitionerRole, Organization, CareTeam)
Is Modifierfalse
Summarytrue
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.

Alternate NamesLaboratory, Service, Practitioner, Department, Company, Authorized by, Director
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
63. DiagnosticReport.resultsInterpreter
Definition

The practitioner or organization that is responsible for the report's conclusions and interpretations.

ShortHL7 v2 OBR-32 Principal Result InterpreterPrimary result interpreter
Comments

If a DiagnosticReport.resultsInterpreter exists this is expected to be a Composition.author; otherwise a DiagnosticReport.performer should be an author.


Might not be the same entity that takes responsibility for the clinical report.

Control0..*
TypeReference(PractitionerRole (EU core), Practitioner (EU core), Organization (EU core), CareTeam, Practitioner, PractitionerRole, Organization, CareTeam)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summarytrue
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.

Alternate NamesAnalyzed by, Reported by
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on DiagnosticReport.resultsInterpreter. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

65. DiagnosticReport.resultsInterpreter:author
Slice Nameauthor
Definition

The practitioner or organization that is responsible for the report's conclusions and interpretations.

ShortPrimary result interpreter
Comments

Might not be the same entity that takes responsibility for the clinical report.

Control0..*
TypeReference(PractitionerRole (EU core), Practitioner, PractitionerRole, Organization, CareTeam)
Is Modifierfalse
Summarytrue
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.

Alternate NamesAnalyzed by, Reported by
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
67. DiagnosticReport.specimen
Definition

Details about the specimens on which this diagnostic report is based.

ShortSpecimens this report is based on.
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.

Control0..*
TypeReference(Specimen, Specimen)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Need to be able to report information about the collected specimens on which the report is based.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
69. DiagnosticReport.result
Definition

Observations that are part of this diagnostic report.

ShortOne per OBR: the test group organizer Observation, or the single result of a one-test OBRObservations
Comments

Observations can contain observations.

Control0..*
TypeReference(Laboratory Result, Observation)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful.

Alternate NamesData, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
71. DiagnosticReport.conclusion
Definition

Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.

ShortReport comment or interpretation (HL7 v2 NTE following OBR, or OBX of type TX / FT)Clinical conclusion (interpretation) of test results
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Requirements

Need to be able to provide a conclusion that is not lost among the basic result data.

Alternate NamesReport
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
73. 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.

ShortRendered report, e.g. PDF (HL7 v2 OBX of type ED or RP)Entire report as issued
Comments

"application/pdf" is recommended as the most reliable and interoperable in this context.

Control0..*
TypeAttachment(Attachment)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Gives laboratory the ability to provide its own fully formatted report for clinical fidelity.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

See the documentation on how to interpret the contents of this table

0. DiagnosticReport
2. DiagnosticReport.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..?
TypeIdentifier(Correlation Identifier)
Must Supporttrue
SlicingThis element introduces a set of slices on DiagnosticReport.identifier. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

4. DiagnosticReport.identifier:fillerOrderNumber
Slice NamefillerOrderNumber
ShortReport (laboratory) number assigned by the Order Filler - HL7 v2 OBR-3, shared by the OBRs of the report
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier(Report Identifier)
Must Supporttrue
6. DiagnosticReport.basedOn
ShortThe orders reported - one per OBR (HL7 v2 ORC-2 / OBR-2 Placer Order Number)
TypeReference(Laboratory Order)
Must Supporttrue
8. DiagnosticReport.status
ShortHL7 v2 OBR-25 Result Status - see ConceptMap v2-0123 to DiagnosticReport.status
Must Supporttrue
10. DiagnosticReport.category
ShortLaboratory discipline (HL7 v2 OBR-24 Diagnostic Serv Sect ID)
Control1..?
BindingUnless not suitable, these codes SHALL be taken from DiagnosticServiceSectionCodes
(extensible to http://hl7.org/fhir/ValueSet/diagnostic-service-sections)
Must Supporttrue
12. DiagnosticReport.code
ShortReport type: SNOMED CT 721981007 Diagnostic studies report (NHS England), LOINC 11502-2 Laboratory report; or, for a report of one test, the PaLM requestable (OBR-4). The tests reported are also ServiceRequest.code and the result Observation.code
Must Supporttrue
14. DiagnosticReport.code.coding
SlicingThis element introduces a set of slices on DiagnosticReport.code.coding. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
16. DiagnosticReport.code.coding:snomedCT
Slice NamesnomedCT
ShortSNOMED CT: the PaLM requestable test reported (OBR-4) - as the Genomic Test Directory code in genomics and NICIP in imaging - and/or the report type 721981007 Diagnostic studies report (NHS England)
Control0..*
BindingThe codes SHOULD be taken from Laboratory Report Codes (SNOMED CT)
(preferred to https://examplesihe.org.uk/ValueSet/laboratory-report-snomedct)
Must Supporttrue
18. DiagnosticReport.code.coding:snomedCT.system
Control1..?
Pattern Value
{
  "system" : "http://snomed.info/sct"
}
<system value="http://snomed.info/sct"/>
20. DiagnosticReport.code.coding:snomedCT.code
Control1..?
22. DiagnosticReport.code.coding:loinc
Slice Nameloinc
ShortLOINC report type, 11502-2 Laboratory report (HL7 Europe Laboratory preferred binding)
Control0..1
Must Supporttrue
24. DiagnosticReport.code.coding:loinc.system
Control1..?
Pattern Value
{
  "system" : "http://loinc.org"
}
<system value="http://loinc.org"/>
26. DiagnosticReport.code.coding:loinc.code
Control1..?
28. DiagnosticReport.subject
TypeReference(Patient)
Must Supporttrue
30. DiagnosticReport.encounter
ShortHL7 v2 PV1-19 Visit Number
Must Supporttrue
32. DiagnosticReport.encounter.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
TypeIdentifier(Visit Number)
34. DiagnosticReport.effective[x]
ShortSpecimen collection date/time (HL7 v2 OBR-7 Observation Date/Time)
Control1..?
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Must Supporttrue
36. DiagnosticReport.issued
ShortDate/time the report was released (HL7 v2 OBR-22 Results Rpt/Status Chng - Date/Time)
Control1..?
Must Supporttrue
38. DiagnosticReport.performer
ShortLaboratory responsible for the report (HL7 v2 OBX-23 Performing Organization Name, MSH-4)
Control1..?
Must Supporttrue
40. DiagnosticReport.resultsInterpreter
ShortHL7 v2 OBR-32 Principal Result Interpreter
Must Supporttrue
42. DiagnosticReport.specimen
TypeReference(Specimen)
Must Supporttrue
44. DiagnosticReport.result
ShortOne per OBR: the test group organizer Observation, or the single result of a one-test OBR
TypeReference(Laboratory Result)
Must Supporttrue
46. DiagnosticReport.conclusion
ShortReport comment or interpretation (HL7 v2 NTE following OBR, or OBX of type TX / FT)
Must Supporttrue
48. DiagnosticReport.presentedForm
ShortRendered report, e.g. PDF (HL7 v2 OBX of type ED or RP)
TypeAttachment(Attachment)
Must Supporttrue

See the documentation on how to interpret the contents of this table

0. DiagnosticReport
Definition

Diagnostic Report EU core

ShortDiagnostic Report EU core
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.

Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesReport, Test, Result, Results, Labs, Laboratory
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. DiagnosticReport.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
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.

Control0..1
Typeid
Is Modifierfalse
Summarytrue
4. 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.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. 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.

ShortA set of rules under which this content was created
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.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. DiagnosticReport.language
Definition

The base language in which the resource is written.

ShortLanguage of the diagnostic report content
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).

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. 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.

ShortText summary of the resource, for human interpretation
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.

Control0..1
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. 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.

ShortContained, inline 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.

Control0..*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. DiagnosticReport.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DiagnosticReport.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. DiagnosticReport.extension:DiagnosticReportCompositionR5
Slice NameDiagnosticReportCompositionR5
Definition

This extension implements the R5 composition element. It allow to link this DiagnosticReport with the Composition documenting this Diagnostic Report.

ShortAssociated Composition
Comments

Element DiagnosticReport.composition has a context of DiagnosticReport based on following the parent source element upwards and mapping to DiagnosticReport. Element DiagnosticReport.composition has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The Composition provides structure to the content of the DiagnosticReport (and only contains contents referenced in the DiagnosticReport) - e.g., to order the sections of an anatomic pathology structured report.

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(R5: Reference to a Composition resource for the DiagnosticReport structure (new)) (Extension Type: Reference(Cross-version Profile for R5.Composition for use in FHIR R4, Composition))
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. DiagnosticReport.extension:DiagnosticReportCompositionR5.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
20. DiagnosticReport.extension:DiagnosticReportCompositionR5.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DiagnosticReport.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
22. DiagnosticReport.extension:DiagnosticReportCompositionR5.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition"
}
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition"/>
24. DiagnosticReport.extension:DiagnosticReportCompositionR5.value[x]
Definition

Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport.

ShortReference to a Composition resource for the DiagnosticReport structure
Comments

The Composition provides structure to the content of the DiagnosticReport (and only contains contents referenced in the DiagnosticReport) - e.g., to order the sections of an anatomic pathology structured report.

Control1..1
TypeReference(Composition (EU core))
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. DiagnosticReport.extension:note
Slice Namenote
Definition

R5: DiagnosticReport.note (new:Annotation)

ShortR5: Comments about the diagnostic report (new)
Comments

Element DiagnosticReport.note has a context of DiagnosticReport based on following the parent source element upwards and mapping to DiagnosticReport. Element DiagnosticReport.note has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(R5: Comments about the diagnostic report (new)) (Extension Type: Annotation)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
28. DiagnosticReport.extension:note.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
30. DiagnosticReport.extension:note.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DiagnosticReport.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
32. DiagnosticReport.extension:note.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note"
}
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note"/>
34. DiagnosticReport.extension:note.value[x]
Definition

Comments about the diagnostic report.

ShortComments about the diagnostic report
Comments

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.

Control0..1
TypeAnnotation
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. DiagnosticReport.extension:note.value[x].id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
38. DiagnosticReport.extension:note.value[x].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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DiagnosticReport.extension.value[x].extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
40. DiagnosticReport.extension:note.value[x].extension:annotation-type
Slice Nameannotation-type
Definition

The type of annotation. This extension can be used to map the v2 NTE-4 comment type field.

ShortThe type of annotation
Comments

This is used to identify the type of annotation.

Control0..*
TypeExtension(Annotation type) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
42. DiagnosticReport.extension:note.value[x].extension:annotation-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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
44. DiagnosticReport.extension:note.value[x].extension:annotation-type.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DiagnosticReport.extension.value[x].extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
46. DiagnosticReport.extension:note.value[x].extension:annotation-type.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
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.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/StructureDefinition/annotationType"
}
<url value="http://hl7.org/fhir/StructureDefinition/annotationType"/>
48. DiagnosticReport.extension:note.value[x].extension:annotation-type.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortType of note
Control1..1
BindingFor example codes, see hl7VS-commentType
(example to http://terminology.hl7.org/ValueSet/v2-0364)
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. DiagnosticReport.extension:note.value[x].author[x]
Definition

The individual responsible for making the annotation.

ShortIndividual responsible for the annotation
Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Control0..1
TypeChoice of: Reference(Practitioner, Patient, RelatedPerson, Organization), string
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. DiagnosticReport.extension:note.value[x].time
Definition

Indicates when this particular annotation was made.

ShortWhen the annotation was made
Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. DiagnosticReport.extension:note.value[x].text
Definition

The text of the annotation in markdown format.

ShortThe annotation - text content (as markdown)
Control1..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. 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).

ShortExtensions that cannot be ignored
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
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.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
58. DiagnosticReport.identifier
Definition

Identifiers assigned to this report by the performer or other systems.

ShortBusiness identifier for report
Comments

Usually assigned by the Information System of the diagnostic service provider for facilitating the Report search. The order id can be used as one of the Report identifier if only one report is produced for that order.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier(Correlation Identifier)
Is Modifierfalse
Must Supporttrue
Summarytrue
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.

Alternate NamesReportID, Filler ID, Placer ID
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on DiagnosticReport.identifier. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

60. DiagnosticReport.identifier:fillerOrderNumber
Slice NamefillerOrderNumber
Definition

Identifiers assigned to this report by the performer or other systems.

ShortReport (laboratory) number assigned by the Order Filler - HL7 v2 OBR-3, shared by the OBRs of the report
Comments

Usually assigned by the Information System of the diagnostic service provider for facilitating the Report search. The order id can be used as one of the Report identifier if only one report is produced for that order.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier(Report Identifier)
Is Modifierfalse
Must Supporttrue
Summarytrue
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.

Alternate NamesReportID, Filler ID, Placer ID
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. DiagnosticReport.basedOn
Definition

Details concerning a service requested.

ShortThe orders reported - one per OBR (HL7 v2 ORC-2 / OBR-2 Placer Order Number)
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.

Control0..*
TypeReference(Laboratory Order)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon.

Alternate NamesRequest
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. DiagnosticReport.status
Definition

The status of the diagnostic report.

ShortHL7 v2 OBR-25 Result Status - see ConceptMap v2-0123 to DiagnosticReport.status
Comments

DiagnosticReport.status and Composition.status shall be aligned

Control1..1
BindingThe codes SHALL be taken from DiagnosticReportStatus
(required to http://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1)

The status of the diagnostic report.

Typecode
Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. 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.

ShortLaboratory discipline (HL7 v2 OBR-24 Diagnostic Serv Sect ID)
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.

Control1..*
BindingUnless not suitable, these codes SHALL be taken from DiagnosticServiceSectionCodes
(extensible to http://hl7.org/fhir/ValueSet/diagnostic-service-sections)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Alternate NamesDepartment, Sub-department, Service, Discipline
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. DiagnosticReport.code
Definition

Defines the document type, it is recommended to take this from the suggested LOINC set.

ShortReport type: SNOMED CT 721981007 Diagnostic studies report (NHS England), LOINC 11502-2 Laboratory report; or, for a report of one test, the PaLM requestable (OBR-4). The tests reported are also ServiceRequest.code and the result Observation.code
Control1..1
BindingThe codes SHOULD be taken from LOINCDiagnosticReportCodes
(preferred to http://hl7.org/fhir/ValueSet/report-codes|4.0.1)

Codes that describe Diagnostic Reports.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Alternate NamesType
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. DiagnosticReport.code.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
72. DiagnosticReport.code.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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DiagnosticReport.code.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
74. DiagnosticReport.code.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control0..*
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on DiagnosticReport.code.coding. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
76. DiagnosticReport.code.coding:snomedCT
Slice NamesnomedCT
Definition

A reference to a code defined by a terminology system.

ShortSNOMED CT: the PaLM requestable test reported (OBR-4) - as the Genomic Test Directory code in genomics and NICIP in imaging - and/or the report type 721981007 Diagnostic studies report (NHS England)
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control0..*
BindingThe codes SHOULD be taken from Laboratory Report Codes (SNOMED CT)
(preferred to https://examplesihe.org.uk/ValueSet/laboratory-report-snomedct)
TypeCoding
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. DiagnosticReport.code.coding:snomedCT.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
80. DiagnosticReport.code.coding:snomedCT.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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DiagnosticReport.code.coding.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
82. DiagnosticReport.code.coding:snomedCT.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

ShortIdentity of the terminology system
Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Pattern Value
{
  "system" : "http://snomed.info/sct"
}
<system value="http://snomed.info/sct"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. DiagnosticReport.code.coding:snomedCT.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

ShortVersion of the system - if relevant
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. DiagnosticReport.code.coding:snomedCT.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

ShortSymbol in syntax defined by the system
Control1..1
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to refer to a particular code in the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. DiagnosticReport.code.coding:snomedCT.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

ShortRepresentation defined by the system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. DiagnosticReport.code.coding:snomedCT.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

ShortIf this coding was chosen directly by the user
Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. DiagnosticReport.code.coding:loinc
Slice Nameloinc
Definition

A reference to a code defined by a terminology system.

ShortLOINC report type, 11502-2 Laboratory report (HL7 Europe Laboratory preferred binding)
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control0..1
TypeCoding
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. DiagnosticReport.code.coding:loinc.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
96. DiagnosticReport.code.coding:loinc.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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DiagnosticReport.code.coding.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
98. DiagnosticReport.code.coding:loinc.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

ShortIdentity of the terminology system
Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Control1..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Pattern Value
{
  "system" : "http://loinc.org"
}
<system value="http://loinc.org"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. DiagnosticReport.code.coding:loinc.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

ShortVersion of the system - if relevant
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. DiagnosticReport.code.coding:loinc.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

ShortSymbol in syntax defined by the system
Control1..1
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to refer to a particular code in the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. DiagnosticReport.code.coding:loinc.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

ShortRepresentation defined by the system
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. DiagnosticReport.code.coding:loinc.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

ShortIf this coding was chosen directly by the user
Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. DiagnosticReport.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. DiagnosticReport.subject
Definition

Who or what this report is about. The report can be about a human patient, a living subject, a device (e.g. a machine), a location or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).

ShortWho and/or what this report is about
Control1..1
TypeReference(Patient)
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

SHALL know the subject context.

Alternate NamesPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. DiagnosticReport.encounter
Definition

The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.

ShortHL7 v2 PV1-19 Visit Number
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).

Control0..1
TypeReference(Encounter)
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Links the request to the Encounter context.

Alternate NamesContext
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. DiagnosticReport.encounter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
116. DiagnosticReport.encounter.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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on DiagnosticReport.encounter.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
118. DiagnosticReport.encounter.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.

ShortLiteral reference, Relative, internal or absolute URL
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.

Control0..1
This element is affected by the following invariants: ref-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
120. DiagnosticReport.encounter.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).

ShortType the reference refers to (e.g. "Patient")
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.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from ResourceType
(extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

Aa resource (or, for logical models, the URI of the logical model).

Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
122. DiagnosticReport.encounter.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.

ShortLogical reference, when literal reference is not known
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).

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier(Visit Number)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
124. DiagnosticReport.encounter.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

ShortText alternative for the resource
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.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. 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.

ShortSpecimen collection date/time (HL7 v2 OBR-7 Observation Date/Time)
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.

Control1..1
TypeChoice of: dateTime, Period
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summarytrue
Requirements

Need to know where in the patient history to file/present this report.

Alternate NamesObservation time, Effective Time, Occurrence
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on DiagnosticReport.effective[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view

128. DiagnosticReport.effective[x]:effectivePeriod
Slice NameeffectivePeriod
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.

ShortEffective period of the 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.

Control0..1
TypePeriod
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summarytrue
Requirements

Need to know where in the patient history to file/present this report.

Alternate NamesObservation time, Effective Time, Occurrence
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
131. 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.

ShortDate/time the report was released (HL7 v2 OBR-22 Results Rpt/Status Chng - Date/Time)
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.

Control1..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Requirements

Clinicians need to be able to check the date that the report was released.

Alternate NamesDate published, Date Issued, Date Verified
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
133. DiagnosticReport.performer
Definition

The diagnostic service that is responsible for issuing the report.

ShortLaboratory responsible for the report (HL7 v2 OBX-23 Performing Organization Name, MSH-4)
Comments

If a DiagnosticReport.resultsInterpreter exists this is expected to be a Composition.author; otherwise a DiagnosticReport.performer should be an author.

Control1..*
TypeReference(PractitionerRole (EU core), Practitioner (EU core), Organization (EU core), CareTeam)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summarytrue
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.

Alternate NamesLaboratory, Service, Practitioner, Department, Company, Authorized by, Director
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on DiagnosticReport.performer. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

135. DiagnosticReport.performer:organization
Slice Nameorganization
Definition

The organization responsible for producing this report. In case practitioners produce them in their private practices, they will be accounted as an organization for this purpose.

ShortThe organization producer of this report
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.

Control0..*
TypeReference(Organization (EU core))
Is Modifierfalse
Summarytrue
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.

Alternate NamesLaboratory, Service, Practitioner, Department, Company, Authorized by, Director
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
137. DiagnosticReport.resultsInterpreter
Definition

The practitioner or organization that is responsible for the report's conclusions and interpretations.

ShortHL7 v2 OBR-32 Principal Result Interpreter
Comments

If a DiagnosticReport.resultsInterpreter exists this is expected to be a Composition.author; otherwise a DiagnosticReport.performer should be an author.

Control0..*
TypeReference(PractitionerRole (EU core), Practitioner (EU core), Organization (EU core), CareTeam)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
Summarytrue
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.

Alternate NamesAnalyzed by, Reported by
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on DiagnosticReport.resultsInterpreter. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

139. DiagnosticReport.resultsInterpreter:author
Slice Nameauthor
Definition

The practitioner or organization that is responsible for the report's conclusions and interpretations.

ShortPrimary result interpreter
Comments

Might not be the same entity that takes responsibility for the clinical report.

Control0..*
TypeReference(PractitionerRole (EU core))
Is Modifierfalse
Summarytrue
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.

Alternate NamesAnalyzed by, Reported by
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
141. DiagnosticReport.specimen
Definition

Details about the specimens on which this diagnostic report is based.

ShortSpecimens this report is based on.
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.

Control0..*
TypeReference(Specimen)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Need to be able to report information about the collected specimens on which the report is based.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
143. DiagnosticReport.result
Definition

Observations that are part of this diagnostic report.

ShortOne per OBR: the test group organizer Observation, or the single result of a one-test OBR
Comments

Observations can contain observations.

Control0..*
TypeReference(Laboratory Result)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful.

Alternate NamesData, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
145. 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.

ShortStudy subject to this report
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.

Control0..*
TypeReference(ImagingStudy)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
147. DiagnosticReport.media
Definition

A list of additional data, other then presented form of the report, associated with this report. This data is generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).

ShortAdditional data (like images, diagrams or documents) associated with this report
Control0..*
TypeBackboneElement
Is Modifierfalse
Summarytrue
Requirements

Some diagnostic reports may include additional data such as images, diagrams or documents that are relevant to the report. This additional information can provide further context and support for the findings presented in the report.

Alternate NamesDICOM, Slides, Scans, DICOM; Slides; Scans; Pictures; Documents; Diagrams
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
149. 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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
151. 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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
153. 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
155. DiagnosticReport.media.comment
Definition

Allows for a comment about the image or data, such as an explanation of its significance or context within the diagnostic report.

ShortComment about the image or data (e.g. explanation)
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.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

The provider of the report should make a comment about each image or data included in the report. This comment can provide valuable context and help the reader understand the significance of the image or data in relation to the overall findings of the report.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
157. DiagnosticReport.media.link
Definition

A reference to the image or data associated with this report.

ShortReference to the image or data
Control1..1
TypeReference(Media)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
159. DiagnosticReport.conclusion
Definition

Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.

ShortReport comment or interpretation (HL7 v2 NTE following OBR, or OBX of type TX / FT)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Requirements

Need to be able to provide a conclusion that is not lost among the basic result data.

Alternate NamesReport
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
161. DiagnosticReport.conclusionCode
Definition

One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.

ShortCodes for the clinical conclusion of test results
Control0..*
BindingFor example codes, see SNOMEDCTClinicalFindings
(example to http://hl7.org/fhir/ValueSet/clinical-findings|4.0.1)

Diagnosis codes provided as adjuncts to the report.

TypeCodeableConcept
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
163. 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.

ShortRendered report, e.g. PDF (HL7 v2 OBX of type ED or RP)
Comments

"application/pdf" is recommended as the most reliable and interoperable in this context.

Control0..*
TypeAttachment(Attachment)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Gives laboratory the ability to provide its own fully formatted report for clinical fidelity.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))