Skip to main content

​
patient.ehi_export_success

{
    "download_links": [{
      "url": "https://api.connect.fastenhealth.com/v1/bridge/fhir/ehi-export/fedec7b7-8cf6-4bc9-72032b426473/download/2024-06-12-6715-4ae4-bde5-ab97519bd1fa.jsonl",
      "export_type": "jsonl",
      "content_type": "application/fhir+ndjson"
    }],
    "org_connection_id": "189484f4-1234-1234-1234-78a8caa3b64a",
    "task_id": "fedec7b78cf6905872032b426473",
    "org_id": "592c0579-443f-a94e-4c8847c0c066",
    "stats": {
      "total_resources": 12
    }
}
​
download_links
object[]
required
This is a an array containing a URL to download the medical records that Fasten has collected for the Patient. Your http client should be able to follow the redirect and download the file.By default, this will be a JSONL(NDJSON) file containing FHIR resources in newline-delimited format (each line is a independent JSON object). The array will only contain one entry by default, but you may enable multiple formats by contacting Fasten support.
​
stats
object
required
This is an object containing statistics about the resources processed and collected by Fasten.

​
patient.ehi_export_failed

{
    "failure_reason": "suppressed_please_contact",
    "org_connection_id": "189484f4-1234-1234-1234-78a8caa3b64a",
    "task_id": "fedec7b78cf6905872032b426473",
    "org_id": "592c0579-443f-a94e-4c8847c0c066"
}
​
failure_reason
string
required
Failure reason for the EHI export. This is a enum that describes the failure. The possible values are:
  • token_refresh_failure: An error is encountered while trying to refresh the Access Token.
  • scope_patient_missing: The Access Token does not have the required patient/*.read or patient/Patient.read scope. This is usually due to the patient unchecking the “Demographics” permission during the Consent flow.
  • resource_patient_failure: An error occurred while trying to fetch a patient resource. This is unusual because the token (likely) refreshed successfully.
  • resource_invalid_content: Parsing issue in a critical FHIR resource
  • suppressed_please_contact: The error was suppressed, as it may contain PII or PHI. This is the default value for failure_reason. Please contact Fasten support for more information.

​
webhook.test

{
    "hello": "world",
    "random": "txpsdf923jksdfl93"
}

​
patient.connection_success (beta)

This event is emitted when the patient has successfully connected to the health system and the popup window has closed. Failures are not yet available as a webhook event.
This event type is in beta, and is not yet available by default. It is subject to change as we add support for TEFCA IAS and other standards. You may enable this event in the Fasten Connect dashboard by toggling the “patient.connection_success” option for your webhook.
{
    "org_connection_id": "",
    "endpoint_id": "",
    "brand_id": "",
    "portal_id": "",
    "connection_status": "",
    "platform_type": "",
    "request_id": "",
    "external_id": "",
}
​
org_connection_id
string
required
Organization Connection Id is a unique identifier for the connection between the patient and the organization. You must store this value in your system to identify the patient in future API calls.
​
endpoint_id
string
required
Endpoint Id is a unique identifier for the endpoint that the patient has connected to. This value can be used to retrieve metadata about the endpoint (e.g. name, description, endpoint url information, etc.)
​
portal_id
string
required
Portal Id is a unique identifier for the Portal that the patient has connected to. This value can be used to retrieve branding information about the institution
​
brand_id
string
required
Brand Id is a unique identifier for the Brand that the patient has connected to. This value can be used to retrieve branding information about the institution
​
connection_status
string
required
The status of the connection. Possible values are authorized, rejected.
​
platform_type
string
required
An identifier for the EHR type associated with the connected endpoint.
​
request-id
string
An correlation id. This should be sent with any support ticket queries to the Fasten Connect support team.
​
external_id
string
(Optional) An Opaque identifier, used to identify the patient in your system. This value will be only be returned if it was previously provided to the stitch html element.
​
external_state
string
required
Usually a generated identifier, can use it to identify unique connection attempts.

​
patient.authorization_revoked (beta)

This event is emitted when the patient consent has been revoked or expired. Fasten connect will refresh patient tokens on a regular basis, and if the refresh fails due to revoked or expired consent, this event will be emitted. Your system should be prepared to handle multiple revocation events in a short period of time, as Fasten may revoke connections in bulk for multiple patients at once.
This event type is in beta, and is not available by default. It is subject to change as we add support for TEFCA IAS and other standards. You may enable this event in the Fasten Connect dashboard by toggling the “patient.authorization_revoked” option for your webhook.
{
    "org_connection_id": "",
    "endpoint_id": "",
    "portal_id": "",
    "brand_id": "",
    "platform_type": "",
    "connection_status": ""
}
​
org_connection_id
string
required
Organization Connection Id is a unique identifier for the connection between the patient and the organization. You must store this value in your system to identify the patient in future API calls.
​
endpoint_id
string
Endpoint Id is a unique identifier for the endpoint that the patient has connected to. This value can be used to retrieve metadata about the endpoint (e.g. name, description, endpoint url information, etc.)
​
portal_id
string
Portal Id is a unique identifier for the Portal that the patient has connected to. This value can be used to retrieve branding information about the institution
​
brand_id
string
Brand Id is a unique identifier for the Brand that the patient has connected to. This value can be used to retrieve branding information about the institution
​
platform_type
string
required
An identifier for the EHR type associated with the connected endpoint.
​
connection_status
string
required
The status of the connection. Will always be revoked.

​
patient.request_health_system

This event is emitted when a patient initiates a request to add a missing health system. 
{
  "email": "john.doe@example.com",
  "name": "My Health System",
  "website": "https://www.examplehealthsystem.com",
  "street_address": "123 Main St, Anytown, USA"

}
​
email
string
required
The email address provided by the patient to contact them about their request.
​
name
string
required
The name of the health system requested by the patient.
​
website
string
The website URL of the health system requested by the patient.
​
street_address
string
The street address of the health system requested by the patient.

​
patient.request_support (beta)

This event is emitted when a patient requests support during the connection process 
{
  "email": "john.doe@example.com",
  "name": "My Health System",
  "body": "(patient message & request metadata, subject to change) I need help with..."
}
​
email
string
required
The email address provided by the patient to contact them about their support request.
​
name
string
The name of the health system the patient was trying to connect to when they requested support.
​
body
string
required
The body of the support request, containing the patient’s message and any relevant metadata. The format of this data is arbitrary and subject to change.Warning: This field may contain Personally Identifiable Information (PII) or Protected Health Information (PHI). Handle with care and in accordance with applicable regulations & your security policy.