StatCan WxT | Collaborative open source project led by the Government of Canada

Client Relationship Management System (2022 Update) - Privacy impact assessment summary

Introduction

Statistics Canada has been leveraging a Client Relationship Management (CRM) solution to help support the provision of client service delivery, business respondent relations, microdata access and Census respondent relations. However, the existing system and underlying database have become increasingly more complex, hard to maintain and challenging to adapt to new realities.

Therefore, in line with the Statistics Canada's modernization objectives, the CRM system is being updated to support a strategic, holistic and consistent approach to the collection of quality client business intelligence data that can help to strategically respond to clients' needs and better serve Canadians.

Objective

A privacy impact assessment for the CRM System was conducted to determine if there were any privacy, confidentiality or security issues with this system and, if so, to make recommendations for their resolution or mitigation.

Description

The new CRM system is a cloud-based software solution that allows us to move to the Protected B cloud, in alignment with the Statistics Canada's cloud migration initiative, as well as leverage modern technology to integrate enhanced security features and better support our business processes.

The new platform will be used by Statistics Canada employees to record details about meaningful client interactions, as is done in the current software. The client information entered is related to:

general inquiries from individuals, organizations and media
transactions for paid and unpaid services and products (e.g., contracts, licensing agreements, invoices and method of payment)
personal client information for recontact purposes (e.g., names, contact information)
client requests for access to data and analytical platforms (e.g., research proposals, security clearance information)
business respondent information to monitor and document operational decisions related to data collection and response burden for business data that is collected under the Statistics Act (e.g., respondent name, business name, contact information, business size and sector, correspondence).

Risk Area Identification and Categorization

The PIA identifies the level of potential risk (level 1 is the lowest level of potential risk and level 4 is the highest) associated with the following risk areas:

a) Type of program or activity

Administration of program or activity and services

Risk scale: 2

b) Type of personal information involved and context

Only personal information, with no contextual sensitivities, collected directly from the individual or provided with the consent of the individual for disclosure under an authorized program.

Risk scale: 1

c) Program or activity partners and private sector involvement

Within the institution (among one or more programs within the same institution)

Risk scale: 1

d) Duration of the program or activity

Long-term program or activity.

Risk scale: 3

e) Program population

The program's use of personal information for internal administrative purposes affects certain employees.

Risk scale: 1

f) Personal information transmission

The personal information is used in a system that has connections to at least one other system.

Risk scale: 2

g) Technology and privacy

Statistics Canada is proceeding with a cloud-based Client Relationship Management (CRM) solution (MS Dynamics 365) which is a Software-as-a-Service (SaaS) solution that will be hosted in the protected B Azure cloud. The system will only be used by internal staff of Statistics Canada as a method to consistently record inbound or outbound client interactions and personal information about clients or to record interactions with respondents for certain operational processes (e.g., response burden monitoring). Information will be sent to and received from other internal systems to ensure that complete and quality information can be efficiently generated in a safe and secure manner. Selected information from the CRM system will also be used to populate external dashboards so that clients requesting information using web forms can view the status of their requests on their personal dashboard. External users will not have access to the CRMS directly.

h) Potential risk that in the event of a privacy breach, there will be an impact on the individual or employee.

There is a very low risk of a breach of the personal information being disclosed without proper authorization. The impact on the individual would be low given the low sensitivity of the information being included in the system.

i) Potential risk that in the event of a privacy breach, there will be an impact on the institution.

There is a very low risk of a breach of the personal information being disclosed without proper authorization. There could be a negative impact on the institution with regards to the public's perception of Statistics Canada's information protection practices.

Conclusion

This assessment of the Client Relationship Management System did not identify any privacy risks that cannot be managed using existing safeguards.

Employee Wellness Surveys - Privacy impact assessment summary

Introduction

This privacy impact assessment (PIA) is to assess the privacy impact of the Employee Wellness Surveys (EWS) and associated Pulse check Surveys, which will operate under the Financial Administration Act and link self-response data (from the internally administered online survey) to existing administrative databases.

Objective

A privacy impact assessment for EWS and associated Pulse check Surveys was conducted to determine if there were any privacy, confidentiality or security issues with this initiative and, if so, to make recommendations for their resolution or mitigation.

Description

The HR Business Intelligence, Wellness, and Transformation Division at Statistics Canada has the mandate of developing robust EWS and associated Pulse Check Surveys for internal collection (i.e., the survey will only be administered to Statistics Canada and Statistical Survey Operations employees). These surveys will use valid and published scales (please see project description for specific information on these scales) which will be linked to relevant administrative databases -in order to offer up-to-date and representative measurement of the state of Statistics Canada’s psychological health and safety, all while reducing unnecessary response burden on participants. These robust and representative data will then inform evidence-based and appropriate interventions, and provide practical insights and recommendations to all levels of management. More specifically, the EWS will allow the Organizational Health team to understand where challenges to psychological health and safety reside, where resources to help bolster psychological health and safety exist, and how to best improve overall psychological health and safety, and ultimately, performance. Since this program is an internal survey, it will be conducted under the Financial Administration Act, and not the Statistics Act.

Risk Area Identification and Categorization

The PIA identifies the level of potential risk (level 1 is the lowest level of potential risk and level 4 is the highest) associated with the following risk areas:

a) Type of program or activity

Program or activity that does not involve a decision about an identifiable individual.

Risk scale: 1

b) Type of personal information involved and context

Personal information, with no contextual sensitivities after the time of collection, provided by the individual with consent to also use personal information held by another source.

Risk scale: 2

c) Program or activity partners and private sector involvement

Within the institution (among one or more programs within the same institution)

Risk scale: 1

d) Duration of the program or activity

Long-term program or activity.

Risk scale: 3

e) Program population

The program's use of personal information for internal administrative purposes affects all employees.

Risk scale: 2

f) Personal information transmission,

The personal information is used in a system that has connections to at least one other system.

Risk scale: 2

g) Technology and privacy

All personal information will be kept within Statistics Canada, and on Statistics Canada servers. Because of the security measures already in place, a technology or privacy breach risk is low.

h) Potential risk that in the event of a privacy breach, there will be an impact on the individual or employee.

In the case of a privacy breach, there will be an intermediate impact on employees, as this breach could bring embarrassment and slight discomfort to those affected.

i) Potential risk that in the event of a privacy breach, there will be an impact on the institution.

There should be very low impact to the institution in the event of a privacy breach.

Conclusion

This assessment of the EWS did not identify any privacy risks that cannot be managed using existing safeguards.

Retail Commodity Survey: CVs for Total Sales (March 2022)

Retail Commodity Survey: CVs for Total Sales March 2022
Table summary
This table displays the results of Retail Commodity Survey: CVs for Total Sales (March 2022). The information is grouped by NAPCS-CANADA (appearing as row headers), and Month (appearing as column headers).
NAPCS-CANADA	Month
NAPCS-CANADA	202201	202202	202203
Total commodities, retail trade commissions and miscellaneous services	0.75	0.67	0.62
Retail Services (except commissions) [561]	0.75	0.66	0.62
Food at retail [56111]	0.71	1.27	0.98
Soft drinks and alcoholic beverages, at retail [56112]	0.54	0.57	0.62
Cannabis products, at retail [56113]	0.00	0.00	0.00
Clothing at retail [56121]	1.61	2.14	1.14
Footwear at retail [56122]	1.75	1.75	1.59
Jewellery and watches, luggage and briefcases, at retail [56123]	5.71	5.30	6.80
Home furniture, furnishings, housewares, appliances and electronics, at retail [56131]	2.20	0.88	1.20
Sporting and leisure products (except publications, audio and video recordings, and game software), at retail [56141]	3.06	1.91	2.16
Publications at retail [56142]	6.03	6.88	6.12
Audio and video recordings, and game software, at retail [56143]	0.50	0.44	0.49
Motor vehicles at retail [56151]	2.80	2.21	2.04
Recreational vehicles at retail [56152]	7.32	4.33	4.53
Motor vehicle parts, accessories and supplies, at retail [56153]	2.01	2.06	1.75
Automotive and household fuels, at retail [56161]	1.65	1.43	2.06
Home health products at retail [56171]	2.40	2.34	2.16
Infant care, personal and beauty products, at retail [56172]	2.17	2.24	2.28
Hardware, tools, renovation and lawn and garden products, at retail [56181]	2.93	2.38	2.19
Miscellaneous products at retail [56191]	2.87	2.17	2.14
Total retail trade commissions and miscellaneous services ^{Footnote 1}	2.17	1.74	2.04
Footnotes Footnote 1 Comprises the following North American Product Classification System (NAPCS): 51411, 51412, 53112, 56211, 57111, 58111, 58121, 58122, 58131, 58141, 72332, 833111, 841, 85131 and 851511. Return to footnote 1 referrer

Video - Data Science and Modern Methods Forum – June 23, 2021

The Data Science and Modern Methods Forum is a virtual event series created to inform Statistics Canada employees of the department's ongoing data science projects. This highlight reel from the June 2021 forum event features some of the innovative data science projects our agency has been working on.

Video - Learning optimal intervention strategies through agent-based reinforcement learning

This presentation by Data Science Division data scientists, Nicholas Denis and Blair Drummond from the June 2021 forum event, features optimal intervention strategies through agent-based reinforcement learning during the COVID-19 pandemic.

Video - 2022 Indigenous Peoples Survey

This video encourages participation from all who have been selected for the Indigenous Peoples Survey, running from May to October 2022, and January to March 2023.

Monthly Survey of Food Services and Drinking Places: CVs for Total Sales by Geography - March 2022

Monthly Survey of Food Services and Drinking Places: CVs for Total Sales by Geography - March 2022
Table summary
This table displays the results of CVs for Total sales by Geography. The information is grouped by Geography (appearing as row headers), Month and percentage (appearing as column headers).
Geography	Month
	202103	202104	202105	202106	202107	202108	202109	202110	202111	202112	202201	202202	202203
	percentage
Canada	0.47	0.70	0.70	1.00	3.40	0.43	0.16	0.19	0.18	0.15	0.68	0.67	0.98
Newfoundland and Labrador	1.87	2.01	3.35	0.36	0.45	0.45	0.47	0.52	0.52	0.57	0.98	2.09	1.75
Prince Edward Island	0.75	16.43	0.84	0.68	0.64	0.58	2.75	7.74	7.11	4.93	8.04	10.78	10.51
Nova Scotia	0.83	2.96	3.07	0.85	0.36	0.27	0.30	0.38	0.38	1.13	0.93	0.75	0.91
New Brunswick	0.33	1.01	1.73	0.39	0.42	0.36	0.52	0.49	0.53	1.69	8.61	15.21	1.02
Quebec	1.17	1.08	1.95	3.60	16.19	0.65	0.53	0.59	0.51	0.27	2.15	1.40	2.17
Ontario	0.98	1.45	1.13	1.80	1.16	0.87	0.23	0.25	0.31	0.20	1.19	0.34	1.46
Manitoba	0.38	1.14	2.61	0.62	0.68	0.33	0.35	0.68	0.78	0.50	4.84	0.70	0.82
Saskatchewan	0.38	1.11	0.84	0.55	10.60	0.89	0.76	1.51	1.22	0.74	1.38	1.28	1.39
Alberta	0.80	1.40	2.37	0.44	2.27	0.64	0.37	0.45	0.36	0.74	1.23	2.86	3.01
British Columbia	0.97	1.87	1.43	0.78	1.64	0.32	0.32	0.41	0.33	0.27	1.16	1.99	3.10
Yukon Territory	2.30	64.50	2.58	1.50	2.66	4.71	1.91	2.96	19.04	12.40	2.59	2.44	2.39
Northwest Territories	2.46	72.86	2.96	1.42	2.81	5.63	2.14	3.33	24.74	4.96	3.70	3.26	3.24
Nunavut	2.42	3.43	4.33	1.20	72.94	2.71	3.48	5.52	3.56	2.53	0.65	0.75	0.55

Time use diary information and instructions

Have you received an invitation to participate in the Time Use Survey? On this page, you will find information about the 24-hour time use diary, which is the main focus of the survey. Watch the three videos below to get an overview of the diary, to learn how to report simultaneous activities (doing two or more things at the same time), and to learn how to report travel activities.

How does the diary work and what questions are asked?

This video is a tool for respondents who have been selected for the Time Use Survey 2022, and explores how to complete the time diary.

Video: Time Use Survey: How does the diary work and what questions are asked?

What if I was doing more than one activity at the same time?

This video explores how to report simultaneous activities within the time diary of the Time Use Survey 2022.

Video: Time Use Survey: How does the diary work and what questions are asked?

How to report travel activities?

Time Use Survey: Reporting travel activities

This video explores what to do if a travel edit is triggered while completing the time diary of the Time Use Survey 2022.

Video: Time Use Survey: Reporting travel activities

Why does Statistics Canada need so much detail about my day?

Time use data are used to identify which percentage of Canadians have participated in a given activity, regardless of the length of time it takes. Taking fifteen minutes to help an elderly neighbor with housework may not seem like a significant part of your day because it is a quick, one-time activity, but collecting this information helps identify the percentage of Canadians who provide informal help. It is important to include all these small activities in your time use diary.

What time period does the diary cover?

You will be asked to account for a 24-hour period in the diary portion of the survey. The 24-hour period starts at 4:00 am and ends at 4:00 the next morning. After completing the diary, you will be asked a few more questions about your day and your use of time.

Can I choose which day to report?

No, please report for the day indicated in your invitation. Even if you think a different day is more interesting, it is important that you indicate the activities you did on your requested day. Time use trends vary between different days (e.g., a Wednesday often looks very different than a Sunday). In order for the data to accurately portray how Canadians spend their time, Statistics Canada assigns specific days to the respondents in order to ensure an even distribution of responses on each day.

What if my assigned reference day is not a good representation of my usual routine?

Respondents are asked to report on days that might not always be a good representation of their average day, either due to short-term illness, vacation, or some other event. Although it might seem unrepresentative of a typical day, the information is still very useful.

Will the survey ask about specific personal or private activities?

Data collected from the Time Use Survey are grouped into several broad categories. While you may participate in some private or personal activities during your diary day, you will not be asked to disclose the specific details. For example, activities like taking a shower, brushing teeth or hair, getting dressed, meditating and sexual activities are all reported as « Personal care ». Statistics Canada always applies strict measures to protect the confidentiality of your information and the respect of your privacy.

The survey is not a way for the government to learn about you as an individual.

The data will be used to understand how Canadians as a whole (or by province, age, gender, visible minority status, etc.) use their time. Your responses will always be confidential. For more information on how Statistics Canada protects your data, visit our Trust Centre.

Reference data as a Service (RDaaS) - API User Guide

Statistical Registers and Metadata Division

Table of contents

Revision history
Purpose of Document
Summary
Access and availability
Technology
Definitions
Application Programming Interface (API) methods and examples:
Concordances
- Map Types

Revision history

Revision history
Date	Version	Revision details
November 14, 2024	2.3	Corrections to documentation
August 16, 2024	2.2	Corrections to documentation
August 15, 2024	2.1	Add Index endpoints
July 5, 2024	2.0	Remove API key requirement New URL
June 1, 2022	1.0	First release of RDaaS User Guide

Purpose of Document

The purpose of this document is to provide users with a guide to the Reference Data as a Service (RDaaS).

Summary

The Reference Data as a Service (RDaaS) is a list of codesets, classifications and concordances that are used within Statistics Canada and shared to help harmonise data for better interdepartmental data integration and analysis. This RDaaS initiative is meant to share Statistics Canada's reference data with everyone that would like to facilitate & harmonise data for analysis between Government of Canada and its data partners.

Access and availability

The Application Programming Interface (API) is accessible to the public. In general, the API is expected to be available 24/7 except during system updates.

The base Universal Resource Locator (URL) of the API is at:

https://api.statcan.gc.ca/rdaas

Technology

Hyper Text Transfer Protocol Secure (HTTPS) is a standard way of communicating across the Web and includes methods such as GET and POST used with the web service.

The implementation is a RESTful (built using representational state transfer [REST] architecture) web data service over HTTPS protocol, which will return data in JSON (JavaScript Object Notation) language.

REST is an architectural style that specifies constraints, such as the uniform interface, that if applied to a web service induce desirable properties, such as performance, scalability and modifiability, which enable services to work best on the Web.

Definitions

These Application Programming Interface (API) will give you full list of codesets in the language asked. Here are the classifications and codesets that are getting included and available for general consumptions: Definitions, data sources and methods (statcan.gc.ca). An example of a classification you can find is Gender where you will be able to download through this API the following information: Classification of gender (statcan.gc.ca).

Application Programming Interface (API) methods and examples:

We list numerous types of methods for the Application Programming Interface (API) here:

Search

RDaaS search functionality provides users with the ability to search for the resources they are looking for based on a variety of parameters. Each type of resource will have an endpoint where the actual search is performed, along with the potential for supplemental endpoints that can be used to retrieve user specific parameters to use in the search. These parameters may change based on the user's role.

Search classifications

Searches and filters classifications. Text searching is applied to the classification names and and descriptions. The applicable filters can be found from the get classification search filters method. This search supports paging, and a offset and limit can be specified.

Search classifications - more information

HTTP request method: GET

Relative URL: /search/classifications

Parameters:

Name: Description
limit integer (query): the number of results to return; optional, 10 by default, 500 maximum
Default value: 10
q string (query): the search text; optional, omit to search all
start integer (query): the start position for the results returned; optional, 0 (start at first result) by default
Default value: 0
audience string (query): A parameter can be repeated to filter on more than one value at a time.
Note that the values shown here may not be available to all users. See the corresponding /filters method for this to determine which filter values are applicable to you.
Available values: PUBLIC, INTERNAL, SYSTEM, IATD
status string (query): A parameter can be repeated to filter on more than one value at a time.
Note that the values shown here may not be available to all users. See the corresponding /filters method for this to determine which filter values are applicable to you.
Available values: DEFINED, VERIFIED, PENDING, APPROVED, RELEASED, WITHDRAWN, RETIRED, ARCHIVED

Response Code:

Http Status Code	Description
200	Classifications retrieved successfully.

Example:
This call will return the first 10 classifications available where you can find the id to be used in other calls.

Call:
https://api.statcan.gc.ca/rdaas/search/classifications?limit=10

Results:

{
"results": {
"@context": "https://api.statcan.gc.ca/rdaas/context/classification-search",
"@graph": [
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/UT1MXA1jXY1fUpI5",
"name": "Accommodations of collective dwellings",
"abbreviation": null,
"versionNumber": "1.0.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2022-05-02T12:36:44Z",
"validFrom": "2017-03-20T04:00:00Z",
"codeCount": 15,
"levelCount": 2,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/O9Kepe4bA1syfqYh"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/E16EWiM6ykmPDq4k",
"name": "Accommodations of collective dwellings - Collapsed classification",
"abbreviation": null,
"versionNumber": "1.0.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2022-05-02T12:36:50Z",
"validFrom": "2017-03-20T04:00:00Z",
"codeCount": 6,
"levelCount": 1,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/Kg860zM75ZI07dvh"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/P1PiDASifm2o9oHQ",
"name": "Admission category",
"abbreviation": null,
"versionNumber": "1.0.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2024-01-09T16:15:28Z",
"validFrom": "2023-10-10T04:00:00Z",
"codeCount": 40,
"levelCount": 4,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/cDazrF4xtw6CMPzK"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/jar887g7uV1OQYov",
"name": "After-tax income",
"abbreviation": null,
"versionNumber": "1.0.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2024-05-27T17:33:53Z",
"validFrom": "2016-03-21T04:00:00Z",
"codeCount": 27,
"levelCount": 2,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/Q85DCmZ2MYZdcqyo"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/Gnka5DWGAyFWxnLT",
"name": "After-tax income of person",
"abbreviation": null,
"versionNumber": "2.0.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2022-09-28T10:53:46Z",
"validFrom": "2016-03-21T04:00:00Z",
"codeCount": 27,
"levelCount": 3,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/AJczsftMQ9bhxv1p"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/z003kOtktxHvwlqs",
"name": "Age categories by five-year age groups",
"abbreviation": null,
"versionNumber": "1.0.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2022-08-12T15:48:17Z",
"validFrom": "2007-05-22T04:00:00Z",
"codeCount": 21,
"levelCount": 1,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/frUSfEXyon94IaZk"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/qeneaaD0bcvKzkhu",
"name": "Agricultural Regions - Variant of SGC",
"abbreviation": null,
"versionNumber": "2016.1.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2023-05-05T18:04:27Z",
"validFrom": "2016-05-16T04:00:00Z",
"codeCount": 7314,
"levelCount": 6,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/gigntSkqxTSeHjlm"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/DhkqJv2iI2ebZju8",
"name": "Apprenticeship certificates",
"abbreviation": null,
"versionNumber": "1.0.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2024-01-08T18:53:28Z",
"validFrom": "2021-05-26T04:00:00Z",
"codeCount": 2,
"levelCount": 1,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/FvNfg3B25APRSxH4"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/WNtEKGZu4qIJx3Oz",
"name": "Canadian citizenship status",
"abbreviation": null,
"versionNumber": "1.0.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2022-05-02T13:18:45Z",
"validFrom": "2011-04-18T04:00:00Z",
"codeCount": 2,
"levelCount": 1,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/tXaph1UBAf4x5ZwD"
},
{
"@id": "https://api.statcan.gc.ca/rdaas/classification/t4QLjaKVS4JX6CGV",
"name": "Canadian Classification of Institutional Units and Sectors",
"abbreviation": "CCIUS",
"versionNumber": "2012.1.0",
"audience": "STANDARDS",
"status": "RELEASED",
"lastUpdated": "2022-05-02T13:37:16Z",
"validFrom": "2015-06-15T04:00:00Z",
"codeCount": 171,
"levelCount": 6,
"classificationSeries": "https://api.statcan.gc.ca/rdaas/classification-series/zQevgSms7fLn6Yie"
}
]
},
"found": 2395,
"start": 0,
"limit": 10,
"facets": {
"status": {
"RELEASED": 1882,
"RETIRED": 487,
"ARCHIVED": 26
},
"audience": {
"NON_STANDARDIZED": 1912,
"STANDARDS": 483
}
}
}

Classification search filters

This will return a list of filters and the values that can be used on them when searching for classifications. The can be used as query parameters on any search request. For example, if the there is a filter named "bank" with values "A", "B", and "C", query parameters can be added to any search request to filter the results based on these values. For instance, to filter on "bank" "A" and "B", one could append ?bank=A&bank=B to the query url. It is worth noting that these filers will also be included as facet counts in all search results.

Classification search filters - more information

HTTP request method: GET

Relative URL: /search/classifications/filters

Parameters:
None

Response Code:

Http Status Code	Description
200	Classifications retrieved successfully.

Example:
This call will return a list a classification filters that can be used in other calls.

Call:
https://api.statcan.gc.ca/rdaas/search/classifications/filters

Results:

[ {
"parameter" : "status",
"values" : [ "RELEASED", "RETIRED", "ARCHIVED" ]
}, {
"parameter" : "audience",
"values" : [ "STANDARDS", "NON_STANDARDIZED" ]
} ]

Search concordances

Searches and filters concordances. Text searching is applied to the concordance names and and descriptions. The applicable filters can be found from the get concordance search filters method. This search supports paging, and an offset and limit can be specified.

Search concordances - more information

HTTP request method: GET

Relative URL: /search/concordances

Parameters:

Name: Description
limit integer (query): the number of results to return; optional, 10 by default, 500 maximum
Default value: 10
q string (query): the search text; optional, omit to search all
start integer (query): the start position for the results returned; optional, 0 (start at first result) by default
Default value: 0
audience string (query): A parameter can be repeated to filter on more than one value at a time.
Note that the values shown here may not be available to all users. See the corresponding /filters method for this to determine which filter values are applicable to you.
Available values: PUBLIC, INTERNAL, SYSTEM, IATD
status string (query): A parameter can be repeated to filter on more than one value at a time.
Note that the values shown here may not be available to all users. See the corresponding /filters method for this to determine which filter values are applicable to you.
Available values: DEFINED, VERIFIED, PENDING, APPROVED, RELEASED, WITHDRAWN, RETIRED, ARCHIVED

Response Code:

Http Status Code	Description
200	Concordances retrieved successfully.

Example:
This call will return the first 10 concordances available where you can use the id for other calls.

Call:
https://api.statcan.gc.ca/rdaas/search/concordances?limit=10

Results:

{
"results" : {
"@context" : "https://api.statcan.gc.ca/rdaas/context/concordance-search",
"@graph" : [ {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/OjYqoufLb12yRhrq",
"name" : "National Occupational Classification V2016.1.0 to V2016.1.1",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-03T13:18:49Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/g8CZeIwUhswtL0Mi",
"source_name" : "National Occupational Classification",
"sourceVersionNumber" : "2016.1.0",
"target" : "https://api.statcan.gc.ca/rdaas/classification/QqdPX82Lk5bKqPul",
"target_name" : "National Occupational Classification",
"targetVersionNumber" : "2016.1.1"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/a2bMQbmThySaqbHO",
"name" : "National Occupational Classification V2016.1.1 to V2016.1.2",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-03T13:22:23Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/QqdPX82Lk5bKqPul",
"source_name" : "National Occupational Classification",
"sourceVersionNumber" : "2016.1.1",
"target" : "https://api.statcan.gc.ca/rdaas/classification/rrIXoQv2XQY7aKLJ",
"target_name" : "National Occupational Classification",
"targetVersionNumber" : "2016.1.2"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/HGJTm7VMSMhwsYEk",
"name" : "National Occupational Classification V2016.1.2 to V2016.1.3",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-03T13:26:06Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/rrIXoQv2XQY7aKLJ",
"source_name" : "National Occupational Classification",
"sourceVersionNumber" : "2016.1.2",
"target" : "https://api.statcan.gc.ca/rdaas/classification/pkba22EgXl2c7apI",
"target_name" : "National Occupational Classification",
"targetVersionNumber" : "2016.1.3"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/Xu7sVCPbxydMH0E2",
"name" : "North American Industry Classification System - Canada V2007.1.0 to V2012.1.0",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2023-05-30T18:14:40Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/rJcCKBjOKGOIe05K",
"source_name" : "North American Industry Classification System - Canada",
"sourceVersionNumber" : "2007.1.0",
"target" : "https://api.statcan.gc.ca/rdaas/classification/P4nBWMtGTR97i4aA",
"target_name" : "North American Industry Classification System - Canada",
"targetVersionNumber" : "2012.1.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/wyFGyCucaNxZn1vl",
"name" : "North American Industry Classification System - Canada V2012.1.0 to V2017.1.0",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-03T13:39:24Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/P4nBWMtGTR97i4aA",
"source_name" : "North American Industry Classification System - Canada",
"sourceVersionNumber" : "2012.1.0",
"target" : "https://api.statcan.gc.ca/rdaas/classification/TGLFzrGej7kGOzM0",
"target_name" : "North American Industry Classification System - Canada",
"targetVersionNumber" : "2017.1.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/gjBOiUvngK15MZg2",
"name" : "North American Industry Classification System - Canada V2017.1.0 to V2017.2.0",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-03T13:41:40Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/TGLFzrGej7kGOzM0",
"source_name" : "North American Industry Classification System - Canada",
"sourceVersionNumber" : "2017.1.0",
"target" : "https://api.statcan.gc.ca/rdaas/classification/bDiwaJL3bjdeZ8TS",
"target_name" : "North American Industry Classification System - Canada",
"targetVersionNumber" : "2017.2.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/qzUQ47PtPMkqPZHj",
"name" : "North American Industry Classification System - Canada V2017.2.0 to V2017.3.0",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-03T13:44:03Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/bDiwaJL3bjdeZ8TS",
"source_name" : "North American Industry Classification System - Canada",
"sourceVersionNumber" : "2017.2.0",
"target" : "https://api.statcan.gc.ca/rdaas/classification/S049Pjk4RIUgw6j2",
"target_name" : "North American Industry Classification System - Canada",
"targetVersionNumber" : "2017.3.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/qEwaBpiTQKKzeGIp",
"name" : "North American Product Classification System - Canada V2012.1.0 to V2012.1.1",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-02T18:57:46Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/X8l4KOP2cmhJzwSH",
"source_name" : "North American Product Classification System - Canada",
"sourceVersionNumber" : "2012.1.0",
"target" : "https://api.statcan.gc.ca/rdaas/classification/oIHxzqfQiLHk9vMc",
"target_name" : "North American Product Classification System - Canada",
"targetVersionNumber" : "2012.1.1"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/UKa2VvehQUt1ZKVt",
"name" : "North American Product Classification System - Canada V2012.1.1 to V2012.1.2",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-02T19:07:08Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/oIHxzqfQiLHk9vMc",
"source_name" : "North American Product Classification System - Canada",
"sourceVersionNumber" : "2012.1.1",
"target" : "https://api.statcan.gc.ca/rdaas/classification/iXY2lQJFVTLMAYK2",
"target_name" : "North American Product Classification System - Canada",
"targetVersionNumber" : "2012.1.2"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/IFg2ANyUAkAB4hcW",
"name" : "North American Product Classification System - Canada V2012.1.2 to V2017.1.0",
"versionNumber" : "1.0.0",
"audience" : "STANDARDS",
"status" : "RELEASED",
"lastUpdated" : "2022-05-02T19:09:49Z",
"source" : "https://api.statcan.gc.ca/rdaas/classification/iXY2lQJFVTLMAYK2",
"source_name" : "North American Product Classification System - Canada",
"sourceVersionNumber" : "2012.1.2",
"target" : "https://api.statcan.gc.ca/rdaas/classification/FojCXY7J9UDmynZZ",
"target_name" : "North American Product Classification System - Canada",
"targetVersionNumber" : "2017.1.0"
} ]
},
"found" : 1200,
"start" : 0,
"limit" : 10,
"facets" : {
"status" : {
"RETIRED" : 1150,
"RELEASED" : 48,
"ARCHIVED" : 2
},
"audience" : {
"NON_STANDARDIZED" : 1183,
"STANDARDS" : 17
}
}
}

Concordance search filters

This will return a list of filters and the values that can be used on them when searching for concordances. The can be used as query parameters on any search request. For example, if the there is a filter named "bank" with values "A", "B", and "C", query parameters can be added to any search request to filter the results based on these values. For instance, to filter on "bank" "A" and "B", one could append ?bank=A&bank=B to the query url. It is worth noting that these filers will also be included as facet counts in all search results.

Concordance search filters - more information

HTTP request method: GET

Relative URL: /search/concordances/filters

Parameters:
None

Response Code:

Http Status Code	Description
200	Concordances retrieved successfully.

Example:
This call will return the list of filters available to be used in other calls.

Call:
https://api.statcan.gc.ca/rdaas/search/concordances/filters

Results:

[ {
"parameter" : "status",
"values" : [ "RELEASED", "RETIRED", "ARCHIVED" ]
}, {
"parameter" : "audience",
"values" : [ "STANDARDS", "NON_STANDARDIZED" ]
} ]

Classifications-codesets

Generally a statistical classification is a way to group a set of related categories in a meaningful, systematic, and standard format. The statistical classification is usually exhaustive, has mutually exclusive and well-described categories, and has either a hierarchical or a flat structure. A statistical classification usually contains codes and descriptors.

This section contains requests that provide information about classifications, their levels and codes, and changes across versions. These resources are available themselves in several different views (typically detailed and summary) along with a few utilities that are designed to provide users with answers to specific questions they may have without requiring them to dig through all the information themselves.

Codes / Categories

Codes are an alphanumeric or numeric value that is associated with a Category. Codes are organized in a classification by levels. In a flat classification there will be a single level that contains all the codes. In a hierarchical classification codes that are stored on the higher levels will be broader while those stored on the lower levels will be more specific refinements of their parents.

Classification detail

Provides detailed information about the specified classification. This includes descriptive information about the classification, version information, levels, and all codes arranged in order and hierarchically (if applicable).

Classification detail - more information

HTTP request method: GET

Relative URL: /classification/{id}

Parameters:

Name: Description
id * string (path): Identifier of the classification.
lang string (query): The internationalization language tags to request content in specific language(s). These can be comma separated. For example, "lang=en, fr-ca" See /api/i18n/tags under InternationalizationController for more details about language support.
Example: en
method string (query): The internationalization serialization method to use. See /api/i18n/methods under InternationalizationController for more details about language support.
Available values: SINGLE, PROPERTY, ARRAY, CONTAINER
Example: SINGLE

Response Code:

Http Status Code	Description
200	Classification retrieved successfully.

Example:
This call will return all information available for the gender classification (lQA3IRH1ER3KXwrJ).

Call:
https://api.statcan.gc.ca/rdaas/classification/lQA3IRH1ER3KXwrJ

Results:

{
"@context" : [ {
"id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/id",
"name" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name",
"abbreviation" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name/~/type=abbreviation",
"audience" : "https://api.statcan.gc.ca/rdaas/model/property/path/audience",
"status" : "https://api.statcan.gc.ca/rdaas/model/property/path/lifecycle/status",
"lastUpdated" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/administrative/properties/_/administrativeLastUpdate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"description" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/description/~/type=background",
"versionName" : "https://api.statcan.gc.ca/rdaas/model/property/path/version/name",
"validFrom" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validFromDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"validTo" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validToDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"levels" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/administrative/properties/_/includes/~/inclusionRole=defines/type=level",
"@context" : [ {
"levelDepth" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/levelNumber",
"name" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name",
"codeCount" : "https://api.statcan.gc.ca/rdaas/model/property/count/codes"
}, {
"@language" : "en"
} ]
},
"codes" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/rootCode",
"@context" : [ {
"code" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/codeValue",
"validFrom" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validFromDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"validTo" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validToDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"descriptor" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name",
"definition" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/description/~/type=definition",
"children" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/child"
}, {
"@language" : "en"
} ]
}
}, {
"@language" : "en"
} ],
"@id" : "https://api.statcan.gc.ca/rdaas/classification/lQA3IRH1ER3KXwrJ",
"name" : "Sex at birth",
"audience" : "Standardized",
"status" : "Released",
"lastUpdated" : "2023-03-27T11:49:44.205Z",
"description" : "<br /><p><strong>Status: </strong>This standard was approved as a <a href=\"https://www.statcan.gc.ca/eng/subjects/standard/napcs/notice/compulsory\" rel=\"nofollow\">departmental standard</a> on October 1, 2021.</p><p>Information on sex at birth may be based on self-reported data or reported by proxy depending on the statistical program. Therefore, the expression 'reported sex at birth' is used in these definitions when referring to self-reported data and answers reported by proxy.</p>",
"versionName" : "V1.0.0",
"validFrom" : "2021-10-01T00:00:00-04:00",
"levels" : [ {
"@id" : "https://api.statcan.gc.ca/rdaas/level/XV0o7C1uTxhWxZI5",
"levelDepth" : 1,
"name" : "Category",
"codeCount" : 2
} ],
"codes" : [ {
"@id" : "https://api.statcan.gc.ca/rdaas/code/vobFEu0ZvMjIOxsH",
"code" : "1",
"descriptor" : "Male",
"definition" : "This category includes persons whose reported sex at birth is male."
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/code/cFJZgJBj8RFFpFJE",
"code" : "2",
"descriptor" : "Female",
"definition" : "This category includes persons whose reported sex at birth is female."
} ]
}

Classification Categories

Returns all categories at all levels of the classification as a flat list. If the classification is hierarchical, the categories here will not be presented in their hierarchy.

Classification Categories - more information

HTTP request method: GET

Relative URL: /classification/{id}/categories

Parameters:

Name: Description
id * string (path): Identifier of the classification version.
lang string (query): The internationalization language tags to request content in specific language(s). These can be comma separated. For example, "lang=en, fr-ca" See /api/i18n/tags under InternationalizationController for more details about language support.
Example: en
method string (query): The internationalization serialization method to use. See /api/i18n/methods under InternationalizationController for more details about language support.
Available values: SINGLE, PROPERTY, ARRAY, CONTAINER
Example: SINGLE

Response Code:

Http Status Code	Description
200	Classification categories retrieved successfully.
404	Classification not found.

Example:
This call will return the gender classification (lQA3IRH1ER3KXwrJ) categories available.

Call:
https://api.statcan.gc.ca/rdaas/classification/lQA3IRH1ER3KXwrJ/categories

Results:

{
"@context" : [ {
"code" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/codeValue",
"validFrom" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validFromDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"validTo" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validToDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"descriptor" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name",
"definition" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/description/~/type=definition",
"levelDepth" : "https://api.statcan.gc.ca/rdaas/model/property/path/code/level/number"
}, {
"@language" : "en"
} ],
"@graph" : [ {
"@id" : "https://api.statcan.gc.ca/rdaas/code/vobFEu0ZvMjIOxsH",
"code" : "1",
"descriptor" : "Male",
"definition" : "This category includes persons whose reported sex at birth is male.",
"levelDepth" : 1
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/code/cFJZgJBj8RFFpFJE",
"code" : "2",
"descriptor" : "Female",
"definition" : "This category includes persons whose reported sex at birth is female.",
"levelDepth" : 1
} ]
}

Classification Categories detailed

Returns the most detailed categories of the classification. These are the categories without any sub-categories. In most hierarchical classifications, these will be the categories from the lowest level. However, in a ragged classification these categories may exist at any level.

Classification Categories detailed - more information

HTTP request method: GET

Relative URL: /classification/{id}/categories/detailed

Parameters:

Name: Description
id * string (path): Identifier of the classification.
lang string (query): The internationalization language tags to request content in specific language(s). These can be comma separated. For example, "lang=en, fr-ca" See /api/i18n/tags under InternationalizationController for more details about language support.
Example: en
method string (query): The internationalization serialization method to use. See /api/i18n/methods under InternationalizationController for more details about language support.
Available values: SINGLE, PROPERTY, ARRAY, CONTAINER
Example: SINGLE

Response Code:

Http Status Code	Description
200	Classification categories retrieved successfully.
404	Classification not found.

Example:
This call will return the gender classification (lQA3IRH1ER3KXwrJ) categories details available.

Call:
https://api.statcan.gc.ca/rdaas/classification/lQA3IRH1ER3KXwrJ/categories/detailed

Results:

{
"@context" : [ {
"code" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/codeValue",
"validFrom" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validFromDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"validTo" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validToDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"descriptor" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name",
"definition" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/description/~/type=definition",
"levelDepth" : "https://api.statcan.gc.ca/rdaas/model/property/path/code/level/number"
}, {
"@language" : "en"
} ],
"@graph" : [ {
"@id" : "https://api.statcan.gc.ca/rdaas/code/vobFEu0ZvMjIOxsH",
"code" : "1",
"descriptor" : "Male",
"definition" : "This category includes persons whose reported sex at birth is male.",
"levelDepth" : 1
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/code/cFJZgJBj8RFFpFJE",
"code" : "2",
"descriptor" : "Female",
"definition" : "This category includes persons whose reported sex at birth is female.",
"levelDepth" : 1
} ]
}

Indices

Index entries are formal definitions and further refinements of categories that fall under a particular code. These are not defined as codes in a classification, but are more informational to specify which terms are included in a particular code that is defined. They can also specify codes as explicit exclusions, indicating that they should not be considered as a value related to that code. This information can be used to help users determine what code their specific category falls under.

All Indices

Returns the details of all index entries for a classification as an array called @graph. An empty @graph array means the classification was found, but the classification does not have any indices.

All Indices - more information

HTTP request method: GET

URL: /api/classification/{id}/indexes

Parameters:

Name	Mandatory	Data Type	Parameter Type (path/query)	Description
id	Yes	string	path	Identifier of the classification.

Response Code:

Http Status Code	Description
200	Index entries retrieved successfully.
404	Classification not found.

Example:
This call will return the details of all the index entries for a classification with id=owrgkARZ8Omww7qX.

Call:
https://api.statcan.gc.ca/rdaas/classification/owrgkARZ8Omww7qX/indexes

Results:

{
  "@context": [
    {
      "indexId": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/id",
      "illustrativeExamples": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexTerm/~/type=illustrativeExample",
      "inclusions": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexTerm/~/type=inclusion",
      "otherExamples": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexTerm/~/type=otherExample",
      "internalExamples": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexTerm/~/type=internal",
      "indexCode": {
        "@id": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexCode",
        "@type": "@id"
      },
      "indexCodeValue": "https://api.statcan.gc.ca/rdaas/model/property/path/index/code/code_value",
      "indexCodeDescriptor": "https://api.statcan.gc.ca/rdaas/model/property/path/index/code/descriptor",
      "exclusions": {
        "@id": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexExclusion",
        "@context": [
          {
            "code": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/codeValue",
            "descriptor": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name"
          },
          {
            "@language": "en"
          }
        ]
      }
    },
    {
      "@language": "en"
    }
  ],
  "@graph": [
    {
      "@id": "https://api.statcan.gc.ca/rdaas/indexentry/aQksihrYIqMLkgiJ",
      "indexId": 7,
      "otherExamples": [
        "hogs for breeding"
      ],
      "indexCode": "https://api.statcan.gc.ca/rdaas/code/ourZOQCA1BMbuRoF",
      "indexCodeValue": "1111211",
      "indexCodeDescriptor": "Hogs for breeding"
    },
    {
      "@id": "https://api.statcan.gc.ca/rdaas/indexentry/d1uakrz9EU9P7xMF",
      "indexId": 12,
      "otherExamples": [
        "hogs for market"
      ],
      "indexCode": "https://api.statcan.gc.ca/rdaas/code/zyDg0ZfhR0B9xm83",
      "indexCodeValue": "1111213",
      "indexCodeDescriptor": "Hogs for market"
    },
    {
      "@id": "https://api.statcan.gc.ca/rdaas/indexentry/vkRhvTgxFs3Hly0S",
      "indexId": 17,
      "otherExamples": [
        "chickens for breeding"
      ],
      "indexCode": "https://api.statcan.gc.ca/rdaas/code/xsurl5uuYmUq5c3Y",
      "indexCodeValue": "1111311",
      "indexCodeDescriptor": "Chickens for breeding"
    }
  ]
}

Single Index

Returns an index entry for a classification by its index id. If the body of the request returns 1 (instead of JSON), this could mean the classification does not have any indices.

Single Index - more information

HTTP request method: GET

URL: /api/classification/{id}/indexes

Parameters:

Name	Mandatory	Data Type	Parameter Type (path/query)	Description
id	Yes	string	path	Identifier of the classification.
indexId	Yes	integer	path	Index id of the index entry.

Response Code:

Http Status Code	Description
200	Index entry retrieved successfully.
404	Classification or index entry not found.

Example:
Returns an index entry for a classification with id=owrgkARZ8Omww7qX and indexId=7.

Call:
https://api.statcan.gc.ca/rdaas/classification/owrgkARZ8Omww7qX/indexes/entry/7

Results:

{
  "@context": [
    {
      "indexId": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/id",
      "illustrativeExamples": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexTerm/~/type=illustrativeExample",
      "inclusions": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexTerm/~/type=inclusion",
      "otherExamples": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexTerm/~/type=otherExample",
      "internalExamples": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexTerm/~/type=internal",
      "indexCode": {
        "@id": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexCode",
        "@type": "@id"
      },
      "indexCodeValue": "https://api.statcan.gc.ca/rdaas/model/property/path/index/code/code_value",
      "indexCodeDescriptor": "https://api.statcan.gc.ca/rdaas/model/property/path/index/code/descriptor",
      "exclusions": {
        "@id": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/indexExclusion",
        "@context": [
          {
            "code": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/classification/properties/_/codeValue",
            "descriptor": "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name"
          },
          {
            "@language": "en"
          }
        ]
      }
    },
    {
      "@language": "en"
    }
  ],
  "@graph": [
    {
      "@id": "https://api.statcan.gc.ca/rdaas/indexentry/aQksihrYIqMLkgiJ",
      "indexId": 7,
      "otherExamples": [
        "hogs for breeding"
      ],
      "indexCode": "https://api.statcan.gc.ca/rdaas/code/ourZOQCA1BMbuRoF",
      "indexCodeValue": "1111211",
      "indexCodeDescriptor": "Hogs for breeding"
    },
    {
      "@id": "https://api.statcan.gc.ca/rdaas/indexentry/d1uakrz9EU9P7xMF",
      "indexId": 12,
      "otherExamples": [
        "hogs for market"
      ],
      "indexCode": "https://api.statcan.gc.ca/rdaas/code/zyDg0ZfhR0B9xm83",
      "indexCodeValue": "1111213",
      "indexCodeDescriptor": "Hogs for market"
    },
    {
      "@id": "https://api.statcan.gc.ca/rdaas/indexentry/vkRhvTgxFs3Hly0S",
      "indexId": 17,
      "otherExamples": [
        "chickens for breeding"
      ],
      "indexCode": "https://api.statcan.gc.ca/rdaas/code/xsurl5uuYmUq5c3Y",
      "indexCodeValue": "1111311",
      "indexCodeDescriptor": "Chickens for breeding"
    }
  ]
}

Concordances

A Concordance is a correspondence table the formally expressed the relationships between subsequent version of variants of Classifications. It can exists between two versions of the same Classification, or across two different Classifications The relationships show how the items of the target relate to the items of the source.

A Concordance holds the collection of Maps between Codes of the source and target Classification. Several different types of Maps exist, from simple one to one correspondences to complex many-to-many relationships, complex mappings primarily exists across different versions of a Classifications.

Map Types

Different types of changes or Maps exist. The following definitions describe the types of maps that are possible in Ariā:

Deletion (1:0) - an existing Code expires
Creation (0:1) - a new Code comes into existence
Combinations (N:1)
Merger: two or more Codes expires, while their denotations proceed in one emerging Code
Take-over: a Code expires, while its denotation proceeds as part of the denotation of another item, which continues its existence
Decomposition (1:N)
Breakdown: a Code expires, while its denotation is distributed over and proceeds in two or more emerging items
Split-off: an Code continues to exist, while part of its denotation moves to another (emerging) Code
Transfer (M:N)
Simple
- Code Change (1:0, 0:1) - A Code expires, while its denotation proceeds as the denotation of en emerging item
- Property Change (1:1) - The name or other properties of a Code changes, while its denotation remains the same
- No Change (1:1) - No change takes place

Concordance detail.

Provides detailed information about the specified concordance. This includes descriptive information about the concordance, version information, and its code maps.

Concordance detail - more information

HTTP request method: GET

Relative URL: /concordance/{id}

Parameters:

Name: Description
id * string (path): Identifier of the concordance.
lang string (query): The internationalization language tags to request content in specific language(s). These can be comma separated. For example, "lang=en, fr-ca" See /api/i18n/tags under InternationalizationController for more details about language support.
Example: en
method string (query): The internationalization serialization method to use. See /api/i18n/methods under InternationalizationController for more details about language support.
Available values: SINGLE, PROPERTY, ARRAY, CONTAINER
Example: SINGLE

Response Code:

Http Status Code	Description
200	Concordance retrieved successfully.
404	Concordance not found.

Example:
This call will return the concordance detail for Reference data standard on Canadian provinces and territories V2002.0.0 to V2002.0.1 (s9aLOlj8BB6DplVz).

Call:
https://api.statcan.gc.ca/rdaas/concordance/s9aLOlj8BB6DplVz

Results:

{
"@context" : [ {
"id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/id",
"name" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/name",
"audience" : "https://api.statcan.gc.ca/rdaas/model/property/path/audience",
"status" : "https://api.statcan.gc.ca/rdaas/model/property/path/lifecycle/status",
"lastUpdated" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/administrative/properties/_/administrativeLastUpdate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"versionName" : "https://api.statcan.gc.ca/rdaas/model/property/path/version/name",
"validFrom" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validFromDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"validTo" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/validToDate",
"@type" : "http://www.w3.org/2001/XMLSchema#dateTime"
},
"source" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/source",
"@type" : "@id"
},
"target" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/properties/_/target",
"@type" : "@id"
},
"versionConcordance" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/concordance/properties/_/isVersionConcordance",
"predominateSource" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/concordance/properties/_/isPredominateSource",
"predominateTarget" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/concordance/properties/_/isPredominateTarget",
"codeMaps" : {
"@id" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/administrative/properties/_/includes/~/inclusionRole=defines/type=codeMap",
"@context" : [ {
"maptype" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/type",
"sourceCode" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/source/code",
"sourceDescriptor" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/source/name",
"sourceSinceVersion" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/source/version/since",
"targetCode" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/target/code",
"targetDescriptor" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/target/name",
"targetSinceVersion" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/target/version/since",
"distributionFactor" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/concordance/properties/_/distributionFactor",
"reverseDistributionFactor" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/concordance/properties/_/reverseDistributionFactor"
}, {
"@language" : "en"
} ]
}
}, {
"@language" : "en"
} ],
"@id" : "https://api.statcan.gc.ca/rdaas/concordance/s9aLOlj8BB6DplVz",
"name" : "Reference data standard on Canadian provinces and territories V2002.0.0 to V2002.0.1",
"audience" : "Non-standardized",
"status" : "Released",
"lastUpdated" : "2022-04-14T19:06:36.372Z",
"versionName" : "V1.0.0",
"validFrom" : "2003-04-01T00:00:00-05:00",
"source" : "https://api.statcan.gc.ca/rdaas/classification/DHE3EVBVfiUdi7n1",
"target" : "https://api.statcan.gc.ca/rdaas/classification/pElnW6jZSn77dSFd",
"versionConcordance" : true,
"codeMaps" : [ {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/RZT2TRNA8mnuideL",
"maptype" : "No Change",
"sourceCode" : "MB",
"sourceDescriptor" : "Manitoba",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "MB",
"targetDescriptor" : "Manitoba",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/poioFhrbrr6yoTv5",
"maptype" : "No Change",
"sourceCode" : "QC",
"sourceDescriptor" : "Quebec",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "QC",
"targetDescriptor" : "Quebec",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/Vhv5c0y4RoagICjZ",
"maptype" : "No Change",
"sourceCode" : "SK",
"sourceDescriptor" : "Saskatchewan",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "SK",
"targetDescriptor" : "Saskatchewan",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/DuxUs08tODCdSZKU",
"maptype" : "No Change",
"sourceCode" : "NS",
"sourceDescriptor" : "Nova Scotia",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "NS",
"targetDescriptor" : "Nova Scotia",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/lBxOFiFMqryqblaq",
"maptype" : "No Change",
"sourceCode" : "NL",
"sourceDescriptor" : "Newfoundland and Labrador",
"sourceSinceVersion" : "2002.0.0",
"targetCode" : "NL",
"targetDescriptor" : "Newfoundland and Labrador",
"targetSinceVersion" : "2002.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/R52XeJK2hJY0FvFb",
"maptype" : "No Change",
"sourceCode" : "PE",
"sourceDescriptor" : "Prince Edward Island",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "PE",
"targetDescriptor" : "Prince Edward Island",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/rczeSiD0Bi5LslOv",
"maptype" : "No Change",
"sourceCode" : "BC",
"sourceDescriptor" : "British Columbia",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "BC",
"targetDescriptor" : "British Columbia",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/xzQH64AQ3MO8yobP",
"maptype" : "No Change",
"sourceCode" : "NU",
"sourceDescriptor" : "Nunavut",
"sourceSinceVersion" : "1999.0.0",
"targetCode" : "NU",
"targetDescriptor" : "Nunavut",
"targetSinceVersion" : "1999.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/KFytLKZ437SzR11p",
"maptype" : "No Change",
"sourceCode" : "NT",
"sourceDescriptor" : "Northwest Territories",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "NT",
"targetDescriptor" : "Northwest Territories",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/CVuFLE9Nm0krCZ98",
"maptype" : "Update",
"sourceCode" : "YT",
"sourceDescriptor" : "Yukon Territory",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "YT",
"targetDescriptor" : "Yukon",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/XBApMvSyym0DFrcU",
"maptype" : "No Change",
"sourceCode" : "AB",
"sourceDescriptor" : "Alberta",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "AB",
"targetDescriptor" : "Alberta",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/NBEufKEmXO4g4Adm",
"maptype" : "No Change",
"sourceCode" : "ON",
"sourceDescriptor" : "Ontario",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "ON",
"targetDescriptor" : "Ontario",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/X8TSQiUFKEgvH4gJ",
"maptype" : "No Change",
"sourceCode" : "NB",
"sourceDescriptor" : "New Brunswick",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "NB",
"targetDescriptor" : "New Brunswick",
"targetSinceVersion" : "1990.0.0"
} ]
}

Code maps.

Returns the code maps for the specified concordance. This will not provide any additional information about the concordance. If users desire the complete detail of the concordance they can call api/concordance/{id} or if they want summary information they can call api/concordance/{id}/summary.

Code maps - more information

HTTP request method: GET

Relative URL: /concordance/{id}/maps

Parameters:

Name: Description
id * string (path): Identifier of the concordance.
lang string (query): The internationalization language tags to request content in specific language(s). These can be comma separated. For example, "lang=en, fr-ca" See /api/i18n/tags under InternationalizationController for more details about language support.
Example: en
method string (query): The internationalization serialization method to use. See /api/i18n/methods under InternationalizationController for more details about language support.
Available values: SINGLE, PROPERTY, ARRAY, CONTAINER
Example: SINGLE

Response Code:

Http Status Code	Description
200	Concordance maps retrieved successfully.
404	Concordance not found.

Example:
This call will return the concordance detail maps for Reference data standard on Canadian provinces and territories V2002.0.0 to V2002.0.1 (s9aLOlj8BB6DplVz).

Call:
https://api.statcan.gc.ca/rdaas/concordance/s9aLOlj8BB6DplVz/maps

Results:

{
"@context" : [ {
"maptype" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/type",
"sourceCode" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/source/code",
"sourceDescriptor" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/source/name",
"sourceSinceVersion" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/source/version/since",
"targetCode" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/target/code",
"targetDescriptor" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/target/name",
"targetSinceVersion" : "https://api.statcan.gc.ca/rdaas/model/property/path/codemap/target/version/since",
"distributionFactor" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/concordance/properties/_/distributionFactor",
"reverseDistributionFactor" : "https://api.statcan.gc.ca/rdaas/model/property/uri/mtna.us/model/core/concordance/properties/_/reverseDistributionFactor"
}, {
"@language" : "en"
} ],
"@graph" : [ {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/RZT2TRNA8mnuideL",
"maptype" : "No Change",
"sourceCode" : "MB",
"sourceDescriptor" : "Manitoba",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "MB",
"targetDescriptor" : "Manitoba",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/poioFhrbrr6yoTv5",
"maptype" : "No Change",
"sourceCode" : "QC",
"sourceDescriptor" : "Quebec",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "QC",
"targetDescriptor" : "Quebec",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/Vhv5c0y4RoagICjZ",
"maptype" : "No Change",
"sourceCode" : "SK",
"sourceDescriptor" : "Saskatchewan",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "SK",
"targetDescriptor" : "Saskatchewan",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/DuxUs08tODCdSZKU",
"maptype" : "No Change",
"sourceCode" : "NS",
"sourceDescriptor" : "Nova Scotia",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "NS",
"targetDescriptor" : "Nova Scotia",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/lBxOFiFMqryqblaq",
"maptype" : "No Change",
"sourceCode" : "NL",
"sourceDescriptor" : "Newfoundland and Labrador",
"sourceSinceVersion" : "2002.0.0",
"targetCode" : "NL",
"targetDescriptor" : "Newfoundland and Labrador",
"targetSinceVersion" : "2002.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/R52XeJK2hJY0FvFb",
"maptype" : "No Change",
"sourceCode" : "PE",
"sourceDescriptor" : "Prince Edward Island",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "PE",
"targetDescriptor" : "Prince Edward Island",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/rczeSiD0Bi5LslOv",
"maptype" : "No Change",
"sourceCode" : "BC",
"sourceDescriptor" : "British Columbia",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "BC",
"targetDescriptor" : "British Columbia",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/xzQH64AQ3MO8yobP",
"maptype" : "No Change",
"sourceCode" : "NU",
"sourceDescriptor" : "Nunavut",
"sourceSinceVersion" : "1999.0.0",
"targetCode" : "NU",
"targetDescriptor" : "Nunavut",
"targetSinceVersion" : "1999.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/KFytLKZ437SzR11p",
"maptype" : "No Change",
"sourceCode" : "NT",
"sourceDescriptor" : "Northwest Territories",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "NT",
"targetDescriptor" : "Northwest Territories",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/CVuFLE9Nm0krCZ98",
"maptype" : "Update",
"sourceCode" : "YT",
"sourceDescriptor" : "Yukon Territory",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "YT",
"targetDescriptor" : "Yukon",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/XBApMvSyym0DFrcU",
"maptype" : "No Change",
"sourceCode" : "AB",
"sourceDescriptor" : "Alberta",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "AB",
"targetDescriptor" : "Alberta",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/NBEufKEmXO4g4Adm",
"maptype" : "No Change",
"sourceCode" : "ON",
"sourceDescriptor" : "Ontario",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "ON",
"targetDescriptor" : "Ontario",
"targetSinceVersion" : "1990.0.0"
}, {
"@id" : "https://api.statcan.gc.ca/rdaas/codemap/X8TSQiUFKEgvH4gJ",
"maptype" : "No Change",
"sourceCode" : "NB",
"sourceDescriptor" : "New Brunswick",
"sourceSinceVersion" : "1990.0.0",
"targetCode" : "NB",
"targetDescriptor" : "New Brunswick",
"targetSinceVersion" : "1990.0.0"
} ]
}

Archived - 2022 Biannual Potato Area and Yield Survey - June

Why do we conduct this survey?

The purpose of this survey is to collect information for producing national and provincial level estimates of potato production and value. These estimates will be used to assess the economic health of the industry. Agricultural producers and industry analysts will work with this information to make production and marketing decisions, and government analysts will use it to develop agricultural policies in Canada.

Your information may also be used by Statistics Canada for other statistical and research purposes.

Your participation in this survey is required under the authority of the Statistics Act.

Other important information

Authorization to collect this information

Data are collected under the authority of the Statistics Act, Revised Statutes of Canada, 1985, Chapter S-19.

Confidentiality

By law, Statistics Canada is prohibited from releasing any information it collects that could identify any person, business, or organization, unless consent has been given by the respondent, or as permitted by the Statistics Act. Statistics Canada will use the information from this survey for statistical purposes only.

Record linkages

To enhance the data from this survey and to reduce the reporting burden, Statistics Canada may combine the acquired data with information from other surveys or from administrative sources.

Data-sharing agreements

To reduce respondent burden, Statistics Canada has entered into data-sharing agreements with provincial and territorial statistical agencies and other government organizations, which have agreed to keep the data confidential and use them only for statistical purposes. Statistics Canada will only share data from this survey with those organizations that have demonstrated a requirement to use the data.

Section 11 of the Statistics Act provides for the sharing of information with provincial and territorial statistical agencies that meet certain conditions. These agencies must have the legislative authority to collect the same information, on a mandatory basis, and the legislation must provide substantially the same provisions for confidentiality and penalties for disclosure of confidential information as the Statistics Act. Because these agencies have the legal authority to compel businesses to provide the same information, consent is not requested and businesses may not object to the sharing of the data.

For this survey, there are Section 11 agreements with the provincial statistical agencies of Newfoundland and Labrador, Nova Scotia, New Brunswick, Quebec, Ontario, Manitoba, Saskatchewan, Alberta and British Columbia. The shared data will be limited to information pertaining to business establishments located within the jurisdiction of the respective province.

Section 12 of the Statistics Act provides for the sharing of information with federal, provincial or territorial government organizations. Under Section 12, you may refuse to share your information with any of these organizations by writing a letter of objection to the Chief Statistician, specifying the organizations with which you do not want Statistics Canada to share your data and mailing it to the following address:

Chief Statistician of Canada
Statistics Canada
Attention of Director, Enterprise Statistics Division
150 Tunney's Pasture Driveway
Ottawa, Ontario
K1A 0T6

You may also contact us by email at statcan.esd-helpdesk-dse-bureaudedepannage.statcan@canada.ca or by fax at 613-951-6583.
For this survey, there is a Section 12 agreement with the Prince Edward Island Statistical agency.

For agreements with provincial and territorial government organizations, the shared data will be limited to information pertaining to business establishments located within the jurisdiction of the respective province or territory.

Business or organization and contact information

1. Verify or provide the business or organization's legal and operating name and correct where needed.

Note: Legal name modifications should only be done to correct a spelling error or typo.

Legal Name

The legal name is one recognized by law, thus it is the name liable for pursuit or for debts incurred by the business or organization. In the case of a corporation, it is the legal name as fixed by its charter or the statute by which the corporation was created.

Modifications to the legal name should only be done to correct a spelling error or typo.

To indicate a legal name of another legal entity you should instead indicate it in question 3 by selecting 'Not currently operational' and then choosing the applicable reason and providing the legal name of this other entity along with any other requested information.

Operating Name

The operating name is a name the business or organization is commonly known as if different from its legal name. The operating name is synonymous with trade name.

Legal name:
Operating name (if applicable):

2. Verify or provide the contact information of the designated business or organization contact person for this questionnaire and correct where needed.

Note: The designated contact person is the person who should receive this questionnaire. The designated contact person may not always be the one who actually completes the questionnaire.

First name:
Last name:
Title:
Preferred language of communication:
- English
- French
Mailing address (number and street):
City:
Province, territory or state:
Postal code or ZIP code:
Country:
- Canada
- United States
Email address:
Telephone number (including area code):
Extension number (if applicable):
The maximum number of characters is 10.
Fax number (including area code):

3. Verify or provide the current operational status of the business or organization identified by the legal and operating name above.

Operational
Not currently operational
Why is this business or organization not currently operational?
- Seasonal operations
  - When did this business or organization close for the season?
    - Date
  - When does this business or organization expect to resume operations?
    - Date
- Ceased operations
  - When did this business or organization cease operations?
    - Date
  - Why did this business or organization cease operations?
    - Bankruptcy
    - Liquidation
    - Dissolution
    - Other - Specify the other reasons for ceased operations
- Sold operations
  - When was this business or organization sold?
    - Date
  - What is the legal name of the buyer?
- Amalgamated with other businesses or organizations
  - When did this business or organization amalgamate?
    - Date
  - What is the legal name of the resulting or continuing business or organization?
  - What are the legal names of the other amalgamated businesses or organizations?
- Temporarily inactive but will re-open
  - When did this business or organization become temporarily inactive?
    - Date
  - When does this business or organization expect to resume operations?
    - Date
  - Why is this business or organization temporarily inactive?
- No longer operating due to other reasons
  - When did this business or organization cease operations?
    - Date
  - Why did this business or organization cease operations?

4. Verify or provide the current main activity of the business or organization identified by the legal and operating name above.

Note: The described activity was assigned using the North American Industry Classification System (NAICS).

This question verifies the business or organization's current main activity as classified by the North American Industry Classification System (NAICS). The North American Industry Classification System (NAICS) is an industry classification system developed by the statistical agencies of Canada, Mexico and the United States. Created against the background of the North American Free Trade Agreement, it is designed to provide common definitions of the industrial structure of the three countries and a common statistical framework to facilitate the analysis of the three economies. NAICS is based on supply-side or production-oriented principles, to ensure that industrial data, classified to NAICS, are suitable for the analysis of production-related issues such as industrial performance.

The target entity for which NAICS is designed are businesses and other organizations engaged in the production of goods and services. They include farms, incorporated and unincorporated businesses and government business enterprises. They also include government institutions and agencies engaged in the production of marketed and non-marketed services, as well as organizations such as professional associations and unions and charitable or non-profit organizations and the employees of households.

The associated NAICS should reflect those activities conducted by the business or organizational units targeted by this questionnaire only, as identified in the 'Answering this questionnaire' section and which can be identified by the specified legal and operating name. The main activity is the activity which most defines the targeted business or organization's main purpose or reason for existence. For a business or organization that is for-profit, it is normally the activity that generates the majority of the revenue for the entity.

The NAICS classification contains a limited number of activity classifications; the associated classification might be applicable for this business or organization even if it is not exactly how you would describe this business or organization's main activity.

Please note that any modifications to the main activity through your response to this question might not necessarily be reflected prior to the transmitting of subsequent questionnaires and as a result they may not contain this updated information.

The following is the detailed description including any applicable examples or exclusions for the classification currently associated with this business or organization.

Description and examples

This is the current main activity
This is not the current main activity
Provide a brief but precise description of this business or organization's main activity:
- e.g., breakfast cereal manufacturing, shoe store, software development

Main activity

5. You indicated that is not the current main activity.

Was this business or organization's main activity ever classified as: ?

Yes
When did the main activity change?
Date:
No

6. Search and select the industry classification code that best corresponds to this business or organization's main activity.

Select this business or organization's activity sector (optional)

Farming or logging operation
Construction company or general contractor
Manufacturer
Wholesaler
Retailer
Provider of passenger or freight transportation
Provider of investment, savings or insurance products
Real estate agency, real estate brokerage or leasing company
Provider of professional, scientific or technical services
Provider of health care or social services
Restaurant, bar, hotel, motel or other lodging establishment
Other sector

7. You have indicated that the current main activity of this business or organization is: Main activity. Are there any other activities that contribute significantly (at least 10%) to this business or organization's revenue?

Yes, there are other activities
Provide a brief but precise description of this business or organization's secondary activity:
e.g., breakfast cereal manufacturing, shoe store, software development
No, that is the only significant activity

8. Approximately what percentage of this business or organization's revenue is generated by each of the following activities?

When precise figures are not available, provide your best estimates.

CAPTION
	Percentage of revenue
Main activity
Secondary activity
All other activities
Total percentage

Potatoes sold in the 2021 crop year

1. Did you sell any potatoes in the 2021 crop year?

Quantity sold and total value received for the 2021 crop year

2. For the 2021 crop year, what was the quantity of potatoes sold and the total value received?

Include all grades of potatoes sold.

Exclude any potatoes purchased for re-sale.

Report the amount received after any deductions or bonuses were made.

The following are for the quantity of potatoes sold and the total value received for the 2021 crop year.

Exclude any potatoes purchased for re-sale.

Report the total value received after any deductions or bonuses.

Report total value received taking into account all grades.

CAPTION
	Quantity of potatoes sold	Unit of measure	Total value received CAN$
a. Tablestock potatoes
b. Seed potatoes
c. Processing potatoes
Unit of measure Metric tonnes Hundredweight (cwt) Imperial tons Barrels (165 pounds) Pounds 10 pound bag 25 pound bag 50 pound bag 75 pound bag Kilograms

Potatoes grown for sale this year

3. Are you growing any potatoes for sale this year?

Please report all planting intentions, if you have not completed your planting activities when completing this survey.

Area planted

4. What is the total area of potatoes planted in the 2022 crop year?

Please report for the entire operation. Report the area of potatoes planted on land owned or rented by all partners in the operation.

Please report all planting intentions, if you have not completed your planting activities when completing this survey.

Total area:

Unit of measure:

Acres
Hectares

Agricultural production

5. Which of the following agricultural products are currently being produced on this operation?

Select all that apply.

Field crops
Hay
Summerfallow
Potatoes
Fruit, berries and nuts
Vegetables
Sod
Nursery products
Greenhouse products
Cattle and calves
Include beef or dairy.
Pigs
Sheep and lambs
Mink
Fox
Hens and chickens
Turkeys
Maple taps
Honey bees
Mushrooms
Other
Specify agricultural products:
Not producing agricultural products

Area in crops

6. What area of this operation is used for the following crops?

Report the areas only once, even if used for more than one crop type.

Exclude land used by others.

CAPTION
	Area	Unit of measure
a. Field crops
b. Hay
c. Summerfallow
d. Potatoes
e. Fruit, berries and nuts
f. Vegetables
g. Sod
h. Nursery products
Unit of measure acres hectares arpents

Greenhouse area

7. What is the total area under glass, plastic or other protection used for growing plants?

Total area:

Unit of measure:

square feet
square metres

Livestock (excluding birds)

8. How many of the following animals are on this operation?

Report all animals on this operation, regardless of ownership, including those that are boarded, custom-fed or fed under contract.

Include all animals kept by this operation, regardless of ownership, that are pastured on a community pasture, grazing co-op or public land.

Exclude animals owned but kept on a farm, ranch or feedlot operated by someone else.

CAPTION
	Number
a. Cattle and calves
b. Pigs
c. Sheep and lambs
d. Mink
e. Fox

Birds

9. How many of the following birds are on this operation?

Report all poultry on this operation, regardless of ownership, including those grown under contract.

Include poultry for sale and poultry for personal use.

Exclude poultry owned but kept on an operation operated by someone else.

CAPTION
	Number
a. Hens and chickens
b. Turkeys

Maple taps

10. What was the total number of taps made on maple trees last spring?

Total number of taps:

Honey bees

11. How many live colonies of honey bees (used for honey production or pollination) are owned by this operation?

Include bees owned, regardless of location.

Number of colonies:

Mushrooms

12. What is the total mushroom growing area (standing footage) on this operation?

Include mushrooms grown using beds, trays, tunnels or logs.

Total area:

Unit of measure:

square feet
square metres

Changes or events

1. Indicate any changes or events that affected the reported values for this business or organization, compared with the last reporting period.

Select all that apply.

Strike or lock-out
Exchange rate impact
Price changes in goods or services sold
Contracting out
Organizational change
Price changes in labour or raw materials
Natural disaster
Recession
Change in product line
Sold business or business units
Expansion
New or lost contract
Plant closures
Acquisition of business or business units
Other
Specify the other changes or events:
No changes or events

Contact person

1. Statistics Canada may need to contact the person who completed this questionnaire for further information. Is [Provided Given Names], [Provided Family Name] the best person to contact?

Who is the best person to contact about this questionnaire?

First name:
Last name:
Title:
Email address:
Telephone number (including area code):
Extension number (if applicable):
The maximum number of characters is 5.
Fax number (including area code):

Feedback

1. How long did it take to complete this questionnaire?

Include the time spent gathering the necessary information.

Hours:
Minutes:

2. Do you have any comments about this questionnaire?

Subscribe to

Date modified:: 2025-12-15

Introduction

Objective

Description

Risk Area Identification and Categorization

a) Type of program or activity

b) Type of personal information involved and context

c) Program or activity partners and private sector involvement

d) Duration of the program or activity

e) Program population

f) Personal information transmission

g) Technology and privacy

h) Potential risk that in the event of a privacy breach, there will be an impact on the individual or employee.

i) Potential risk that in the event of a privacy breach, there will be an impact on the institution.

Conclusion

Introduction

Objective

Description

Risk Area Identification and Categorization

a) Type of program or activity

b) Type of personal information involved and context

c) Program or activity partners and private sector involvement

d) Duration of the program or activity

e) Program population

f) Personal information transmission,

g) Technology and privacy

h) Potential risk that in the event of a privacy breach, there will be an impact on the individual or employee.

i) Potential risk that in the event of a privacy breach, there will be an impact on the institution.

Conclusion

Footnotes

How does the diary work and what questions are asked?

What if I was doing more than one activity at the same time?

How to report travel activities?

Why does Statistics Canada need so much detail about my day?

What time period does the diary cover?

Can I choose which day to report?

What if my assigned reference day is not a good representation of my usual routine?

Will the survey ask about specific personal or private activities?

Revision history

Purpose of Document

Summary

Access and availability

Technology

Definitions

Application Programming Interface (API) methods and examples:

Search

Search concordances

Classifications-codesets

Codes / Categories

Indices

Concordances

Map Types

Why do we conduct this survey?

Other important information

Business or organization and contact information

Main activity

Potatoes sold in the 2021 crop year

Quantity sold and total value received for the 2021 crop year

Potatoes grown for sale this year

Area planted

Agricultural production

Area in crops

Greenhouse area

Livestock (excluding birds)

Birds

Maple taps

Honey bees

Mushrooms

Changes or events

Contact person

Feedback