This API will help you connect to the Patient Vault 2.0 API. The API is a REST API which you can connect thru HTTP verbs.
The following links will help you get started with the PatientVault API:
Configuration and Browsers
The following are the endpoint URLS:
- Any browser can be used to connect to the API since it uses simple HTTP verbs for communication.
Security on Endpoints
To connect to the Patient Vault API you will need to connect via SSL using the HTTPS endpoint only.
Credentials for the API
The portal requires the following credentials to work
|API Key||An API Key provided to you as a developer/company|
|DEV Key||A developer key provided to your application|
|User Name / Password||These are the portal credentials for the user / patient accessing the portal|
These credentials are provided on the Login API call.
Getting your API keys
To use the Patient Vault API as a developer you will need an API key and a DEV key. The keys are free and you can obtain them by emailing firstname.lastname@example.org.
Testing the API and API Clients
You can use POSTMAN to test the API by importing the collection below. Once you have tested you can use any programming language to connect to the API via HTTP.
|Postman Screenshot||Postman Collection|
- Can date range parameters can be used on each of these categories?
- Yes, you can specify a specific category and include the date range, on a category where it there are dates involved, the API will filter by the dates provided.