General User Application Manual
HAWK stands for Health and Wildlife Knowledge database, and it is a user-friendly web-based database designed to manage wildlife health data. Data in HAWK are structured following a versatile data model created by the Data Task Force within the Wildlife Health Intelligence Network (WHIN), a global community of practice for growing wildlife health surveillance. HAWK can effectively manage data generated by wildlife health surveillance systems, research, and public initiatives under one structure. Examples include typical morbidity/mortality investigations, opportunistic findings such as reports of dead animals by the public or in social media; testing of samples from captured, marked, and recaptured animals; multilevel study designs; and transect survey observations among others. HAWK is developed and maintained by Wildlife Conservation Society’s Health and Conservation Technology Programs, based in Bronx, New York, United States.
In this manual, we Capitalize and bold nouns such as Projects, Surveillance Activities, Field Visits, Locations, Collections, Events, Sources, and Specimens when they refer to specific HAWK data units.
This manual focuses on general user functions. To learn more about administrator account, refer to the “HAWK Administrator Account Manual” (under construction).
If a specific section or explanation is missing in this manual, plese contact dmontecino@wcs.org
Structure of the health data in HAWK and data units
This manual provides a summary of the data structure in HAWK For a full description, visit the website describing the data model link. Briefly, HAWK has “data units”: Project, Surveillance Activity, Field Visit, Location, Collection, Event, Source, Source Record, Specimen, Diagnostic, Result, Interpretation, Necropsy, Shipment, and Storage. Projects identify a specific Project leader and information. Under Projects are Surveillance Activities that are executed following a methodology documented in a standard metadata format. Surveillance Activities are conducted through Field Visits that encompass a period during which Locations (i.e. study sites) are surveyed. These Locations contain Events, epidemiological units with a spatiotemporal coordinate that can contain four types of Sources: group of animals of the same taxon (Group), individual animals (Animal), arthropods population at a site (Arthropod), or a site where environmental measurements or specimens can be sampled from (i.e., water or feces; Environmental). Sources at time t are Source Records. The Events can be found, observed, or accomplished through a Collection that involves an effort to obtain data.
Units in HAWK can be grouped in temporal and spatial clusters when needed using tags. What a Location, Event, and other data units represent must be documented and consistently applied within each Surveillance Activity.
The four types of Sources can provide Specimens cross-sectionally or longitudinally. Necropsy of animal carcasses can be documented. Live or dead Group Source Records, Animal Source Records, Environmental Source Records, and Specimens can be tested for health metircs using Diagnostics i.e. pathogens, fracture, heavy metals, or cardiomegaly. Diagnostics can be conducted in a Laboratory or in the field. Each Diagnostic can have one or multiple Results (one per health metric). Results, Specimens, and Sources receive an Interpretation for health metrics measured following documented case definitions. The data model also supports the administration of Specimens or carcass storage or and shipments.
For a detailed explanations of the data units visit the HAWK data model manual link.
We encourage a modular approach for each system implementing HAWK, starting with the foundational frame and only adding additional components as needed.
General User
General User accounts belong to specific individuals. General Users are granted data view, edit, delete, and export permissions from Projects to Interpretations per Surveillance Activity within the Organization, by Organization Administrators. *
General Users must be granted access to an Organization; however, the same General User can be accepted in several Organizations
General Users Navigating HAWK
Logging in to the Web-based User Interface (under construction)
Organization Administrators and approved General Users access HAWK by opening this link on a Chrome web browser and providing their username and password. HAWK software is optimized for Chrome and may not work properly on other browsers:
Initial Screen
Once successfully logged on, the Graphical User Interface (GUI) appears. The GUI has two panels that are always available. On the left side of the screen is the Navigation Panel (red frame in the image below). On the right side is the Workspace (green frame in the image below):
The Navigation Panel shows all the Organizations that a user has access to. The relative size of the Navigation and Workspace Panels can be adjusted by selecting the divider bar separating the two panels (red frame in the figure below) and dragging it to the left or right. Compare the two images below:
Horizontal and vertical scroll bars appear to aid independent navigation of the Navigation and Workspace Panels.
The Navigation Panel
The Navigation Panel has a tree hierarchy. This tree begins with a display of the Organizations to which an individual has access. Within, each Organization has a Projects folder that contains the Projects belonging to the corresponding Organization. Each Project contains a Surveillance Activity folder that contains the Surveillance Activities of each Project. The tree continues with each Surveillance Activity containing a Field Visits folder, each Field Visit containing a Locations folder, a Collection Track, Collection Area, Collection Point, and Collection No Effort folders under the Location folder, an Event folder nested in each Collection, etc. following the structure explained above.
The number in parenthesis at the right of each folder name indicates the number of data units included. For example, “Projects (2)” label indicates that the “Projects” folder contains two Project units (see image below). The “+” icon to the right of each folder in the Navigation Panel indicates that the contents of the folder are not displayed. To open the content of a folder, select the folder icon. Once a folder is opened, the “+” icon switches to a “-“ icon, and the contents are displayed:
Similarly, to reveal folders under a specific data unit, select the “+” icon. The icon switches to a “-“ icon and contents are displayed:
On selection of a data unit within any folder in the Navigation Panel, the “Details”, “Files”, and “Map & Tabular Data” tabs are displayed in the Workspace Panel.
The Workspace Panel
The Workspace Panel has the buttons “Save changes” and “Cancel” on the top left. These buttons are always displayed and are inactive or active depending on the addition or modification of data units.
The button “Save changes” is grey when inactive and blue when active. The “Cancel” button is grey when inactive and dark grey when active. These buttons are inactive by default but become active when:
- A field of an existing data unit is modified, or a new file is added to an existing data unit (see “Manipulating Data to HAWK” section below). Compare the red frame in the two images below showing the switch from inactive to active buttons. The first image shows a saved data unit as currently stored with inactive buttons:
In the second image below, field 2 has been modified and the buttons are now active:
- A new data unit is being created but not saved yet (see “Manipulating Data to HAWK” section below). Although the “Save changes” button is active, an error message will appear if mandatory fields are not completed:
The Workspace Panel also has an “Archive” button on the top right. This button is only displayed when working on existing data units. This button is active (red) when:
- An existing data unit is opened, and it has not been modified (no edition of any field or addition or removal of files):
This button is inactive (grey) when an existing data unit has been modified but these changes have not yet been saved:
The “Archive” button does not appear when a new data unit is being created.
The Workspace Panel’s three tabs: “Details”, “Files” and “Map & Tabular Data” are described in the next sections.
The Workspace Panel - Details Tab
The “Details” tab (red frame below) contains the variables that characterize each data unit. Existing data units contain filled fields whereas new unit fields will be blank:
Users navigate across this tab by scrolling up and down. The fields are editable (active) or not. Non-active fields are grey and cannot be editable (read-only). Read only fields may occur when a user does not have edit permission or when only a single option can apply for a specific unit (i.e., environmental Specimens can only be collected from the field). See “Mandatory and Conditional Fields” below). Fields are logically ordered; the order is retained even as the Workspace Panel is modified. Compare the two images below:
The Workspace Panel - Files Tab
The “Files” tab receives and stores files associated with the selected data unit. HAWK supports many file extensions (e.g. images, pictures, videos, pdf, docx, xlsx, csv, json, shp, etc). When files have been added to a data unit, the “Files” tab lists them in the “Uploaded Files” area (blue solid frame in the image below). The “Drop the Files to Upload” area attaches files (green frame in the image below) to the selected data unit (see “Adding a New Data Unit” section below).
The “Preview” tool displays a file (black frame in the image below) selected from the list of uploaded files. When no files are associated with the data unit, the “Uploaded Files” area and the “Preview” tool are not displayed.
The relative size of the “Uploaded Files” and “Preview” tool can be modified by selecting and dragging the bar separating them to the left or right. Compare the two images below:
The Workspace Panel - Map & Tabular Data Tab
The “Map & Tabular Data” tab displays a data unit’s spatial data (black frame in the image below) and tabular information with the relationships with the corresponding parent and children data units:
For a Project, the Map shows all Events across its Surveillance Activities, while the table shows the Project ID and the corresponding Surveillance Activity IDs. The tabular data at the Specimens level include the IDs of its parents. It also shows the Specimen ID and its children, Diagnostics ID.
The data displayed in this tab cannot be directly modified. The content of the “Map & Tabular Data” changes based on the data unit’s content in the “Details” tabs.
System and User-Provided Identifiers
Data units in HAWK, from Organization to Interpretation, have at least one identifier. All data units receive an “ID”, a system-based identifier unique for each data unit. This field is automatically assigned by the database once a data unit is saved. “Code” fields (i.e., Surveillance Activity Code) are user-provided identifiers for those data units. “Name” fields are a third type of identifiers for specific data units (see online Data Dictionary) that receive a user-provided name for a data unit (i.e., “Field Activity Name”).
Field Definitions
In addition to the data model dictionary, the definition of each field can be found in the GUI. To view the definition, select the “i” or information icon that appears to the right of each field header:
Data Types for Fields in HAWK
HAWK supports different data types for fields. This allows HAWK to accommodate the wide range of variables associated with wildlife health surveillance.
Integer
These fields require an integer number and they are entered directly. For example, the number individuals observed in a Group Source in a specific demographic category:
Floating
These fields expect a integer or non-integer number. The value must be entered directly. For example, the longitud and latitude in decimal degrees:
Date
These fields require a date. The date can be entered directly using the mm/dd/yyyy format. Alternatively, the date can be entered using the calendar icon to the right of the field. For example, the “Start Date” of a Project:
After selecting the calendar icon, a calendar appears. The left and right arrows (blue frame in the image above) change the month sequentially backward and forward in time, respectively. The down arrows (red frame in the image above) help select a specific month and year. The home icon (green frame in the image above) resets the calendar to the current date. Enter the specific date by navigating to the correct month, year, and date and selecting it (black frame in the image above). The application will display an error message when the month value is larger than 12 and when the day value exceeds the possible number for the corresponding month (i.e., February 30th).
Boolean
These fields request a “Yes” or “No” answer. For example, the field “Project Group Source” in Project
Single-choice List
These fields are completed by selecting one response from a list of fixed options. These fields have a down-arrow on the right that when selected open a list of options. Select a response from the list using the cursor. Alternatively, you can type a specific option, and the list will narrow to match what you’ve entered. For example, the “Project Leading Organization” field in Project:
When the list is large, the options may not be automatically displayed. In this case, start typing your option.
Multi-choice List
These fields accommodate one or more responses from a list of fixed options. These fields have a down arrow icon on the right. After selecting that icon, a list of options appears. One or more responses can be selected using the cursor. For example, the “Project Funder Organization” field of Project (the red frame indicates the up and down arrow):
When the list is large, the options may not be automatically displayed. In this case, start typing your option.
Text
These fields are text boxes and are used for long-form or free text written response. For example, the “Surveillance Activity Purpose” field of Surveillance Activities:
Active, Conditional, and Mandatory Fields in HAWK
Active Fields
Fields in the “Details” tab that can be edited are active. Not active or read-only fields are grey in color. This may be the case if a user does not have edit permission, because only one answer applies and selection is not available, or because the system shows relevant information (e.g., fixed diagnostic test parameters). For example, the “Key URL” and “Key Citation” parameters for the diagnostic name “Minion Mk1D”.
Conditional Fields
Some fields are not displayed until previous fields are answered or receive a specific response. These Conditional fields minimize data entry by only requesting the additional specific details when required (i.e., the field “Animal Toxins” in Project is available when the “Animal Toxin” option is added in field “Chemical Toxins”. Compare the two images below:
Mandatory Fields
Mandatory fields are indicated with an asterisk. For example the field “Project Name” in Projecct:
Active Mandatory fields must be completed to save changes to the data.
Adding Data in HAWK
Adding a New Data Unit
The addition of data to HAWK follows the same process across all data units. To add data units:
Navigate to the data unit folder where are a new unit is to be added
Select its folder icon and a green “+ Add [data unit name]” button will appear in the top left corner of the Navigation Panel (i.e., “Add Project”):
- Select the button and a “New Record” with the three fixed tabs: “Details”, “Files”, and “Map and Tabular data” appears in the Workspace Panel. The “Details” tab is first by default (see red frame in the image below). As the data unit is new, all the fields in this tab are empty:
Once the mandatory fields are completed, the new data unit can be saved by selecting “Save Changes”, located in the top left of the Workspace Panel:
Adding a new data unit requires completion of the mandatory fields. Non-mandatory fields can be completed, and files can be added (see next section) after the creation of the data unit, during the creation of the data unit, or not added at all.
Active fields that are being completed or edited are highlighted with a blue frame. Compare the fields in the images below:
Adding Files to a Data Unit
To add files to a data unit:
- Navigate to the “Files” tab by selecting the “Files” button of the Workspace Panel. Initially, the “Files” tab will only show a “Drop the Files to Upload” box bordered with a light-blue dashed contour (red frame in the image below):
- Upon moving the cursor to the “Drop the Files to Upload” the area will turn light blue. Select anywhere in the box, an explorer window to browse files on the computer will open:
- Select the file to upload followed by the “Open” button of the explorer window. A list will appear with the new file(s) uploaded displayed directly below the “Drop the Files to Upload” box. These files are not yet saved in HAWK but are rather queued for the user to confirm they are the correct files before saving:
Alternatively, drag the files to upload from your computer and drop them in the “Drop the files to Upload” area.
- To save the files, select the “Save changes” button in the upper left corner of the Workspace Panel. The list of the uploaded files attached to the data unit is displayed to the left of the Workspace Panel (the “Upload Files” area). Once one or more files are saved to a data unit the “Preview” tool will appear to the right of the Workspace Panel. A selected file (“Upload Files” area in the red frame on the image below) that has a compatible extension will appear in the “Preview” tool. The selected file will have a darker grey file name than others is the list.
- The “Save changes” button is inactive (grey) when all files are saved. Add new or additional files to any data unit following the steps provided above.
Adding a New Project to an Organization
To add a new Project to an Organization, navigate to the Project folder under the corresponding Organization, select the folder and then click “Add Project” button in the top left corner of the Navigation Panel. Complete the mandatory fields in the Workspace Panel and select the “Save Changes” button. The definition of each field is provided in the online Data Dictionary here or by hovering over the “i” icon to the right of the field names in the “Details” tab.
Selecting Surveillance Targets for the Project
The selection of surveillance targets at the Project-level depends on the fields “Project Type”, “Biological Hazards”, “Chemical Hazards”, “Physical Hazards”, and “Physiological Hazards”.
Selecting “General Surveillance” or “Outbreak Investigation” for “Project Type” does not allow to select specific targets to track and the fields “Biological”, “Chemical”, “Physical”, and “Physiological Hazards” are automatically completed with the option “Not specific [Biological, Chemical, Physical, Physiological] target”:
Selecting “Targeted Surveillance” or “Outbreak Investigation” for “Project Type” allows to select specific targets to track, therefore, the fields “Biological”, “Chemical”, “Physical”, and “Physiological Hazards” are open to select one or multiple options. The options include “No [Biological, Chemical, Physical, Physiological] Hazard” when the Project does not include a specific category of hazards (see image below); “Any [Biological, Chemical, Physical, Physiological] Hazard”, when there is not a specific type of target to track within the general categories (e.g., metagenomics could sequence and detect the nucleic acids of any species); and specific subcategories displayed depending on other options selected. For example, it is possible to select “Virus” for “Biological Hazards” which will display a new field “Virus”. Then, a specific virus species to track can be recorded:
To track “viruses” in general, select “Virus” under “Biological Hazards” and “Any virus” under “Virus”:
Multiple options can be selected for the fields “Biological”, “Chemical”, “Physical”, and “Physiological Hazards” and the corresponding conditional fields (e.g., multiple specific viral species can be added in the “Virus” field).
The target(s) selected at the Project level determine the target choices available for the nested Surveillance Activities. So the selection of “Not [Chemical, Physical, Physiological] Hazard” for “Chemical”, “Physical”, “Physiological Hazard” fields at the Project level; selection of “Bacteria” for Biological Hazard”; and selection of “Any Bacteria” in the “Bacteria” leaves “Any Bacteria” as the only choice for the Surveillance Activity units (see “Selecting targets for the Surveillance Activity” below).
Adding a New Surveillance Activity to a Project
To add a new Surveillance Activity to a Project, navigate to the Surveillance Activity folder under the corresponding Project, select the folder and then click on the “Add Surveillance Activity” button on the top left corner of the Navigation Panel. The addition of a Surveillance Activity is the most time–consuming step of data entry. These fields are also the most important because they document the methods employed to conduct the activity, including Source-specific metadata.
The addition of a Surveillance Activity is broken into two parts. A “Metadata” folder and a field data section that starts with a “Field Visit” folder. The first folder requests information about the methods to obtain field data, diagnostics used, and case definitions (under construction).
The answers provided in the Surveillance Activity determined the fields or options available within the Surveillance Activity and the folders, fields, or options of its nested units (Field Visits, Locations, etc). For example, if the answer to “…” is “No”, then it is not possible to add “Environmental Sources” to the Surveillance Activity. Similarly, it is only possible to track those targets reported in Surveillance Activity (see below).
Selecting targets for the Surveillance Activity
The surveillance targets at the Surveillance Activity-level depends on the target(s) selected in the parent Project and the choice for the “Surveillance Activity Type” field in the Surveillance Activity unit. The options for “Surveillance Activity Type” depend on the choice(s) selected for “Project Type” field in the parent Project unit. If “Project Type” only includes “Targeted Surveillance”, then the only option available for “Surveillance Activity Type” is “Targeted Surveillance”.
Selecting “General Surveillance” or “Outbreak Investigation” for “Surveillance Activity Type” does not allow to select specific targets tracked and the field “Surveillance Activity Hazard Names” shows the options “Any Biological Hazard”, “Any Chemical Hazard”, “Any Physical Hazard”, and “Any Physiological Hazard”. The selection(s) should reflect the broad categories of targets to be tracked.
Selecting “Targeted Surveillance” or “Outbreak Investigation” for “Surveillance Activity Type” allows to select specific target(s) to track. The field “Surveillance Activity Hazard Names” will contain a list based on the selections at the Project level. For example, the option “Any virus” should be selected if any virus is targeted during a Surveillance Activity:
Multiple options can be selected for the field “Surveillance Activity Hazard Names”.
The target(s) selected at the Surveillance Activity level determine the target choices available for the nested Interpretation units.
Adding a New Field Visit to a Surveillance Activity
To add a new Field Visit to a Surveillance Activity, follow the instructions in “Adding a New Data Unit”.
Adding a New Location to a Field Visit
To add a new Location to a Field Visit, follow the instructions in “Adding a New Data Unit”.
Adding an New Collection to a Location
Collections are added to Locations when there is an “effort” to collect Events. A Collection includes a spatial effort (i.e., track like a transect, areal like the exploration of a beach looking for dead birds, or point like a camera trap or a mist net), and a temporal effort (i.e., the time conducting the spatial effort).
Opportunistic findings do not have an effort and the associated Events should be added to the folder “Collection No Effort”. The Collection types available to add are those reported in the Surveillance Activity. Areal, track, and point Collections have a start and an end date.
For more details, refer to the Data Model Manual here.
Adding an New Event to a Collection
The Event data contains the spatial and temporal coordinates. Coordinates can be entered in decimal degrees; degrees, minutes, and seconds; or Universal Transverse Mercator. The coordinate system selected will determine what spatial coordinate information is required. For degrees, minutes, and seconds:
For decimal degrees:
For Universal Transverse Mercator:
The database documents the original coordinate system and automatically converts to other coordinate systems.
The field “Event Coordinate Source” documents the accuracy of the spatial coordinates. For example, if the coordinates were obtained with a GPS device, calculated based on the distance to a site with known coordinates, or estimated by pointing a site in a digital map and recovering the coordinates returned by the digital map (i.e., Google Earth):
Adding Source Records to an Event
To add a Source Record to an Event, it is necessary to choose the right folder type under the Event. The set of fields to complete for each Source Record is different. For Group Source Records, the number of individuals per species, life status, sex, and age is completed using a pop-up window that adds rows to a table informing the total number of individuals in the Source Record:
For Animal Source Records, fields request information to complete specific information regarding vaccinations, data of a dead animal, and what is the fate of the carcass in those cases:
For Environmental Source Records fields are meant to request data on the current visit to the Environmental Source.
For Arthropod Source Records the fields include the number of individuals per species, life status, sex, and condition. This information is completed using a pop-up window that adds rows to a table informing the total number of individuals. Click the “Add to the Arthropod Source Record” button:
When the Collection containing an Arthropod Source Record does not require effort (not Track, Area, or Point Collection), the information regarding the retrieval of arthropods in the Arthropod Source Record is requested. For Arthropod Source Record under Track, Area, or Point Collection, that information can be inferred from the spatial effort reported (e.g., C02 trap).
Adding a Necropsy to an Animal Source Record
A Necropsy can be added only to Animal Source Records. Just like with other units, to add a Necropsy the user needs to identify the “Necropsy” folder under the Animal Source Record receiving the necropsy data. Fields in the Necropsy unit include open text boxes per body system, condition of the carcass at necropsy, where the necropsy was conducted, and if the necropsy is full or partial, among others.
More than one Necropsy can be added to each Animal Source Record in case a partial necropsy, a general necropsy, or a secondary necropsy are conducted on the same individual.
Adding Specimens to a Source Record
Specimens are used for Diagnostics. Specimens originate from sampling a Group Source Record, an Animal Source Record, and an Environmental Source Record, and from the arthropods in an Arthropod Source Record.
In HAWK, Specimens originating directly from a Source Record are added in the folder “Specimens”.
Specimens’ characteristics include the tissue type, the quantity, the medium, and field storage.
Specimens belonging to an Environmental Source Record linked to a Collection without effort (not Track, Area, or Point Collection), require information regarding their retrieval (Environmental Source Record is a site at time t and, therefore, it is not retrievable). For Environmental Source Record under Track, Area, or Point Collection, that information for the corresponding Specimens can be inferred from the spatial effort reported (e.g., device to obtain particles from the air at the Environmental Source).
–>
Adding Diagnostics to a Specimen
To add a Diagnostic to a Specimen, navigate and select the “Diagnostic” folder under the “Specimen” folder and then click “Add Diagnostic” in the top left corner of the Navigation Panel. Complete the mandatory fields in the Workspace Panel and select the “Save Changes” button. Diagnostic information includes the type of diagnostic and based on this selection there is a subset of specific diagnostic names. Moreover, certain diagnostic names will reveal diagnostic-specific parameters (e.g., metrics of the sequencing process completed through metagenomics techniques). Diagnostics names also reveal read-only information. For example, key citations for the diagnostic name.
Adding Diagnostics to a Group, Animal, or Environmental Source Record
A Diagnostic can be added directly to a Group Source Record, to an Animal Source Record, and to an Environmental Source Record. A group of frogs can be tested together, an individual can undergo an MRI or a clinical examination, and turbidity can be measure in the water at an Envronmental Source Record. To add a Diagnostic navigate to the “Diagnostics” folder linked to the Source Record directly, select the folder and then click “Add Diagnostic” in the top left corner of the Navigation Panel. Complete the mandatory fields in the Workspace Panel and select the “Save Changes” button.
Just like with the Diagnostics for Specimens, Diagnostic information includes the type of diagnostic and based on this selection there is a subset of specific diagnostic names. Moreover, certain diagnostic names will reveal diagnostic-specific parameters (e.g., mode used in ultrasound diagnostic). Diagnostics names also reveal read-only information. For example, key citations for the diagnostic name.
Adding a Result to a Diagnostic
To add a Result to a Diagnostic navigate to the “Results” folder linked to the Diagnostic, select the folder and then click “Add Result” in the top left corner of the Navigation Panel. Complete the mandatory fields in the Workspace Panel and select the “Save Changes” button.
Each Result reports an outcome of the parent Diagnostic test for one specific target. The hazard choices available are specific based on the selection of “Diagnostic Name” in the parent Diagnostic. A Result can request specific information associated with the target detection. For example, the gene holding the nucleic acids amplified by a specific PCR assay. The Result request the unit of the diagnostic outcome (e.g., ct curve) and the value of the outcome.
Uploading a file to support the output of a Result is best practice and strongly encouraged. For example, an electrophoresis gel image of amplified genetic products, including negative and positive controls, alongside a ladder showing bands in the expected wells and sizes:
A Result can be interpreted as “Positive”, “Negative”, or “Undetermined” depending on the case definition for a specific target. To provide the interpretation of the Result, the question “[Source Record Specimen, Source Record] Diagnostic Interpreted” must be answered “Yes”. Then, a set of fields to provide an interpretation to the result will be displayed:
Adding an Interpretation to a Specimen
To add an Interpretation to a Specimen navigate to the “Interpretation” folder linked to the Specimen, select the folder and then click “Add Interpretation” in the top left corner of the Navigation Panel. Complete the mandatory fields in the Workspace Panel and select the “Save Changes” button.
The Interpretation categorizes a Specimen as “Positive”, “Negative”, or “Undetermined” for a specific surveillance target based on the case definition. For example, a Specimen could have mixed Results for the same target (e.g., some positive and some negative). The final categorization for that Specimen is needed.
Adding an Interpretation to a Source Record
To add an Interpretation to a Source Record navigate to the “Interpretation” folder linked to the Source Record, select the folder and then click “Add Interpretation” in the top left corner of the Navigation Panel. Complete the mandatory fields in the Workspace Panel and select the “Save Changes” button.
The Interpretation categorizes a Source Record as “Positive”, “Negative”, or “Undetermined” for a specific surveillance target based on the case definition. For example, a Source Record could have some Specimens considered positive for a target and some Specimens considered negative for the same target. The final categorization for that Source Record is needed.
Adding a Storage to a Specimen
Storage aims to keep track of the specific site of Specimen storage. The Storage collects information regarding the current amount of Specimen stored, the facility and the nested units building, room, freezer/refrigerator/other (“Storage Unit”), shelf, rack, box, and row where the Specimen is stored.
To add an Storage to a Specimen navigate to the “Storage” folder linked to the Specimen, select the folder and then click “Add Storage” in the top left corner of the Navigation Panel. Complete the mandatory fields in the Workspace Panel and select the “Save Changes” button.
Adding a Storage to a Group and Animal Source Record
Storage aims to keep track of the specific site of a Source Record storage. The Storage collects information regarding the the facility where a Source Record is stored, and the nested units building, room, freezer/refrigerator/other (“Storage Unit”), shelf, rack, box, and row where the Source Record is stored.
To add an Storage to a Source Record navigate to the “Storage” folder linked to the Source Record, select the folder and then click “Add Storage” in the top left corner of the Navigation Panel. Complete the mandatory fields in the Workspace Panel and select the “Save Changes” button.
Adding a Shipment to a Specimen
Shipment aims to keep track of the movements of a Specimen among facilities. The Shipment collects information regarding the amount of Specimen shipped, the origin, the destination, and the current Shipment status.
To add an Shipment to a Specimen navigate to the “Shipment” folder linked to the Specimen, select the folder and then click “Add Shipment” in the top left corner of the Navigation Panel. Complete the mandatory fields in the Workspace Panel and select the “Save Changes” button.
Adding a Shipment to a Source
Shipment aims to keep track of the movements of a Source among facilities (the carcasses of a Group Source or an Animal Source carcass. The Shipment collects information regarding the amount of Source Record shipped, the origin, the destination, and the current Shipment status.
To add an Shipment to a Source navigate to the “Shipment” folder linked to the Source, select the folder and then click “Add Shipment” in the top left corner of the Navigation Panel. Complete the mandatory fields in the Workspace Panel and select the “Save Changes” button.
Cancelling the Addition of Data in HAWK
Cancelling the Addition of a Data Unit
To cancel the addition of a data unit,
- Select the “Cancel” button above the Workspace Panel at any time before the data unit is created. The data unit is created only after the “Save Changes” is selected:
Cancelling the Addition of a File to a Data Unit
To cancel the addition of a specific file to a data unit,
- Find it in the list of files below the “Drop the Files to Upload” box and select the “X” or cancel button on the right of the file name (red frame in the image below):
The file will be removed from the list.
Further Clustering Data Units in HAWK using Tags
It is possible that the design of a Surveillance Activity involves more spatial and temporal units than the ones available in HAWK between Location and Event. For example, a Surveillance Activity could involve the collection of samples from animals, the animals are within cages, the cages are within stalls, the stalls are within vendors, and the vendors are within markets, and markets are within cities. If the Event corresponds to the sampling of animals in a cage, its position (longitude/latitude) is the cage, and the Location is the market, then stalls, vendors, and cities still need to be taking into account. The solution in HAWK is to tag the existing units. Tags will allow to query data units and group them. In the example, Events can be tagged by stall and by vendor. the Location could be. Moreover, the each Event and Location can be tagged with a season or any other grouping category.
Tags are available for Surveillance Activities up to Diagnostic.
Creating Tags
To create tags in HAWK, open a data unit (e.g., an Event) by selecting it under one of the corresponding folder (e.g., the “Event” folder) and click in the “Create New Tag” button on the top of the Workspace Panel. A pop-up window allows to name the tag and select if it is a spatial, temporal, or other type of tag. Then click “Create New Tag”:
To cancel the creation of a new tag, click the cancel button instead.
Create Nested Tags
Nested tags can be added to an existing tag in order to categorize a unit (e.g. an Event) with more than one level, with each level having different groups. Following the market sample example above, an Event (the sampling of the animals in a cage) could be tagged by vendor and by the stall within the vendor.
To create a nested tag, create the tag for the higher level first (in the example, the vendors) as explained in the section “Creating tags”. Then find that tag under the “Select a tag” button on the top of the Workspace Panel and hover in the area to the right of the tag name until three blue icons appear:
These icons are to delete the current tag (X icon), to edit the current tag (pencil icon), and to add a nested tag (plus icon). Click on the plus icon and the system will allow you to name the nested tag. Then click “Create New Tag”:
The nested tags will be available after clicking on “Selecte Tags” in Workspace Panel:
To cancel the creation of a nested tag, click the cancel button instead.
Adding Tags or Nested Tags
To add tags to a unit in HAWK, click in the “Select tags” button on the top of the Workspace Panel. The list of available tags will be displayed. To add a specific tag for the specific unit, click on the check box to the left of the chosen tag. The selected tag will be displayed under the “tags” header:
Multiple tags can be added to the same unit.
To tag a unit using a set of nested tags, it is only necessary to click the check box of the lowest level tag. Selecting higher level tags will only add the selected tag and its parents but not the further nested tags.
Special Fields
Targets in a Project
if “Targeted Surveillance” or “Research” are selected in the “Project Type”, then it is possible to select specific biological, chemical, physical and physiological type of targets in a specific field (e.g., “Bacteria” for biological targets). Multiple options can be added.
The selections made at this first level trigger the display of new fields (e.g., “Bacteria”) to select a more specific target (e.g., Bordetella bronchiseptica in the “Bacteria” field as the specific Bacteria species):
Because these target related field are mandatory when displayed, the require a selection. For this reason, these target fields have the options “Any [target],” and “No [target]”.
The “Project type” and targets selected at the Project level impact the targets available in the corresponding Surveillance Activities and Interpretations. When the “Project type” is “Targeted Surveillance” or “Research”, the nested Surveillance Activities can only be “Targeted Surveillance” or “Research”. In these cases, the target hazards in the nested Surveillance Activities only include the options selected in the “Project”. Similarly, the Interpretations only include the target hazards selected in the “Project”:
When the “Project type” is “General Surveillance” or “Outbreak Investigation”, the nested Surveillance Activities can only be “General Surveillance” or “Outbreak Investigation”. In these cases, any target hazards can be selected in the nested Surveillance Activities and in the Interpretations.
Viewing Data in HAWK
To view specific data, navigate through the data units in the Navigation Panel until finding the data unit of interest. View either the data unit fields, files, the contextual information, or the spatial distribution of a specific data unit in the “Map and Tabular Data” tab of the Workspace Panel.
Quick Search
To quickly search for a unit in HAWK, click on the magnifier icon on the top right corner of the Navigation Panel.
A new window will pop-up. In this window there is a table to query units. Units can be searched using keywords written in the search bar. Results can be filtered by selecting a specific type of unit (Surviellance Activity, Field Visits, etc), a start date, or and end date for the period to search for. To go to a specific unit click on the cell in the second column containing the id of the unit of interest:
Editing Data in HAWK
Editing a Data Unit
Editing permissions are needed to edit the fields of a data unit or modify its files. If the permission is active, then follow the instructions provided in section “Adding a New Data Unit in HAWK”. Once the edits are completed, select the “Save Changes” button on the top left of the Navigation Panel. Edits can be cancelled if the changes made have not been saved. To cancel follow the instructions provided in section “Cancelling the Addition of a Data Unit in HAWK”.
Editing Files of a Data Unit
To add new or additional files to a data unit, follow the instructions provided in the section, “Adding Files to a Data Unit”. To cancel the addition of files, follow the instructions provided in the section “Cancelling the Addition of a File to a Data Unit in HAWK”. To delete files uploaded to a data unit, see the next section.
Deleting Data in HAWK
Deleting a Data Unit
To delete a data unit, navigate to the corresponding data unit and select it. The Workspace Panel has an “Archived” button on the top right corner (red frame in the image below):
To delete the data unit, select the “Archive” button. A window will pop-up to confirm the action to ‘Archive’ or to “Cancel & Close” the deletion of the data unit:
Confirm the archiving of the data unit by selecting “Archive” or “Cancel & Close” to cancel the archiving of the data unit
Deleting Files of a Data Unit
To delete files of a data unit, navigate to the corresponding data unit using the Navigation Panel and open. Then, open the “Files” tab in the Workspace Panel and find the “Uploaded Files”:
To delete the file, select the “X” button to the right of the file name:
A window will pop-up to confirm or cancel the deletion of the data unit. Confirm the deletion of the file by selecting “Delete” or “Cancel & Close” to cancel the deletion of the file:
Exporting Data from HAWK (under construction)
Downloading Files
Files associated with data units can be downloaded. To download files of data units, navigate to the corresponding data unit adn select it. Then, open the “Files” tab in the Workspace Panel and find the “Uploaded Files”.
To download a file, select the down arrow icon to the right of the file name:
A window to browse the download Location and name the file will pop-up.
Data Safety and Security (under construction)
FAIR and CARE Principles
General Aspects
Beyond proper recording, annotation, and archival, HAWK promotes data stewardship, the notion of “long-term care” of valuable digital assets, with the goal that they should be discovered and re-used for downstream investigations, either alone, or in combination with newly generated data. The FAIR (Findability, Accessibility, Interoperability, and Reusability) Principles (here) are a guideline for those wishing to enhance the reusability of their data holdings. Table 2 summarizes how HAWK supports the FAIR Principles:
FAIR Principle | FAIR Sub-Principle | How HAWK supports |
|---|---|---|
To be Findable | (Meta)data* are assigned a globally unique and persistent identifier | Surveillance Activity system-based identifier and user-based code |
Data are described with rich metadata | Surveillance Activity extensive metadata | |
Metadata clearly and explicitly include the identifier of the data it describes | HAWK complies with this sub-principle | |
(Meta)data are registered or indexed in a searchable resource | Data and metadata can be searched in HAWK using the Surveillance Activity Identifier or the Code | |
To be Accessible | (Meta)data are retrievable by their identifier using a standardized communications protocol | HAWK supports this sub-principle |
The protocol is open, free, and universally implementable | Yes, for Global South users without funding. API to be developed | |
The protocol allows for an authentication and authorization procedure, where necessary | HAWK complies with this sub-principle | |
Metadata are accessible, even when the data are no longer available | Yes, data is archived including its metadata | |
To be Interoperable | (Meta)data use a formal, accessible, shared, and broadly applicable language for knowledge representation. | Long term goal is to develop such language for wildlife health surveillance through the Wildlife Health Intelligence Network including an ontology |
(Meta)data use vocabularies that follow FAIR principles | Yes, the data dictionary is available online | |
(meta)data include qualified references to other (meta)data | Yes, this is the goal of cross-identifier fields in HAWK data units | |
To be Reusable | Meta(data) are richly described with a plurality of accurate and relevant attributes | Yes, as more metadata is provided at the Surveillance Activity level, it will be possible to identify and propose more accurate and relevant attributes |
(Meta)data are released with a clear and accessible data usage license | Yes, the metadata and data are accessible depending on their administrators. Data from closed accounts is available after embargo. The data license is established in the Surveillance Activity metadata | |
(Meta)data are associated with detailed provenance | HAWK keeps record of all data changes and archives deleted data | |
(Meta)data meet domain-relevant community standards | Metadata and data structure is supported by the Wildlife Health Intelligence Network |
The CARE (Collective Benefit, Authority to Control, Responsibility, and Ethics) Principles for Indigenous Data Governance (here) are designed to complement the FAIR Principles and guide the inclusion of Indigenous Peoples in data processes that strengthen Indigenous control for improved discovery, access, use, reuse, and attribution in contemporary data landscapes. The CARE Principles (Table 3) are people and purpose-oriented, reflecting the crucial role of data in advancing Indigenous innovation and self-determination.
CARE Principle | CARE Sub-Principle | How HAWK supports |
|---|---|---|
Collective Benefit | For inclusive development and innovation | NA |
For improved governance and citizen engagement | NA | |
For equitable outcomes | NA | |
Authority to Control | Recognizing rights and interests | NA |
Data for governance | Data in HAWK that are relevant to Indigenous People world views and empower self-determination and effective self-governance are available and accessible to Indigenous nations and communities by requiring database users to accept specific condition in the Terms of Use | |
Governance of data | HAWK is free of cost for Indigenous Communities establishing their own *Organization Account* | |
Responsibility | For positive relationships | NA |
For expanding capability and capacity | HAWK is free of cost for Indigenous Communities establishing their own *Organization Account* | |
For Indigenous languages and worldviews | HAWK can be translated to any language | |
Ethics | For minimizing harm and maximizing benefit | NA |
For justice | NA | |
For future use | Availability of Indigenous data in HAWK, controlled under an *Organization Account* of an Indigenous Community or Individual depends on the corresponding Organization Account administrators |