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

Datavant Visits API

A visit is a record of the actions performed by Datavant to obtain charts from a specific clinic within the specified date ranges for a specific patient.

Datavant Visits API is one of 8 APIs that Datavant publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Visits. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, and a changelog.

This API exposes 2 operations across 2 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 2023-04-01.

Requests are made against a single base URL, https://api.datavant.io/v2.

2 operations 2 paths 25 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-04-01
Base URL
https://api.datavant.io/v2
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Datavant Visits API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow. By default, every request must be authenticated.

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.

Visits 2

A visit is a record of the actions performed by Datavant to obtain charts from a specific clinic within the specified date ranges for a specific patient.

GET
/projects/{project_id}/queries/{query_id}/visits/{visit_uuid}
Get details about a specific visit under the given project and query.
get_visit_details_projects__project_id__queries__query_id__visits__visit_uuid__get 4 params → 200400422404
GET
/projects/{project_id}/queries/{query_id}/visits
Get all visits for a particular patient (identified by query.id) across all orders in the given project.
get_query_visits_projects__project_id__queries__query_id__visits_get 5 params → 200400422404

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are Patient (17 properties), Visit (12 properties), Facility (8 properties), Practitioner (7 properties). Each schema is shown below with its type and property counts.

ChartPackage
Packages referring to pre-configured bundles of chart components.
BirthDate
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
3 properties 3 required
JsonApiPage_Visit_
object
JSON:API 1.0 specification says that result key should be a data.
6 properties 3 required
Links
object
5 properties
Visit
object
An effort to obtain charts from a patient's visit to a specific clinic within the specified date ranges.
12 properties 12 required
VisitRetrievalDetails
object
Details about the retrieval of a visit.
2 properties 1 required
Patient
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
17 properties 1 required
VisitStatusDetail
Enum for visit status tags.
Encounter
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
6 properties 1 required
ChartComponent
Individual components of a chart.
Gender
string
An enumeration.
Facility
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
8 properties
Error
object
3 properties 2 required
UserDefinedText
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
4 properties
FacilityType
string
An enumeration.
ServiceDates
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
2 properties 1 required
DateRange
object
A date range for a visit.
2 properties 1 required
VisitHistoryEntry
object
The ledger of updates made to a visit.
3 properties 3 required
Insurance
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
4 properties
VisitType
Enum for visit types.
ErrorHTTPResponse
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
1 property 1 required
VisitDocuments
object
Documents attached to a visit.
5 properties
Address
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
7 properties
VisitStatus
Enum for visit statuses.
Practitioner
object
A custom BaseModel with the eventual goal of populating inheriting models with the value property of enums rather than the raw enum. For now this is set to Fal…
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datavant-visits-api-openapi.yml Raw ↑

Other APIs Datavant publishes across the network.

Datavant Configuration API
Datavant Documents API
Datavant Oauth2 API
Datavant Order Queries API
Datavant Orders API
Datavant Prematch API
Datavant Projects API
Where this information came from

This is an independent, third-party profile of Datavant Visits 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.