The DiagnosticReport resource implements the FHIR R4 DiagnosticReport specification and the following US Core v3.1.1 profiles: DiagnosticReport Profile for Laboratory Results Reporting and US Core DiagnosticReport Profile for Report and Note exchange

Fields

Name Type Cardinality Required Description
identifier Identifier 0..*   Business identifier for report
basedOn Reference 0..*   What was requested
status code 1..1 * registered | partial | preliminary | final + - Binding
category CodeableConcept 1..* * Service category
encounter Reference(US Core Encounter Profile) 0..1   The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about
code CodeableConcept 1..1 * Name/Code for this diagnostic report
subject Reference(US Core Patient Profile) 1..1 * The subject of the report - usually, but not always, the patient
effectiveDateTime dateTime 1..1 * Clinically relevant time/time-period for report - either effactiveDateTime or effectivePeriod should be provided
effectivePeriod Period 1..1 * Clinically relevant time/time-period for report - either effactiveDateTime or effectivePeriod should be provided
issued instant 1..1 * DateTime this version was released
performer Reference(US Core Practitioner Profile | US Core Organization Profile) 0..*   Practitioner | PractitionerRole | Organization | CareTeam
resultsInterpreter Reference 0..*   The practitioner or organization that is responsible for the report’s conclusions and interpretations.
specimen Reference 0..*   Specimens this report is based on
result Reference(US Core Laboratory Result Observation Profile) 0..*   Observations - simple, or complex nested groups
imagingStudy Reference 0..*   Reference to full details of imaging associated with the diagnostic report
media BackboneElement 0..*   Key images associated with this report
conclusion string 0..1   Clinical Interpretation of test results
conslusionCode CodeableConcept 0..*   Codes for the conclusion
presentedForm Attachment 0..*   Entire report as issued

Interactions

Read

Get an DiagnosticReport entry by id

GET /DiagnosticReport/:id

Example

Request

https://r4cert.medicasoft.us/api/fhir/DiagnosticReport/85436fb1-772c-ae03-320b-fef37129febf

Response

{
  "resourceType": "DiagnosticReport",
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "code": "LAB",
          "system": "http://terminology.hl7.org/CodeSystem/v2-0074",
          "display": "Laboratory"
        }
      ],
      "text": "Laboratory"
    }
  ],
  "encounter": {
    "reference": "Encounter/53e6d860-a079-dc7f-7c11-0f46035fce9c"
  },
  "code": {
    "coding": [
      {
        "code": "58410-2",
        "system": "http://loinc.org",
        "display": "Complete blood count (hemogram) panel - Blood by Automated count"
      }
    ],
    "text": "Complete blood count (hemogram) panel - Blood by Automated count"
  },
  "subject": {
    "reference": "Patient/bcfa83df-ee8c-9721-cc07-bdcfc2b1e3f2"
  },
  "effectiveDateTime": "1983-06-29T00:56:44-04:00",
  "issued": "1983-06-29T00:56:44.801-04:00",
  "performer": [
    {
      "reference": "Organization/6092e2a8-bf40-3b65-9d03-9eb8e7e651c1",
      "display": "PCP5851"
    },
    {
      "reference": "Practitioner/e8329507-747c-301b-b16a-dc5e163ed791"
    }
  ],
  "result": [
    {
      "reference": "Observation/5d51beb4-8e32-622f-756c-856aabacd4e5",
      "display": "Leukocytes [#/volume] in Blood by Automated count"
    },
    {
      "reference": "Observation/215e29f8-d15e-898e-7804-a8bbfc8597ca",
      "display": "Erythrocytes [#/volume] in Blood by Automated count"
    },
    {
      "reference": "Observation/1368cde4-2d90-e822-a268-7c0595efa270",
      "display": "Hemoglobin [Mass/volume] in Blood"
    },
    {
      "reference": "Observation/495b14cf-2891-9773-2183-a836922e4832",
      "display": "Hematocrit [Volume Fraction] of Blood by Automated count"
    },
    {
      "reference": "Observation/148a1ba9-a68c-d217-9f5f-e9f6ad78e4f0",
      "display": "MCV [Entitic volume] by Automated count"
    },
    {
      "reference": "Observation/821e3e0f-1873-9033-9096-4dd593383736",
      "display": "MCH [Entitic mass] by Automated count"
    },
    {
      "reference": "Observation/ae5ecf93-ad2a-e841-e31b-7bc4fdbcb89d",
      "display": "MCHC [Mass/volume] by Automated count"
    },
    {
      "reference": "Observation/4cef965f-e84a-3813-4dc0-c5c829579871",
      "display": "Erythrocyte distribution width [Entitic volume] by Automated count"
    },
    {
      "reference": "Observation/62d2db00-1ea4-5a16-af2a-ede80e363c94",
      "display": "Platelets [#/volume] in Blood by Automated count"
    },
    {
      "reference": "Observation/a8dc217b-69d8-6adb-619a-d76ccffa6ca1",
      "display": "Platelet distribution width [Entitic volume] in Blood by Automated count"
    },
    {
      "reference": "Observation/c36cdfa2-dcea-e2d3-e5f3-974bc5078b53",
      "display": "Platelet mean volume [Entitic volume] in Blood by Automated count"
    }
  ],
  "id": "85436fb1-772c-ae03-320b-fef37129febf"
}

Query DiagnosticReport resources

GET /DiagnosticReport?:query_parameters

Example

Request

https://r4cert.medicasoft.us/api/fhir/DiagnosticReport?category=LP29684-5&date=le1957-04-19T00:19:44-05:00&patient=bcfa83df-ee8c-9721-cc07-bdcfc2b1e3f2

Parameters

Name Type Description
date date The clinically relevant time of the report
identifier token An identifier for the report
media reference A reference to the image source.
performer reference Who was the source of the report (organization)
code token The code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result
results-interpreter reference Who was the source of the report
subject reference The subject of the report
diagnosis token A coded diagnosis on the report
encounter reference The Encounter when the order was made
encounter-class token  
result reference Link to an atomic result (observation resource)
based-on reference Reference to the procedure request.
patient reference The subject of the report if a patient
specimen reference The specimen details
context reference Healthcare event (Episode of Care or Encounter) related to the report
issued date When the report was issued
category token Which diagnostic discipline/department created the report
status token The status of the report
requester-id string  
_include undefined DiagnosticReport:performer | DiagnosticReport:subject | DiagnosticReport:result | DiagnosticReport:based-on | DiagnosticReport:patient | DiagnosticReport:specimen | DiagnosticReport:context | DiagnosticReport:imagingstudy
_revinclude   Provenance:target

Errors

Code Description
400 Invalid parameters
404 Resource not found

Profiles

DiagnosticReport Profile for Laboratory Results Reporting

On top of the other constraints, a DiagnosticReport for Laboratory Results Reporting must have:

  • one entry in the category array having system = http://terminology.hl7.org/CodeSystem/v2-0074, code = LAB
  • the result values should be coded as Observation entries and referenced in the result field

DiagnosticReport Profile for Report and Note exchange

On top of the other constraints, a DiagnosticReport for Laboratory Results Reporting must have:

The system supports the following clinical note categories:

  1. Consultation Note (11488-4)
  2. Discharge Summary (18842-5)
  3. History & Physical Note (34117-2)
  4. Procedures Note (28570-0)
  5. Progress Note (11506-3)

and the following DiagnosticReport categories:

  1. Cardiology / Laboratory Report (LP29708-2)
  2. Pathology Report (LP7839-6)
  3. Radiology / Immaging Narrative (LP29684-5)