From eb5c48b16b75a3a2727ec23f4b25c759d71549c2 Mon Sep 17 00:00:00 2001 From: Aleksa Krolls Date: Sat, 7 Dec 2024 13:43:37 +0300 Subject: [PATCH] Update ocl links --- adaptors/ocl.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/adaptors/ocl.md b/adaptors/ocl.md index 0fe4eddbf87..7032d2f97cb 100644 --- a/adaptors/ocl.md +++ b/adaptors/ocl.md @@ -6,15 +6,17 @@ title: OCL Adaptor [OCL (Open Concept Lab)](https://openconceptlab.org/) 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]()https://docs.openconceptlab.org/en/latest/oclapi/overview.html#overview to learn more, access the [Swagger API](https://api.openconceptlab.org/swagger/), and to learn more about the cloud instance available at [https://openconceptlab.org](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](https://docs.openconceptlab.org/en/latest/oclapi/overview.html) 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 integrations or systems without direct API connectivity. +**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, **Basic Authentication** is supported. See this adaptor's [Configuration docs](/adaptors/packages/ocl-configuration-schema) for more on the required authentication parameters. +When integrating with OCL via OpenFn, you must provide a username and password to generate an authorization token ([see OCL docs](https://docs.openconceptlab.org/en/latest/oclapi/overview.html#authentication-and-authorization)). See this adaptor's [Configuration docs](/adaptors/packages/ocl-configuration-schema) for more on the required authentication parameters. See platform docs on [managing credentials](documentation/manage-projects/manage-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: