This endpoint allows you to retrieve the logo image of a healthcare institution.

Brand Logo Image

Fasten Connect

Introduction

Authentication

This endpoint will generate a state value and redirect the user to their healthcare provider Patient Portal to authenticate with the healthcare provider's EHR.

On completion, Fasten Connect will redirect the user back to your redirect_uri with an `org_connection_id` and `endpoint_id` query parameter.

If an error occurred during the authentication process, Fasten Connect will redirect the user back with an `error` and `error_description` query parameter.

<Warning>
If you have configured more than one Redirect URL in the Fasten Connect Portal, you **MUST** include the `redirect_uri` query parameter in the request.
This is done automatically by the [Stitch.js](stitch/v3/introduction) widget.
</Warning>


Initiate Connection

<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](https://build.fhir.org/ig/argonautproject/ehi-api/ehi-export.html) 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](/api-reference/ehi_export/get) 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.


Bulk Records Request

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_link`. 
Instead, the `download_link` will be sent asynchronously to a customer-defined [webhook](/webhooks/introduction). 

<Note>
We use [webhooks](/webhooks/introduction) to deliver the `download_link` 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](/webhooks/introduction) 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 Request Status

When provided with a `taskId` and `fileId`, this endpoint will return a signed URL to download the file in the `Location` header.
Your http client should be able to follow the redirect and download the file.

This signed URL will expire after a short period of time, so you should download the file immediately.
If you are unable to do so, you can request a new signed URL by calling this endpoint again.

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


Download Bulk Records

Get information about your organization. This is used to display branding information in the Stitch.js popup widget.

Get Organization

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


Get Organization Connection

Get branding & metadata information associated with healthcare institutions supported by Fasten Connect. 

<Note>
This is used to display branding information in the Stitch.js popup widget.
This API not required, unless you are building a custom widget.
</Note>

Get Catalog Entry

Search for healthcare institutions supported by Fasten Connect. 

<Note>
This is used to display branding information in the Stitch.js popup widget.
This API not required, unless you are building a custom widget.
</Note>

<Warning>
This API is rate limited and is subject to change. **Please contact support@fastenhealth.com before use.**
</Warning>

Search Catalog Brands

File a support ticket with the Fasten team using our API. 

<Note>
This endpoint is in BETA and is not recommended for production use.
We reserve the right to remove this endpoint at any time.
</Note>

<Warning>
This API is rate limited and is subject to change. **Please contact support@fastenhealth.com before use.**
</Warning>

Support Request

Use Webhooks to listen to events from Fasten Connect, rather than polling the API.

There are multiple event types that can be emitted by Fasten Connect.

Event Types

This section helps you understand different behaviors of Fasten Connect webhook delivery & provides some best practices.

Delivery

Verify webhook signatures to confirm that received events are sent from Fasten Connect

Verification

Home

Start collecting medical records in under 5 minutes

Quickstart

Learn about the latest updates to the Fasten Connect service.

Changelog

This endpoint will generate a state value and redirect the user to their healthcare provider Patient Portal to authenticate with the healthcare provider's EHR.

On completion, Fasten Connect will redirect the user back to your redirect_uri with an `org_connection_id` and `endpoint_id` query parameter.

If an error occurred during the authentication process, Fasten Connect will redirect the user back with an `error` and `error_description` query parameter.

<Warning>
This is done automatically by the [Stitch.js](stitch/introduction) widget.
</Warning>


Check the status of the EHI Export Task. If the task completed successfully, it will return a download link to download the results.

A webhook will also be sent to your `webhook_url` with metadata about the task, which is the preferred method to receive task results.

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


Documentation for the Stitch.js javascript library, containing a [WebComponent](https://www.webcomponents.org/introduction) for building Fasten Connect applications.

<fasten-stitch> is a custom element that injects our healthcare institution selector.

Quick Start

The stitch Web Component has multiple options that can be used to customize the look and feel of the component.

API Documentation

Patient Registration

Patient Bulk Records - EHI Export

Organization

Organization Connection

Catalog

Support

Brand Logo Image