Skip to main content

Accessing Patient Data

Once a patient chooses to share their health data with your organization, you have several options to access that data.

Data Delivery (Push)​

HealthEx supports having patient data "pushed" to your organization whenever a patient shares or updates their data. In this model, you are responsible for storing the patient data long-term within your organization's boundaries, and can access that data whenever you need to.

Data can be delivered through two mechanisms:

Amazon S3 Bucket​

Patient data can be uploaded to an Amazon S3 bucket of your choosing, within an AWS account that you control.

To set up this integration, you will need:

  • The S3 bucket name
  • The ARN of an IAM role in your account with write access to that bucket
  • The path within the bucket that you would like the data uploaded to. The path can be parameterized with variables listed below.

IAM Role Setup: The IAM role that you specify will need to created or configured to allow HealthEx perform the upload:

  • We recommend you create a new dedicated role for best security.
  • You should ensure your role has permission to write to the target bucket.
  • You will have to grant HealthEx the ability to assume this role. You should configure a trust policy that allows your role to be assumed by another IAM role, owned by HealthEx, with the ARN arn:aws:iam::549768250936:role/demo-us-west-2-backend-external-data-delivery-role.

SFTP Server​

Patient data can be uploaded to any SFTP server that you control.

To set up this integration, you will need:

  • SFTP Host
  • Port, if nonstandard
  • Username
  • Password
  • The path on the server that you would like the data uploaded to. The path can be parameterized with variables listed below.

Reference: Path Variables​

  • orgId - the unique ID of your organization in HealthEx
  • projectId - the unique ID of your HealthEx project
  • referenceId - the unique ID HealthEx has assigned the patient for your project
  • externalId - a unique ID that you have assigned the patient through our Add Patient API or a unique link
  • retrievalId - a unique ID representing this data retrieval. This will change every time the patient updates their data
  • dataType - the format type of the data, ccda or fhir
  • timestamp - the time that the data was delivered at

Data Query (Pull)​

HealthEx also supports your organization fetching data on-demand. In this model, you do not need to store patient data long-term, but rather call our APIs whenever you need a part of the patient's data.

HealthEx MCP Server​

HealthEx's Model Context Protocol server brings HealthEx directly into any AI agent workflow by implementing the MCP standard.

See the documentation for our MCP server

HealthEx FHIR APIs​

HealthEx's FHIR APIs allow you to fetch a patient's health data across a broad range of supported FHIR resource types.

See the documentation for our FHIR Server