v1

latestOpenAPI 3.0.1Private2026-07-2212926.5 KB
bridge

Register EHI Export request

<Note> This endpoint is idempotent. If a request with the same `org_connection_id` has already been registered, it will return the existing request. </Note>

This endpoint will register an bulk medical record export request with the Fasten Connect API for the provided org_connection_id (Patient id)

This functionality is similar in design to the HL7 EHI Export specification. However it is designed to be a unified API for all EHRs, as many EHRs do not support the HL7 EHI Export specification.

<Warning> This endpoint requires an API public id & private key for authentication. Do not expose these keys in the browser. </Warning>

This task will run asynchronously and may take some time to complete. You can check the status of the task using the Get Request Status endpoint.

On completion a webhook will be sent to your webhook_url with metadata about the task, and a download_link to download the results.

post/bridge/fhir/ehi-export

Request body

org_connection_idstring uuid

Patient Connection Id

Example request

{
  "org_connection_id": "16e39045-5382-42a0-b93d-b75268984c1f",
  "fixtures": {
    "tefca_ccda": "myra-jones.xml"
  }
}

Response

successful operation

successboolean

Example response

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