Skip to main content

Developer README for the godata adaptor

Source: https://github.com/OpenFn/adaptors/tree/main/packages/godata

language-godata

An OpenFn adaptor for building integration jobs for use with the WHO Go.Data API.

Go.Data is an outbreak investigation tool for field data collection during public health emergencies. The tool includes functionality for case investigation, contact follow-up, visualization of chains of transmission including secure data exchange and is designed for flexibility in the field, to adapt to the wide range of outbreak scenarios.

Documentation

sample configuration

{
"email": "mamadou@openfn.org",
"password": "supersecret",
"apiUrl": "https://www.who-godata.com/api"
}

Helper Functions

post(...)

Fetch the list of outbreaks

This function is used to fetch the whole list of outbreaks in Go.Data.

listOutbreaks(state => {
console.log(state.data);
return state;
});

Get a specific outbreak

This function can be used to fetch one specific outbreak. A filtering mechanism is used to specify a criteria to match. Mutliple outbreaks could be returned if matched by the filter.

getOutbreak({ where: { name: 'Outbreak demo' } }, state => {
console.log(state.data);
return state;
});

Insert or Update an outbreak using a unique id as a key

This function is used to either update a record in Go.Data if matched or insert a new one if no record matched the unique id.

upsertOutbreak({
externalId: '3dec33-ede3',
data: {
name: 'string',
description: 'string',
disease: 'string',
countries: [
{
id: 'SENEGAL',
},
],
startDate: '2020-12-17T14:54:19.498Z',
endDate: '2020-12-17T14:54:19.498Z',
longPeriodsBetweenCaseOnset: 0,
periodOfFollowup: 0,
},
});

Fetch the list of cases

This function is used to fetch the whole list of cases for a specific outbreak in Go.Data.

listCases('4c444f7-4e11-41d0-c1af-331dd15a892e', state => {
console.log(state);
return state;
});

Get a specific case

This function can be used to fetch one specific case for an outbreak. A filtering mechanism can specify a criteria to match. Mutliple cases could be returned if matched by the filter.

getCase(
'4c444f7-4e11-41d0-c1af-331dd15a892e',
{ 'where.relationship': { active: true }, where: { firstName: 'Luca' } },
state => {
console.log(state);
return state;
}
);

Insert or Update a case using a unique id as a key

This function is used to either update a case in Go.Data if matched or insert a new one if no record matched the unique id.

upsertCase('4dce-3eedce3-rd33', 'visualId',
data: state => {
const patient = state.data.body;
return {
firstName: patient.Patient_name.split(' ')[0],
lastName: patient.Patient_name.split(' ')[1],
visualId: patient.Case_ID,
'age:years': patient.Age_in_year,
gender: patient.Sex,
};
});

Fetch the list of contacts

This function is used to fetch the whole list of contacts for a specific outbreak in Go.Data.

listContacts('4c444f7-4e11-41d0-c1af-331dd15a892e', state => {
console.log(state);
return state;
});

Get a specific contact

This function can be used to get one specific contact for an outbreak. A filtering mechanism can specify a criteria to match. Mutliple contacts could be returned if matched by the filter.

getContact('343d-dc3e', { where: { firstName: 'Luca' } }, state => {
console.log(state.data);
return state;
});

Insert or Update a contact using a unique id as a key

This function is used to either update a contact in Go.Data if matched or insert a new one if no record matched the unique id.

upsertContact('4dce-3eedce3-rd33', 'visualId', {
firstName: 'Luca',
gender: 'male',
'age:years': '20',
});

Fetch the list of locations

This function is used to fetch the list of locations.

listLocations(state => {
console.log(state);
return state;
});

Get a specific location

This function can be used to get one specific location. A filtering mechanism can specify a criteria to match. Mutliple locations could be returned if matched by the filter.

getLocation({ where: { name: '30 DE MAYO' } }, state => {
console.log(state.data);
return state;
});

Insert or Update a location using a unique id as a key

This function is used to either update a location if matched or insert a new. A custom externalId can be provided.

upsertLocation('name', {
name: '30 DE DECIEMBRE',
synonyms: [],
identifiers: [],
active: true,
populationDensity: 0,
geoLocation: {
lat: -45.343244,
lng: -67.193873,
},
});

Fetch the list of reference data

This function is used to fetch the list of reference data.

listReferenceData(state => {
console.log(state);
return state;
});

Get a specific reference data

This function can be used to get one specific reference data. A filtering mechanism can specify a criteria to match.

getReferenceData(
{ where: { categoryId: 'LNG_REFERENCE_DATA_CATEGORY_CENTRE_NAME' } },
state => {
console.log(state.data);
return state;
}
);

Insert or Update a reference data using a unique id as a key

This function is used to either update a location if matched or insert a new. A custom externalId can be provided.

upsertReferenceData('id', {
categoryId: 'CATEGORY',
value: 'VALUE',
readOnly: false,
active: true,
id: 'ID',
createdAt: '2020-10-01T18:48:31.784Z',
createdBy: '95d31ea9',
updatedAt: '2020-10-01T18:48:31.784Z',
updatedBy: '95d31ea9',
createdOn: 'API',
deleted: false,
});

Development

Clone the adaptors monorepo. Follow the Getting Started guide inside to get set up.

Run tests using pnpm run test or pnpm run test:watch

Build the project using pnpm build.

To just build the docs run pnpm build docs