Guidance

Algorithmic Transparency Recording Standard v2.1

Updated 2 December 2021

1. Metadata and Title Information

reference number attribute (an asterisk indicates a multi-value field) name tier category type notes for completion required
0.1 id ID   Metadata integer The attribute ‘id’ provides the unique id for the algorithmic transparency report. The id will be issued during the process of publication. TRUE 
0.2                                       standard_version                                                 Standard Version                                           Metadata                             float The attribute ‘standard_version’ indicates the version of the standard that is being used.       TRUE   
0.3 date_completion Date of completion   Metadata date The attribute ‘date_completion’ is the date that the algorithmic transparency report was first published in DD/MM/YY format. TRUE 
0.4                                       date_update*                                                 Date updated                                           Metadata                             date The attribute ‘date_update’ is the date or dates on which the algorithmic transparency report has been updated. Input this information in DD/MM/YYYY format and separate multiple update dates by a comma. For example: 10/05/2021, 03/02/2022 FALSE   
0.5                                       date_archive                                                Date archive                                           Metadata                             date The attribute ‘date_archive’ is the date that the algorithmic transparency report was archived in DD/MM/YY format.  FALSE   
0.6                                       title                                                Title                                          Title Information                             UTF-8 string The attribute ‘title’ is the title or name used to identify the algorithmic tool and which will be used as a title for the algorithmic transparency report. TRUE   
0.7                                       organisation_name                                                Organisation name                                          Title Information                             UTF-8 string The attribute ‘organisation_name’ is the full name of the organisation, department or public sector body that completed the algorithmic transparency report and carries responsibility for use of the algorithmic tool. This name will be used in the title of the algorithmic transparency report.  TRUE   
0.8                                       phase                                                Phase                                          Title Information                             UTF-8 string The attribute ‘phase’ indicates in which of the following stages or phases the tool is currently in. Please choose: Idea; Design; Development; Beta/Pilot; Production; Retired  TRUE   
0.9 one_sentence_description  One sentence description    Title Information UTF-8 string The attribute ‘one_sentence_description’ is a one sentence description of the tool which will function as a subheading underneath the name of the tool. TRUE

2. Core Data

reference number attribute (an asterisk indicates a multi-value field) name tier  category  type notes for completion required
1.1                                       name                                                 Name                                         Tier 1 Overview                             UTF-8 string The attribute ‘name’ is the colloquial name used to identify the algorithmic tool. TRUE   
1.2                                       description                                          Description                                  Tier 1 Overview                             UTF-8 string The attribute ‘description’ is a description to give a basic overview of the purpose of the algorithmic tool. It should include: - how the algorithmic tool is used - why the algorithmic tool is being used TRUE   
1.3                                       website                                              URL of the website                           Tier 1 Overview                             URL         The attribute ‘website’ is the URL reference to a page with further information about the algorithmic tool and its use. This facilitates users searching more in-depth information about the practical use or technical details.This could, for instance, be a local government page, a link to a GitHub repository or a departmental landing page with additional information. FALSE  
1.4                                       contact_email                                        Contact email                                Tier 1 Owner and responsibility             UTF-8 string The attribute ‘contact_email’ is the email address of the organisation, or team for this entry. For continuity and security purposes, we would advise using or creating a team email address instead of using an individual email address.    TRUE   
2.1.1                                    organisation                                         Organisation/ department                     Tier 2 Owner and responsibility             UTF-8 string The attribute ‘organisation’ is the full name of the organisation, department or public sector body that carries responsibility for use of the algorithmic tool. For example, ‘Department for Transport’.  TRUE   
2.1.2                                    team                                                 Team                                         Tier 2 Owner and responsibility             UTF-8 string The attribute ‘team’ is the full name of the team that carries responsibility for use of the algorithmic tool. TRUE       
2.1.3                                    senior_responsible_owner                             Senior responsible owner                     Tier 2 Owner and responsibility             UTF-8 string The attribute ‘senior_responsible_owner’ is the role title of the senior responsible owner for the algorithmic tool. TRUE       
2.1.4  external_supplier_involvement External supplier involvement Tier 2 Owner and responsibility UTF-8 string Have external suppliers been involved in the development and operation of the tool? Please choose: Yes; No TRUE 
2.1.4.1                                    external_supplier*                                   Supplier or developer of the algorithmic tool Tier 2 Owner and responsibility             UTF-8 string The attribute ‘supplier’ gives the name of any external organisation or person that has been contracted to develop the whole or parts of or the algorithmic tool.   FALSE   
2.1.4.2                                    companies_house_number*                        Companies House Number                   Tier 2 Owner and responsibility             UTF-8 string The attribute ‘companies_house_number’ gives, if available, the Companies House number of the external organisation that has been contracted to develop either the whole, or a part of the algorithmic tool. You can find a company’s Companies House number by searching the Companies House register or using the Companies House API. If multiple organisations have been contracted, the Companies House Number for all of the companies should be provided, specifying which number represents which organisation. FALSE  
2.1.4.3                                    external_supplier_role*                              External supplier role                       Tier 2 Owner and responsibility             UTF-8 string The attribute ‘external_supplier_role’ gives a short description of the role the external supplier had in the development of the algorithmic tool.If multiple organisations have been contracted or there are multiple companies involved in the delivery of the tool, these relationships should be described clearly and concisely.  FALSE   
2.1.4.4                                    procurement_procedure_type*                        Procurement procedure type                   Tier 2 Owner and responsibility             UTF-8 string The attribute ‘procurment_procedure_type’ details the procurement procedure through which the contract has been set up. For example, ‘open’, ‘restricted’, or ‘competitive procedure with negotiation’, or ‘call-off from a dynamic purchasing system’, and ‘call-off from a framework’ where a contracting authority has awarded to a supplier under a pre-established framework agreement.                                              FALSE  
2.1.4.5                                    data_access_terms*                                   Terms of access to data for external supplier Tier 2 Owner and responsibility             UTF-8 string The attribute ‘data_access_terms’ details the terms of access to (government) data applied to the external supplier.    FALSE
2.2.1                                   detailed_description                                   Detailed description Tier 2 Detailed Description and Rationale             UTF-8 string The attribute ‘detailed_description’ gives a detailed description of how the algorithmic tool works. Compared to the high-level description in Tier 1, the detailed description should provide an explanation at a more granular and technical level, including the main rules and criteria used by the algorithm/algorithms. This field is optional and is very likely to include information required in other fields below. It is open to the organisation to decide whether they want to include a summary detailed description in addition to the information below.    FALSE
2.2.2                                    scope                                                Scope                                        Tier 2 Detailed Description and Rationale                          UTF-8 string The attribute ‘scope’ describes the purpose of the tool in terms of what it has been designed for and what it has not been designed for. This can include a list of potential purposes that the tool was not designed for: this can help to avoid  misconceptions about the scope and purpose of the tool.   TRUE   
2.2.3                                    benefit                                              Benefit                                      Tier 2 Detailed Description and Rationale                          UTF-8 string The attribute ‘benefit’ describes the key benefits that the algorithmic tool is expected to deliver, and an expanded justification on why the tool is being used.  TRUE   
2.2.4                                    previous_process                              Previous process                      Tier 2 Detailed Description and Rationale                          UTF-8 string The attribute ‘previous_process’ gives a description of the decision making process that took place prior to the deployment of the tool, where applicable. FALSE
2.2.5                                    alternatives_considered                              Alternatives considered                      Tier 2 Detailed Description and Rationale                          UTF-8 string The attribute ‘alternatives_considered’ details, where applicable, a list of other algorithmic and non-algorithmic alternatives considered. It should explain why a certain algorithmic approach was chosen over other approaches, and why the chosen tool is the best available option given any known risks and shortcomings and trade-offs. FALSE
2.3.1                                    process_integration                                  Process integration                          Tier 2 Decision-making Process                            UTF-8 string The attribute ‘process_integration’ explains how the algorithmic tool is integrated into the decision-making process and what influence the algorithmic tool has on the decision-making process. It gives a more detailed and extensive description of the wider decision-making process into which the algorithmic tool is embedded.  TRUE
2.3.2                                    provided_information                                 Provided information                         Tier 2 Decision-making Process                            UTF-8 string The attribute ‘provided information” details how much and what information the algorithmic tool provides to the decision maker. For example, this can include the prediction output and the form in which it is presented to the decision maker. This field should also detail any internal procedures that are in place to document the relationship between the output and the decision. Such procedures should, where applicable, include information on the extent to which decisions made have been influenced by the tool. TRUE
2.3.3                                    human_decisions_and_review                                      Human decisions and review                             Tier 2 Decision-making Process                            UTF-8 string The attribute ‘human_decisions_and_review’ describes the decisions that people take in the overall process. It should also detail human review options. For example, specific details on when and how a person reviews or checks the automated decision.         TRUE   
2.3.4                                    required_training                                    Required training                            Tier 2 Decision-making Process                            UTF-8 string The attribute ‘required_training’ details the required training those deploying or using the algorithmic tool must undertake, if applicable. This can include training for operations, users, maintenance, compliance, or oversight personnel. For example, the person responsible for the management of the tool had to complete data science training. TRUE
2.3.5                                    appeals_and_review                                   Appeals and review                           Tier 2 Decision-making Process                            UTF-8 string The attribute ‘appeals_and_review’ details the mechanisms that are in place for review or appeal of the decision available to the general public, where applicable.   FALSE
2.4.1                                    method                                           Method                                Tier 2 Technical Specification and Data                          UTF-8 string The attribute ‘method’ indicates which types of methods or models the algorithm is using. For example, linear regression, expert system, different kinds of machine learning algorithms, and so on. This can also include a short description of the method(s) used and/or a link to resources providing further resources on the method(s).  TRUE   
2.4.2                                    frequency_and_scale_of_usage                                      Frequency and scale of usage                           Tier 2 Technical Specification and Data                          UTF-8 string The attribute ‘frequency_and_scale_of_usage’ gives information on how regularly the algorithmic tool is being used and the scale of use. For example, the number of decisions made per month, the number of citizens interacting with the tool, and so on.   TRUE
2.4.3                                    phase                                                Phase                                        Tier 2 Technical Specification and Data                          UTF-8 string The attribute ‘phase’ indicates in which of the following stages or phases the tool is currently in. Please choose: Idea; Design; Development; Beta/Pilot; Production; Retired. This field includes date and time stamps of creation and any updates.   TRUE   
2.4.4                                    maintenance                                          Maintenance                                  Tier 2 Technical Specification and Data                          UTF-8 string The attribute ‘maintenance’ gives details on the maintenance schedule and frequency of any reviews. This includes information such as how often and in what way the tool is being reviewed post-deployment, and how it is being maintained if further development is needed. This can concern maintenance both by the supplier as well as by the operator/user of the tool.   TRUE
2.4.5                                    model_performance                                          Model performance                                 Tier 2 Technical Specification and Data                          UTF-8 string The attribute ‘model_performance’ gives details on the model or tool’s performance. Useful metrics to consider are: accuracy metrics (such as precision, recall, F1 scores), metrics related to privacy, and metrics related to computational efficiency. It also gives details on any identified biases in the data and model. If applicable, it describes how bias and accuracy have been balanced in the model.  TRUE
2.4.6                                    system_architecture                                  System architecture                          Tier 2 Technical Specification and Data                          URL         The attribute ‘system_architecture’ is the URL reference to documentation about the system architecture. For example, a link to a GitHub repository image or additional documentation about the system architecture.            
2.4.7                                    source_data_name*                                    Source data name                             Tier 2 Technical Specification and Data                  UTF-8 string The attribute ‘source_data_name’ gives, if applicable, the name of the datasets used.   TRUE   
2.4.8                                    source_data_description*                             Source data                                  Tier 2 Technical Specification and Data                  UTF-8 string The attribute ‘source_data_description’ gives an overview of the data used to train, test, configure and operate the algorithmic tool, specifying which data was used for which purpose. This should encompass data used by both the public sector team and the supplier, where applicable. It should include a description of the types of variables or features used to train, test or run the model - for example ‘age’ or ‘address’. In certain cases, it might not be feasible for a team to disclose all the variables in a dataset. In this case, teams should disclose - at a minimum: whether the data contains personal and special category information; variables of interest, such as protected characteristics and potential proxies; and variables with high predictive power or that have a significant bearing on the model.                 TRUE   
2.4.9                                    source_data_url*                                     Source data URL                              Tier 2 Technical Specification and Data                  URL         The attribute ‘source_data_url’ provides a URL to the openly accessible dataset wherever possible.          FALSE  
2.4.10                                    data_collection*                                     Data collection                              Tier 2 Technical Specification and Data                  UTF-8 string The attribute ‘data_collection’ gives information on the data collection process. This can include details on the original purpose of data collection and the context in which it was initially collected. If the data was initially collected for different purposes and is now being repurposed, there should be consideration of to what extent the data transferable and suitable for the new context.   TRUE   
2.4.11                                    data_cleaning                                     Data cleaning                              Tier 2 Technical Specification and Data                  UTF-8 string The attribute ‘data_cleaning’ gives information on data cleaning, including a description of any pre-processing or cleaning of the data conducted by either the supplier or public sector customer.                      FALSE   
2.4.12                                    data_completeness_and_representativeness                                     Data completeness and representativeness                              Tier 2 Technical Specification and Data                  UTF-8 string The attribute ‘data_completeness_and_representativeness’ provides information on the completeness of the data, including missing data and on how representative the data is.      TRUE   
2.4.13                                    data_sharing_agreements*                             Data sharing agreements                      Tier 2 Technical Specification and Data                  UTF-8 string The attribute ‘data_sharing_agreements’ provides further information on data sharing agreements in place.   TRUE   
2.4.14                                    data_access_and_storage*                             Data access and storage                      Tier 2 Technical Specification and Data                 UTF-8 string The attribute ‘data_access_and_storage’ details: who has, or will have, access to this data; how long it is stored; under what circumstances; and who is responsible for its storage. Where personal and/or sensitive data is being stored and accessed, a description of the mechanisms used to protect the security and privacy of the data should be described, including technical (e.g. de-identification techniques, Privacy Enhancing Technologies) and operational (e.g. role-based access controls) methods. TRUE   
2.5.1                                    impact_assessments                              Impact assessments                       Tier 2 Risks, mitigations and impact assessments UTF-8 string The attribute ‘impact_assessments’ provides the names and a short overview of the impact assessments conducted, date of completion, and if possible a summary of the findings. If available, a publicly accessible link should be provided. If multiple impact assessments were completed, they should all be listed in this field. Examples of impact assessments are Data Protection Impact Assessments (DPIAs), Equality Impact Assessments, Algorithmic Impact Assessments. This field also provides an opportunity to list other monitoring and evaluation requirements under relevant legislation.  TRUE   
2.5.2                                    risks                              Risks                       Tier 2 Risks, mitigations and impact assessments UTF-8 string The attribute ‘risks’ is an overview and a description of the possible risks that have been identified for the algorithmic tool. It also gives an overview of how the risks have been mitigated.     TRUE   

3. Annex

3.1                                       Annex                                                 Annex                                           Annex                             UTF-8 string The attribute ‘annex’ provides an option to add complementary information that contributes to a better understanding of other sections or fields in the standard but that would be too long or detailed to add to a given field in the standard itself.    FALSE