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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Datavant

Datavant Orders API

An order is the parent container for incoming queries. An order contains one or more queries alongwith other identifying information (e.g., type, reason, etc.)

Documentation Provider Profile APIs.io OpenAPI GitHub

Datavant Orders 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. 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 18 operations across 16 paths, and defines 71 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.

18 operations 16 paths 71 schemas 9 GET7 POST2 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 Orders 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 18

Across 16 paths, the API surfaces 18 operations — 9 GET, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Orders 18

An order is the parent container for incoming queries. An order contains one or more queries along with other identifying information (e.g., type, reason, etc.)

GET
/orders/
List all orders
list_orders_orders__get 9 params → 200400422
POST
/orders/
Create an order
create_order_orders__post 1 param body → 201400422409
GET
/orders/order
Get an order
get_order_by_specific_id_orders_order_get 3 params → 200400422404
GET
/orders/{order_id}
Get an order
get_order_orders__order_id__get 3 params → 200400422404
PUT
/orders/{order_id}
Update an order
update_order_orders__order_id__put 2 params body → 204400422
GET
/orders/order/validation/stats
Get an order's basic validation results
get_order_validation_results_by_specific_id_orders_order_validation_stats_get 3 params → 200400422404
GET
/orders/{order_id}/validation/stats
Get an order's basic validation results
get_order_validation_results_orders__order_id__validation_stats_get 2 params → 200400422404
GET
/orders/{order_uuid}/validation/report
Get an order validation report
get_order_validation_report_orders__order_uuid__validation_report_get 2 params → 200400422404
GET
/orders/{order_uuid}/validation/supplemental-data-report
Get an order supplemental data validation report
get_order_supplemental_data_validation_report_orders__order_uuid__validation_supplemental_data_report_get 2 params → 200400422404
GET
/orders/{order_uuid}/error-and-warning-counts
Get grouped order validation errors and varnings with counts
get_order_errors_and_warnings_orders__order_uuid__error_and_warning_counts_get 2 params → 200400422404
GET
/orders/{order_id}/reporting/retrievals
Get reporting for order retrievals
get_order_retrievals_reporting_data_orders__order_id__reporting_retrievals_get 4 params → 200400422404
POST
/orders/{order_uuid}/cancel
Cancel an order
cancel_order_orders__order_uuid__cancel_post 2 params → 204400422
POST
/orders/{order_id}/close-request
Deal with an order close request
close_order_orders__order_id__close_request_post 2 params → 204400422
POST
/orders/{order_id}/roster
Attach a roster to an order
attach_roster_orders__order_id__roster_post 2 params body → 201400422
POST
/orders/{order_id}/supplemental-data
Upload supplemental data to an order
attach_supplemental_data_orders__order_id__supplemental_data_post 2 params body → 201400422
POST
/orders/{order_id}/dispatch
Dispatch an order
dispatch_order_orders__order_id__dispatch_post 2 params → 204400422
POST
/orders/{order_id}/submit
Submit an order
submit_order_orders__order_id__submit_post 2 params → 204400422
PUT
/orders/{order_id}/start-record-retrieval
Begin dispatching instructions
dispatch_instructions_orders__order_id__start_record_retrieval_put 2 params → 204400422

Schemas 71

The contract defines 71 schemas that model the data the API accepts and returns. The most detailed are OrderResponse (55 properties), CreateOrderRequest (52 properties), UpdateOrderRequest (42 properties), Patient (17 properties). Each schema is shown below with its type and property counts.

ChartPackage
Packages referring to pre-configured bundles of chart components.
ChartFinderConfiguration
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
ConnectionsReport
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
EachDocumentDeliveryOptions
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 2 required
RetrievalSources
string
An enumeration.
DailyDeliveryOptions
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 2 required
StructuredDataExtractionReportConfiguration
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 1 required
MonthlyDeliveryOptions
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 2 required
Contacts
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
Sftp
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 2 required
OrderResponse
object
Represents an Order object returned through the API.
55 properties 5 required
AllDeliveryConfig
object
Model for the delivery configuration.
5 properties
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
DueDateDeliveryOptions
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 2 required
FlowType
string
An enumeration.
ConnectionCounts
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 2 required
SecondaryReason
string
An enumeration.
DeliveryFormat
string
An enumeration.
Links
object
5 properties
CodingConfiguration
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 1 required
CDRLocation
object
Attributes used to identify the CDR location of a file.
1 property 1 required
AllowBlockGroup
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
OrderStatus
string
OrderStatus is an enumeration representing the different stages in an order's lifecycle. Definitions: draft: An initial state for orders that are created but n…
S3FileTransferConfig
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 2 required
LegalEntity
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…
12 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
PrimaryReason
string
An enumeration.
RequesterType
string
An enumeration.
BaseDeliveryConfig
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…
5 properties 1 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.
Error
object
3 properties 2 required
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
PdfDeliveryConfig
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 1 required
SubmissionSource
string
An enumeration.
DeliveryTiming
string
An enumeration.
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
WeeklyDeliveryOptions
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 2 required
ChartDetailExtractConfiguration
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 1 required
FacilityType
string
An enumeration.
ImportReviewStatus
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
DeliveryFrequencyDay
integer
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
FileLocation
object
Attributes used to identify the location of the specified file.
1 property 1 required
UpdateOrderRequest
object
Model for all delivery configuration fields (including those set at project/customer level). Should contain any fields that need to be referenced when creating…
42 properties 1 required
StructuredExtractionDeliveryConfig
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 2 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
ManifestDeliveryConfig
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…
5 properties 1 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
JsonApiPage_OrderResponse_
object
JSON:API 1.0 specification says that result key should be a data.
6 properties 3 required
BiweeklyDeliveryOptions
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 2 required
DeliveryType
string
An enumeration.
Mail
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 2 required
ClientFile
object
Attributes used to identify a file owned by the client that is available for download.
4 properties 2 required
DeliveryLocation
string
Additional delivery locations for documents (besides API)
Body_attach_roster_orders__order_id__roster_post
object
1 property 1 required
ZipDeliveryConfig
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
ExtractionDeliveryConfig
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 2 required
FileRetrievalMethodEnum
string
The method to use to fetch the file
DeliveryFrequency
string
An enumeration.
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
CreateOrderRequest
object
52 properties 2 required
Body_attach_supplemental_data_orders__order_id__supplemental_data_post
object
1 property 1 required
RetrievalAllowBlockConfiguration
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
AlternateDelivery
object
Delivery to an alternate entity separate from the primary requester.
2 properties
OrderReportingResponse
object
Order reporting information.
6 properties 4 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
ChartDetailExtractDeliveryConfig
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
OrderValidationResponse
object
Order validation results.
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datavant-orders-api-openapi.yml Raw ↑

Other APIs Datavant publishes across the network.

Datavant Configuration API
AE Profile APIs.io
Datavant Documents API
AE Profile APIs.io
Datavant Oauth2 API
AE Profile APIs.io
Datavant Order Queries API
AE Profile APIs.io
Datavant Prematch API
AE Profile APIs.io
Datavant Projects API
AE Profile APIs.io
Datavant Visits API
AE Profile APIs.io
#Order
← Back to D APIs
API Details
ID
datavant:datavant-orders-api
Base URL
https://api.datavant.io/v2
Docs
https://developer.datavant.com/docs
Provider
Datavant
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=datavant-orders-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/datavant-orders-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

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