How to Use

Basic usage of Verto APIs

Basics

Verto's Web API is a collection of RESTful methods.

Use HTTPS, SSL and TLS v1.2 or above when calling these endpoints.

You should use the following methods to pass arguments to these endpoints:

  • GET query parameters
  • POST, PATCH parameters presented as application/json or application/fhir+json if using FHIR APIs.
  • DELETE query parameters are allowed for deletion reason
  • files.upload expects multipart/form-data

JSON-encoded bodies

When calling endpoints with POST or PATCH, please follow the below rules:

  • Content-Type in HTTP Header must be set to application/json
  • Access token should be defined in Authorization header as a Bearer token.
  • Do not mix arguments between query parameters, or request body.

Web API Responses

All Web API responses contain a JSON object. If the request is successful, the API will respond with a 200 OK response code with a structure defined in the reference documentation. Otherwise, it will respond with a non 2xx response code and a JSON response with the following format:

{
  "errors": {
    "patient": {
      "dob": "Date of Birth cannot be in the future."
    }
  }
}

Authentication

You should authenticate to the Web API using a Bearer token from the Authorization HTTP Header. You can obtain a Bearer token using the supported OAuth grant types.

Treat tokens as secrets. Tokens are able to execute actions on the authorized user's behalf. Do not publish tokens on public repositories, and encrypt them if necessary.

Retry Best Practices

In the case that the server is temporarily not able to respond to your requests, we recommend retrying using an exponential backoff and jitter approach.

Open API Specification

Refer to Reference

Edit on GitHub