How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

VOA Health RNDS API

Submit, query, replace, and delete clinical records on the RNDS national bus.

VOA Health RNDS API is one of 2 APIs that VOA Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include RNDS. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 6 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://api.voa.health.

6 operations 6 paths 8 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://integration.voa.health/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

VOA Health RNDS API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-voa-token (authToken).

  • authToken — Voa Auth Token issued to the integrating partner.

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

RNDS 6

Submit, query, replace, and delete clinical records on the RNDS national bus.

POST
/ehrs/{ehr_id}/rnds/submit
Enviar registro clínico à RNDS
submitRndsRecord 1 param body → 200400422
GET
/ehrs/{ehr_id}/rnds/status
Consultar status de envio
getRndsStatus 1 param → 200404
PUT
/ehrs/{ehr_id}/rnds/replace
Substituir registro na RNDS
replaceRndsRecord 1 param body → 200400
DELETE
/ehrs/{ehr_id}/rnds
Excluir registro da RNDS
deleteRndsRecord 1 param body → 200400
GET
/rnds/patient
Consultar paciente na RNDS
getRndsPatient 2 params → 200404
GET
/rnds/practitioner
Consultar profissional na RNDS
getRndsPractitioner 1 param → 200404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Practitioner (6 properties), RndsStatus (6 properties), Patient (5 properties), RndsSubmitResult (5 properties). Each schema is shown below with its type and property counts.

RndsSubmitResult
object
5 properties
RndsStatus
object
6 properties
Practitioner
object
6 properties
RndsDeleteResult
object
3 properties
RndsSubmitRequest
object
5 properties 2 required
Error
object
Voa error envelope. Not RFC 9457; uses a machine-readable error code, a human message, and an optional details array.
3 properties
Patient
object
5 properties
RndsReplaceResult
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

voa-health-rnds-api-openapi.yml Raw ↑

Other APIs VOA Health publishes across the network.

VOA Health Authentication API
Where this information came from

This is an independent, third-party profile of VOA Health RNDS API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.