VOA Health · OpenAPI Overlay 1.0.0

API Evangelist enrichment overlay — Voa RNDS API

3 actions 3 updates update extends ../openapi/voa-health-rnds-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for VOA Health's API. It is a proposal applied on top of the contract, not a document VOA Health publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-rate-limitsx-error-formatx-error-detailx-conventionsx-authenticationx-conformancex-data-standardx-token-exchange

Targets 3

$.info

$.paths['/ehrs/{ehr_id}/rnds/submit'].post

$.paths['/ehrs/{ehr_id}/rnds'].delete

OpenAPI Overlay

overlay: 1.0.0
x-provenance:
  generated: '2026-07-21'
  method: generated
  source: >-
    API Evangelist enrichment overlay for openapi/voa-health-rnds-openapi.yml.
    Captures cross-cutting metadata (rate limits, FHIR/RNDS context, error
    envelope, auth exchange) without mutating the base spec.
info:
  title: API Evangelist enrichment overlay — Voa RNDS API
  version: 1.0.0
extends: ../openapi/voa-health-rnds-openapi.yml
actions:
  - target: $.info
    update:
      x-rate-limits:
        requests_per_hour: 1000
        requests_per_second: 10
        note: RNDS national-bus round trips add 2-5s latency; use async calls.
      x-error-format: custom
      x-error-detail: ../errors/voa-health-problem-types.yml
      x-conventions: ../conventions/voa-health-conventions.yml
      x-authentication: ../authentication/voa-health-authentication.yml
      x-conformance: ../conformance/voa-health-conformance.yml
      x-data-standard: FHIR R4 (Brazilian RNDS profiles)
  - target: $.paths['/ehrs/{ehr_id}/rnds/submit'].post
    update:
      x-token-exchange: POST https://api.voa.health/integration/identify/ (Auth Token -> Bearer JWT)
      x-fhir-document-types: [RAC, RPM, REL]
  - target: $.paths['/ehrs/{ehr_id}/rnds'].delete
    update:
      x-irreversible: true
      x-warning: Deletion on the RNDS national bus is irreversible.

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/voa-health-rnds-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.