xCaliber healthCare Data Mesh

DiagnosticReport

Overview

The DiagnosticReport API empowers healthcare developers to seamlessly manage and retrieve diagnostic report information, facilitating the integration of diagnostic findings and results into clinical workflows. By utilizing this API, developers can optimize the accessibility of diagnostic data, streamline reporting processes, and enhance the efficiency of healthcare professionals in interpreting and acting upon diagnostic information for improved patient care.Use Cases

  • Test Ordering - Place lab, medical imaging, and pathology test orders.
  • Results Delivery - Receive electronic diagnostic test results into health records.
  • Care Coordination - Share test reports with public health, specialists, and patients.
  • Clinical Decision Support - Apply diagnostic report findings to evidence-based order sets rules.
  • Billing & Reimbursement - Link accurate procedure codes for tests performed to claims.
  • Patient Timelines - Attach diagnostic findings to graphed trends within patient histories.
  • Analytics & Research - Compile diagnostic data sets and assess outcomes.
  • Result Validation - Validate report integrity using profiles and authenticity proofs.
  • Attachments Management - Associate medical imaging media to report records.
  • Reporting Compliance - Ensure diagnostic reports meet clinical documentation regulations.

EHR Data Model

EHRSupported?Mapped Source Object
AthenaLab Results, Imaging Result
ElationLab Report, External Report
EpicN/A

Operations & APIs

Object Definition

{
  "resourceType": "DiagnosticReport",
  "id": "ultrasound",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: ultrasound</p><p><b>status</b>: final</p><p><b>category</b>: Radiology <span>(Details : {SNOMED CT code '394914008' = 'Radiology - speciality', given as 'Radiology'}; {http://terminology.hl7.org/CodeSystem/v2-0074 code 'RAD' = 'Radiology)</span></p><p><b>code</b>: Abdominal Ultrasound <span>(Details : {SNOMED CT code '45036003' = 'Ultrasonography of abdomen', given as 'Ultrasonography of abdomen'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>effective</b>: 01/12/2012 12:00:00 PM</p><p><b>issued</b>: 01/12/2012 12:00:00 PM</p><p><b>performer</b>: <a>Practitioner/example</a></p><h3>Media</h3><table><tr><td>-</td><td><b>Comment</b></td><td><b>Link</b></td></tr><tr><td>*</td><td>A comment about the image</td><td><a>WADO example image</a></td></tr></table><p><b>conclusion</b>: Unremarkable study</p></div>"
  },
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "394914008",
          "display": "Radiology"
        },
        {
          "system": "http://terminology.hl7.org/CodeSystem/v2-0074",
          "code": "RAD"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "45036003",
        "display": "Ultrasonography of abdomen"
      }
    ],
    "text": "Abdominal Ultrasound"
  },
  "subject": {
    "reference": "Patient/example"
  },
  "effectiveDateTime": "2012-12-01T12:00:00+01:00",
  "issued": "2012-12-01T12:00:00+01:00",
  "performer": [
    {
      "reference": "Practitioner/example"
    }
  ],
  "media": [
    {
      "comment": "A comment about the image",
      "link": {
        "reference": "Media/1.2.840.11361907579238403408700.3.1.04.19970327150033",
        "display": "WADO example image"
      }
    }
  ],
  "conclusion": "Unremarkable study",
  "meta": {
    "tag": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "HTEST",
        "display": "test health data"
      }
    ]
  }
}

Data Fields

Data FieldTypeDescription
resourceTypeDiagnosticReportThis is a DiagnosticReport resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedBackboneElementThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierIdentifierIdentifiers assigned to this report by the performer or other systems.
basedOnReferenceDetails concerning a service requested.
statuscodeThe status of the diagnostic report.
categoryCodeableConceptA 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.
codeCodeableConceptA code or name that describes this diagnostic report.
subjectReferenceThe 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.
encounterReferenceThe healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.
effectiveDateTimestringThe 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.
effectivePeriodPeriodThe 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.
issuedinstantThe date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.
performerReferenceThe diagnostic service that is responsible for issuing the report.
resultsInterpreterReferenceThe practitioner or organization that is responsible for the report's conclusions and interpretations.
specimenReferenceDetails about the specimens on which this diagnostic report is based.
resultReference[Observations](observation.html) that are part of this diagnostic report.
imagingStudyReferenceOne or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.
mediaBackboneElementA list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).
media.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
media.extensionExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
media.modifierExtensionExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
media.commentstringA comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features.
media.linkReferenceReference to the image source.
conclusionstringConcise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.
conclusionCodeCodeableConceptOne or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.
presentedFormAttachmentRich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.

Extensions

NameURL
ABNORMALhttp://xcaliber-fhir/structureDefinition/is-abnormal
ABNORMAL_FLAGhttp://xcaliber-fhir/structureDefinition/abnormal-flag
ACCESSION_NUMBERhttp://xcaliber-fhir/structureDefinition/accession-number
ATTACHMENTEXISTShttp://xcaliber-fhir/structureDefinition/attachment-exists
CHART_DATEhttp://xcaliber-fhir/structureDefinition/chart-date
CREATED_DATEhttp://xcaliber-fhir/structureDefinition/created-date
COLLECTED_DATEhttp://xcaliber-fhir/structureDefinition/collected-date
DOCUMENT_DATEhttp://xcaliber-fhir/structureDefinition/document-date
DELETED_DATEhttp://xcaliber-fhir/structureDefinition/deleted-date
EXACTDUPLICATEDOCUMENTIDhttp://xcaliber-fhir/structureDefinition/exact-duplicate-document-id
LOINChttp://xcaliber-fhir/structureDefinition/loinc
NOTEhttp://xcaliber-fhir/structureDefinition/note
OBSERVATIONIDENTIFIERhttp://xcaliber-fhir/structureDefinition/analytes/observation-identifier
PERFORMINGLABADDRESS1http://xcaliber-fhir/structureDefinition/performing-lab-address1
PERFORMINGLABADDRESS2http://xcaliber-fhir/structureDefinition/performing-lab-address2
PERFORMINGLABCITYhttp://xcaliber-fhir/structureDefinition/performing-lab-city
PERFORMINGLABZIPhttp://xcaliber-fhir/structureDefinition/performing-lab-zip
PERFORMINGLABSTATEhttp://xcaliber-fhir/structureDefinition/performing-lab-state
PHYSICIANhttp://xcaliber-fhir/structureDefinition/physician
PRACTICEhttp://xcaliber-fhir/structureDefinition/practice
PRIORITYhttp://xcaliber-fhir/structureDefinition/priority
PROVIDERIDhttp://xcaliber-fhir/structureDefinition/provider-id
PRINTABLE_VIEWhttp://xcaliber-fhir/structureDefinition/printable-view
RESULT_DATEhttp://xcaliber-fhir/structureDefinition/result-date
SIGNED_BYhttp://xcaliber-fhir/structureDefinition/signed-by
SIGNED_DATEhttp://xcaliber-fhir/structureDefinition/signed-date
STATUShttp://xcaliber-fhir/structureDefinition/status
SUPERSEDEDDOCUMENTIDhttp://xcaliber-fhir/structureDefinition/superseded-document-id
TAGShttp://xcaliber-fhir/structureDefinition/tags
TAGhttp://xcaliber-fhir/structureDefinition/tag
TEXThttp://xcaliber-fhir/structureDefinition/text
TEST_CATEGORY_DESCRIPTIONhttp://xcaliber-fhir/structureDefinition/test-category-description
TEST_CATEGORY_VALUEhttp://xcaliber-fhir/structureDefinition/test-category-value
VALUE_TYPEhttp://xcaliber-fhir/structureDefinition/value-type
UNITShttp://xcaliber-fhir/structureDefinition/units
FACILITYIDhttp://xcaliber-fhir/structureDefinition/facility-id
INTERNALNOTEhttp://xcaliber-fhir/structureDefinition/internal-note
INTERPRETATIONTEMPLATEhttp://xcaliber-fhir/structureDefinition/interpretation-template
ISREVIEWEDBYPROVIDERhttp://xcaliber-fhir/structureDefinition/is-reviewed-by-provider
LABRESULTDATEhttp://xcaliber-fhir/structureDefinition/lab-result-date
PATIENTNOTEhttp://xcaliber-fhir/structureDefinition/patient-note
ABNORMALHL7CODEhttp://xcaliber-fhir/structureDefinition/abnormal-hl7-code
ABNORMALHL7NAMEhttp://xcaliber-fhir/structureDefinition/abnormal-hl7-name
ANALYTEDATEhttp://xcaliber-fhir/structureDefinition/analyte-date
DESCRIPTIONhttp://xcaliber-fhir/structureDefinition/description
DOCUMENT_SOURCEhttp://xcaliber-fhir/structureDefinition/document-source
LAB_RESULT_STATUShttp://xcaliber-fhir/structureDefinition/lab-result-status
ORIGINALFILENAMEhttp://xcaliber-fhir/structureDefinition/original-file-name

DiagnosticReport-GET

DiagnosticReport-POST

DiagnosticReport ID-GET

DiagnosticReport ID-PUT

DiagnosticReport ID-DELETE

DiagnosticReport Export-POST