Class HealthRiskAssessmentService

A class for the Health Risk Assessment Report Controller.
https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-hra/api-docs/v1/index.html#tag/Report

Hierarchy

BaseService
- HealthRiskAssessmentService

Index

Constructors

constructor

new HealthRiskAssessmentService(baseURL: string, tokenFactory?: (() => Promise<null | string>)): HealthRiskAssessmentService
Sets the controllerName to 'Reports'.
Parameters
- baseURL: string
  
  The service's base URL
- Optional tokenFactory: (() => Promise<null | string>)
  
  Optional factory to set axios instance's token before http calls.
  - - (): Promise<null | string>
    - Returns Promise<null | string>
Returns HealthRiskAssessmentService
Overrides BaseService.constructor
- Defined in packages/traversal-core/src/Services/HRA/index.ts:14

Properties

`Protected` axios

axios: AxiosInstance

The axios instance used by this service.

Methods

getComparison

getComparison(traversalId: string, compareTraversalId: string, riskAtAge: number): Promise<AxiosResponse<any>>
Compare HRA traversals at a certain age.
https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-hra/api-docs/v1/index.html#operation/Report_Compare
Parameters
- traversalId: string
- compareTraversalId: string
- riskAtAge: number
Returns Promise<AxiosResponse<any>>
- Defined in packages/traversal-core/src/Services/HRA/index.ts:31

getHealthRisk

getHealthRisk(traversalId: string, ages: number[], conclusions: number[]): Promise<AxiosResponse<any>>
Gets health risks.
https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-hra/api-docs/v1/index.html#operation/Report_GetRisks
Parameters
- traversalId: string
  
  The HRA traversal id.
- ages: number[]
  
  Ages for which to calculate the risks.
- conclusions: number[]
  
  Asset IDs of any selected conclusions.
Returns Promise<AxiosResponse<any>>
- Defined in packages/traversal-core/src/Services/HRA/index.ts:61

getSnapShot

getSnapShot(traversalId: string): Promise<AxiosResponse<any>>
Get previous snapshots for a member.
https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-hra/api-docs/v1/index.html#operation/Report_PreviousSnapshots
Parameters
- traversalId: string
Returns Promise<AxiosResponse<any>>
- Defined in packages/traversal-core/src/Services/HRA/index.ts:23

getWellness

getWellness(traversalId: string, conclusions: number[]): Promise<AxiosResponse<any>>
Gets wellness results.
https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-hra/api-docs/v1/index.html#operation/Report_GetWellness
Parameters
- traversalId: string
  
  The HRA traversal id.
- conclusions: number[]
  
  Asset IDs of any selected conclusions.
Returns Promise<AxiosResponse<any>>
- Defined in packages/traversal-core/src/Services/HRA/index.ts:46

setBaseUrl

setBaseUrl(baseURL: string): void
Set the service's base URL e.g. /engine/ or https://api-integration.healthherotechnologies.co.uk/traversalcompositor/tenantId/
Parameters
- baseURL: string
  
  e.g. /engine/
Returns void
Inherited from BaseService.setBaseUrl
- Defined in packages/traversal-core/src/Services/BaseService.ts:49

setToken

setToken(token: null | string): void
Set the token to use in the service's axios instance
Parameters
- token: null | string
  
  Bearer token or null.
Returns void
Inherited from BaseService.setToken
- Defined in packages/traversal-core/src/Services/BaseService.ts:57

Class HealthRiskAssessmentService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

baseURL: string

Optional tokenFactory: (() => Promise<null | string>)

Returns Promise<null | string>

Returns HealthRiskAssessmentService

Properties

Protected axios

Methods

getComparison

Parameters

traversalId: string

compareTraversalId: string

riskAtAge: number

Returns Promise<AxiosResponse<any>>

getHealthRisk

Parameters

traversalId: string

ages: number[]

conclusions: number[]

Returns Promise<AxiosResponse<any>>

getSnapShot

Parameters

traversalId: string

Returns Promise<AxiosResponse<any>>

getWellness

Parameters

traversalId: string

conclusions: number[]

Returns Promise<AxiosResponse<any>>

setBaseUrl

Parameters

baseURL: string

Returns void

setToken

Parameters

token: null | string

Returns void

Settings

Member Visibility

Theme

`Optional` tokenFactory: (() => Promise<null | string>)

`Protected` axios