Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Health Gorilla DocumentReference API

Clinical document metadata.

Health Gorilla DocumentReference API is one of 10 APIs that Health Gorilla publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.1, at version R4.

Requests are made against 2 base URLs: https://api.healthgorilla.com/fhir/R4, https://sandbox.healthgorilla.com/fhir/R4.

2 operations 2 paths 2 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
R4
Base URL
https://api.healthgorilla.com/fhir/R4
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Health Gorilla DocumentReference API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 bearer access token. Obtain a token using the client credentials issued during onboarding via the Health Gorilla OAuth 2.0 token endpoint, then pass…

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

DocumentReference 2

Clinical document metadata.

GET
/DocumentReference
Search DocumentReference resources.
searchDocumentReferences 3 params → 200
GET
/DocumentReference/{id}
Read a DocumentReference resource by id.
readDocumentReference 1 param → 200

Schemas 2

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

DocumentReference
object
6 properties
Bundle
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

health-gorilla-documentreference-api-openapi.yml Raw ↑

Other APIs Health Gorilla publishes across the network.

Health Gorilla Binary API
Health Gorilla CapabilityStatement API
Health Gorilla Coverage API
Health Gorilla DiagnosticReport API
Health Gorilla Observation API
Health Gorilla Patient API
Health Gorilla Practitioner API
Health Gorilla RequestGroup API
Health Gorilla ServiceRequest API