DiagnosticReport
Defines the ID Core constraints and extensions on the DiagnosticReport resource for the minimal set of data to query and retrieve diagnostic reports associated with laboratory results for a patient.
Usage
A diagnostic report is the set of information that is typically provided by a diagnostic service when investigations are complete. The information includes a mix of atomic results, text reports, images, and codes. The mix varies depending on the nature of the diagnostic procedure, and sometimes on the nature of the outcomes for a particular investigation.
The DiagnosticReport resource has information about the diagnostic report itself, and about the subject and, in the case of laboratory tests, the specimen of the report. It can also refer to the request details and atomic observations details or image instances. Report conclusions can be expressed as a simple text blob, structured coded data or as an attached fully formatted report such as a PDF.
The DiagnosticReport resource is suitable for the following kinds of diagnostic reports:
- Laboratory (Clinical Chemistry, Hematology, Microbiology, etc.)
- Pathology / Histopathology / related disciplines
- Imaging Investigations (x-ray, CT, MRI etc.)
- Other diagnostics - Cardiology, Gastroenterology etc.
Laboratory results are grouped and summarized using the DiagnosticReport resource which typically reference Observation resource(s). Each Observation resource represents an individual laboratory test and result value or component result values, or a “nested” panel which references other observations. They can also be presented in report form or as free text (e.g. radiology expertise).
The DiagnosticReport resource is not intended to support cumulative result presentation (tabular presentation of past and present results in the resource).
URL
Type | URL |
---|---|
Canonical | https://fhir.kemkes.go.id/r4/StructureDefinition/DiagnosticReport |
Structure
Snapshot
DiagnosticReport | I | https://fhir.kemkes.go.id/r4/StructureDefinition/DomainResource | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
basedOn | I | 0..* | Reference(CarePlan | https://fhir.kemkes.go.id/r4/StructureDefinition/ImmunizationRecommendation | MedicationRequest | https://fhir.kemkes.go.id/r4/StructureDefinition/NutritionOrder | ServiceRequest) |
status | Σ ?! | 1..1 | codeBinding |
category | Σ | 0..* | CodeableConcept |
code | Σ | 1..1 | CodeableConceptBinding |
subject | Σ I | 1..1 | Reference(Patient | https://fhir.kemkes.go.id/r4/StructureDefinition/Group | Device | Location) |
encounter | Σ I | 1..1 | Reference(Encounter) |
effective[x] | Σ | 0..1 | |
effectiveDateTime | dateTime | ||
effectivePeriod | Period | ||
issued | Σ | 0..1 | instant |
performer | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) |
resultsInterpreter | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) |
specimen | I | 0..* | Reference(Specimen) |
result | I | 0..* | Reference(Observation) |
imagingStudy | I | 0..* | Reference(https://fhir.kemkes.go.id/r4/StructureDefinition/ImagingStudy) |
media | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
comment | 0..1 | string | |
link | Σ I | 1..1 | Reference(https://fhir.kemkes.go.id/r4/StructureDefinition/Media) |
conclusion | 0..1 | string | |
conclusionCode | 0..* | CodeableConcept | |
presentedForm | I | 0..* | Attachment |
Examples
Dictionary
DiagnosticReport | |
Definition | The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. |
Cardinality | 0...* |
Alias | Report, Test, Result, Results, Labs, Laboratory |
Comments | This is intended to capture a single report and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing. |
Invariants |
|
Mappings |
|
DiagnosticReport.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
DiagnosticReport.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
DiagnosticReport.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
DiagnosticReport.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
DiagnosticReport.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
DiagnosticReport.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
DiagnosticReport.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DiagnosticReport.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DiagnosticReport.identifier | |
Definition | Identifiers assigned to this report by the performer or other systems. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Alias | ReportID, Filler ID, Placer ID |
Requirements | Need to know what identifier to use when making queries about this report from the source laboratory, and for linking to the report outside FHIR context. |
Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). |
Invariants |
|
Mappings |
|
DiagnosticReport.basedOn | |
Definition | Details concerning a service requested. |
Cardinality | 0...* |
Type | Reference(CarePlan | https://fhir.kemkes.go.id/r4/StructureDefinition/ImmunizationRecommendation | MedicationRequest | https://fhir.kemkes.go.id/r4/StructureDefinition/NutritionOrder | ServiceRequest) |
Alias | Request |
Requirements | This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon. |
Comments | Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single test result resource. Note that there are also cases where one request leads to multiple reports. |
Invariants |
|
Mappings |
|
DiagnosticReport.status | |
Definition | The status of the diagnostic report. |
Cardinality | 1...1 |
Type | code |
Binding | The status of the diagnostic report. |
Modifier | True |
Summary | True |
Requirements | Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
DiagnosticReport.category | |
Definition | A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes for diagnostic service sections. |
Summary | True |
Alias | Department, Sub-department, Service, Discipline |
Comments | Multiple categories are allowed using various categorization schemes. The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in DiagnosticReport.code. |
Invariants |
|
Mappings |
|
DiagnosticReport.code | |
Definition | A code or name that describes this diagnostic report. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Codes that describe Diagnostic Reports. |
Summary | True |
Alias | Type |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
DiagnosticReport.subject | |
Definition | The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources. |
Cardinality | 1...1 |
Type | Reference(Patient | https://fhir.kemkes.go.id/r4/StructureDefinition/Group | Device | Location) |
Summary | True |
Alias | Patient |
Requirements | SHALL know the subject context. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
DiagnosticReport.encounter | |
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. |
Cardinality | 1...1 |
Type | Reference(Encounter) |
Summary | True |
Alias | Context |
Requirements | Links the request to the Encounter context. |
Comments | This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests). |
Invariants |
|
Mappings |
|
DiagnosticReport.effective[x] | |
Definition | The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Alias | Observation time, Effective Time, Occurrence |
Requirements | Need to know where in the patient history to file/present this report. |
Comments | If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic. |
Invariants |
|
Mappings |
|
DiagnosticReport.issued | |
Definition | The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Alias | Date published, Date Issued, Date Verified |
Requirements | Clinicians need to be able to check the date that the report was released. |
Comments | May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report. |
Invariants |
|
Mappings |
|
DiagnosticReport.performer | |
Definition | The diagnostic service that is responsible for issuing the report. |
Cardinality | 0...* |
Type | Reference(Practitioner | PractitionerRole | Organization | CareTeam) |
Summary | True |
Alias | Laboratory, Service, Practitioner, Department, Company, Authorized by, Director |
Requirements | Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis. |
Comments | This is not necessarily the source of the atomic data items or the entity that interpreted the results. It is the entity that takes responsibility for the clinical report. |
Invariants |
|
Mappings |
|
DiagnosticReport.resultsInterpreter | |
Definition | The practitioner or organization that is responsible for the report's conclusions and interpretations. |
Cardinality | 0...* |
Type | Reference(Practitioner | PractitionerRole | Organization | CareTeam) |
Summary | True |
Alias | Analyzed by, Reported by |
Requirements | Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis. |
Comments | Might not be the same entity that takes responsibility for the clinical report. |
Invariants |
|
Mappings |
|
DiagnosticReport.specimen | |
Definition | Details about the specimens on which this diagnostic report is based. |
Cardinality | 0...* |
Type | Reference(Specimen) |
Requirements | Need to be able to report information about the collected specimens on which the report is based. |
Comments | If the specimen is sufficiently specified with a code in the test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per observation or group. |
Invariants |
|
Mappings |
|
DiagnosticReport.result | |
Definition | [Observations](observation.html) that are part of this diagnostic report. |
Cardinality | 0...* |
Type | Reference(Observation) |
Alias | Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer |
Requirements | Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. |
Comments | Observations can contain observations. |
Invariants |
|
Mappings |
|
DiagnosticReport.imagingStudy | |
Definition | One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. |
Cardinality | 0...* |
Type | Reference(https://fhir.kemkes.go.id/r4/StructureDefinition/ImagingStudy) |
Comments | ImagingStudy and the image element are somewhat overlapping - typically, the list of image references in the image element will also be found in one of the imaging study resources. However, each caters to different types of displays for different types of purposes. Neither, either, or both may be provided. |
Invariants |
|
Mappings |
|
DiagnosticReport.media | |
Definition | A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest). |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Alias | DICOM, Slides, Scans |
Requirements | Many diagnostic services include images in the report as part of their service. |
Invariants |
|
Mappings |
|
DiagnosticReport.media.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DiagnosticReport.media.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DiagnosticReport.media.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DiagnosticReport.media.comment | |
Definition | A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features. |
Cardinality | 0...1 |
Type | string |
Requirements | The provider of the report should make a comment about each image included in the report. |
Comments | The comment should be displayed with the image. It would be common for the report to include additional discussion of the image contents in other sections such as the conclusion. |
Invariants |
|
Mappings |
|
DiagnosticReport.media.link | |
Definition | Reference to the image source. |
Cardinality | 1...1 |
Type | Reference(https://fhir.kemkes.go.id/r4/StructureDefinition/Media) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
DiagnosticReport.conclusion | |
Definition | Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report. |
Cardinality | 0...1 |
Type | string |
Alias | Report |
Requirements | Need to be able to provide a conclusion that is not lost among the basic result data. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
DiagnosticReport.conclusionCode | |
Definition | One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Diagnosis codes provided as adjuncts to the report. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
DiagnosticReport.presentedForm | |
Definition | Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. |
Cardinality | 0...* |
Type | Attachment |
Requirements | Gives laboratory the ability to provide its own fully formatted report for clinical fidelity. |
Comments | "application/pdf" is recommended as the most reliable and interoperable in this context. |
Invariants |
|
Mappings |
|