Class FhiClient

Client for the FHI Statistikk open API: statistics from Norwegian health registers such as the Cause of Death Registry and the public-health profiles.

FHI suppresses or cannot compute some observations, publishing a flag symbol instead of a number. Normalized rows preserve those symbols in flag with value: null, and each result carries the provider's flag legend. Flagged cells must stay suppressed in downstream use.

Index

Methods

getSources getTableDimensions getTableMetadata getTables query queryRaw

Methods

getSources

getSources(
options?: RequestOptions,
): Promise<OpenDataResponse<HealthStatisticsSource[]>>
Lists the registers and statistics banks publishing data through the API.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<HealthStatisticsSource[]>>
- Defined in src/providers/fhi/client.ts:135

getTableDimensions

getTableDimensions(
    source: string,
    tableId: number,
    options?: RequestOptions,
): Promise<OpenDataResponse<HealthTableDimensions>>
Fetches the queryable dimensions of one table, preserving category hierarchy.
Parameters
- source: string
- tableId: number
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<HealthTableDimensions>>
- Defined in src/providers/fhi/client.ts:238

getTableMetadata

getTableMetadata(
    source: string,
    tableId: number,
    options?: RequestOptions,
): Promise<OpenDataResponse<HealthTableMetadata>>
Fetches the provider-authored descriptive documentation for one table.
Parameters
- source: string
- tableId: number
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<HealthTableMetadata>>
- Defined in src/providers/fhi/client.ts:197

getTables

getTables(
source: string,
options?: RequestOptions,
): Promise<OpenDataResponse<HealthStatisticsTable[]>>
Lists the published tables of one source.
Parameters
- source: string
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<HealthStatisticsTable[]>>
- Defined in src/providers/fhi/client.ts:165

query

query(
query: HealthStatisticsQuery,
options?: RequestOptions,
): Promise<OpenDataResponse<HealthStatisticsResult>>
Runs a validated selection query and flattens the JSON-stat2 cube into rows.
Parameters
- query: HealthStatisticsQuery
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<HealthStatisticsResult>>
- Defined in src/providers/fhi/client.ts:273

queryRaw

queryRaw(
query: HealthStatisticsQuery,
options?: RequestOptions,
): Promise<OpenDataResponse<HealthJsonStatDataset>>
Runs a validated selection query and returns FHI's JSON-stat2 dataset.
Parameters
- query: HealthStatisticsQuery
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<HealthJsonStatDataset>>
- Defined in src/providers/fhi/client.ts:289

Class FhiClient

Index

Methods

Methods

getSources

Parameters

Returns Promise<OpenDataResponse<HealthStatisticsSource[]>>

getTableDimensions

Parameters

Returns Promise<OpenDataResponse<HealthTableDimensions>>

getTableMetadata

Parameters

Returns Promise<OpenDataResponse<HealthTableMetadata>>

getTables

Parameters

Returns Promise<OpenDataResponse<HealthStatisticsTable[]>>

query

Parameters

Returns Promise<OpenDataResponse<HealthStatisticsResult>>

queryRaw

Parameters

Returns Promise<OpenDataResponse<HealthJsonStatDataset>>

Settings

On This Page