Retrieve health records

Retrieve a health record based on the given identifier, hip_id, and health_id in nrces FHIR json format.

GET /health/api/v1/fhir/retrieve

Retrieve the prased data for the upload audio file

cURL

curl --request GET \
  --url https://api.eka.care/health/api/v1/fhir/retrieve \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.eka.care/health/api/v1/fhir/retrieve"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.eka.care/health/api/v1/fhir/retrieve', 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/health/api/v1/fhir/retrieve",
  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>"
  ],
]);

$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/health/api/v1/fhir/retrieve"

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

	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/health/api/v1/fhir/retrieve")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eka.care/health/api/v1/fhir/retrieve")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "resourceType": "Bundle",
  "type": "document",
  "link": [
    {
      "url": "<string>",
      "relation": "<string>"
    }
  ],
  "entry": [
    {
      "resource": {
        "author": [
          {
            "reference": "<string>"
          }
        ],
        "date": "2023-11-07T05:31:56Z",
        "extension": [
          {
            "url": "<string>",
            "valueString": "<string>"
          }
        ],
        "id": "<string>",
        "identifier": {
          "system": "<string>",
          "value": "<string>"
        },
        "meta": {
          "lastUpdated": "2023-11-07T05:31:56Z"
        },
        "resourceType": "<string>",
        "section": [
          {
            "entry": [
              {
                "reference": "<string>"
              }
            ],
            "title": "<string>"
          }
        ],
        "status": "<string>",
        "subject": {
          "reference": "<string>"
        },
        "title": "<string>",
        "type": {
          "text": "<string>"
        }
      }
    }
  ],
  "id": "<string>",
  "meta": {
    "versionId": "<string>",
    "lastUpdated": "2023-11-07T05:31:56Z",
    "profile": [
      "<string>"
    ],
    "security": [
      {
        "code": "<string>",
        "display": "<string>",
        "system": "<string>"
      }
    ]
  },
  "identifier": {
    "system": "<string>",
    "value": "<string>"
  },
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "message": "Unauthorized"
}

{
  "resourceType": "Bundle",
  "type": "document",
  "meta": {
    "lastUpdated": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

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

Query Parameters

identifier · string · required

The unique identifier for the health record is care_context_id.

Response

200

application/json

Successful retrieval of health records.

resourceType · string

Example:

"Bundle"

type · string

Example:

"document"

link · object[]

Show child attributes

entry · object[]

Show child attributes

id · string

meta · object

Show child attributes

identifier · object

Show child attributes

timestamp · string<date-time>