guide de l’API pour ePATHogène

De l'Agence de la santé publique du Canada

L’utilisation de cette API vous permettra d’obtenir les données sur les pathogènes que vous voulez dans votre application. Il est fourni sous forme de recherche, la même recherche que l’application utilise.

Recherche dans l’API

URL :

https://health.canada.ca/fr/epathogene/recherche

méthode HTTP

GET

Description

Cette fonction de recherche retournera la liste des agents avec tous les détails.

Arguments

term

Par défaut chaîne vide

Le terme que vous voulez rechercher (p. ex., le nom de l’agent pathogène). Lorsqu’une chaîne vide est transmise, la liste complète des agents pathogènes sera retournée.

format

Par défaut 'json'

Précisez le format dans lequel vous voulez que les informations vous soient retournées. La valeur par défaut est JSON, mais vous pouvez préciser csv pour retourner un fichier CSV. Vous pouvez également préciser csvweb pour recevoir un fichier lisible par l’humain CSV (les clés de colonne sont lisibles par l’utilisateur plutôt que des identificateurs).

lang

Par défaut 'en'

La langue d’affichage choisie pour les résultats. Les valeurs acceptées sont en et fr.

agentType

Par défaut tableau vide

Un tableau de types d’agents à retourner. Les types d’agents sont les bactéries, les champignons, les prions, les virus, etc. Les valeurs sont séparées par « ou », ce qui signifie que si vous sélectionnez deux valeurs, le système retournera les agents qui font partie de l’un et l’autre groupe, et pas seulement les agents qui font partie uniquement des deux groupes.Pour obtenir une liste des valeurs valides, veuillez consulter la section sur le remplissage automatique ci-dessous.

humanRisk

Par défaut 'en'

Un tableau de classification des groupes de risque humain à retourner. Les valeurs sont séparées par « ou », ce qui signifie que si vous sélectionnez deux valeurs, le système retournera les agents qui font partie de l’un et l’autre groupe, et pas seulement les agents qui font partie uniquement des deux groupes. Pour obtenir une liste des valeurs valides, veuillez consulter la section sur le remplissage automatique ci-dessous.

animalRisk

Par défaut 'en'

Un tableau de classification des groupes de risque animal à retourner. Les valeurs sont séparées par « ou », ce qui signifie que si vous sélectionnez deux valeurs, le système retournera les agents qui font partie de l’un et l’autre groupe, et pas seulement les agents qui font partie uniquement des deux groupes. Pour obtenir une liste des valeurs valides, veuillez consulter la section sur le remplissage automatique ci-dessous.

terrestrialAnimalPathogenUnderCFIAAuthority

Par défaut -1

Est-ce que les résultats devraient n’inclure que l’agent pathogène de type animal terrestre sous l’autorité de l’ACIA? Pour obtenir une liste des valeurs valides, veuillez consulter la section sur le remplissage automatique ci-dessous.

securitySensitiveBiologicalAgent

Par défaut -1

Est-ce que les résultats devraient n’inclure que l’agent pathogène dont la sécurité est de nature délicate? Pour obtenir une liste des valeurs valides, veuillez consulter la section sur le remplissage automatique ci-dessous.

idAsKey

Par défaut true

Booléen. S’il est établi à vrai, un objet JSON sera retourné avec l’identificateur de l’agent comme clés de l’objet. S’il est établi à faux, un tableau normal de JSON (aucune clé) sera retourné. Ceci ne s’applique que pour retourner JSON.

Retours de la recherche

Si le format demandé est json, l’information sera retournée dans les formats décrits ci-dessous. Si l’on utilise le format csv , les colonnes sont représentées par le même objet results (résultat) décrit ci-dessous, sauf que le altNames n’est pas un objet, mais une liste d’autres noms séparés par une virgule. Si l’on utilise le format csvweb, toutes les ID des colonnes et de certaines colonnes de date seront supprimées. Ce dernier format est principalement présenté comme étant lisible par l’utilisateur.

options

Objet contenant tous les paramètres de recherche reçus par le serveur.

results

Si l’argument idAsKey est vrai, alors results (résultats) est un objet dont les clés sont l’identificateur de chaque agent. L’Identificateur est en format UUID (p. ex. : 643dde10-6394-e511-814c-000c2902c387). S’il a été établi à faux, résultats est un simple tableau d’agents. Chaque agent est un objet avec les clés suivantes :

id

Un UUID unique pour l’agent.

name

Le nom de l’agent, les autres noms se trouvent dans la clé altName.

type

Prêt à afficher le type d’agent lisible par l’utilisateur dans la langue demandée.

typeId

L’identificateur spécifique de ce type d’agent.

HumanRiskGroup

Prêt à afficher la valeur lisible par l’utilisateur de la classification de groupes de risque pour l’humain ou de la toxine réglementée ou non réglementée pour l’humain.

HumanRiskGroupId

L’identificateur spécifique de cette classification de groupe de risque pour l’humain.

AnimalRiskGroup

Prêt à afficher la valeur lisible par l’utilisateur de la classification de groupes de risque pour l’animal ou de la toxine animale réglementée ou non réglementée.

AnimalRiskGroupId

L’identificateur spécifique de cette classification de groupe de risque pour l’animal.

SecuritySensitiveBiologicalAgent

Prêt à afficher la valeur lisible par l’utilisateur de l’agent biologique dont la sécurité est de nature délicate. Des exigences de sécurité supplémentaires s’appliquent.

SecuritySensitiveBiologicalAgentId

L’identificateur spécifique de cette valeur SecuritySensitiveBiologicalAgent.

TerrestrialAnimalPathogenUnderCFIAAuthority

Prêt à afficher la valeur lisible par l’utilisateur si l’agent est un agent pathogène pour les animaux terrestres sous l’autorité de l’Agence canadienne d’inspection des aliments. Les agents pathogènes qui touchent les animaux aquatiques, les abeilles et les plantes sont également réglementés par l’ACIA.

TerrestrialAnimalPathogenUnderCFIAAuthorityId

L’identificateur spécifique de cette valeur TerrestrialAnimalPathogenUnderCFIAAuthority.

ContainmentLevel

Prêt à afficher la valeur lisible par l’utilisateur du niveau de confinement requis pour cet agent.

ContainmentLevelId

L’identificateur spécifique de cette valeur ContainmentLevel.

ConsiderationsForContainment

Si l’agent accorde une attention particulière au confinement, ce sera indiqué dans ce champ.

AgentCreatedDate

La date de création de cet agent dans notre base de données.

AgentLastModifiedDate

La date de la dernière modification de cet agent dans notre base de données.

RiskAssessmentCreatedDate

La date de création de l’évaluation des risques dans notre base de données.

RiskAssessmentLastModifiedDate

La date de la dernière modification de l’évaluation des risques de cet agent.

orderValue

Valeur interne utilisée pour commander la liste d’agents. Si le nom de l’agent correspond exactement au term (terme) de la recherche, la valeur est de 100. Si le nom de l’agent commence par le terme de recherche, cette valeur est 85. Si le terme complet est présent dans le nom (p. ex., le terme encéphalopathie dans le nom Agent d’encéphalopathie spongiforme bovine), la valeur est 75. Si le terme correspond au début d’un mot dans le nom, la valeur est 50. Si le terme correspond à la fin d’un mot, la valeur est 25. Enfin, si la valeur représente une partie d’un mot dans le nom, la valeur sera 10.

altName

Un tableau de tous les autres noms, s’il y a lieu, pour cet agent. Chaque élément de ce tableau est composé de :

altId

L’UUID spécifique à cet autre nom de l’agent.

name

L’autre nom de cet agent.

latestDateModified

La date la plus récente de cette liste : AgentCreatedDate, AgentLastModifiedDate, RiskAssessmentCreatedDate et RiskAssessmentLastModifiedDate.

Remplissage automatique

URL :

https://sante.canada.ca/fr/epathogene/autocomplete

méthode HTTP

GET

Description

Cette URL fournira une liste JSON de valeurs ou d’étiquettes pour chaque élément à remplir. Vous pouvez l’utiliser comme un formulaire de saisie pour l’utilisateur final ou comme une liste de remplissage automatique.

Arguments

lang

Par défaut 'en'

The language you want the results in. Accepted values are 'en' and 'fr'.

returnNames

Par défaut true

Si la valeur est vrai, tous les noms de l’agent de la base de données seront retournés (utilisés dans le remplissage automatique). Si la valeur est faux, seulement les autres renseignements seront retournés, ce qui peut économiser une partie de la bande passante si vous ne l’utilisez pas.

Retour du remplissage automatique (JSON)

names

Tableau des noms et autres noms d’agent de la base de données. Il peut servir au remplissage automatique lorsque l’utilisateur entre un terme de recherche.

types

Tableau d’objets comprenant value (la valeur) et label (l’étiquette) de chaque type d’agent de la base de données.

humanRisk

Tableau d’objets comprenant value (la valeur) et label (l’étiquette) des classifications de groupe de risque valides pour l’humain.

animalRisk

Tableau d’objets comprenant value (la valeur) et label (l’étiquette) des classifications de groupe de risque valides pour l’animal.

terrestrialAnimalPathogen

Tableau d’objets comprenant value (la valeur) et label (l’étiquette) des valeurs possibles de terrestrialAnimalPathogen.

securitySensitive

Tableau d’objets comprenant value (la valeur) et label (l’étiquette) des valeurs possibles de securitySensitive.