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 Order Queries API

An order query is a request for medical records for a specific patient, but the exact encounter criteria are unknown and/or are flexible.It's possible, depending on the encounter criteria, that one or more patient searches and/or chases will result from an order query.

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

Tagged areas include Order Queries. 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 10 operations across 4 paths, and defines 23 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.

10 operations 4 paths 23 schemas 3 DELETE4 GET2 POST1 PUT

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 Order Queries 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 10

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

Order Queries 10

An order query is a request for medical records for a specific patient, but the exact encounter criteria are unknown and/or are flexible. It's possible, depending on the encounter…

GET
/orders/{order_id}/queries
List all queries for an order
list_queries_orders__order_id__queries_get 4 params → 200400422404
POST
/orders/{order_id}/queries
Add a query to an order
add_query_to_order_orders__order_id__queries_post 2 params body → 201400422404
GET
/orders/{order_id}/queries/{query_id}
Get a query from an order
get_query_in_order_orders__order_id__queries__query_id__get 3 params → 200400422404
PUT
/orders/{order_id}/queries/{query_id}
Update a query from an order
update_query_in_order_orders__order_id__queries__query_id__put 3 params body → 204400422404
DELETE
/orders/{order_id}/queries/{query_id}
Delete a query from an order
delete_query_orders__order_id__queries__query_id__delete 3 params → 204400422404
GET
/orders/{order_id}/queries/{query_id}/supporting-documents/patient-authorizations
List all Patient Authorizations.
list_patient_authorization_filenames_orders__order_id__queries__query_id__supporting_documents_patient_authorizations_get 5 params → 200400422
POST
/orders/{order_id}/queries/{query_id}/supporting-documents/patient-authorizations
Create Patient Authorization
create_patient_authorization_orders__order_id__queries__query_id__supporting_documents_patient_authorizations_post 3 params body → 200400422404409
DELETE
/orders/{order_id}/queries/{query_id}/supporting-documents/patient-authorizations
Delete All Patient Authorizations
delete_all_patient_authorizations_orders__order_id__queries__query_id__supporting_documents_patient_authorizations_delete 3 params → 200400422404
GET
/orders/{order_id}/queries/{query_id}/supporting-documents/patient-authorizations/{filename}
Get Patient Authorization
get_patient_authorization_orders__order_id__queries__query_id__supporting_documents_patient_authorizations__filename__get 4 params → 200400422404
DELETE
/orders/{order_id}/queries/{query_id}/supporting-documents/patient-authorizations/{filename}
Delete Patient Authorization
delete_patient_authorization_orders__order_id__queries__query_id__supporting_documents_patient_authorizations__filename__delete 4 params → 200400422404

Schemas 23

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

ChartPackage
Packages referring to pre-configured bundles of chart components.
FilenameResponse
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
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
Body_create_patient_authorization_orders__order_id__queries__query_id__supporting_documents_patient_authorizations_post
object
1 property 1 required
Links
object
5 properties
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
JsonApiPage_OrderQueryResponse_
object
JSON:API 1.0 specification says that result key should be a data.
6 properties 3 required
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
OrderQueryResponse
object
The representation of an OrderQuery as it is returned to an external customer.
6 properties 5 required
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
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
JsonApiPage_FilenameResponse_
object
JSON:API 1.0 specification says that result key should be a data.
6 properties 3 required
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
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
UpdateOrderQueryRequest
object
The field required to update an existing order query.
2 properties 2 required
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
CreateOrderQueryRequest
object
The fields that a customer must specify to define an OrderQuery.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datavant-order-queries-api-openapi.yml Raw ↑

Other APIs Datavant publishes across the network.

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

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