Guides

Guides explain how to use APIs and platform tools in real-world workflows. They provide step-by-step instructions and practical examples for implementing solution-specific and workflow-specific use cases using both API-based integrations and supported UI-based configuration and validation flows.

Each guide focuses on how components work together in practice—such as retrieving longitudinal patient records, configuring Clinical Alerts delivery, managing enrollment, or validating integration readiness—rather than documenting individual endpoints in isolation. For detailed request and response definitions, refer to the API Reference.

Guides may include a combination of programmatic steps, administrative actions, and operational considerations, depending on the workflow. Together, they are intended to help you move from initial setup through testing and into production.

If you need help with implementation planning or configuration, contact your Client Success Manager or create a Support ticket.