-
Notifications
You must be signed in to change notification settings - Fork 18
Create documentation for EAPTS adaptor #717
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mercy-ship-it
wants to merge
5
commits into
main
Choose a base branch
from
mercy-ship-it-eapts-adaptor
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| --- | ||
| title: EAPTS Adaptor | ||
| --- | ||
|
|
||
| ## About EAPTS | ||
|
|
||
| [EAPTS](https://dhpi.moh.gov.et/project/b7175989-30d8-42d6-a5ee-8d48cbad0c61) (Electronic Asset and Pharmaceutical Tracking System) is a comprehensive pharmaceutical management platform used across healthcare facilities to monitor medicines, medical supplies, and equipment. | ||
|
|
||
| It provides real-time visibility into inventory, prescription tracking, and dispensing unit performance to strengthen pharmaceutical logistics and health program oversight. | ||
|
|
||
| The **@openfn/language-eapts** adaptor enables seamless integration between OpenFn workflows and EAPTS APIs—automating tasks such as: | ||
|
|
||
| - Synchronizing stock and dispensing data | ||
| - Validating prescriptions and patient records | ||
| - Generating dashboards or analytics reports | ||
| - Monitoring supply chain performance programmatically | ||
|
|
||
| --- | ||
|
|
||
| ## Use OpenFn + EAPTS for Data-Driven Health Workflows | ||
|
|
||
| EAPTS plays a critical role in pharmaceutical inventory control and traceability. | ||
| However, managing cross-system data exchange—such as syncing with DHIS2, KoboToolbox, or Salesforce—can be complex. | ||
|
|
||
| **OpenFn workflows bridge this gap**, enabling automated data exchange, real-time validations, and notifications across multiple digital health systems. | ||
|
|
||
| Example: | ||
| > Use OpenFn to fetch updated stock levels from EAPTS nightly and automatically sync them with your national reporting system. | ||
|
|
||
| --- | ||
|
|
||
| ## Integration Options | ||
|
|
||
| Use this adaptor to connect to the **EAPTS API**, enabling your workflows to make authenticated HTTP requests for retrieving or sending data related to medicines, stock reports, or prescription validations. | ||
|
|
||
| Typical workflow example: | ||
|
|
||
| _Coming soon !!!_ | ||
|
|
||
| --- | ||
|
|
||
| ## Authentication | ||
|
|
||
| See this adaptor’s | ||
| [Configuration docs](https://docs.openfn.org/adaptors/packages/eapts-configuration-schema) | ||
| for details on the authentication parameters required to connect securely to the EAPTS API. | ||
|
|
||
| --- | ||
|
|
||
| ## Functions | ||
|
|
||
| ### `get(path, options) ⇒ Operation` | ||
|
|
||
| Make a GET request to fetch data from EAPTS. | ||
|
|
||
| | Param | Type | Description | | ||
| |-------|------|-------------| | ||
| | path | `string` | Path to the API resource | | ||
| | options | `RequestOptions` | Optional request parameters | | ||
|
|
||
| **Writes to state:** | ||
|
|
||
| | State Key | Description | | ||
| |-----------|-------------| | ||
| | data | Parsed response body | | ||
| | response | HTTP response (headers, statusCode, body, etc.) | | ||
| | references | Array of previous data objects used in the Job | | ||
|
|
||
| **Example: Get a stockout report** | ||
| ```js | ||
| get("DispensingUnit/Dashboard/StockOutReport"); | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the format arrangement is different compared to the other documents