CDC National Healthcare Safety Network (NHSN) Digital Quality Measures (dQM) Content Package IG - Local Development build (v3.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: AcuteCareHospitalMonthlyNoteDiagnosticReport - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the ach-monthly-diagnosticreport-note resource profile.

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

0. DiagnosticReport
Definition

-


The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.

Short A 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.

Control 0..*
Is Modifier false
Must Support false
Summary false
Alternate Names Report, Test, Result, Results, Labs, Laboratory, Imaging Report, Radiology Report, Clinical Test Report
Invariants dom-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())
us-core-10: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended' ((status='partial' or status='preliminary' or status='final' or status='amended' or status='corrected' or status='appended' ) implies effective.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.

Short (NHSN-MS) Logical id of this artifactLogical 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.

Control 10..1
Type id
Is Modifier false
Must Support true
Summary true
4. 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.

Short A 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.

Control 0..1
Type uri
Is Modifier true 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 Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. 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).

Short Extensions 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.

Control 0..*
Type Extension
Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary false
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 Names extensions, user content
Invariants 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())
8. DiagnosticReport.basedOn
Definition

Details concerning a service requested.

Short (NHSN-MS) What was requestedWhat 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.

Control 0..*
Type Reference(CarePlan, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ServiceRequest, CarePlan, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ServiceRequest)bundled
Is Modifier false
Must Support true
Must Support Types No must-support rules about the choice of types/profiles
Summary false
Requirements

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

Alternate Names Request
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. DiagnosticReport.basedOn.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.

Short (NHSN-MS) Literal reference, Relative, internal or absolute URLLiteral 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.

Control 10..1
This element is affected by the following invariants: ref-1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. DiagnosticReport.status
Definition

The status of the diagnostic report.

Short (NHSN-MS)(USCDI) registered | partial | preliminary | final +registered | partial | preliminary | final +
Control 1..1
This element is affected by the following invariants: us-core-10
Binding The 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)
Type code
Is Modifier true 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 Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Requirements

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

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

Short (NHSN-MS)(QI-Core)(USCDI) Service CategoryService 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.

Control 10..*
Binding For example codes, see DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections|4.0.1
(example to http://hl7.org/fhir/ValueSet/diagnostic-service-sections)

Codes for diagnostic service sections.

Type CodeableConcept
Is Modifier false
Must Support true
Summary true
Alternate Names Department, Sub-department, Service, Discipline
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing This element introduces a set of slices on DiagnosticReport.category. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ $this

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

16. DiagnosticReport.category:us-core
Slice Name us-core
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.

Short (NHSN-MS)(QI-Core)(USCDI) Service CategoryService 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.

Control 0..*
Binding The codes SHALL be taken from For example codes, see USCoreDiagnosticReportCategory (6.1.0)http://hl7.org/fhir/ValueSet/diagnostic-service-sections|4.0.1
(required to http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-category|6.1.0)

Note that other codes are permitted, see Required Bindings When Slicing by Value Sets


Codes for diagnostic service sections.

Type CodeableConcept
Is Modifier false
Must Support true
Summary true
Alternate Names Department, Sub-department, Service, Discipline
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. DiagnosticReport.code
Definition

The test, panel, report, or note that was ordered.


A code or name that describes this diagnostic report.

Short (NHSN-MS)(QI-Core)(USCDI) QI-Core Report CodeName/Code for this diagnostic report
Comments

The typical patterns for codes are: 1) a LOINC code either as a translation from a "local" code or as a primary code, or 2) a local code only if no suitable LOINC exists, or 3) both the local and the LOINC translation. Systems SHALL be capable of sending the local code if one exists.

Control 1..1
Binding Unless not suitable, these codes SHALL be taken from The codes SHOULD be taken from USCoreNonLaboratoryCodes (6.1.0)http://hl7.org/fhir/ValueSet/report-codes|4.0.1
(extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-report-and-note-codes|6.1.0)

LOINC codes


Codes that describe Diagnostic Reports.

Type CodeableConcept
Is Modifier false
Must Support true
Summary true
Alternate Names Type
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. DiagnosticReport.subject
Definition

The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.

Short (NHSN-MS)(QI-Core)(USCDI) The subject of the report - usually, but not always, the patientThe subject of the report - usually, but not always, the patient
Control 10..1
Type Reference(Cross-Measure Patient Profile, Patient, Group, Device, Location)bundled
Is Modifier false
Must Support true
Summary true
Requirements

SHALL know the subject context.

Alternate Names Patient
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. DiagnosticReport.subject.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.

Short (NHSN-MS) Literal reference, Relative, internal or absolute URLLiteral 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.

Control 10..1
This element is affected by the following invariants: ref-1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. DiagnosticReport.encounter
Definition

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

Short (NHSN-MS)(QI-Core)(USCDI) Health care event when test orderedHealth 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).

Control 0..1
Type Reference(QICore Encounter, Encounter)bundled
Is Modifier false
Must Support true
Summary true
Requirements

Links the request to the Encounter context.

Alternate Names Context
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. 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.

Short (NHSN-MS) Literal reference, Relative, internal or absolute URLLiteral 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.

Control 10..1
This element is affected by the following invariants: ref-1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. 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.

Short (NHSN-MS)(QI-Core)(USCDI) Diagnostically relevant time (typically the time of the procedure)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.

Control 10..1
This element is affected by the following invariants: us-core-10
Type Choice of: dateTime, Period
[x] Note SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Must Support Types dateTime
Summary true
Requirements

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

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

Short (NHSN-MS)(QI-Core)(USCDI) DateTime this version was madeDateTime 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.

Control 0..1
Type instant
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Requirements

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

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

The diagnostic service that is responsible for issuing the report.

Short (QI-Core)(USCDI) Responsible Diagnostic ServiceResponsible 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.

Control 0..*
Type Reference(QICore Practitioner, QICore Organization, Practitioner, PractitionerRole, Organization, CareTeam)
Is Modifier false
Must Support true
Must Support Types No must-support rules about the choice of types/profiles
Summary true
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 Names Laboratory, Service, Practitioner, Department, Company, Authorized by, Director
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. DiagnosticReport.result
Definition

Observations that are part of this diagnostic report.

Short (QI-Core)(USCDI) ObservationsObservations
Comments

Observations can contain observations.

Control 0..*
Type Reference(QICore Laboratory Result Observation, QICore Observation Clinical Result, Observation)
Is Modifier false
Must Support true
Must Support Types No must-support rules about the choice of types/profiles
Summary false
Requirements

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

Alternate Names Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. DiagnosticReport.media
Definition

A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).

Short (QI-Core)(USCDI) Key images associated with this reportKey images associated with this report
Control 0..*
Type BackboneElement
Is Modifier false
Must Support true
Summary true
Requirements

Many diagnostic services include images in the report as part of their service.

Alternate Names DICOM, Slides, Scans
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. 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).

Short Extensions 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.

Control 0..*
Type Extension
Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary true
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 Names extensions, user content, modifiers
Invariants 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())
40. DiagnosticReport.media.link
Definition

Reference to the image source.

Short (USCDI) Reference to the image sourceReference to the image source
Control 1..1
Type Reference(Media, Media)
Is Modifier false
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. DiagnosticReport.conclusionCode
Definition

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

Short (NHSN-MS) Codes for the clinical conclusion of test resultsCodes for the clinical conclusion of test results
Control 0..*
Binding For example codes, see SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings|4.0.1
(example to http://hl7.org/fhir/ValueSet/clinical-findings)

Diagnosis codes provided as adjuncts to the report.

Type CodeableConcept
Is Modifier false
Must Support true
Summary false
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. 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.

Short (USCDI) Entire report as issuedEntire report as issued
Comments

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

Control 0..*
Type Attachment
Is Modifier false
Must Support true
Summary false
Requirements

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

Invariants ele-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.id
Short (NHSN-MS) Logical id of this artifact
Control 1..?
Must Support true
4. DiagnosticReport.meta
6. DiagnosticReport.meta.extension:link-received-date-extension
Slice Name link-received-date-extension
Control 0..1
Type Extension(Received Date) (Extension Type: dateTime)
8. DiagnosticReport.basedOn
Short (NHSN-MS) What was requested
Type Reference(CarePlan, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ServiceRequest)bundled
Must Support true
Must Support Types No must-support rules about the choice of types/profiles
10. DiagnosticReport.basedOn.reference
Short (NHSN-MS) Literal reference, Relative, internal or absolute URL
Control 1..?
Must Support true
12. DiagnosticReport.status
Short (NHSN-MS)(USCDI) registered | partial | preliminary | final +
14. DiagnosticReport.category
Short (NHSN-MS)(QI-Core)(USCDI) Service Category
16. DiagnosticReport.category:us-core
Slice Name us-core
Short (NHSN-MS)(QI-Core)(USCDI) Service Category
18. DiagnosticReport.code
Short (NHSN-MS)(QI-Core)(USCDI) QI-Core Report Code
20. DiagnosticReport.subject
Short (NHSN-MS)(QI-Core)(USCDI) The subject of the report - usually, but not always, the patient
Type Reference(Cross-Measure Patient Profile)bundled
22. DiagnosticReport.subject.reference
Short (NHSN-MS) Literal reference, Relative, internal or absolute URL
Control 1..?
Must Support true
24. DiagnosticReport.encounter
Short (NHSN-MS)(QI-Core)(USCDI) Health care event when test ordered
Type Reference(QICore Encounter)bundled
26. DiagnosticReport.encounter.reference
Short (NHSN-MS) Literal reference, Relative, internal or absolute URL
Control 1..?
Must Support true
28. DiagnosticReport.effective[x]
Short (NHSN-MS)(QI-Core)(USCDI) Diagnostically relevant time (typically the time of the procedure)
Control 1..?
[x] Note SeeChoice of Data Typesfor further information about how to use [x]
30. DiagnosticReport.issued
Short (NHSN-MS)(QI-Core)(USCDI) DateTime this version was made
32. DiagnosticReport.conclusionCode
Short (NHSN-MS) Codes for the clinical conclusion of test results
Must Support true

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

0. DiagnosticReport
Definition

-

Short A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
Comments

-

Control 0..*
Is Modifier false
Must Support false
Summary false
Alternate Names Report, Test, Result, Results, Labs, Laboratory, Imaging Report, Radiology Report, Clinical Test Report
Invariants dom-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())
us-core-10: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended' ((status='partial' or status='preliminary' or status='final' or status='amended' or status='corrected' or status='appended' ) implies effective.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.

Short (NHSN-MS) Logical 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.

Control 1..1
Type id
Is Modifier false
Must Support true
Summary true
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.

Short Metadata about the resource
Control 0..1
Type Meta
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. DiagnosticReport.meta.id
Definition

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

Short Unique id for inter-element referencing
Control 0..1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
8. DiagnosticReport.meta.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.

Short Additional 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.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants 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())
Slicing This element introduces a set of slices on DiagnosticReport.meta.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
10. DiagnosticReport.meta.extension:link-received-date-extension
Slice Name link-received-date-extension
Definition

This extension stores the date and time a Resource was received by the processing system (e.g., NHSNLink).

Short Received Date
Control 0..1
Type Extension(Received Date) (Extension Type: dateTime)
Is Modifier false
Summary false
Invariants 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())
12. DiagnosticReport.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Short Version specific identifier
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Control 0..1
Type id
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. DiagnosticReport.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Short When the resource version last changed
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Control 0..1
Type instant
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. DiagnosticReport.meta.source
Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Short Identifies where the resource comes from
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Control 0..1
Type uri
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. DiagnosticReport.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Short Profiles this resource claims to conform to
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Control 0..*
Type canonical(StructureDefinition)
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. DiagnosticReport.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Short Security Labels applied to this resource
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Control 0..*
Binding Unless not suitable, these codes SHALL be taken from All Security Labels
(extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)

Security Labels from the Healthcare Privacy and Security Classification System.

Type Coding
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. DiagnosticReport.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Short Tags applied to this resource
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Control 0..*
Binding For example codes, see CommonTags
(example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

Type Coding
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. 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.

Short A 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.

Control 0..1
Type uri
Is Modifier true 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 Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. DiagnosticReport.language
Definition

The base language in which the resource is written.

Short Language of the resource 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).

Control 0..1
Binding The codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages)

A human language.

Additional Bindings Purpose
AllLanguages Max Binding
Type code
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary false
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. 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.

Short Text 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.

Control 0..1
Type Narrative
Is Modifier false
Summary false
Alternate Names narrative, html, xhtml, display
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. 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.

Short Contained, 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.

Control 0..*
Type Resource
Is Modifier false
Summary false
Alternate Names inline resources, anonymous resources, contained resources
32. DiagnosticReport.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Additional 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.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants 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())
34. 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).

Short Extensions 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.

Control 0..*
Type Extension
Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary false
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 Names extensions, user content
Invariants 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())
36. DiagnosticReport.identifier
Definition

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

Short Business identifier for report
Comments

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

Note This is a business identifier, not a resource identifier (see discussion)
Control 0..*
Type Identifier
Is Modifier false
Summary true
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 Names ReportID, Filler ID, Placer ID
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. DiagnosticReport.basedOn
Definition

Details concerning a service requested.

Short (NHSN-MS) 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.

Control 0..*
Type Reference(CarePlan, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ServiceRequest)bundled
Is Modifier false
Must Support true
Must Support Types No must-support rules about the choice of types/profiles
Summary false
Requirements

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

Alternate Names Request
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. DiagnosticReport.basedOn.id
Definition

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

Short Unique id for inter-element referencing
Control 0..1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
42. DiagnosticReport.basedOn.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.

Short Additional 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.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants 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())
Slicing This element introduces a set of slices on DiagnosticReport.basedOn.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
44. DiagnosticReport.basedOn.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.

Short (NHSN-MS) Literal 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.

Control 1..1
This element is affected by the following invariants: ref-1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. DiagnosticReport.basedOn.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).

Short Type 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.

Control 0..1
Binding Unless 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).

Type uri
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. DiagnosticReport.basedOn.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.

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

Note This is a business identifier, not a resource identifier (see discussion)
Control 0..1
Type Identifier
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. DiagnosticReport.basedOn.display
Definition

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

Short Text 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.

Control 0..1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. DiagnosticReport.status
Definition

The status of the diagnostic report.

Short (NHSN-MS)(USCDI) registered | partial | preliminary | final +
Control 1..1
This element is affected by the following invariants: us-core-10
Binding The codes SHALL be taken from DiagnosticReportStatus
(required to http://hl7.org/fhir/ValueSet/diagnostic-report-status)
Type code
Is Modifier true 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 Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Requirements

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

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

Short (NHSN-MS)(QI-Core)(USCDI) 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.

Control 1..*
Binding For example codes, see DiagnosticServiceSectionCodes
(example to http://hl7.org/fhir/ValueSet/diagnostic-service-sections)

Codes for diagnostic service sections.

Type CodeableConcept
Is Modifier false
Must Support true
Summary true
Alternate Names Department, Sub-department, Service, Discipline
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing This element introduces a set of slices on DiagnosticReport.category. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ $this

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

56. DiagnosticReport.category:us-core
Slice Name us-core
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.

Short (NHSN-MS)(QI-Core)(USCDI) 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.

Control 0..*
Binding The codes SHALL be taken from USCoreDiagnosticReportCategory (6.1.0)
(required to http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-category|6.1.0)

Note that other codes are permitted, see Required Bindings When Slicing by Value Sets

Type CodeableConcept
Is Modifier false
Must Support true
Summary true
Alternate Names Department, Sub-department, Service, Discipline
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. DiagnosticReport.code
Definition

The test, panel, report, or note that was ordered.

Short (NHSN-MS)(QI-Core)(USCDI) QI-Core Report Code
Comments

The typical patterns for codes are: 1) a LOINC code either as a translation from a "local" code or as a primary code, or 2) a local code only if no suitable LOINC exists, or 3) both the local and the LOINC translation. Systems SHALL be capable of sending the local code if one exists.

Control 1..1
Binding Unless not suitable, these codes SHALL be taken from USCoreNonLaboratoryCodes (6.1.0)
(extensible to http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-report-and-note-codes|6.1.0)

LOINC codes

Type CodeableConcept
Is Modifier false
Must Support true
Summary true
Alternate Names Type
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. DiagnosticReport.subject
Definition

The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.

Short (NHSN-MS)(QI-Core)(USCDI) The subject of the report - usually, but not always, the patient
Control 1..1
Type Reference(Cross-Measure Patient Profile)bundled
Is Modifier false
Must Support true
Summary true
Requirements

SHALL know the subject context.

Alternate Names Patient
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. DiagnosticReport.subject.id
Definition

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

Short Unique id for inter-element referencing
Control 0..1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
64. DiagnosticReport.subject.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.

Short Additional 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.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants 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())
Slicing This element introduces a set of slices on DiagnosticReport.subject.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
66. DiagnosticReport.subject.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.

Short (NHSN-MS) Literal 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.

Control 1..1
This element is affected by the following invariants: ref-1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. DiagnosticReport.subject.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).

Short Type 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.

Control 0..1
Binding Unless 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).

Type uri
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. DiagnosticReport.subject.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.

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

Note This is a business identifier, not a resource identifier (see discussion)
Control 0..1
Type Identifier
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. DiagnosticReport.subject.display
Definition

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

Short Text 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.

Control 0..1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. DiagnosticReport.encounter
Definition

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

Short (NHSN-MS)(QI-Core)(USCDI) Health 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).

Control 0..1
Type Reference(QICore Encounter)bundled
Is Modifier false
Must Support true
Summary true
Requirements

Links the request to the Encounter context.

Alternate Names Context
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. 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.

Short Unique id for inter-element referencing
Control 0..1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
78. 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.

Short Additional 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.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants 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())
Slicing This 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
80. 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.

Short (NHSN-MS) Literal 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.

Control 1..1
This element is affected by the following invariants: ref-1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. 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).

Short Type 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.

Control 0..1
Binding Unless 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).

Type uri
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. 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.

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

Note This is a business identifier, not a resource identifier (see discussion)
Control 0..1
Type Identifier
Is Modifier false
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. DiagnosticReport.encounter.display
Definition

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

Short Text 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.

Control 0..1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. 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.

Short (NHSN-MS)(QI-Core)(USCDI) Diagnostically relevant time (typically the time of the procedure)
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.

Control 1..1
This element is affected by the following invariants: us-core-10
Type Choice of: dateTime, Period
[x] Note SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Must Support Types dateTime
Summary true
Requirements

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

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

Short (NHSN-MS)(QI-Core)(USCDI) 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.

Control 0..1
Type instant
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support true
Summary true
Requirements

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

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

The diagnostic service that is responsible for issuing the report.

Short (QI-Core)(USCDI) Responsible 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.

Control 0..*
Type Reference(QICore Practitioner, QICore Organization)
Is Modifier false
Must Support true
Must Support Types No must-support rules about the choice of types/profiles
Summary true
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 Names Laboratory, Service, Practitioner, Department, Company, Authorized by, Director
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. DiagnosticReport.resultsInterpreter
Definition

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

Short Primary result interpreter
Comments

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

Control 0..*
Type Reference(Practitioner, PractitionerRole, Organization, CareTeam)
Is Modifier false
Summary true
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 Names Analyzed by, Reported by
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. DiagnosticReport.specimen
Definition

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

Short Specimens 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.

Control 0..*
Type Reference(Specimen)
Is Modifier false
Summary false
Requirements

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

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

Observations that are part of this diagnostic report.

Short (QI-Core)(USCDI) Observations
Comments

Observations can contain observations.

Control 0..*
Type Reference(QICore Laboratory Result Observation, QICore Observation Clinical Result)
Is Modifier false
Must Support true
Must Support Types No must-support rules about the choice of types/profiles
Summary false
Requirements

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

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

Short (QI-Core) Reference to full details of imaging associated with the diagnostic 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.

Control 0..*
Type Reference(QICore ImagingStudy)
Is Modifier false
Summary false
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. DiagnosticReport.media
Definition

A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).

Short (QI-Core)(USCDI) Key images associated with this report
Control 0..*
Type BackboneElement
Is Modifier false
Must Support true
Summary true
Requirements

Many diagnostic services include images in the report as part of their service.

Alternate Names DICOM, Slides, Scans
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. 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.

Short Unique id for inter-element referencing
Control 0..1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
106. 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.

Short Additional 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.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants 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())
108. 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).

Short Extensions 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.

Control 0..*
Type Extension
Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary true
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 Names extensions, user content, modifiers
Invariants 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())
110. DiagnosticReport.media.comment
Definition

A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features.

Short Comment about the image (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.

Control 0..1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary false
Requirements

The provider of the report should make a comment about each image included in the report.

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

Reference to the image source.

Short (USCDI) Reference to the image source
Control 1..1
Type Reference(Media)
Is Modifier false
Must Support true
Summary true
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. DiagnosticReport.conclusion
Definition

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

Short Clinical conclusion (interpretation) of test results
Control 0..1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Summary false
Requirements

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

Alternate Names Report
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
116. DiagnosticReport.conclusionCode
Definition

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

Short (NHSN-MS) Codes for the clinical conclusion of test results
Control 0..*
Binding For example codes, see SNOMEDCTClinicalFindings
(example to http://hl7.org/fhir/ValueSet/clinical-findings)

Diagnosis codes provided as adjuncts to the report.

Type CodeableConcept
Is Modifier false
Must Support true
Summary false
Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. 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.

Short (USCDI) Entire report as issued
Comments

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

Control 0..*
Type Attachment
Is Modifier false
Must Support true
Summary false
Requirements

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

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

National Center for Emerging and Zoonotic Infectious Diseases