Getting started
Last updated
Was this helpful?
Last updated
Was this helpful?
The ePrescription module is available as a Docker image with several versioning options:
The latest
tag represents the most recent development version, though it may contain unstable features
The stable
tag indicates a thoroughly tested version that has passed through multiple release cycles without known issues
For specific versions, we use vMAJOR.MINOR.PATCH
tags following conventions
Deploy the Docker image to your infrastructure using the following reference compose as a guide.
The module can function without volume mounts, but we recommend mounting a volume to /data
to enable directory backup functionality and ensure data persistence.
Resource definitions will be provided by our team directly.
Create the application using the provided resource definition. To do that, simply insert the resource definition into the App section in Aidbox (/ui/console#/entities/App
).
Key Notes:
Include your real secret in Client section (replace PUT_SECRET_HERE
).
Include your deployment host (replace PUT_APP_ENDPOINT_URL_HERE
), but retain the /rpc
part.
After deployment, test the setup by calling these endpoints:
(directly) /
: Access the OpenAPI/Swagger documentation to explore available APIs.
(directly) /api/configuration
: Get all module configuration for debugging purposes.
(via aidbox) /e-prescription/health
: Check the current version and retrieve health state.
If you're not sure about the Surescripts secrets, please read this guide:
For more information about available configuration options, please go to the .