Tracker¶
Le trackers incluent un ou plusieurs programmes de suivi pour la collecte de données au niveau individuel (niveau individuel) et les métadonnées associées telles que les indicateurs de programme et les tableaux de bord. Dans la mesure du possible, les configurations de suivi incluent les indicateurs de programme nécessaires pour remplir les ensembles de données des packages de configuration agrégés associés.
Tracked Entity Attributes¶
status |
Time |
Size |
200 OK |
2.41 s |
798 B |
{ "trackedEntityAttributes": [ { "id": "xxxxxxxxxxx", "displayName": "Adresse" }, { "id": "xxxxxxxxxxx", "displayName": "Age" }, { "id": "xxxxxxxxxxx", "displayName": "Mois" }, { "id": "xxxxxxxxxxx", "displayName": "Noms" }, { "id": "xxxxxxxxxxx", "displayName": "Prenoms" }, { "id": "xxxxxxxxxxx", "displayName": "Sexe" } ] }
status |
Time |
Size |
200 OK |
1878 ms |
1.46 KB |
{ "lastUpdated": "2017-11-22T09:39:42.860", "id": "xxxxxxxxxxx", "href": "https://ministere-sante.mg/api/trackedEntityAttributes/xxxxxxxxxxx", "created": "2017-11-22T09:39:42.860", "name": "Adresse", "shortName": "Adresse", "aggregationType": "COUNT", "displayInListNoProgram": false, "publicAccess": "rw------", "displayName": "Adresse", "pattern": "", "description": "Adresse", "skipSynchronization": false, "displayShortName": "Adresse", "externalAccess": false, "periodOffset": 0, "generated": false, "displayOnVisitSchedule": false, "valueType": "TEXT", "confidential": false, "orgunitScope": false, "displayDescription": "Adresse", "dimensionItem": "xxxxxxxxxxx", "displayFormName": "Adresse", "unique": false, "inherit": false, "favorite": false, "dimensionItemType": "PROGRAM_ATTRIBUTE", "optionSetValue": false, "access": { "read": true, "update": false, "externalize": false, "delete": false, "write": false, "manage": false }, "user": { "displayName": "xxxxxxxxxxx", "id": "xxxxxxxxxxx" }, "favorites": [], "translations": [], "userGroupAccesses": [], "attributeValues": [], "userAccesses": [], "legendSets": [] }
Tracked Entity Instance Filters¶
Pour créer, lire, mettre à jour le tracked entity instance filters, vous pouvez interagir avec la ressource /api/trackedEntityInstanceFilters.
status |
Time |
Size |
200 OK |
5.31 s |
546 B |
{
"trackedEntityInstanceFilters": []
}
Pour rechercher des tracked entity instance filters dans le système, vous pouvez interagir avec la ressource /api/trackedEntityInstanceFilters.
Paramètres de requête des filtres d’instance d’entité suivie
Paramètre de requête |
Description |
---|---|
program |
Identificateur du programme. Limite les filtres au programme donné. |
Tracked Entity Types¶
status |
Time |
Size |
200 OK |
2.92 s |
638 B |
{ "trackedEntityTypes": [ { "id": "xxxxxxxxxxx", "displayName": "Person" }, { "id": "xxxxxxxxxxx", "displayName": "Renseignement Malade" } ] }
Tracked Entity Instances¶
Pour rechercher des tracked entity instance filters dans le système, vous pouvez interagir avec la ressource /api/trackedEntityInstanceFilters.
Paramètres de requête des instances d’entités suivies
Paramètre de requête |
Description |
---|---|
filter |
Attributs à utiliser comme filtre pour la requête. Param peut être répété plusieurs fois. Les filtres peuvent être appliqués à une dimension du format <attribute-id>:<operator>:<filter>[:<operator>:<filter>]. Les valeurs de filtre sont insensibles à la casse et peuvent être répétées plusieurs fois avec l’opérateur. Les opérateurs peuvent être EQ | GT | GE | LT | LE | NE | LIKE | IN. |
ou |
Identifiants des unités organisationnelles, séparés par « ; ». |
ouMode |
Le mode de sélection des unités d’organisation peut être SELECTED | CHILDREN | DESCENDANTS | ACCESSIBLE | CAPTURE | ALL. La valeur par défaut est SELECTED, qui se réfère uniquement aux unités d’organisation sélectionnées. Voir le tableau ci-dessous pour les explications. |
program |
Identificateur du programme. Limite les cas d’inscription au programme donné. |
programStatus |
Statut de l’instance pour le programme donné. Peut être ACTIVE | COMPLETED | CANCELLED. |
followUp |
Suivi de l’état de l’instance pour le programme donné. Peut être vrai | faux ou omis. |
programStartDate |
Date de début de l’inscription au programme donné pour l’entité suivie. |
programEndDate |
Date de fin d’inscription au programme donné pour l’entité suivie. |
trackedEntity |
Identificateur d’entité suivi. Limite les instances au type d’instance suivi donné. |
page |
Le numéro de page. La page par défaut est 1. |
pageSize |
La taille de la page. La taille par défaut est 50 lignes par page. |
totalPages |
Indique s’il faut inclure le nombre total de pages dans la réponse de téléappel (ce qui implique un temps de réponse plus élevé). |
skipPaging |
Indique si la pagination doit être ignorée et si toutes les lignes doivent être retournées. |
lastUpdatedStartDate |
Filtre pour les événements qui ont été mis à jour après cette date. Ne peut pas être utilisé avec lastUpdatedDuration. |
lastUpdatedEndDate |
Filtre pour les événements qui ont été mis à jour jusqu’à cette date. Ne peut pas être utilisé avec lastUpdatedDuration. |
lastUpdatedDuration |
N’inclure que les éléments mis à jour dans la durée donnée. Le format est , où les unités de temps prises en charge sont « d » (jours), « h » (heures), « m » (minutes) et « s » (secondes). Ne peut pas être utilisé avec lastUpdatedStartDate and/or lastUpdatedEndDate. |
assignedUserMode |
Limite le résultat à tei avec les événements attribués en fonction du mode de sélection de l’utilisateur assigné, peut être CURRENT | PROVIDED | NONE | ANY. |
assignedUser |
Filtrez le résultat jusqu’à un ensemble limité de teis avec des événements qui sont affectés aux identifiants d’utilisateur donnés en utilisant assignedUser=id1;id2. Ce paramètre ne sera pris en compte que si assignedUserMode affecté est PROVIDED ou null. L’API sera une erreur, si par exemple, assignedUserMode=CURRENT et assignedUser=someId |
trackedEntityInstance |
Filtrer le résultat jusqu’à un ensemble limité de teis en utilisant les uids explicites des instances d’entités suivies en utilisant trackedEntityInstance=id1;id2. Ce paramètre créera à tout le moins la limite extérieure des résultats, formant la liste de tous les teis en utilisant les uids fournis. Si d’autres paramètres/filtres de cette table sont utilisés, ils limiteront davantage les résultats de la limite extérieure explicite. |