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>'

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"
}

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>