bridge

Get EHI Export Status/Results

Check the status of the EHI Export Task.

This is a polling endpoint intended for informational purposes only. It does not return the actual medical records or a download_links array. Instead, the download_links will be sent asynchronously to a customer-defined webhook.

<Note> We use [webhooks](/webhooks/introduction) to deliver the `download_links` because they are more reliable and scalable for background job completion. Polling this endpoint repeatedly introduces unnecessary load and latency for your system and ours. Webhooks enable instant delivery of results the moment they're ready.

If your webhook is not configured, you will not be able to retrieve the exported EHI. </Note>

<Warning> This endpoint requires an API public id & private key for authentication. Do not expose these keys in the browser. </Warning>
get/bridge/fhir/ehi-export/{taskId}

Request

  • Base URL
    https://api.connect.fastenhealth.com/v1
  • URL
    https://api.connect.fastenhealth.com/v1/bridge/fhir/ehi-export/{taskId}
  • Auth
    HTTP basic

Path parameters

taskIdstring required

Task Id

Response

successful operation

successboolean

Example response

{
  "success": true,
  "data": {
    "task_id": "c9c7a91b66b34fdca749bb8e9cfbf617",
    "status": "pending"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.