Describes a document

Once you retrieve a list of all documents with their corresponding IDs, you can use this endpoint to get more details about a specific document.

GET /mr/api/v1/docs/{document_id}

Describes a document

cURL

curl --request GET \
  --url https://api.eka.care/mr/api/v1/docs/{document_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Pt-Id: <x-pt-id>'

import requests

url = "https://api.eka.care/mr/api/v1/docs/{document_id}"

headers = {
    "X-Pt-Id": "<x-pt-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Pt-Id': '<x-pt-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.eka.care/mr/api/v1/docs/{document_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eka.care/mr/api/v1/docs/{document_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Pt-Id: <x-pt-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eka.care/mr/api/v1/docs/{document_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Pt-Id", "<x-pt-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.eka.care/mr/api/v1/docs/{document_id}")
  .header("X-Pt-Id", "<x-pt-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eka.care/mr/api/v1/docs/{document_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Pt-Id"] = '<x-pt-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "source": "androidp",
  "document_date_epoch": 1614556800,
  "document_type": "lr",
  "tags": [
    "covid"
  ],
  "files": [
    {
      "asset_url": "https://sample-lab-report.s3.ap-south-1.amazonaws.com/161494290947153/2df9e795-d368-4ceb-be9d-b44281703827/0cb1277e-1c4d-42cc-acd1-9630497e4f9d.jpeg",
      "file_type": "IMG"
    },
    {
      "asset_url": "https://sample-lab-report.s3.ap-south-1.amazonaws.com/161494290947153/2df9e795-d368-4ceb-be9d-b44281703827/0cb1277e-1c4d-42cc-acd1-9630497e4f9d.pdf",
      "file_type": "PDF"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Headers

X-Pt-Id · string · required

eka user id (OID)

Path Parameters

document_id · string · required

Document ID to fetch the document details.

Example:

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

Query Parameters

p_oid · string

Include the patient identifier (p_oid) to fetch a patient's record, applicable only for EMR cases.

Response

200

application/json

Description of a document.

source · string

document_date_epoch · integer

tags · string[]

dt · enum<string>

Available options: lr, ps, ds, vc, in, iv, sc, ot

smart_report · object

Show child attributes

files · object[]

Show child attributes