RESTful (non-FHIR) terminology API from Canada Health Infoway for browsing and downloading Canadian terminology content - code systems, subsets (value sets), maps, resource locations, and packages - with delta/versioning, session login (basic credentials, SSO token, or JWT), and webhook-style notification subscriptions.
{
"swagger" : "2.0",
"info" : {
"description" : "RESTful web services used to browse terminology data.",
"version" : "1.0.0",
"title" : "Terminology API",
"termsOfService" : "http://swagger.io/terms/"
},
"basePath" : "/rest/v1",
"tags" : [
{
"name" : "codesystems",
"description" : "APIs for accessing code system data"
},
{
"name" : "codesystem",
"description" : "Retrieves information about a single codesystem"
},
{
"name" : "concepts",
"description" : "APIs for accessing concepts from terminology subsets"
},
{
"name" : "concept",
"description" : "Retrieves concept(s) associated to a subset version"
},
{
"name" : "entities",
"description" : "Retrieves the list of entities associated to a codesystem version"
},
{
"name": "maps",
"description": "APIs for accessing map data"
},
{
"name" : "notification",
"description" : "APIs for accessing user notifications"
},
{
"name": "packages",
"description": "APIs for accessing package data"
},
{
"name": "package",
"description": "Retrieves information about a single package"
},
{
"name": "resourcelocations",
"description": "APIs for accessing resource location data"
},
{
"name": "resourcelocation",
"description": "Retrieves the list of resource locations"
},
{
"name" : "session",
"description" : "APIs for programmatically logging in"
},
{
"name" : "subsets",
"description" : "APIs for terminology subsets",
"externalDocs" : {
"description" : "Find out more",
"url" : "https://infocentral.infoway-inforoute.ca"
}
},
{
"name" : "subset",
"description" : "Retrieves information about a single subset"
}
],
"paths" : {
"/codesystems" : {
"get" : {
"tags" : ["codesystems"],
"summary" : "Retrieves a list of codesystems",
"description" : "Retrieves a list of codesystems matching the provided search criteria.",
"operationId" : "getCodeSystems",
"produces" : ["application/json", "application/xml"],
"parameters" : [
{
"name" : "auth",
"description" : "basic access authentication credentials, specified as username:password and encoded using <a href='https://www.base64encode.org/' target='_blank'><b>Base64</b></a> encoding. These credentials can alternatively be passed in the 'Authorization: Basic' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "btoken",
"description" : "JSON web token. This token can alternatively be passed in the 'Authorization: Bearer' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "name",
"description" : "returns only codesystems matching the given name. The name filter can use a regular expression format.",
"in" : "query",
"type" : "string"
},
{
"name" : "format",
"required" : false,
"description" : "output format",
"in" : "query",
"type" : "string",
"enum" : ["json","xml"],
"default" : "json"
},
{
"name" : "sortby",
"description" : "sorts the result set by the specified field.",
"in" : "query",
"type" : "string",
"enum" : ["id","name","versionid"]
},
{
"name" : "sortdir",
"description" : "sorting direction. Only relevant if the sortby parameter is also specified.",
"in" : "query",
"type" : "string",
"enum" : ["ascending","descending"]
},
{
"name" : "page",
"description" : "page number used for pagination",
"in" : "query",
"type" : "integer",
"default" : "1"
},
{
"name" : "size",
"description" : "page size used for pagination",
"in" : "query",
"type" : "integer",
"default" : "1000"
}
],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CodeSystems"
}
}
},
"400" : {
"description" : "Invalid parameters"
},
"403" : {
"description" : "Missing or invalid credentials"
}
}
}
},
"/codesystems/download" : {
"get" : {
"tags" : ["codesystems"],
"summary" : "Returns a downloadable list containing all codesystems.",
"description" : "Generates a full list containing all codesystems. The list is returned as an attachment to the HTTP response. This API doesn't apply any pagination to the result set.",
"operationId" : "downloadCodeSystems",
"produces" : ["application/json", "application/xml"],
"parameters" : [
{
"name" : "auth",
"description" : "basic access authentication credentials, specified as username:password and encoded using <a href='https://www.base64encode.org/' target='_blank'><b>Base64</b></a> encoding. These credentials can alternatively be passed in the 'Authorization: Basic' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "btoken",
"description" : "JSON web token. This token can alternatively be passed in the 'Authorization: Bearer' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "sortby",
"description" : "sorts the result set by the specified field.",
"in" : "query",
"type" : "string",
"enum" : ["id","name","versionid","effectivedate", "active", "language"]
},
{
"name" : "sortdir",
"description" : "sorting direction. Only relevant if the sortby parameter is also specified.",
"in" : "query",
"type" : "string",
"enum" : ["ascending","descending"]
},
{
"name" : "format",
"required" : false,
"description" : "output format",
"in" : "query",
"type" : "string",
"enum" : ["json","xml"],
"default" : "json"
}
],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "file"
}
},
"400" : {
"description" : "Invalid parameters"
},
"403" : {
"description" : "Missing or invalid credentials"
}
}
}
},
"/codesystem/{codesystemid}/versions" : {
"get" : {
"tags" : ["codesystems"],
"summary" : "Returns metadata for all versions of a codesystem.",
"description" : "Returns the metadata associated to all codesystem version.",
"operationId" : "getCodeSystemVersions",
"produces" : ["application/json", "application/xml"],
"parameters" : [
{
"name" : "auth",
"description" : "basic access authentication credentials, specified as username:password and encoded using <a href='https://www.base64encode.org/' target='_blank'><b>Base64</b></a> encoding. These credentials can alternatively be passed in the 'Authorization: Basic' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "btoken",
"description" : "JSON web token. This token can alternatively be passed in the 'Authorization: Bearer' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "codesystemid",
"required" : true,
"description" : "codesystem identifier",
"in" : "path",
"type" : "string"
},
{
"name" : "format",
"required" : false,
"description" : "output format",
"in" : "query",
"type" : "string",
"enum" : ["json","xml"],
"default" : "json"
},
{
"name" : "variant",
"description" : "SNOMED CT Variant. Required for SNOMED CT.",
"in" : "query",
"type" : "string",
"enum" : ["core", "canadian"]
}
],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CodeSystem"
}
}
},
"400" : {
"description" : "Invalid parameters"
},
"403" : {
"description" : "Missing or invalid credentials"
}
}
}
},
"/codesystem/{codesystemid}/download" : {
"get" : {
"tags" : ["codesystems"],
"summary" : "Returns metadata for a single codesystem version.",
"description" : "Returns downloadable metadata for a single codesystem version.",
"operationId" : "downloadCodeSystem",
"produces" : [ "application/json", "application/xml","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/octet-stream", "application/zip"],
"parameters" : [
{
"name" : "auth",
"description" : "basic access authentication credentials, specified as username:password and encoded using <a href='https://www.base64encode.org/' target='_blank'><b>Base64</b></a> encoding. These credentials can alternatively be passed in the 'Authorization: Basic' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "btoken",
"description" : "JSON web token. This token can alternatively be passed in the 'Authorization: Bearer' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "apikey",
"required" : true,
"description" : "security key required to access the web service",
"in" : "query",
"type" : "string",
"default" : "AB3"
},
{
"name" : "codesystemid",
"required" : true,
"description" : "codesystem identifier",
"in" : "path",
"type" : "string"
},
{
"name" : "versionid",
"description" : "codesystem version, latest version if not provided",
"in" : "query",
"type" : "string"
},
{
"name" : "format",
"required" : false,
"description" : "output format",
"in" : "query",
"type" : "string",
"enum" : ["json","xml", "excel", "rf2", "access"],
"default" : "json"
},
{
"name" : "sortby",
"description" : "sorts the result set by the specified field.",
"in" : "query",
"type" : "string",
"enum" : ["id","name","active","language"]
},
{
"name" : "sortdir",
"description" : "sorting direction. Only relevant if the sortby parameter is also specified.",
"in" : "query",
"type" : "string",
"enum" : ["ascending","descending"]
},
{
"name" : "variant",
"description" : "SNOMED CT Variant. Required for SNOMED CT.",
"in" : "query",
"type" : "string",
"enum" : ["core", "canadian"]
}
],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "file"
}
},
"400" : {
"description" : "Invalid parameters"
},
"403" : {
"description" : "Missing or invalid apikey"
}
}
}
},
"/codesystem/{codesystemid}" : {
"get" : {
"tags" : ["codesystems"],
"summary" : "Returns metadata for a single codesystem version.",
"description" : "Returns the metadata associated to a single codesystem version.",
"operationId" : "getCodeSystemVersion",
"produces" : ["application/json", "application/xml"],
"parameters" : [
{
"name" : "auth",
"description" : "basic access authentication credentials, specified as username:password and encoded using <a href='https://www.base64encode.org/' target='_blank'><b>Base64</b></a> encoding. These credentials can alternatively be passed in the 'Authorization: Basic' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "btoken",
"description" : "JSON web token. This token can alternatively be passed in the 'Authorization: Bearer' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "codesystemid",
"required" : true,
"description" : "codesystem identifier",
"in" : "path",
"type" : "string"
},
{
"name" : "versionid",
"description" : "codesystem version, latest version if not provided",
"in" : "query",
"type" : "string"
},
{
"name" : "format",
"required" : false,
"description" : "output format",
"in" : "query",
"type" : "string",
"enum" : ["json","xml"],
"default" : "json"
},
{
"name" : "variant",
"description" : "SNOMED CT Variant. Required for SNOMED CT.",
"in" : "query",
"type" : "string",
"enum" : ["core", "canadian"]
}
],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CodeSystemVersion"
}
}
},
"400" : {
"description" : "Invalid parameters"
},
"403" : {
"description" : "Missing or invalid credentials"
}
}
}
},
"/codesystem/{codesystemid}/entities" : {
"get" : {
"tags" : ["codesystems"],
"summary" : "Retrieves the list of entities that are part of a codesystem version.",
"description" : "Retrieves a full list of entities that are part of a codesystem version.",
"operationId" : "getCodeSystemEntities",
"produces" : ["application/json", "application/xml"],
"parameters" : [
{
"name" : "auth",
"description" : "basic access authentication credentials, specified as username:password and encoded using <a href='https://www.base64encode.org/' target='_blank'><b>Base64</b></a> encoding. These credentials can alternatively be passed in the 'Authorization: Basic' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "btoken",
"description" : "JSON web token. This token can alternatively be passed in the 'Authorization: Bearer' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "codesystemid",
"required" : true,
"description" : "codesystem identifier",
"in" : "path",
"type" : "string"
},
{
"name" : "versionid",
"description" : "codesystem version, latest version if not provided",
"in" : "query",
"type" : "string"
},
{
"name" : "name",
"description" : "returns only entities matching the given name. The name filter can use a regular expression format",
"in" : "query",
"type" : "string"
},
{
"name" : "sortby",
"description" : "sorts the result set by the specified field.",
"in" : "query",
"type" : "string",
"enum" : ["id","name","versionid","effectivedate","active","language"]
},
{
"name" : "sortdir",
"description" : "sorting direction. Only relevant if the sortby parameter is also specified.",
"in" : "query",
"type" : "string",
"enum" : ["ascending","descending"]
},
{
"name" : "page",
"description" : "page number used for pagination",
"in" : "query",
"type" : "integer",
"default" : "1"
},
{
"name" : "size",
"description" : "page size used for pagination",
"in" : "query",
"type" : "integer",
"default" : "1000"
},
{
"name" : "format",
"required" : false,
"description" : "output format",
"in" : "query",
"type" : "string",
"enum" : ["json","xml"],
"default" : "json"
}
],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Entities"
}
}
},
"400" : {
"description" : "Invalid parameters"
},
"403" : {
"description" : "Missing or invalid credentials"
}
}
}
},
"/subsets" : {
"get" : {
"tags" : ["subsets"],
"summary" : "Retrieves a list of subsets",
"description" : "Retrieves a list of subsets matching the provided search criteria.",
"operationId" : "findSubsets",
"produces" : ["application/json", "application/xml"],
"parameters" : [
{
"name" : "auth",
"description" : "basic access authentication credentials, specified as username:password and encoded using <a href='https://www.base64encode.org/' target='_blank'><b>Base64</b></a> encoding. These credentials can alternatively be passed in the 'Authorization: Basic' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "btoken",
"description" : "JSON web token. This token can alternatively be passed in the 'Authorization: Bearer' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "active",
"description" : "returns active or inactive subsets if specified, all subsets if this parameter is absent",
"in" : "query",
"type" : "boolean"
},
{
"name" : "reflang",
"description" : "returns only subsets for the specified language. The language identifier must be provided in ISO639-1 format",
"in" : "query",
"type" : "string",
"enum" : ["en"]
},
{
"name" : "startdate",
"description" : "returns only subsets that were active on or after the given start date. The date must be specified as yyyyMMdd",
"in" : "query",
"type" : "string"
},
{
"name" : "enddate",
"description" : "returns only subsets that were active on or before the given end date. The date must be specified as yyyyMMdd",
"in" : "query",
"type" : "string"
},
{
"name" : "name",
"description" : "returns only subsets matching the given name. The name filter can use a regular expression format",
"in" : "query",
"type" : "string"
},
{
"name" : "sortby",
"description" : "sorts the result set by the specified field.",
"in" : "query",
"type" : "string",
"enum" : ["id","name","active","language"]
},
{
"name" : "sortdir",
"description" : "sorting direction. Only relevant if the sortby parameter is also specified.",
"in" : "query",
"type" : "string",
"enum" : ["ascending","descending"]
},
{
"name" : "page",
"description" : "page number used for pagination",
"in" : "query",
"type" : "integer",
"default" : "1"
},
{
"name" : "size",
"description" : "page size used for pagination",
"in" : "query",
"type" : "integer",
"default" : "1000"
},
{
"name" : "format",
"required" : false,
"description" : "output format",
"in" : "query",
"type" : "string",
"enum" : ["json","xml"],
"default" : "json"
},
{
"name" : "tags",
"description" : "describes a specific category of subsets that this subset belongs to",
"in" : "query",
"type" : "string"
}
],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Subsets"
}
}
},
"400" : {
"description" : "Invalid parameters"
},
"403" : {
"description" : "Missing or invalid credentials"
}
}
}
},
"/subsets/download" : {
"get" : {
"tags" : ["subsets"],
"summary" : "Returns a downloadable list containing all subsets.",
"description" : "Generates a full list containing all subsets. The list is returned as an attachment to the HTTP response. This API doesn't apply any pagination to the result set.",
"operationId" : "downloadSubsets",
"produces" : ["application/json", "application/xml"],
"parameters" : [
{
"name" : "auth",
"description" : "basic access authentication credentials, specified as username:password and encoded using <a href='https://www.base64encode.org/' target='_blank'><b>Base64</b></a> encoding. These credentials can alternatively be passed in the 'Authorization: Basic' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "btoken",
"description" : "JSON web token. This token can alternatively be passed in the 'Authorization: Bearer' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "sortby",
"description" : "sorts the result set by the specified field.",
"in" : "query",
"type" : "string",
"enum" : ["id","name","active","language"]
},
{
"name" : "sortdir",
"description" : "sorting direction. Only relevant if the sortby parameter is also specified.",
"in" : "query",
"type" : "string",
"enum" : ["ascending","descending"]
},
{
"name" : "format",
"required" : false,
"description" : "output format",
"in" : "query",
"type" : "string",
"enum" : ["json","xml"],
"default" : "json"
},
{
"name" : "tags",
"description" : "describes a specific category of subsets that this subset belongs to",
"in" : "query",
"type" : "string"
}
],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "file"
}
},
"400" : {
"description" : "Invalid parameters"
},
"403" : {
"description" : "Missing or invalid credentials"
}
}
}
},
"/subset/{subsetid}/versions" : {
"get" : {
"tags" : ["subsets"],
"summary" : "Returns metadata for all versions of a subset.",
"description" : "Returns the metadata associated to all subset version.",
"operationId" : "getSubsetVersions",
"produces" : ["application/json", "application/xml"],
"parameters" : [
{
"name" : "auth",
"description" : "basic access authentication credentials, specified as username:password and encoded using <a href='https://www.base64encode.org/' target='_blank'><b>Base64</b></a> encoding. These credentials can alternatively be passed in the 'Authorization: Basic' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "btoken",
"description" : "JSON web token. This token can alternatively be passed in the 'Authorization: Bearer' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "subsetid",
"required" : true,
"description" : "subset identifier",
"in" : "path",
"type" : "string"
},
{
"name" : "format",
"required" : false,
"description" : "output format",
"in" : "query",
"type" : "string",
"enum" : ["json","xml"],
"default" : "json"
}
],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Subset"
}
}
},
"400" : {
"description" : "Invalid parameters"
},
"403" : {
"description" : "Missing or invalid credentials"
}
}
}
},
"/subset/{subsetid}" : {
"get" : {
"tags" : ["subsets"],
"summary" : "Returns metadata for a single subset version.",
"description" : "Returns the metadata associated to a single subset version.",
"operationId" : "getSubsetVersion",
"produces" : ["application/json", "application/xml"],
"parameters" : [
{
"name" : "auth",
"description" : "basic access authentication credentials, specified as username:password and encoded using <a href='https://www.base64encode.org/' target='_blank'><b>Base64</b></a> encoding. These credentials can alternatively be passed in the 'Authorization: Basic' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "btoken",
"description" : "JSON web token. This token can alternatively be passed in the 'Authorization: Bearer' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "subsetid",
"required" : true,
"description" : "subset identifier",
"in" : "path",
"type" : "string"
},
{
"name" : "versionid",
"description" : "subset version, latest version if not provided",
"in" : "query",
"type" : "string"
},
{
"name" : "reflang",
"description" : "returns the subset version for the specified language. The language identifier must be provided in ISO639-1 format",
"in" : "query",
"type" : "string",
"enum" : ["en"]
},
{
"name" : "format",
"required" : false,
"description" : "output format",
"in" : "query",
"type" : "string",
"enum" : ["json","xml"],
"default" : "json"
}
],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/SubsetVersion"
}
}
},
"400" : {
"description" : "Invalid parameters"
},
"403" : {
"description" : "Missing or invalid credentials"
}
}
}
},
"/subset/{subsetid}/download" : {
"get" : {
"tags" : ["subsets"],
"summary" : "Downloads the data associated to a subset version.",
"description" : "Downloads the data associated to a subset version. This includes all concepts that are part of the subset. The data is returned as an attachment to the HTTP response.",
"operationId" : "downloadSubset",
"produces" : ["application/json", "application/xml", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"],
"parameters" : [
{
"name" : "auth",
"description" : "basic access authentication credentials, specified as username:password and encoded using <a href='https://www.base64encode.org/' target='_blank'><b>Base64</b></a> encoding. These credentials can alternatively be passed in the 'Authorization: Basic' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "btoken",
"description" : "JSON web token. This token can alternatively be passed in the 'Authorization: Bearer' HTTP header.",
"in" : "query",
"type" : "string"
},
{
"name" : "subsetid",
"required" : true,
"description" : "subset identifier",
"in" : "path",
"type" : "string"
},
{
"name" : "versionid",
"description" : "subset version, latest version if not provided",
"in" : "query",
"type" : "string"
},
{
"name" : "sortby",
"description" : "sorts the result set by the specified field.",
"in" : "query",
"type" : "string",
"enum" : ["id","name","active","language"]
},
{
"name" : "sortdir",
"description" : "sorting direction. Only relevant if the sortby parameter is also specified.",
"in" : "query",
"type" : "string",
"enum" : ["ascending","descending"]
},
{
"name" : "format",
"required" : false,
"description" : "output format",
"in" : "query",
"type" : "string",
"enum" : ["json","xml","excel"],
"default" : "json"
},
{
"name" : "lang",
"description" : "returns the output in the specified language. Only supported for excel outputs. The language identifier must be provided in ISO639-1 format",
"in" : "query",
"type" : "string",
"enum" : ["en","fr"]
}
],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "file"
}
},
"400" : {
"description" : "Invalid parameters"
},
"403" : {
"description" : "Missing or invalid credentials"
}
}
}
},
"/codesystem/{codesystemid}/entity/{entityid}" : {
"get" : {
"tags" : ["codesystems"],
"summary" : "Retrieves a single entity associated with a codesystem.",
"description" : "R
# --- truncated at 32 KB (122 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/canada-health-infoway/refs/heads/main/openapi/infoway-terminology-service-api-openapi.json