Skip to main content

CSV Bulk calculations specifications: HAL

This type of CSV allows to get, for each row, adjusted scores according to the hip axis length (HAL).

Adjusting FRAX hip fracture probabilities according to the hip axis length (HAL). Only available if BMD included in the FRAX calculation. These adjustments have been derived from a study in the Manitoba cohort using a GE Lunar scanner. The calculation is based on differences in measured HAL from the sex-specific mean HAL in that study (121.3mm for men, 104.7mm for women). Caution needs to be exercised when the patient is measured on other manufacturers’ devices or is not Caucasian (mean HAL may differ), or has a BMI at the extremes of the distribution (magnification errors may be introduced).

Input Variables

A CSV input file should always have 14 columns. An optional header can be sent as first line of the CSV file:

Score unit,Country,Age,Sex,BMI,Previous fracture,Parental history,Current smoker,Gluccocorticoid,Rheumatoid Arthritis,Secondary osteoporosis,Alcohol,Femoral neck BMD,HAL

The first columns are the FRAX variables:

# Col Variable Description Possible Values
1 A Score unit Unit for variable 13 t: T-score, z: Z-score. Unit for parameter 13 (BMD) described below.
2 B Country Code for country and ethnicity Integer. Get valid countries' id from the API.
3 C Age Age in years Positive real number (40-90), can have decimals. Out of bound values will be capped.
4 D Sex Gender 0: men, 1: women
5 E BMI Body Mass Index Positive real number (kg/m²), can have decimals
6 F Previous fracture History of previous fracture 0: no, 1: yes
7 G Parental history Parent(s) with hip fracture history 0: no, 1: yes
8 H Current smoker Current smoking status 0: no, 1: yes
9 I Gluccocorticoid Gluccocorticoid use 0: no, 1: yes
10 J Rheumatoid Arthritis Presence of rheumatoid arthritis 0: no, 1: yes
11 K Secondary osteoporosis Presence of secondary osteoporosis 0: no, 1: yes
12 L Alcohol More than two drinks a day 0: no, 1: yes
13 M Femoral neck BMD Bone mineral density measurement Real number (T-score or Z-score). The T-score for both genders should be derived by comparing the individual BMD to the young normal FEMALE NHANES III reference range for the make of scanner that you are using.

Then we need the adjustment variable:

# Col Variable Description Possible Values
14 N HAL Hip axis length in mm. Real positive number

Output Results

Once processed, you will receive an output file with, for each row, the results append to the original line (the variables above).

# Col Result Description
15 O HAL MOF w BMD Adjusted MOF with BMD according to hip axis length
16 P HAL Hip w BMD Adjusted HIP with BMD according to hip axis length

Output warning or error reporting

If an error for any adjustments of the row has been triggered, a specific message will be added at the end of the line.

# Col Processor messages
17 Q Warning or error messages