Connection Manager for data source connections and OAuth management
Connection Manager for data source connections and OAuth management. Provides methods for managing connections to healthcare providers and data sources.
Methods
getMemberConnections()
getMemberConnections():
Promise<BWellQueryResult<MemberConnection[],BaseManagerError>>
Retrieves a list of MemberConnections resources from a FHIR server. There are no parameters and no request object for this method.
Returns
Promise<BWellQueryResult<MemberConnection[], BaseManagerError>>
A promise resolving to an object representing the list of MemberConnections resources retrieved, along with potential validation or GraphQL errors.
getDataSource()
getDataSource(
request):Promise<BWellQueryResult<DataSource,BaseManagerError>>
Retrieves a data source by ID. Gets information about a specific healthcare provider connection.
Parameters
request
Returns
Promise<BWellQueryResult<DataSource, BaseManagerError>>
Example
const dataSource = await sdk.connection.getDataSource(
new DataSourceRequest({
connectionId: 'epic-123'
})
);createConnection()
createConnection(
request):Promise<BWellTransactionResult<Connection,BaseManagerError>>
Creates a new connection to a healthcare provider. Establishes a connection to retrieve health data.
Parameters
request
Returns
Promise<BWellTransactionResult<Connection, BaseManagerError>>
Example
await sdk.connection.createConnection(
new ConnectionRequest({
connectionId: 'epic-123',
username: 'user',
password: 'pass'
})
);disconnectConnection()
disconnectConnection(
request):Promise<BWellTransactionResult<ConnectionStatus,BaseManagerError>>
Disconnects an existing connection. Stops data synchronization but preserves existing data.
Parameters
request
Returns
Promise<BWellTransactionResult<ConnectionStatus, BaseManagerError>>
Example
await sdk.connection.disconnectConnection(
new DataSourceRequest({
connectionId: 'epic-123'
})
);deleteConnection()
deleteConnection(
request):Promise<BWellTransactionResult<ConnectionStatus,BaseManagerError>>
Permanently deletes a connection. Removes the connection and all associated data.
Parameters
request
Returns
Promise<BWellTransactionResult<ConnectionStatus, BaseManagerError>>
Example
await sdk.connection.deleteConnection(
new DataSourceRequest({
connectionId: 'epic-123'
})
);getOauthUrl()
getOauthUrl(
request):Promise<BWellQueryResult<OAuthUrl,BaseManagerError>>
Retrieves OAuth URL for connection setup. Gets the authorization URL for OAuth-based connections.
Parameters
request
Returns
Promise<BWellQueryResult<OAuthUrl, BaseManagerError>>
Example
const oauthUrl = await sdk.connection.getOauthUrl(
new DataSourceRequest({
connectionId: 'epic-123'
})
);