Health Impacts File (HIF)
The output from HIF is used by report generator to prepare text reports. For radionuclides, health impacts are expressed as risk of developing cancer, either as total incidence, fatal incidence, or incidence of severe genetic effects. Input to impacts report generator component is provided in Primary Data Communication File, "runname".HIF. Currently the HIF has one qualifier type: "Health Impacts".
The following outline is a description of basic information provided in a HIF. This file may be modified through an API. See the Software Development Kit (SDK) for more information. An example HIF is included after outline. Comparing line-by-line description in outline to example should clarify and help locate data contained in HIF. Lines beginning with ';' are descriptive comments only and will not appear in actual HIF.
For each 'Module' producing a HIF section
A line with:
Module Name - [STRING]
Number of Lines in section - [INTEGER]
End Line
A line with:
Number of Header Lines - [INTEGER]
End Line
For each 'Header Line'
A line with:
Header information - [STRING]
End Line
Next 'Header Line'
A line with:
Number of Data Sets - [INTEGER]
End Line
For each 'Data Set'
A line with:
Data set type - [Const STRING] - "acute"/ "chronic"
File Extension - [STRING]
;If 'Data Set' is user defined then
; 'File Extension' is ""
;ElseIf 'Data Set' generated from RIF then
; 'File Extension' is passed through from RIF
;Else 'File Extension' is a valid PDCF Extension (i.e. "SCF"/ "WCF" / ...)
; The consumed PDCF's extension used to generate this data set
;EndIf
;If more than one input file was used to generate this data set then
; Separate each with a semicolon (e.g. "SCF:WCF")
;EndIf
File Qualifier - [STRING]
;If 'Data Set' is user defined then
; 'File Qualifier' is the media that exposed this data set
;ElseIf 'Data Set' generated from RIF then
; 'File Qualifier' is passed through from RIF
;Else 'File Qualifier' is a valid PDCF Qualifier for 'File Extension' (i.e. "Sediment" / "Aquifer" / ...)
; The consumed PDCF's qualifier used to generate this data set
;EndIf
;If more than one input file was used to generate this data set then
; Separate each with a semicolon (e.g. "Sediment:quifer")
;EndIf
Number of Exposure Media Points - [INTEGER]
Number of Age Groups - [INTEGER]
Number of Constituents - [INTEGER]
Number of Cancer Effect Organs - [INTEGER]
Number of Radiation Dose Effect Organs - [INTEGER]
End Line
A line with:
Names of 'Cancer Effects Organs' - [STRING]
End Line
A line with:
Names of 'Radiation Dose Effect Organs' - [STRING]
End Line
For each 'Exposure Media Point'
A line with:
X coordinate - [FLOAT]
X coordinate unit - [Const STRING] - "km"
Y coordinate - [FLOAT]
Y coordinate unit - [Const STRING] - "km"
End Line
Next 'Exposure Media Point'
For each 'Age Group'
A line with:
Starting Age - [FLOAT]
Ending Age - [FLOAT]
Age group unit - [STRING] - "yr"
End Line
For each 'Constituent'
A line with:
Constituent Name - [STRING]
Constituent ID - [STRING]
Number of Progeny - [INTEGER] - 0
; must be set to zero for 1.6+ specifications
Number of Exposure Start Times - [INTEGER]
End Line
For each 'Exposure Start Time'
A line with:
Exposure Start Time - [FLOAT]
Exposure Start Time unit - [Const STRING] - "yr"
Exposure Duration - [FLOAT]
Exposure Duration unit - [Const STRING] - "yr"
Number of Exposure Pathways - [INTEGER]
End Line
For each 'Exposure Pathway'
A line with:
Exposure Pathway Population - [FLOAT]
Exposure Pathway Name - [STRING]
;"Air" / "Indoor air" / "Ground" / "Leafy vegetables" /
;"Root vegetables" / "Fruit" / "Grain" / "Beef" /
;"Poultry" / "Milk" / "Eggs" / "Soil" / "Swimming" /
;"Boating" / "Shoreline" / "Water" / "Fish" / "Mollusks" /
;"Crustacea" / "Aquatic plants" / "Showering" / ...
Exposure Route - [Const STRING]
;"Ingestion" / "Inhalation" / "Dermal" / "External"
Exposure Risk unit - [Const STRING] - "Risk" / "HI" / "Dose"
Exposure Endpoint Type - [Const STRING]
;If 'Constituent' is not a radionuclide then
; "carcinogenic" / "noncarcinogenic"
;ElseIf 'Constituent' is a radionuclide then
; "Sv" / "cancer incidence"
; "cancer fatalities" / "cancer plus severe hereditary effects"
End Line
For each 'Exposure Media Point'
A line with:
Health Impacts - [Set of FLOAT]
;If 'Constituent' is not a radionuclide then
;If 'Exposure Risk unit' = "Risk" then
; one value for each 'Cancer Effect Organ'
;ElseIf 'Exposure Risk unit' = "HI" then
; one value for each 'Radiation Dose Effect Organ'
;ElseIf 'Constituent' is a radionuclide then
;If 'Exposure Risk unit' = "Risk" then
; one value for each 'Cancer Effect Organ'
;ElseIf 'Exposure Risk unit' = "Dose" then
; one value for each 'Radiation Dose Effect Organ'
End Line
Next 'Exposure Media Point'
Next 'Exposure Pathway'
Next 'Exposure Start Time'
Next 'Constituent'
Next 'Age Group'
Next 'Data Set'
Next 'Module'
This HIF Example was created using the case_01 test case. For testing information visit the Frames Wiki Wiki testing page.
