External Accounts Data Export Format

Updated October 02, 2024 16:41

The external accounts data export provides a snapshot of all external accounts linked to participants (e.g. healthcare providers, Fitbit, Garmin, etc.) and their status at the time of the export.

Table of Contents

Data Fields
Sample CSV Export
Sample JSON Export

Data Fields

Field	Description
`ExternalAccountID`	Integer identifier specific to the account.
`ParticipantID`	The stable, automatically generated, internal system identifier for this participant. Universally unique identifier (UUID).
`ParticipantIdentifier`	The identifier of the participant that connected the external account. Can be used to cross reference with Participants.
`Status`	The status field can contain the following values: Unauthorized: The connection credentials are incorrect (and the participant should reconnect). Error: There was an error with the most recent data fetch. FetchComplete: The most recent data fetch was successful.
`LastRefreshDate`	The timestamp for the most recent fetch of data from the account connection, in UTC.
`ProviderID`	Integer identifier specific to the provider. This data field is automatically set.
`ProviderName`	Name of the provider. This data field is automatically set.
`ProviderCategory`	Category such as Provider, Device Manufacturer, and Health Plan.
`ConnectionDate`	The timestamp for when the provider account was first connected by the participant, in UTC.
`ProviderUserID`	The external account provider’s internal identifier corresponding to this participant.

Sample CSV Export

ExternalAccountID,ParticipantID,ParticipantIdentifier,Status,LastRefreshDate,ProviderID,ProviderName,ProviderCategory,ConnectionDate,ProviderUserID
1,28596c6c-03c8-4b32-9234-231a53556936,MDH-1234,FetchComplete,2023-01-02T03:04:05,2,CareEvolutionTest,Health Plan,2023-01-02T03:04:05,6709dc13-ca3e-4969-886a-fe0889eb8256

Sample JSON Export

{
 "ExternalAccountID": 1,
 "ParticipantID": "28596c6c-03c8-4b32-9234-231a53556936",
 "ParticipantIdentifier": "MDH-1234",
 "Status": "FetchComplete",
 "LastRefreshDate": "2023-01-02T03:04:05",
 "Provider":
 {
  "ID": 2,
  "Name": "CareEvolutionTest",
  "Category": "Health Plan"
 }
"ConnectionDate": "2023-01-02T03:04:05"
"ProviderUserID": "6709dc13-ca3e-4969-886a-fe0889eb8256"
}

Was this article helpful?