Skip to main content

​
Overview

The Parchment Health API is a RESTful API that allows you to manage your Patient information in Parchment. Our API follows industry standards including RFC 7807 for error responses and provides consistent, predictable response formats across all endpoints.

​
Getting Started

Once you’ve received your sandbox credentials from Parchment, follow these steps to start using the API.

Sign up to the Parchment sandbox

Create your partner account in the Parchment sandbox environment.

Generate API credentials

Generate your API client credentials from the Parchment sandbox portal.

Connect each organization

Call the /validate endpoint for each organization you need to connect so that the org is linked to your integration. See Partner Token Creation for details.

Implement the relevant APIs

Implement the Parchment APIs that are relevant to your business workflows (patients, users, prescriptions, SSO, iFrame etc.).

Test your implementation

Validate end-to-end behaviour against the sandbox environment to ensure your integration works as expected.

Request the conformance form

Request the conformance form from Parchment once your sandbox implementation is complete.

​
Response Structure

All API responses follow a standardized format. See the Response Standards section for detailed information about success and error response formats.