Skip to main content

OCL Adaptor

About OCL​

OCL (Open Concept Lab) is an open-source platform that provides a collaborative environment for creating, managing, and sharing standardized healthcare terminologies, dictionaries, and value sets.

Relationships between concepts are defined in OCL as mappings. The API supports searching and editing concepts and mappings, building sources, and logically grouping concepts and mappings into collections. See OCL docs to learn more, access the Swagger API, and to learn more about the cloud instance available at https://openconceptlab.org.

Integration Options​

1. Rest API: OCL offers a REST API that allows systems to interact with its concept dictionaries and value sets. With the API, you can: This option is suited for scheduled synchronization or workflows requiring regular updates to or from OCL. Refer to the OCL REST API documentation for endpoint details and usage examples.

2. Bulk Export and Import: OCL supports exporting and importing concept dictionaries and value sets in various formats (e.g., JSON, CSV). This allows for manual or automated bulk data integration. Use this option for one-time data transfer or systems without direct API connectivity.

Authentication​

When integrating with OCL via OpenFn, you must provide a username and password to generate an authorization token (see OCL docs). See this adaptor's Configuration docs for more on the required authentication parameters.

See platform docs on managing credentials for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:

{
  "hostUrl": "https://api.openconceptlab.org/",
  "username": "usernmame",
  "password": "supersecretpassword"
}
  1. OCL Developer Guide
  2. OCL API Reference
  3. OCL Community Support
  4. OCL GitHub Repository

Implementation Examples​

  1. OpenFn Prototype for Médecins Sans Frontières (MSF) LIME Project - OpenMRS -> OCL -> DHIS2 sync: https://github.com/OpenFn/openfn-lime