Parsed Report Result

Processing Time: Record parsing typically takes 1–2 minutes for documents up to 10 pages and 2–4 minutes for those exceeding 10 pages, depending on the document size.
Understanding the Components of Response
- Lab Report
  
  Lab test
  Every lab test will have:
  - test_name : Verbatim as written in the lab report
  - test_eka_id : Eka identifier for the test
  - loinc_id : LOINC identifier for the test
  - NOTE: we use method agnostic LOINC identifiers in majority of the lab tests. Mapping of all Eka identifiers with LOINC identifiers can be obtained from here.
  Lab test data (value | unit | range)
  Lab test observation is parsed and shared in two variants
  
  Non unit-normalised data (data )
  This data is not unit-normalised, meaning this is verbatim as written in the report. The keys comprise
  - value : value of the test as given in the report
  - unit : unit of the test as given in the report, parsed by OCR (Non post processed). NOTE: at times OCR reads 10^3 u/ml as 103u/ml
  - unit_processed : unit of the test as given in the report, parsed by OCR and then processed by eka. In the above example 103u/ml is converted back to 10*3u/ml after applying post processing
  - normal_range_report : normal range parsed object basis the low-high values given in the report
  - normal_range_eka : normal range parsed object basis EkaCare’s database considering age / gender information of the person from the report.
  - unit_eka_id : Eka id for unit
  - display_range : Verbatim range display text (string) parsed from the report.
  Unit-Normalised data (normalised_data )
  This object contains unit normalised data for Value, Unit and range objects mentioned above. Normalisation is explained in detailed in the subsequent section. This object contains all the fields mentioned above except display_range and unit_processedsince that is verbatim and normalisation does not make sense.
  
  Normalisation process
  In order to create longitudinal lab investigation trends across lab reports across time, one needs to convert lab values and ranges to a standard unit. For every lab test, EkaCare defines a standard unit (basis highest frequency across millions of records). List of standard units for every test can be found here. Normalisation is process of multiplying values and normal ranges with a factor that converts the numerical results in the report to EkaCare standard unit for that lab test.
  
  Range-object
  Range objects contain structured low and high values of the normal range. Note that our parsers only structured low-high normal range format. Any other formats such as: normal: < 200 borderline high: 200-240 high: 240+ While this data is available in “display_range” field in non unit-normalised object as string, we do not parse and structure this kind of structure. However, EkaCare ranges in structured formats are available for someone to still interpret the results if need be.
  
  PII data
  This section outlines the structure and components of Personally Identifiable Information (PII) as provided within medical documentation. The information captured includes page number, document dates, patient details, and report specifics.
  
  Components of PII Data
  <unique_file_path>: A unique identifier representing the file path is utilized to group related PII information. Each file path is mapped to a collection of PII data for different pages in the document..
  - PageNum: Represents the page number within the document where relevant PII data is found.
  - DocumentDate: Captures the document date in Unix timestamp format for consistent time-related operations.
  Patient Details
  - Name: Verbatim representation of the patient’s name as found in the document.
  - Age: The patient’s age is detailed in years, months, and days, providing a comprehensive age identification.
  - Gender: Captures the patient’s gender, e.g., “male” or “female”.
  Report Details
  - SampleCollectionDate: (only for Lab-reports) The date and time when the sample was collected, in “dd/mm/yyyy hh:mm:ss” format.
  - SampleReceivedDate: (only for Lab-reports) The date and time when the sample was received, in “dd/mm/yyyy hh:mm:ss” format.
  - GeneratedDate: (only for Lab-reports) The report generation date and time in “dd/mm/yyyy hh:mm:ss” format.
  - Doctor: The doctor’s name, if available.
  - Facility: The name of the facility or laboratory where the test was conducted, e.g., “LalPath Labs”.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Pt-Id

string

eka user id (OID)

Path Parameters

document_id

string

required

Document ID to update the document details.

Example:

"2df9e795-d368-4ceb-be9d-b44281703827"

Response

Successful response

status

enum<string>

The current status of the request.

Available options:

queued,

inprogress,

completed,

deleted,

error

error

object[]

Show child attributes

error.code

integer

Error code.

error.message

string

Error message.

data

object

Show child attributes

data.fhir

string<byte>

Base64 encoded FHIR data.

data.output

object

Show child attributes

data.output.data

object[]

Show child attributes

data.output.data.test_name

string

Name of the test.

data.output.data.data

object

Show child attributes

data.output.data.data.value

number

Measured value of the test.

data.output.data.data.unit

string

Original unit.

data.output.data.data.unit_processed

string

Processed unit.

data.output.data.data.normal_range_report

string

JSON string of normal range as reported.

data.output.data.data.normal_range_eka

string

JSON string of normal range for Eka.

data.output.data.data.unit_eka_id

string

Eka ID for the unit.

data.output.data.data.display_range

string

Displayed range.

data.output.data.normalised_data

object

Show child attributes

data.output.data.normalised_data.value

number

Normalized value.

data.output.data.normalised_data.unit

string

Normalized unit.

data.output.data.normalised_data.normal_range_report

string

JSON string of normalized range as reported.

data.output.data.normalised_data.normal_range_eka

string

JSON string of normalized range for Eka.

data.output.data.normalised_data.unit_eka_id

string

Eka ID for the normalized unit.

data.output.data.confidence

number

Confidence level in the test data.

data.output.data.test_eka_id

string

Eka ID for the test.

data.output.data.loinc_id

string

LOINC ID of the test.

data.output.pii

object

Show child attributes

data.output.pii.{key}

object[]

Show child attributes

data.output.pii.{key}.PageNum

integer

Page number in the document.

data.output.pii.{key}.DocumentDate

integer<int64>

Epoch timestamp of the document date.

data.output.pii.{key}.Patient

object

Show child attributes

data.output.pii.{key}.Patient.Age

object

Show child attributes

data.output.pii.{key}.Patient.Age.Years

integer

Age in years.

data.output.pii.{key}.Patient.Age.Months

integer

Age in months.

data.output.pii.{key}.Patient.Age.Days

integer

Age in days.

data.output.pii.{key}.Patient.Gender

string

Gender of the patient.

data.output.pii.{key}.Patient.Name

string

Name of the patient.

data.output.pii.{key}.Report

object

Show child attributes

data.output.pii.{key}.Report.SampleCollectionDate

string<date-time>

Date and time of sample collection.

data.output.pii.{key}.Report.SampleReceivedDate

string<date-time>

Date and time the sample was received.

data.output.pii.{key}.Report.GeneratedDate

string<date-time>

Date and time the report was generated.

data.output.pii.{key}.Report.Doctor

string

Name of the doctor associated with the report.

data.output.pii.{key}.Report.Facility

string

Name of the facility generating the report.

Authorization

End-to-End Encryption

Connect

HealthAI

Medical Database

General Tools

Doctor Tool

ABDM Connect

Medical Knowledge-bases

Medical Records

User App

Lab Report

Lab test

Lab test data (value | unit | range)

Non unit-normalised data (`data` )

Unit-Normalised data (`normalised_data` )

Normalisation process

Range-object

PII data

Components of PII Data

Patient Details

Report Details

Authorizations

Headers

Path Parameters

Response

Authorization

End-to-End Encryption

Connect

HealthAI

Medical Database

General Tools

Doctor Tool

ABDM Connect

Medical Knowledge-bases

Medical Records

User App

​Lab Report

​Lab test

​Lab test data (value | unit | range)

​Non unit-normalised data (data )

​Unit-Normalised data (normalised_data )

​Normalisation process

​Range-object

​PII data

​Components of PII Data

​Patient Details

​Report Details

Authorizations

Headers

Path Parameters

Response

Lab Report

Lab test

Lab test data (value | unit | range)

Non unit-normalised data (`data` )

Unit-Normalised data (`normalised_data` )

Normalisation process

Range-object

PII data

Components of PII Data

Patient Details

Report Details