Imaging Diagnostic Report
0.0.1-current - ci-build
Imaging Diagnostic Report, published by IHE Radiology Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.0.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/RAD.IDR/ and changes regularly. See the Directory of published versions
| Draft as of 2025-09-14 |
Definitions for the imaging-diagnosticreport resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. DiagnosticReport | |
| 2. DiagnosticReport.text | |
| Short | Fully-rendered, human-readable report |
| Must Support | true |
| 4. DiagnosticReport.extension | |
| Slicing | This element introduces a set of slices on DiagnosticReport.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. DiagnosticReport.extension:comparison | |
| Slice Name | comparison |
| Definition | Prior imaging studies that were considered relevant to the current study and made available to the imaging clinician at the time of reporting. |
| Short | Relevant prior exams |
| Comments | The primary study being reported is referenced from the study element. |
| Control | 0..* |
| Type | Extension((AddR6toR4) DiagnosticReport.comparison) (Extension Type: Reference(IDR ImagingStudy)) |
| Must Support | true |
| 8. DiagnosticReport.extension:conclusionCodeR | |
| Slice Name | conclusionCodeR |
| Short | Impression / Conclusion (coded) |
| Comments | A .conclusionCode item, being a CodeableReference, may contain an individual code instead of a reference when a code exists that encompasses the conclusion or impression. An impression drawn from a *-RADS System, such as BI-RADS TOLINK, is encoded as a .conclusionCode item containing the corresponding code. For example, (397143007, SCT, "Mammography assessment (Category 3) - Probably benign finding, short interval follow-up"). Note 1. *-RADS codes correspond to the result of a composite assessment, and the conclusion may represent a point on a diagnostic pathway, which encompasses both a differential diagnosis and protocolized follow-up actions. |
| Control | 0..* |
| Type | Extension((AddR6toR4) DiagnosticReport.conclusionCode as CodeableReference) (Extension Type: Reference(IDR Report Impression Condition, IDR Imaging Observation)) |
| Must Support | true |
| 10. DiagnosticReport.extension:recommendation | |
| Slice Name | recommendation |
| Definition | Proposed follow-up actions based on the findings and interpretations of the diagnostic test for which this report is the subject. |
| Short | Recommendations based on findings and interpretations |
| Control | 0..* |
| Type | Extension((AddR6toR4) DiagnosticReport.recommendation) (Extension Type: Reference(IDR Recommendation ServiceRequest)) |
| Must Support | true |
| 12. DiagnosticReport.extension:communication | |
| Slice Name | communication |
| Definition | Communications initiated during the generation of the DiagnosticReport by members of the organization fulfilling that order. e.g. direct communication of time critical results by the radiologist to the referring physician. |
| Short | Communication initiated during the reporting process |
| Comments | These communications are limited to those initiated during the generation of the DiagnosticReport by members of the organization fulfilling that order. E.g. direct communication of time critical results by the radiologist to the referring physician. Communications that follow publication of the report (e.g. between the referring physician and the patient or a subsequent specialist) are not referenced here. |
| Control | 0..* |
| Type | Extension((AddR6toR4) DiagnosticReport.communication) (Extension Type: Reference(IDR Report Communication)) |
| Must Support | true |
| 14. DiagnosticReport.extension:patientHistory | |
| Slice Name | patientHistory |
| Definition | May have originally been extracted from the medical record by imaging staff, automated tools, or by the radiologists themselves. |
| Short | Patient history items selected by radiologist |
| Control | 0..* |
| Type | Extension(IDR Patient History) (Extension Type: Reference(IDR Patient History Condition, IDR Patient History Observation, IDR Patient History Procedure, IDR FamilyMemberHistory)) |
| Must Support | true |
| 16. DiagnosticReport.extension:procedure | |
| Slice Name | procedure |
| Definition | Imaging procedure used to acquire the study. |
| Short | Imaging procedure |
| Control | 0..* |
| Type | Extension(IDR Imaging Procedure) (Extension Type: Reference(IDR Reported Imaging Procedure)) |
| Must Support | true |
| 18. DiagnosticReport.basedOn | |
| Comments | Note 1. For result resources like DiagnosticReport, .basedOn references the authorizing request being fulfilled; i.e. the order, not the input data. So DiagnosticReport.basedOn references the imaging ServiceRequest, not the ImagingStudy. Note 2. Report Creators do not create orders. It is expected that an appropriate ServiceRequest resource will exist which may have been created by another system more integrated with order management. The hospital may originate orders as ServiceRequest resources, or may create ServiceRequests based on HL7 v2 ORM or OMG messages. In either case, reporting systems are not the Source of Truth for order management; it would be disruptive for them to directly create/modify order resources. Note 3. "Group Cases": While one report typically corresponds to one order (ServiceRequest) comprised of one study, some reports do cover multiple orders. A radiologist may satisfy multiple ServiceRequests in a single report. Depending on site preferences related to billing and workflow, systems should be prepared to handle this as a single report basedOn multiple ServiceRequests, or as multiple copies of the same report, each basedOn a different ServiceRequest. Note 4. If the DiagnosticReport is associated with an Accession Number, this field should include a reference to that value in the form: identifier.value = (Accession Number Value) identifier.type = ACSN. A reference value pointing to a ServiceRequest resource is allowed but is not required. Note 5. DiagnosticReport.basedOn may be empty in some scenarios, e.g. when emergency imaging is performed and an order has not been backfilled before reporting. |
| Must Support | true |
| Slicing | This element introduces a set of slices on DiagnosticReport.basedOn. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. DiagnosticReport.basedOn:serviceRequest | |
| Slice Name | serviceRequest |
| Definition | The order for the imaging procedure being reported. |
| Short | The imaging order |
| Control | 0..* |
| Type | Reference(IDR Imaging ServiceRequest) |
| 22. DiagnosticReport.status | |
| Comments | Values of preliminary and final shall be used when their conventional meaning for imaging reports applies. A value of registered state be used while the report is being composed during the interpretation process. For addenda, a value of amended shall be used. . Note: Other FHIR status values such as modified, corrected, or appended are not profiled here. They may be addressed in a reporting workflow profile. |
| Binding | The codes SHALL be taken from IDR DiagnosticReport.status ValueSet (required to https://profiles.ihe.net/RAD/IDR/ValueSet/idr-diagnostic-report-status-vs) |
| 24. DiagnosticReport.category | |
| Definition | A code for the diagnostic service that performed the imaging study |
| Short | Diagnostic Service |
| Comments | It is recommended that this code focus on the service/department, since the modality is already reflected in DiagnosticReport.code. Potential codes may be drawn from DICOM PS3.16 CID 7030 "Institutional Department/Unit/Service" and the HL7 terminology code set referenced in FHIR. This value may be copied from the ServiceRequest.category that the report is basedOn. |
| Control | 1..? |
| Must Support | true |
| 26. DiagnosticReport.code | |
| Comments | Imaging report titles are frequently site specific, but commonly communicate the modality, body part, and/or clinical focus of the performed imaging procedure. Note 1. Since report titles often mirror the name of the ordered imaging procedure, the codes from the RSNA Radlex Playbook provide a useful example codeset. (Search LOINC for \“playbook\”) |
| 28. DiagnosticReport.subject | |
| Short | The imaged patient |
| Comments | Note 1. Report Creators do not create patient resources. It is expected that an appropriate Patient resource will exist, even if only a John Doe, created by another system more integrated with patient management. Imaging systems are not the Source of Truth for patient demographics and management; it would be disruptive for them to directly create/modify patient resources. If a patient reference is a pre-requisite to publish imaging DiagnosticReport resources, the local infrastructure will arrange for appropriate Patient resources for the Report Creator to use. |
| Control | 1..? |
| Type | Reference(IDR Patient) |
| Must Support | true |
| 30. DiagnosticReport.encounter | |
| Definition | If present, will reflect the encounter of the imaging procedure being reported (which may also be found in DiagnosticReport.procedure.encounter.) To find the encounter during with the order for the imaging procedure was placed, see DiagnosticReport.basedOn[ServiceRequest].encounter. |
| 32. DiagnosticReport.issued | |
| Short | DateTime report was published. |
| Control | 1..? |
| 34. DiagnosticReport.procedure | |
| 36. DiagnosticReport.performer | |
| Comments | The organization (which may be a diagnostic service) responsible for the report is captured here. The specific clinician is captured in resultsInterpreter. |
| Control | 1..? |
| Slicing | This element introduces a set of slices on DiagnosticReport.performer. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 38. DiagnosticReport.performer:organization | |
| Slice Name | organization |
| Control | 1..* |
| Type | Reference(Organization) |
| 40. DiagnosticReport.resultsInterpreter | |
| Comments | This is imaging clinician(s) the study is reported by. Additional report authors may also be referenced. PractitionerRole resources may be used to record participants such as residents, collaborating clinicians and the role they played. |
| Control | 1..? |
| Type | Reference(Practitioner, PractitionerRole) |
| 42. DiagnosticReport.result | |
| Definition | Detailed description of the findings on the imaging study. The findings should be described in a clear and concise manner, using standardized anatomic, pathologic, and radiologic terminology whenever possible. |
| Short | Findings |
| Type | Reference(IDR Imaging Observation) |
| Must Support | true |
| 44. DiagnosticReport.note | |
| Short | See Detailed Description Comments |
| Comments | In imaging diagnostic reports, statements about significant, unexpected or unreliable result values appear as needed in the Findings, Conclusions, or Procedure, not in .note. Other imaging usage was not identified. |
| 46. DiagnosticReport.study | |
| Definition | Study interpreted by the imaging clinician in this report. |
| Short | Reported Imaging Study |
| Comments | The ImagingStudy for the study being read shall be referenced unless no such ImagingStudy resource exists. Note 1. Report Creators do not typically create ImagingStudy resources. It is expected that an appropriate ImagingStudy resource will exist, created by another system more integrated with image management, such as the PACS, or the VNA, or the EMR in response to messaging from the PACS or VNA. Report Creators are not the Source of Truth for imaging study management. In the absence of an ImagingStudy, the ServiceRequest and Accession Number will serve to provide basic linkages between the images and the report. Note 2. Studies available for comparison during reporting are tracked in the comparison element, not the study element. |
| Control | 1..? |
| Type | Reference(IDR ImagingStudy) |
| Must Support | true |
| 48. DiagnosticReport.media | |
| Short | Auxilliary media |
| Comments | Graphical elements such as charts and icons that appear in the presentedForm of the report may go here if they cannot be included inline in the format used (PDF, etc.). The interpreted study is referenced from the .study element, not here. Those study images may be accessible as RESTful resources via DICOMweb (which includes parameterized renderings using the /rendered DICOMweb endpoint to adjust windowing and other parameters). Selected parts or points of those images are encoded as ImagingSelection resources. Comparison studies are referenced from the .comparison element. |
| 50. DiagnosticReport.composition | |
| Short | Additional compositions |
| Comments | Composition may be included to supplement .text and .presentedForm with additional presentations and compositions of the report content to meet the preferences of different readers, tasks, or site guidelines. |
| 52. DiagnosticReport.conclusion | |
| Short | Impression / Conclusion |
| Comments | Note 1. In the presentedForm (PDF, HTML, etc.), section text titled Impression frequently contains not just impressions, but also recommendations, and communications. IDR profiles usage of specific encodings for those in the recommendation and communication elements. |
| Must Support | true |
| 54. DiagnosticReport.conclusionCode | |
| Short | supplemented by conclusionCodeR |
| Comments | R6 makes .conclusionCode a CodeableReference to allow a Condition (or Observation) to be a coded conclusion. Since I haven't figured out how to do that in a Profile (it is an expansion, not a constraint on the underlying resource) I have created a sister element .conclusionCodeR so I can continue building sample objects and resolving brittle build issues. |
| 56. DiagnosticReport.presentedForm | |
| Invariants | IDRAttachmentInvariant: Either data or url SHALL be present for any attachment (e.g. in DiagnosticReport). (data.exists() or url.exists()) |
| 58. DiagnosticReport.presentedForm.contentType | |
| Control | 1..? |
| Must Support | true |
| 60. DiagnosticReport.presentedForm.size | |
| Control | 1..? |
| Must Support | true |
| 62. DiagnosticReport.presentedForm.hash | |
| Control | 1..? |
| Must Support | true |
Guidance on how to interpret the contents of this table can be foundhere
| 0. DiagnosticReport | |
| Definition | The findings and interpretation of diagnostic tests performed on patients, groups of patients, products, substances, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. The report also includes non-clinical context such as batch analysis and stability reporting of products and substances. |
| 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 |
| Invariants | dgr-1: When a Composition is referenced in `DiagnosticReport.composition`, all Observation resources referenced in `Composition.entry` must also be referenced in `DiagnosticReport.result` or in the `Observation.hasMember` references. (composition.exists() implies (composition.resolve().section.entry.reference.where(resolve() is Observation) in (result.reference|result.reference.resolve().hasMember.reference))) 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) |
| 2. DiagnosticReport.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| 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 its 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 its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. 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 | Fully-rendered, human-readable reportText summary of the resource, for human interpretation |
| Comments | Contained resources do not have a 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 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Is Modifier | false |
| Must Support | true |
| 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())) |
| 6. DiagnosticReport.contained | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| 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. Contained resources may be a resource type defined in the FHIR specification, or an additional resource. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 8. DiagnosticReport.extension | |
| Definition | An Extension 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 managable, 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 | ExtensionAdditional 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 |
| Must Support | 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())) |
| Slicing | This element introduces a set of slices on DiagnosticReport.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 10. DiagnosticReport.extension:comparison | |
| Slice Name | comparison |
| Definition | Prior imaging studies that were considered relevant to the current study and made available to the imaging clinician at the time of reporting. |
| Short | Relevant prior exams |
| Comments | The primary study being reported is referenced from the study element. |
| Control | 0..* |
| Type | Extension((AddR6toR4) DiagnosticReport.comparison) (Extension Type: Reference(IDR ImagingStudy)) |
| 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())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 12. DiagnosticReport.extension:conclusionCodeR | |
| Slice Name | conclusionCodeR |
| Definition | Coded Conclusions about Conditions and Observations |
| Short | Impression / Conclusion (coded) |
| Comments | A .conclusionCode item, being a CodeableReference, may contain an individual code instead of a reference when a code exists that encompasses the conclusion or impression. An impression drawn from a *-RADS System, such as BI-RADS TOLINK, is encoded as a .conclusionCode item containing the corresponding code. For example, (397143007, SCT, "Mammography assessment (Category 3) - Probably benign finding, short interval follow-up"). Note 1. *-RADS codes correspond to the result of a composite assessment, and the conclusion may represent a point on a diagnostic pathway, which encompasses both a differential diagnosis and protocolized follow-up actions. |
| Control | 0..* |
| Type | Extension((AddR6toR4) DiagnosticReport.conclusionCode as CodeableReference) (Extension Type: Reference(IDR Report Impression Condition, IDR Imaging Observation)) |
| 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())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 14. DiagnosticReport.extension:recommendation | |
| Slice Name | recommendation |
| Definition | Proposed follow-up actions based on the findings and interpretations of the diagnostic test for which this report is the subject. |
| Short | Recommendations based on findings and interpretations |
| Control | 0..* |
| Type | Extension((AddR6toR4) DiagnosticReport.recommendation) (Extension Type: Reference(IDR Recommendation ServiceRequest)) |
| 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())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 16. DiagnosticReport.extension:communication | |
| Slice Name | communication |
| Definition | Communications initiated during the generation of the DiagnosticReport by members of the organization fulfilling that order. e.g. direct communication of time critical results by the radiologist to the referring physician. |
| Short | Communication initiated during the reporting process |
| Comments | These communications are limited to those initiated during the generation of the DiagnosticReport by members of the organization fulfilling that order. E.g. direct communication of time critical results by the radiologist to the referring physician. Communications that follow publication of the report (e.g. between the referring physician and the patient or a subsequent specialist) are not referenced here. |
| Control | 0..* |
| Type | Extension((AddR6toR4) DiagnosticReport.communication) (Extension Type: Reference(IDR Report Communication)) |
| 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())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 18. DiagnosticReport.extension:patientHistory | |
| Slice Name | patientHistory |
| Definition | May have originally been extracted from the medical record by imaging staff, automated tools, or by the radiologists themselves. |
| Short | Patient history items selected by radiologist |
| Control | 0..* |
| Type | Extension(IDR Patient History) (Extension Type: Reference(IDR Patient History Condition, IDR Patient History Observation, IDR Patient History Procedure, IDR FamilyMemberHistory)) |
| 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())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 20. DiagnosticReport.extension:procedure | |
| Slice Name | procedure |
| Definition | Imaging procedure used to acquire the study. |
| Short | Imaging procedure |
| Control | 0..* |
| Type | Extension(IDR Imaging Procedure) (Extension Type: Reference(IDR Reported Imaging Procedure)) |
| 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())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 22. 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 managable, 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 |
| Must Support | false |
| 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 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. DiagnosticReport.basedOn | |
| Definition | Details concerning a service requested. |
| Short | What was requested |
| Comments | Note 1. For result resources like DiagnosticReport, .basedOn references the authorizing request being fulfilled; i.e. the order, not the input data. So DiagnosticReport.basedOn references the imaging ServiceRequest, not the ImagingStudy. Note 2. Report Creators do not create orders. It is expected that an appropriate ServiceRequest resource will exist which may have been created by another system more integrated with order management. The hospital may originate orders as ServiceRequest resources, or may create ServiceRequests based on HL7 v2 ORM or OMG messages. In either case, reporting systems are not the Source of Truth for order management; it would be disruptive for them to directly create/modify order resources. Note 3. "Group Cases": While one report typically corresponds to one order (ServiceRequest) comprised of one study, some reports do cover multiple orders. A radiologist may satisfy multiple ServiceRequests in a single report. Depending on site preferences related to billing and workflow, systems should be prepared to handle this as a single report basedOn multiple ServiceRequests, or as multiple copies of the same report, each basedOn a different ServiceRequest. Note 4. If the DiagnosticReport is associated with an Accession Number, this field should include a reference to that value in the form: identifier.value = (Accession Number Value) identifier.type = ACSN. A reference value pointing to a ServiceRequest resource is allowed but is not required. Note 5. DiagnosticReport.basedOn may be empty in some scenarios, e.g. when emergency imaging is performed and an order has not been backfilled before reporting. 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) |
| 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())) |
| Slicing | This element introduces a set of slices on DiagnosticReport.basedOn. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 26. DiagnosticReport.basedOn:serviceRequest | |
| Slice Name | serviceRequest |
| Definition | The order for the imaging procedure being reported. Details concerning a service requested. |
| Short | The imaging orderWhat 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(IDR Imaging ServiceRequest, CarePlan, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ServiceRequest) |
| Is Modifier | false |
| Must Support | false |
| 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())) |
| 28. DiagnosticReport.status | |
| Definition | The status of the diagnostic report. |
| Short | registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown |
| Comments | Values of preliminary and final shall be used when their conventional meaning for imaging reports applies. A value of registered state be used while the report is being composed during the interpretation process. For addenda, a value of amended shall be used. . Note: Other FHIR status values such as modified, corrected, or appended are not profiled here. They may be addressed in a reporting workflow profile. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IDR DiagnosticReport.status ValueSethttp://hl7.org/fhir/ValueSet/diagnostic-report-status|6.0.0-ballot3 (required to https://profiles.ihe.net/RAD/IDR/ValueSet/idr-diagnostic-report-status-vs) |
| 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 | false |
| 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())) |
| 30. DiagnosticReport.category | |
| Definition | A code for the diagnostic service that performed the imaging study 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 | Diagnostic ServiceService category |
| Comments | It is recommended that this code focus on the service/department, since the modality is already reflected in DiagnosticReport.code. Potential codes may be drawn from DICOM PS3.16 CID 7030 "Institutional Department/Unit/Service" and the HL7 terminology code set referenced in FHIR. This value may be copied from the ServiceRequest.category that the report is basedOn. 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|6.0.0-ballot3 (example to http://hl7.org/fhir/ValueSet/diagnostic-service-sections|6.0.0-ballot3)HL7 V2 table 0074 |
| 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())) |
| 32. DiagnosticReport.code | |
| Definition | A code or name that describes this diagnostic report. |
| Short | Name/Code for this diagnostic report |
| Comments | Imaging report titles are frequently site specific, but commonly communicate the modality, body part, and/or clinical focus of the performed imaging procedure. Note 1. Since report titles often mirror the name of the ordered imaging procedure, the codes from the RSNA Radlex Playbook provide a useful example codeset. (Search LOINC for \“playbook\”) DiagnosticReport.code is primarily meant to characterize the nature of the entire report, not to summarize the content in detail. In the case where multiple orderables are included in a single report, then the single DiagnosticReport.code would represent the entire 'panel' that the report is covering. |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from LOINCDiagnosticReportCodeshttp://hl7.org/fhir/ValueSet/report-codes|6.0.0-ballot3 (preferred to http://hl7.org/fhir/ValueSet/report-codes|6.0.0-ballot3)LOINC Codes for Diagnostic Reports |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | Type |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 34. 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 | The imaged patientThe subject of the report - usually, but not always, the patient |
| Comments | Note 1. Report Creators do not create patient resources. It is expected that an appropriate Patient resource will exist, even if only a John Doe, created by another system more integrated with patient management. Imaging systems are not the Source of Truth for patient demographics and management; it would be disruptive for them to directly create/modify patient resources. If a patient reference is a pre-requisite to publish imaging DiagnosticReport resources, the local infrastructure will arrange for appropriate Patient resources for the Report Creator to use. |
| Control | 10..1 |
| Type | Reference(IDR Patient, Patient, Group, Device, Location, Organization, Practitioner, Medication, Substance, BiologicallyDerivedProduct) |
| 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())) |
| 36. DiagnosticReport.encounter | |
| Definition | If present, will reflect the encounter of the imaging procedure being reported (which may also be found in DiagnosticReport.procedure.encounter.) To find the encounter during with the order for the imaging procedure was placed, see DiagnosticReport.basedOn[ServiceRequest].encounter. The encounter (e.g. a patient and healthcare provider interaction) that is associated with the DiagnosticReport. |
| Short | Encounter associated with the DiagnosticReport |
| Comments | This will typically be the encounter, when it exists, during which the data or specimens (e.g. imaging, blood draw, or assessment procedure) that are being reported by the DiagnosticReport were obtained/acquired. When a DiagnosticReport is based on a ServiceRequest (order), the ServiceRequest.encounter referenced in DiagnosticReport.basedOn may be used to associate the two. |
| Control | 0..1 |
| Type | Reference(Encounter) |
| Is Modifier | false |
| Must Support | false |
| 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())) |
| 38. 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 | DateTime report was published.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 | 10..1 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 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())) |
| 40. DiagnosticReport.procedure | |
| Definition | The procedure(s) that are reported on in the DiagnosticReport. |
| Short | The procedure(s) from which the report was produced |
| Comments | This is a summary of the report, not a list of results. |
| Control | 0..* |
| Type | Reference(Procedure) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 42. DiagnosticReport.performer | |
| Definition | The diagnostic service that is responsible for issuing the report. |
| Short | Responsible Diagnostic Service |
| Comments | The organization (which may be a diagnostic service) responsible for the report is captured here. The specific clinician is captured in resultsInterpreter. 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. In the regulated context of diagnostic laboratory work on humans, it is extremely likely that regulation requires a human performer. Point of care testing, veterinary testing, drug screens, and environmental surveillance are common cases where the device is the performer with no additional human interaction or direct oversight. |
| Control | 10..* |
| Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Device) |
| Is Modifier | false |
| Must Support | 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 | 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())) |
| Slicing | This element introduces a set of slices on DiagnosticReport.performer. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 44. DiagnosticReport.performer:organization | |
| Slice Name | organization |
| Definition | The diagnostic service that is responsible for issuing the report. |
| Short | 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. In the regulated context of diagnostic laboratory work on humans, it is extremely likely that regulation requires a human performer. Point of care testing, veterinary testing, drug screens, and environmental surveillance are common cases where the device is the performer with no additional human interaction or direct oversight. |
| Control | 10..* |
| Type | Reference(Organization, Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Device) |
| Is Modifier | false |
| Must Support | 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 | 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())) |
| 46. DiagnosticReport.resultsInterpreter | |
| Definition | The practitioner or organization that is responsible for the report's conclusions and interpretations. |
| Short | Primary result interpreter |
| Comments | This is imaging clinician(s) the study is reported by. Additional report authors may also be referenced. PractitionerRole resources may be used to record participants such as residents, collaborating clinicians and the role they played. Might not be the same entity that takes responsibility for the clinical report. |
| Control | 10..* |
| Type | Reference(Practitioner, PractitionerRole, Practitioner, PractitionerRole, Organization, CareTeam) |
| Is Modifier | false |
| Must Support | 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())) |
| 48. DiagnosticReport.result | |
| Definition | Detailed description of the findings on the imaging study. The findings should be described in a clear and concise manner, using standardized anatomic, pathologic, and radiologic terminology whenever possible. Observations that are part of this diagnostic report. |
| Short | FindingsObservations |
| Comments | Observations can contain observations. |
| Control | 0..* This element is affected by the following invariants: dgr-1 |
| Type | Reference(IDR Imaging Observation, Observation) |
| Is Modifier | false |
| Must Support | true |
| 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())) |
| 50. DiagnosticReport.note | |
| Definition | Comments about the diagnostic report. |
| Short | See Detailed Description CommentsComments about the diagnostic report |
| Comments | In imaging diagnostic reports, statements about significant, unexpected or unreliable result values appear as needed in the Findings, Conclusions, or Procedure, not in .note. Other imaging usage was not identified. May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation. |
| Control | 0..* |
| Type | Annotation |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Need to be able to provide free text additional information. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 52. DiagnosticReport.study | |
| Definition | Study interpreted by the imaging clinician in this report. One or more links to full details of any study performed during the diagnostic investigation. An ImagingStudy might comprise a set of radiologic images obtained via a procedure that are analyzed as a group. 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. A GenomicStudy might comprise one or more analyses, each serving a specific purpose. These analyses may vary in method (e.g., karyotyping, CNV, or SNV detection), performer, software, devices used, or regions targeted. |
| Short | Reported Imaging StudyReference to full details of an analysis associated with the diagnostic report |
| Comments | The ImagingStudy for the study being read shall be referenced unless no such ImagingStudy resource exists. Note 1. Report Creators do not typically create ImagingStudy resources. It is expected that an appropriate ImagingStudy resource will exist, created by another system more integrated with image management, such as the PACS, or the VNA, or the EMR in response to messaging from the PACS or VNA. Report Creators are not the Source of Truth for imaging study management. In the absence of an ImagingStudy, the ServiceRequest and Accession Number will serve to provide basic linkages between the images and the report. Note 2. Studies available for comparison during reporting are tracked in the comparison element, not the study element. For laboratory-type studies like GenomeStudy, type resources will be used for tracking additional metadata and workflow aspects of complex studies. ImagingStudy and the media element are somewhat overlapping - typically, the list of image references in the media 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 | 10..* |
| Type | Reference(IDR ImagingStudy, GenomicStudy, ImagingStudy) |
| 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())) |
| 54. DiagnosticReport.media | |
| Definition | A list of key images or data associated with this report. The images or data are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest). |
| Short | Auxilliary mediaKey images or data associated with this report |
| Comments | Graphical elements such as charts and icons that appear in the presentedForm of the report may go here if they cannot be included inline in the format used (PDF, etc.). The interpreted study is referenced from the .study element, not here. Those study images may be accessible as RESTful resources via DICOMweb (which includes parameterized renderings using the /rendered DICOMweb endpoint to adjust windowing and other parameters). Selected parts or points of those images are encoded as ImagingSelection resources. Comparison studies are referenced from the .comparison element. |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Many diagnostic services include images or data 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 or both (hasValue() or (children().count() > id.count())) |
| 56. 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 managable, 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())) |
| 58. DiagnosticReport.media.link | |
| Definition | Reference to the image or data source. |
| Short | Reference to the image or data source |
| Control | 1..1 |
| Type | Reference(DocumentReference) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 60. DiagnosticReport.composition | |
| Definition | Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport. |
| Short | Additional compositionsReference to a Composition resource for the DiagnosticReport structure |
| Comments | Composition may be included to supplement .text and .presentedForm with additional presentations and compositions of the report content to meet the preferences of different readers, tasks, or site guidelines. The Composition provides structure to the content of the DiagnosticReport (and only contains contents referenced in the DiagnosticReport) - e.g., to order the sections of an anatomic pathology structured report. |
| Control | 0..1 This element is affected by the following invariants: dgr-1 |
| Type | Reference(Composition) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 62. DiagnosticReport.conclusion | |
| Definition | Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report. |
| Short | Impression / ConclusionClinical conclusion (interpretation) of test results |
| Comments | Note 1. In the presentedForm (PDF, HTML, etc.), section text titled Impression frequently contains not just impressions, but also recommendations, and communications. IDR profiles usage of specific encodings for those in the recommendation and communication elements. |
| Control | 0..1 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 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())) |
| 64. DiagnosticReport.conclusionCode | |
| Definition | One or more codes and/or references that represent the summary conclusion (interpretation/impression) of the diagnostic report. |
| Short | supplemented by conclusionCodeRCodes and/or references for the clinical conclusion of test results |
| Comments | R6 makes .conclusionCode a CodeableReference to allow a Condition (or Observation) to be a coded conclusion. Since I haven't figured out how to do that in a Profile (it is an expansion, not a constraint on the underlying resource) I have created a sister element .conclusionCodeR so I can continue building sample objects and resolving brittle build issues. |
| Control | 0..* |
| Binding | For example codes, see SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings|6.0.0-ballot3 (example to http://hl7.org/fhir/ValueSet/clinical-findings|6.0.0-ballot3)SNOMED CT Clinical Findings |
| Type | CodeableReference(Observation, Condition) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. 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 | 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 | false |
| 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())) IDRAttachmentInvariant: Either data or url SHALL be present for any attachment (e.g. in DiagnosticReport). ( data.exists() or url.exists()) |
| 68. DiagnosticReport.presentedForm.contentType | |
| Definition | Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. |
| Short | Mime type of the content, with charset etc. |
| Control | 10..1 This element is affected by the following invariants: att-1 |
| Binding | The codes SHALL be taken from MimeTypeshttp://hl7.org/fhir/ValueSet/mimetypes|6.0.0-ballot3 (required to http://hl7.org/fhir/ValueSet/mimetypes|6.0.0-ballot3)BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Processors of the data need to be able to know how to interpret the data. |
| Example | General: text/plain; charset=UTF-8, image/png |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 70. DiagnosticReport.presentedForm.size | |
| Definition | The number of bytes of data that make up this attachment (before base64 encoding, if that is done). |
| Short | Number of bytes of content (if url provided) |
| Comments | The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference. |
| Control | 10..1 |
| Type | integer64 |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 72. DiagnosticReport.presentedForm.hash | |
| Definition | The calculated hash of the data using SHA-1. Represented using base64. |
| Short | Hash of the data (sha-1, base64ed) |
| Comments | The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature. The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature. |
| Control | 10..1 |
| Type | base64Binary |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version). |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. DiagnosticReport | |
| Definition | The findings and interpretation of diagnostic tests performed on patients, groups of patients, products, substances, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. The report also includes non-clinical context such as batch analysis and stability reporting of products and substances. |
| 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 |
| Invariants | dgr-1: When a Composition is referenced in `DiagnosticReport.composition`, all Observation resources referenced in `Composition.entry` must also be referenced in `DiagnosticReport.result` or in the `Observation.hasMember` references. (composition.exists() implies (composition.resolve().section.entry.reference.where(resolve() is Observation) in (result.reference|result.reference.resolve().hasMember.reference)))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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists()) |
| 2. DiagnosticReport.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Control | 0..1 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| 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 |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. DiagnosticReport.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| 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 its 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 its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. DiagnosticReport.language | |
| Definition | The base language in which the resource is written. |
| 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 SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. DiagnosticReport.text | |
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| Short | Fully-rendered, human-readable report |
| Comments | Contained resources do not have a 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 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Is Modifier | false |
| Must Support | true |
| 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())) |
| 12. DiagnosticReport.contained | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| 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. Contained resources may be a resource type defined in the FHIR specification, or an additional resource. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 14. DiagnosticReport.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| 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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 16. DiagnosticReport.extension:comparison | |
| Slice Name | comparison |
| Definition | Prior imaging studies that were considered relevant to the current study and made available to the imaging clinician at the time of reporting. |
| Short | Relevant prior exams |
| Comments | The primary study being reported is referenced from the study element. |
| Control | 0..* |
| Type | Extension((AddR6toR4) DiagnosticReport.comparison) (Extension Type: Reference(IDR ImagingStudy)) |
| 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()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 18. DiagnosticReport.extension:conclusionCodeR | |
| Slice Name | conclusionCodeR |
| Definition | Coded Conclusions about Conditions and Observations |
| Short | Impression / Conclusion (coded) |
| Comments | A .conclusionCode item, being a CodeableReference, may contain an individual code instead of a reference when a code exists that encompasses the conclusion or impression. An impression drawn from a *-RADS System, such as BI-RADS TOLINK, is encoded as a .conclusionCode item containing the corresponding code. For example, (397143007, SCT, "Mammography assessment (Category 3) - Probably benign finding, short interval follow-up"). Note 1. *-RADS codes correspond to the result of a composite assessment, and the conclusion may represent a point on a diagnostic pathway, which encompasses both a differential diagnosis and protocolized follow-up actions. |
| Control | 0..* |
| Type | Extension((AddR6toR4) DiagnosticReport.conclusionCode as CodeableReference) (Extension Type: Reference(IDR Report Impression Condition, IDR Imaging Observation)) |
| 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()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 20. DiagnosticReport.extension:recommendation | |
| Slice Name | recommendation |
| Definition | Proposed follow-up actions based on the findings and interpretations of the diagnostic test for which this report is the subject. |
| Short | Recommendations based on findings and interpretations |
| Control | 0..* |
| Type | Extension((AddR6toR4) DiagnosticReport.recommendation) (Extension Type: Reference(IDR Recommendation ServiceRequest)) |
| 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()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 22. DiagnosticReport.extension:communication | |
| Slice Name | communication |
| Definition | Communications initiated during the generation of the DiagnosticReport by members of the organization fulfilling that order. e.g. direct communication of time critical results by the radiologist to the referring physician. |
| Short | Communication initiated during the reporting process |
| Comments | These communications are limited to those initiated during the generation of the DiagnosticReport by members of the organization fulfilling that order. E.g. direct communication of time critical results by the radiologist to the referring physician. Communications that follow publication of the report (e.g. between the referring physician and the patient or a subsequent specialist) are not referenced here. |
| Control | 0..* |
| Type | Extension((AddR6toR4) DiagnosticReport.communication) (Extension Type: Reference(IDR Report Communication)) |
| 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()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 24. DiagnosticReport.extension:patientHistory | |
| Slice Name | patientHistory |
| Definition | May have originally been extracted from the medical record by imaging staff, automated tools, or by the radiologists themselves. |
| Short | Patient history items selected by radiologist |
| Control | 0..* |
| Type | Extension(IDR Patient History) (Extension Type: Reference(IDR Patient History Condition, IDR Patient History Observation, IDR Patient History Procedure, IDR FamilyMemberHistory)) |
| 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()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 26. DiagnosticReport.extension:procedure | |
| Slice Name | procedure |
| Definition | Imaging procedure used to acquire the study. |
| Short | Imaging procedure |
| Control | 0..* |
| Type | Extension(IDR Imaging Procedure) (Extension Type: Reference(IDR Reported Imaging Procedure)) |
| 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()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 28. 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 managable, 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 |
| Must Support | false |
| 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 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 30. 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 |
| Must Support | 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())) |
| 32. DiagnosticReport.basedOn | |
| Definition | Details concerning a service requested. |
| Short | What was requested |
| Comments | Note 1. For result resources like DiagnosticReport, .basedOn references the authorizing request being fulfilled; i.e. the order, not the input data. So DiagnosticReport.basedOn references the imaging ServiceRequest, not the ImagingStudy. Note 2. Report Creators do not create orders. It is expected that an appropriate ServiceRequest resource will exist which may have been created by another system more integrated with order management. The hospital may originate orders as ServiceRequest resources, or may create ServiceRequests based on HL7 v2 ORM or OMG messages. In either case, reporting systems are not the Source of Truth for order management; it would be disruptive for them to directly create/modify order resources. Note 3. "Group Cases": While one report typically corresponds to one order (ServiceRequest) comprised of one study, some reports do cover multiple orders. A radiologist may satisfy multiple ServiceRequests in a single report. Depending on site preferences related to billing and workflow, systems should be prepared to handle this as a single report basedOn multiple ServiceRequests, or as multiple copies of the same report, each basedOn a different ServiceRequest. Note 4. If the DiagnosticReport is associated with an Accession Number, this field should include a reference to that value in the form: identifier.value = (Accession Number Value) identifier.type = ACSN. A reference value pointing to a ServiceRequest resource is allowed but is not required. Note 5. DiagnosticReport.basedOn may be empty in some scenarios, e.g. when emergency imaging is performed and an order has not been backfilled before reporting. |
| Control | 0..* |
| Type | Reference(CarePlan, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ServiceRequest) |
| 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())) |
| Slicing | This element introduces a set of slices on DiagnosticReport.basedOn. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 34. DiagnosticReport.basedOn:serviceRequest | |
| Slice Name | serviceRequest |
| Definition | The order for the imaging procedure being reported. |
| Short | The imaging order |
| 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(IDR Imaging ServiceRequest) |
| Is Modifier | false |
| Must Support | false |
| 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())) |
| 36. DiagnosticReport.status | |
| Definition | The status of the diagnostic report. |
| Short | registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown |
| Comments | Values of preliminary and final shall be used when their conventional meaning for imaging reports applies. A value of registered state be used while the report is being composed during the interpretation process. For addenda, a value of amended shall be used. . Note: Other FHIR status values such as modified, corrected, or appended are not profiled here. They may be addressed in a reporting workflow profile. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IDR DiagnosticReport.status ValueSet (required to https://profiles.ihe.net/RAD/IDR/ValueSet/idr-diagnostic-report-status-vs) |
| 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 | false |
| 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())) |
| 38. DiagnosticReport.category | |
| Definition | A code for the diagnostic service that performed the imaging study |
| Short | Diagnostic Service |
| Comments | It is recommended that this code focus on the service/department, since the modality is already reflected in DiagnosticReport.code. Potential codes may be drawn from DICOM PS3.16 CID 7030 "Institutional Department/Unit/Service" and the HL7 terminology code set referenced in FHIR. This value may be copied from the ServiceRequest.category that the report is basedOn. |
| Control | 1..* |
| Binding | For example codes, see DiagnosticServiceSectionCodes (example to http://hl7.org/fhir/ValueSet/diagnostic-service-sections|6.0.0-ballot3)HL7 V2 table 0074 |
| 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())) |
| 40. DiagnosticReport.code | |
| Definition | A code or name that describes this diagnostic report. |
| Short | Name/Code for this diagnostic report |
| Comments | Imaging report titles are frequently site specific, but commonly communicate the modality, body part, and/or clinical focus of the performed imaging procedure. Note 1. Since report titles often mirror the name of the ordered imaging procedure, the codes from the RSNA Radlex Playbook provide a useful example codeset. (Search LOINC for \“playbook\”) |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from LOINCDiagnosticReportCodes (preferred to http://hl7.org/fhir/ValueSet/report-codes|6.0.0-ballot3)LOINC Codes for Diagnostic Reports |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | Type |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 42. 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 | The imaged patient |
| Comments | Note 1. Report Creators do not create patient resources. It is expected that an appropriate Patient resource will exist, even if only a John Doe, created by another system more integrated with patient management. Imaging systems are not the Source of Truth for patient demographics and management; it would be disruptive for them to directly create/modify patient resources. If a patient reference is a pre-requisite to publish imaging DiagnosticReport resources, the local infrastructure will arrange for appropriate Patient resources for the Report Creator to use. |
| Control | 1..1 |
| Type | Reference(IDR Patient) |
| 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())) |
| 44. DiagnosticReport.relatesTo | |
| Definition | Other DiagnosticReports that the current DiagnosticReport replaces, amendens, extends, or otherwise relates to. |
| Short | Related DiagnosticReports |
| Control | 0..* |
| Type | RelatedArtifact |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 46. DiagnosticReport.encounter | |
| Definition | If present, will reflect the encounter of the imaging procedure being reported (which may also be found in DiagnosticReport.procedure.encounter.) To find the encounter during with the order for the imaging procedure was placed, see DiagnosticReport.basedOn[ServiceRequest].encounter. |
| Short | Encounter associated with the DiagnosticReport |
| Comments | This will typically be the encounter, when it exists, during which the data or specimens (e.g. imaging, blood draw, or assessment procedure) that are being reported by the DiagnosticReport were obtained/acquired. When a DiagnosticReport is based on a ServiceRequest (order), the ServiceRequest.encounter referenced in DiagnosticReport.basedOn may be used to associate the two. |
| Control | 0..1 |
| Type | Reference(Encounter) |
| Is Modifier | false |
| Must Support | false |
| 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())) |
| 48. 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 | Clinically relevant time/time-period for the results that are included in the report |
| Comments | If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic. |
| Control | 0..1 |
| 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 | false |
| 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())) |
| 50. 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 | DateTime report was published. |
| 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 | 1..1 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 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())) |
| 52. DiagnosticReport.procedure | |
| Definition | The procedure(s) that are reported on in the DiagnosticReport. |
| Short | The procedure(s) from which the report was produced |
| Comments | This is a summary of the report, not a list of results. |
| Control | 0..* |
| Type | Reference(Procedure) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. DiagnosticReport.performer | |
| Definition | The diagnostic service that is responsible for issuing the report. |
| Short | Responsible Diagnostic Service |
| Comments | The organization (which may be a diagnostic service) responsible for the report is captured here. The specific clinician is captured in resultsInterpreter. |
| Control | 1..* |
| Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Device) |
| Is Modifier | false |
| Must Support | 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 | 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())) |
| Slicing | This element introduces a set of slices on DiagnosticReport.performer. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 56. DiagnosticReport.performer:organization | |
| Slice Name | organization |
| Definition | The diagnostic service that is responsible for issuing the report. |
| Short | 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. In the regulated context of diagnostic laboratory work on humans, it is extremely likely that regulation requires a human performer. Point of care testing, veterinary testing, drug screens, and environmental surveillance are common cases where the device is the performer with no additional human interaction or direct oversight. |
| Control | 1..* |
| Type | Reference(Organization) |
| Is Modifier | false |
| Must Support | 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 | 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())) |
| 58. DiagnosticReport.resultsInterpreter | |
| Definition | The practitioner or organization that is responsible for the report's conclusions and interpretations. |
| Short | Primary result interpreter |
| Comments | This is imaging clinician(s) the study is reported by. Additional report authors may also be referenced. PractitionerRole resources may be used to record participants such as residents, collaborating clinicians and the role they played. |
| Control | 1..* |
| Type | Reference(Practitioner, PractitionerRole) |
| Is Modifier | false |
| Must Support | 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())) |
| 60. 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 |
| Must Support | 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())) |
| 62. DiagnosticReport.result | |
| Definition | Detailed description of the findings on the imaging study. The findings should be described in a clear and concise manner, using standardized anatomic, pathologic, and radiologic terminology whenever possible. |
| Short | Findings |
| Comments | Observations can contain observations. |
| Control | 0..* This element is affected by the following invariants: dgr-1 |
| Type | Reference(IDR Imaging Observation) |
| Is Modifier | false |
| Must Support | true |
| 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())) |
| 64. DiagnosticReport.note | |
| Definition | Comments about the diagnostic report. |
| Short | See Detailed Description Comments |
| Comments | In imaging diagnostic reports, statements about significant, unexpected or unreliable result values appear as needed in the Findings, Conclusions, or Procedure, not in .note. Other imaging usage was not identified. |
| Control | 0..* |
| Type | Annotation |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Need to be able to provide free text additional information. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. DiagnosticReport.study | |
| Definition | Study interpreted by the imaging clinician in this report. |
| Short | Reported Imaging Study |
| Comments | The ImagingStudy for the study being read shall be referenced unless no such ImagingStudy resource exists. Note 1. Report Creators do not typically create ImagingStudy resources. It is expected that an appropriate ImagingStudy resource will exist, created by another system more integrated with image management, such as the PACS, or the VNA, or the EMR in response to messaging from the PACS or VNA. Report Creators are not the Source of Truth for imaging study management. In the absence of an ImagingStudy, the ServiceRequest and Accession Number will serve to provide basic linkages between the images and the report. Note 2. Studies available for comparison during reporting are tracked in the comparison element, not the study element. |
| Control | 1..* |
| Type | Reference(IDR ImagingStudy) |
| 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())) |
| 68. DiagnosticReport.supportingInfo | |
| Definition | This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report. |
| Short | Additional information supporting the diagnostic report |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count())) |
| 70. DiagnosticReport.supportingInfo.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 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 72. DiagnosticReport.supportingInfo.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 managable, 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())) |
| 74. DiagnosticReport.supportingInfo.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 managable, 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())) |
| 76. DiagnosticReport.supportingInfo.type | |
| Definition | The code value for the role of the supporting information in the diagnostic report. |
| Short | Supporting information role code |
| Control | 1..1 |
| Binding | For example codes, see hl7VS-VS-observationType (example to http://terminology.hl7.org/ValueSet/v2-0936)The code value for the role of the supporting information in the diagnostic report. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 78. DiagnosticReport.supportingInfo.reference | |
| Definition | The reference for the supporting information in the diagnostic report. |
| Short | Supporting information reference |
| Control | 1..1 |
| Type | Reference(ImagingStudy, Procedure, Observation, DiagnosticReport, Citation, FamilyMemberHistory, AllergyIntolerance, DeviceUsage, Condition, GenomicStudy) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 80. DiagnosticReport.media | |
| Definition | A list of key images or data associated with this report. The images or data are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest). |
| Short | Auxilliary media |
| Comments | Graphical elements such as charts and icons that appear in the presentedForm of the report may go here if they cannot be included inline in the format used (PDF, etc.). The interpreted study is referenced from the .study element, not here. Those study images may be accessible as RESTful resources via DICOMweb (which includes parameterized renderings using the /rendered DICOMweb endpoint to adjust windowing and other parameters). Selected parts or points of those images are encoded as ImagingSelection resources. Comparison studies are referenced from the .comparison element. |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Many diagnostic services include images or data 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 or both (hasValue() or (children().count() > id.count())) |
| 82. 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 This element is affected by the following invariants: ele-1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 84. 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 managable, 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())) |
| 86. 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 managable, 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())) |
| 88. DiagnosticReport.media.comment | |
| Definition | A comment about the image or data. Typically, this is used to provide an explanation for why the image or data is included, or to draw the viewer's attention to important features. |
| Short | Comment about the image or data (e.g. explanation) |
| Comments | The comment should be displayed with the image or data. It would be common for the report to include additional discussion of the image or data contents or 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 |
| Must Support | false |
| Summary | false |
| Requirements | The provider of the report should make a comment about each image or data included in the report. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 90. DiagnosticReport.media.link | |
| Definition | Reference to the image or data source. |
| Short | Reference to the image or data source |
| Control | 1..1 |
| Type | Reference(DocumentReference) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 92. DiagnosticReport.composition | |
| Definition | Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport. |
| Short | Additional compositions |
| Comments | Composition may be included to supplement .text and .presentedForm with additional presentations and compositions of the report content to meet the preferences of different readers, tasks, or site guidelines. |
| Control | 0..1 This element is affected by the following invariants: dgr-1 |
| Type | Reference(Composition) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 94. DiagnosticReport.conclusion | |
| Definition | Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report. |
| Short | Impression / Conclusion |
| Comments | Note 1. In the presentedForm (PDF, HTML, etc.), section text titled Impression frequently contains not just impressions, but also recommendations, and communications. IDR profiles usage of specific encodings for those in the recommendation and communication elements. |
| Control | 0..1 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 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())) |
| 96. DiagnosticReport.conclusionCode | |
| Definition | One or more codes and/or references that represent the summary conclusion (interpretation/impression) of the diagnostic report. |
| Short | supplemented by conclusionCodeR |
| Comments | R6 makes .conclusionCode a CodeableReference to allow a Condition (or Observation) to be a coded conclusion. Since I haven't figured out how to do that in a Profile (it is an expansion, not a constraint on the underlying resource) I have created a sister element .conclusionCodeR so I can continue building sample objects and resolving brittle build issues. |
| Control | 0..* |
| Binding | For example codes, see SNOMEDCTClinicalFindings (example to http://hl7.org/fhir/ValueSet/clinical-findings|6.0.0-ballot3)SNOMED CT Clinical Findings |
| Type | CodeableReference(Observation, Condition) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 98. DiagnosticReport.recomendation | |
| Definition | Proposed follow-up actions based on the findings and interpretations of the diagnostic test for which this report is the subject. |
| Short | Recommendations based on findings and interpretations |
| Comments | The resources that should be referenced include CarePlan, ServiceRequest, CommunicationRequest, etc. that allow for proposed actions and next steps. |
| Control | 0..* |
| Type | CodeableReference(Resource) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 100. 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 | 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 | false |
| 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()))IDRAttachmentInvariant: Either data or url SHALL be present for any attachment (e.g. in DiagnosticReport). ( data.exists() or url.exists()) |
| 102. DiagnosticReport.presentedForm.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 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 104. DiagnosticReport.presentedForm.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 managable, 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())) |
| Slicing | This element introduces a set of slices on DiagnosticReport.presentedForm.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 106. DiagnosticReport.presentedForm.contentType | |
| Definition | Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. |
| Short | Mime type of the content, with charset etc. |
| Control | 1..1 This element is affected by the following invariants: att-1 |
| Binding | The codes SHALL be taken from MimeTypes (required to http://hl7.org/fhir/ValueSet/mimetypes|6.0.0-ballot3)BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Processors of the data need to be able to know how to interpret the data. |
| Example | General: text/plain; charset=UTF-8, image/png |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 108. DiagnosticReport.presentedForm.language | |
| Definition | The human language of the content. The value can be any valid value according to BCP 47. |
| Short | Human language of the content (BCP-47) |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3)IETF language tag for a human language. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Users need to be able to choose between the languages in a set of attachments. |
| Example | General: en-AU |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 110. DiagnosticReport.presentedForm.data | |
| Definition | The actual data of the attachment - a sequence of bytes, base64 encoded. |
| Short | Data inline, base64ed |
| Comments | The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. |
| Control | 0..1 This element is affected by the following invariants: att-1 |
| Type | base64Binary |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Requirements | The data needs to able to be transmitted inline. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 112. DiagnosticReport.presentedForm.url | |
| Definition | A location where the data can be accessed. |
| Short | Uri where the data can be found |
| Comments | If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data. |
| Control | 0..1 |
| Type | url |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | The data needs to be transmitted by reference. |
| Example | General: http://www.acme.com/logo-small.png |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 114. DiagnosticReport.presentedForm.size | |
| Definition | The number of bytes of data that make up this attachment (before base64 encoding, if that is done). |
| Short | Number of bytes of content (if url provided) |
| Comments | The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference. |
| Control | 1..1 |
| Type | integer64 |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 116. DiagnosticReport.presentedForm.hash | |
| Definition | The calculated hash of the data using SHA-1. Represented using base64. |
| Short | Hash of the data (sha-1, base64ed) |
| Comments | The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature. |
| Control | 1..1 |
| Type | base64Binary |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version). |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 118. DiagnosticReport.presentedForm.title | |
| Definition | A label or set of text to display in place of the data. |
| Short | Label to display in place of the data |
| Comments | May sometimes be derived from the source filename. |
| 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 |
| Requirements | Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer. |
| Example | General: Official Corporate Logo |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 120. DiagnosticReport.presentedForm.creation | |
| Definition | The date that the attachment was first created. |
| Short | Date attachment was first created |
| Control | 0..1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | This is often tracked as an integrity issue for use of the attachment. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 122. DiagnosticReport.presentedForm.height | |
| Definition | Height of the image in pixels (photo/video). |
| Short | Height of the image in pixels (photo/video) |
| Control | 0..1 |
| Type | positiveInt |
| 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())) |
| 124. DiagnosticReport.presentedForm.width | |
| Definition | Width of the image in pixels (photo/video). |
| Short | Width of the image in pixels (photo/video) |
| Control | 0..1 |
| Type | positiveInt |
| 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())) |
| 126. DiagnosticReport.presentedForm.frames | |
| Definition | The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. |
| Short | Number of frames if > 1 (photo) |
| Comments | if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated. |
| Control | 0..1 |
| Type | positiveInt |
| 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())) |
| 128. DiagnosticReport.presentedForm.duration | |
| Definition | The duration of the recording in seconds - for audio and video. |
| Short | Length in seconds (audio / video) |
| Comments | The duration might differ from occurrencePeriod if recording was paused. |
| Control | 0..1 |
| Type | decimal |
| 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())) |
| 130. DiagnosticReport.presentedForm.pages | |
| Definition | The number of pages when printed. |
| Short | Number of printed pages |
| Control | 0..1 |
| Type | positiveInt |
| 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())) |
| 132. DiagnosticReport.communication | |
| Definition | Communications initiated during the generation of the DiagnosticReport by members of the organization fulfilling that order. e.g. direct communication of time critical results by the radiologist to the referring physician. |
| Short | Communication initiated during the reporting process |
| Comments | Note: This can document attempted communications as well as completed communications. Communications that follow publication of the report (e.g. between the referring physician and the patient or a subsequent specialist) are not referenced here. DiagnosticReport.recommendation might also contain references to ServiceRequest or CommunicationRequest instances for proposed subsequent communications. |
| Control | 0..* |
| Type | Reference(Communication) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Need to record details of such communications for medico-legal purposes, to support review or the improvement of conformance to best practices for patient safety and quality of care. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |