---
title: "Get an order"
method: GET
path: "/orders/{order_id}"
tags: ["Orders"]
---

# Get an order

`GET /orders/{order_id}`

Fetch the details of a specific order.

## Path parameters

- `order_id` string, required

## Query parameters

- `queries` boolean

## Headers

- `version-datavant` string — Version of the Orders API to use with this call

## Response `200`

Successful Response

- OrderResponse — Represents an Order object returned through the API.
  - `delivery_type` DeliveryType[] — The preferred formats the charts should be delivered in.
  - `delivery_format` 'individual' | 'zipped' — An enumeration.
  - `structured_data_file_delivery_format` 'individual' | 'zipped' — An enumeration.
  - `delivery_filename_template` string — file naming template for charts to be delivered.
  - `delivery_manifest_included` boolean — Whether to include a manifest with the delivery.
  - `delivery_manifest_filename_template` string — file naming template for delivery manifests.
  - `delivery_manifest_file_extension` '.csv' | '.txt' | '.dat' — file extension for delivery manifests.
  - `delivery_manifest_delimiter` ',' | '|' | '	' — delimiter for delivery manifests.
  - `delivery_zip_filename_template` string — file naming template for zip file for when charts need to be zipped.
  - `delivery_frequency` 'continuous' | 'daily' | 'weekly' | 'biweekly' | 'monthly' | 'order_due_date' | 'each_document' — An enumeration.
  - `delivery_frequency_sub_option` union — A list of days for a weekly delivery, or a date (e.g. 5 for the 5th of the month) for a monthly delivery.
    - DeliveryFrequencyDay[]
    - integer
  - `delivery_schedule` string[] — A list of date times (in ISO format) for when deliveries should happen.
  - `delivery_timing` 'continuous' | 'scheduled' — An enumeration.
  - `delivery_location` 'api' | 'sftp' | 's3' — Additional delivery locations for documents (besides API)
  - `delivery_email_recipients` string[] — Email recipients for order delivery notifications.
  - `delivery_manifest_configuration` unknown
  - `zip_password` string, password — User can specify a password that will be applied to the zip file encryption on delivery
  - `merge_charts` boolean — Flag to indicate if merged charts per patient is required
  - `structured_data_extraction_report_configuration` StructuredDataExtractionReportConfiguration — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
    - `delivery_schedule` string[] — List of datetimes (in ISO format) for when deliveries should happen
    - `deliver_automatically` boolean — Whether to deliver the report automatically
    - `delivery_schedule_options` union — Options for scheduling the delivery of the structured data extraction report.
      - DailyDeliveryOptions — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `delivery_frequency_sub_option` unknown, required
        - `delivery_frequency` 'daily', required
      - WeeklyDeliveryOptions — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `delivery_frequency_sub_option` DeliveryFrequencyDay[], required
        - `delivery_frequency` 'weekly', required
      - BiweeklyDeliveryOptions — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `delivery_frequency_sub_option` DeliveryFrequencyDay[], required
        - `delivery_frequency` 'biweekly', required
      - MonthlyDeliveryOptions — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `delivery_frequency_sub_option` integer, required
        - `delivery_frequency` 'monthly', required
      - DueDateDeliveryOptions — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `delivery_frequency_sub_option` unknown, required
        - `delivery_frequency` 'order_due_date', required
      - EachDocumentDeliveryOptions — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `delivery_frequency_sub_option` unknown, required
        - `delivery_frequency` 'each_document', required
    - `filename_prefix` string, required — The filename will be <filename_prefix>_YYYY-MM-DD.csv
    - `include_npi` boolean
    - `include_diagnosis` boolean
    - `filter_encounters_by_requested_dos` boolean
    - `write_empty_encounters` boolean
  - `chart_detail_extract_report_configuration` ChartDetailExtractConfiguration — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
    - `delivery_schedule` string[] — List of datetimes (in ISO format) for when deliveries should happen
    - `deliver_automatically` boolean — Whether to deliver the report automatically
    - `delivery_schedule_options` union — Options for scheduling the delivery of the structured data extraction report.
      - DailyDeliveryOptions — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `delivery_frequency_sub_option` unknown, required
        - `delivery_frequency` 'daily', required
      - WeeklyDeliveryOptions — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `delivery_frequency_sub_option` DeliveryFrequencyDay[], required
        - `delivery_frequency` 'weekly', required
      - BiweeklyDeliveryOptions — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `delivery_frequency_sub_option` DeliveryFrequencyDay[], required
        - `delivery_frequency` 'biweekly', required
      - MonthlyDeliveryOptions — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `delivery_frequency_sub_option` integer, required
        - `delivery_frequency` 'monthly', required
      - DueDateDeliveryOptions — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `delivery_frequency_sub_option` unknown, required
        - `delivery_frequency` 'order_due_date', required
      - EachDocumentDeliveryOptions — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `delivery_frequency_sub_option` unknown, required
        - `delivery_frequency` 'each_document', required
    - `filename_template` string, required — The template for the CDE report filename.
  - `uuid` string, uuid4, required — Unique identifier for the object.
  - `id` string, required — User-provided identifier for the object. * Must be between 4 and 32 characters * Must contain only upper or lower-case alphanumeric characters, numbers, hyphens and/or underscores.
  - `name` string — User-friendly name for the order.
  - `project_id` string — ID of the project associated with the order.
  - `project_uuid` string, uuid4 — UUID of the project associated with the order.
  - `project_name` string — Name of the project associated with the order.
  - `project_config_options` object
  - `package_configuration_pk_id` integer
  - `package_configuration_pk_id_for_project_type` integer
  - `type` 'attorney' | 'datavant' | 'disability' | 'continuing_care' | 'copya' | 'copyi' | 'facility' | 'government' | 'insurance' | 'patient' | 'payd' | 'payi' | 'pro' | 'fac', required — An enumeration.
  - `due_date` string, date-time — Date by which record delivery should be complete.
  - `primary_reason` 'attorney' | 'hospital_lien' | 'patient_directive' | 'personal_injury' | 'social_security_disability' | 'subpoena' | 'workers_comp' | 'illinois_industrial_commission_subpoena' | 'florida_statute' | 'veterans_disability' | 'ssa_appeal_representative_form_1696' | 'patient_social_security_appeal' | 'life_sciences' | 'audit_of_claims' | 'clinical_research' | 'disability' | 'insurance' | 'medicare_medicaid' | 'rac' | 'revenue_cycle_management' | 'business_office_copy_risk_management' | 'special_project' | 'drg_payment_integrity' | 'hedis_audit' | 'hix' | 'radv' | 'standard_insurance_claim_payment' | 'utilization_review' | 'disability_gov_benefits' | 'forms_completion_by_provider' | 'patient_personal' | 'patient_transfer' | 'second_request_not_work_comp' | 'agency' | 'government_audit' | 'medicaid_dds' | 'non_profit' | 'state_dds' | 'workers_comp_board' | 'continuity_of_care' | 'ciox_audit' | 'mra' | 'ciox_real_world_data_team_request' | 'aca_hix' | 'drg' | 'underwriting' | 'claim' | 'general_attorney' | 'general_attorney_subpoena' | 'workers_comp_subpoena' | 'ssa_appeal' | 'pro_medicaid' | 'standard_pro' | 'value_based_care' | 'payd' | 'payer' | 'attestation' | 'unknown', required — An enumeration.
  - `secondary_reason` 'aca' | 'defense_attorney' | 'defense_subpoena' | 'personal_injury' | 'state_attorney_office' | 'represent_indignant' | 'subpoena_second_request' | 'disability_gov_benefits' | 'ssi_claim_second_request' | 'hospital_per_admission' | 'no' | 'second_request' | 'social_security_appeal' | 'patient_social_security_appeal' | 'social_security_claim_appeal_second_request' | 'forms_completion_by_provider' | 'attorney_rep_pat' | 'appeal_second_request' | 'court_issued' | 'criminal' | 'subpoena' | 'workers_comp_subpoena' | 'subpoena_deposition_trial_testimony_with_records' | 'workers_comp_second_request' | 'workers_comp' | 'workers_comp_self_insured' | 'requested_by_patient' | 'requested_by_attorney' | 'drg_payment_integrity' | 'hedis_audit' | 'hix' | 'mra' | 'radv' | 'utilization_review' | 'short_term_long_term_claim' | 'second_request_insurance' | 'bc_bs_claim' | 'non_medical_insurance_claim' | 'standard_insurance_claim_payment' | 'underwriting' | 'pharmacy' | 'aps' | 'medicare_medicaid_utl_review' | 'medicare_medicaid_eligibility' | 'rac_medicaid' | 'second_request_workers_comp' | 'standard_workers_comp' | 'county' | 'dept_of_health_human_services' | 'dept_of_welfare' | 'family_and_child' | 'omap' | 'probation' | 'public_schools' | 'social_security_application' | 'veterans_affairs' | 'voc_rehab' | 'mi_family' | 'nc_prison' | 'attorney_general' | 'state_attorney' | 'federal_public_defender' | 'utilization_review_medicare_and_medicaid' | 'home_risk_assessment' | 'in_office_assessment' | 'payment_integrity' | 'post_payment_denials' | 'pre_payment_denials' | 'provider_as_requester' | 'switchboard_for_acos' | 'whole_person_understanding' — An enumeration.
  - `meta` object — Miscellaneous configuration related to order that may be used for scheduling, reporting or billing purposes.
  - `contacts` Contacts — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
    - `billing` LegalEntity — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
      - `phone_number` string — Phone number
      - `full_name` string — If entity is an organization or individual with only full name available include full_name
      - `first_name` string — If entity is an individual include first_name
      - `alternate_first_name` string — If entity is an individual and uses an alias or nickname include alternate_first_name
      - `middle_name` string — If entity is an individual include middle_name if applicable
      - `last_name` string — If entity is an individual include last_name
      - `prefix` string — If entity is an individual include name prefix if applicable
      - `suffix` string — If entity is an individual include name suffix if applicable
      - `id` string, required — An identifier that the Customer has assigned to this legal entity
      - `order_id` string — An identifier that this legal entity has assigned to this order
      - `address` Address — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `normalizations` unknown[]
          - unknown
        - `line1` string — Street address
        - `line2` string — Building, Suite#, Unit#, etc..
        - `city` string — City
        - `country` string — Country Code, ISO 3166-1 alpha-2 code
        - `state` string — State/Province Abbreviation Code, 2 characters
        - `postal_code` string — Postal Code, US - 5 digits or 5+4, Other - Alphanumeric
      - `health_plan` string
    - `customer` LegalEntity — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
      - `phone_number` string — Phone number
      - `full_name` string — If entity is an organization or individual with only full name available include full_name
      - `first_name` string — If entity is an individual include first_name
      - `alternate_first_name` string — If entity is an individual and uses an alias or nickname include alternate_first_name
      - `middle_name` string — If entity is an individual include middle_name if applicable
      - `last_name` string — If entity is an individual include last_name
      - `prefix` string — If entity is an individual include name prefix if applicable
      - `suffix` string — If entity is an individual include name suffix if applicable
      - `id` string, required — An identifier that the Customer has assigned to this legal entity
      - `order_id` string — An identifier that this legal entity has assigned to this order
      - `address` Address — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `normalizations` unknown[]
          - unknown
        - `line1` string — Street address
        - `line2` string — Building, Suite#, Unit#, etc..
        - `city` string — City
        - `country` string — Country Code, ISO 3166-1 alpha-2 code
        - `state` string — State/Province Abbreviation Code, 2 characters
        - `postal_code` string — Postal Code, US - 5 digits or 5+4, Other - Alphanumeric
      - `health_plan` string
  - `retrieval_sources` RetrievalSources[] — List of one or more Identified Switchboard sources to use when retrieving records. Default retrieval sources are based on configuration.
  - `retrieval_allow_block_configuration` RetrievalAllowBlockConfiguration — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
    - `allow` AllowBlockGroup — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
      - `data_foundation_health_system_ids` string[] — The set of Data Foundation health system IDs that are allowed or blocked.
    - `block` AllowBlockGroup — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
      - `data_foundation_health_system_ids` string[] — The set of Data Foundation health system IDs that are allowed or blocked.
  - `manual_qa` boolean — Flag to indicate if manual QA is required
  - `coding_required` boolean — Flag to indicate if coding is required
  - `coding_required_v2` boolean — Flag to route coding through the new SB->Archon workflow instead of the legacy ARCH DB export.
  - `submission_source` 'api' | 'switchboard' | 'sftp' | 'legacy' — An enumeration.
  - `total_queries` integer — Number of queries associated with the order.
  - `status` 'draft' | 'accepted' | 'rejected' | 'processing' | 'failed' | 'dispatched' | 'canceled' | 'complete' | 'pending_close' | 'close_in_progress' | 'intake_review_required' | 'intake_review_completed', required — OrderStatus is an enumeration representing the different stages in an order's lifecycle. Definitions: draft: An initial state for orders that are created but not yet submitted for processing. - Used for orders created manually through the IDSB UI, requiring explicit action to proceed to dispatch. accepted: A ready-for-processing state for newly received orders. - Used for orders submitted via the CF orders API, indicating they are queued for dispatch without requiring further manual intervention. intake_review_required: An action required state to complete steps prior to dispatching instructions. - Used for orders that require action items to be completed as part of the import review process. intake_review_completed: A state indicating that the import review process has been completed. - Used for orders that have completed the import review process and are ready for dispatch. rejected: A terminal state indicating the order was declined. - Used for prematch when an order fails input file validation processing: A temporary state while initial processing actions are performed on the order. - Used after submission but before any external requests are dispatched, including internal steps like intake database updates, routing, and merging charts (for semi-auto/ML sweep). failed: A terminal state indicating the order failed to process. - Used for prematch orders to indicate order failed to process. dispatched: A state indicating that external chart or patient searches have been initiated. - Set once the first external request related to the order is sent out. canceled: A terminal state indicating the order was withdrawn and processing has ceased. complete: A terminal state signifying that the order has been fully processed and closed. - Currently set manually after all retrievals and chart deliveries are finalized. pending_close: A terminal state indicating that further processing should halt. - This state mirrors CF updates instructing IDSB to stop any remaining work on the order. close_in_progress: A temporary state during which the order is being closed. - Set when a close request is initiated. Closing actions are underway, and status will transition to 'complete' once finalized. Order status lifecycle for IDSB fully automated projects: - draft -> processing -> dispatched -> close_in_progress -> complete Order status lifecycle for IDSB semi-automated projects: - accepted -> dispatched -> complete Order status lifecycle for IDSB traditional projects: - draft -> accepted -> processing -> intake_review_required -> intake_review_completed -> dispatched -> complete
  - `created_at` string, date-time — The ISO8601 formatted timestamp for when the object was created.
  - `updated_at` string, date-time — The ISO8601 formatted timestamp for when the object was last updated.
  - `demand_id` integer — This field is used to link forecasts to Orders. DemandID can be a dummy value (99999) and does not have to be unique.
  - `wave` integer — This field is used to provide information to ChartFinder for traditional projects.Wave must be an integer between 1 and 9999.
  - `chart_review_year` integer — This field is used to provide information to ChartFinder for traditional projects.Chart Review Year must be an integer between 2022 and 2025.
  - `target_yield` number — This field is used to provide information to ChartFinder for traditional projects.Target Yield must be a float between 0 and 1.
  - `yield_type` integer — This field is used to provide information to ChartFinder for traditional projects.Must be an integer between 1 and 3.
  - `ticket_number` string
  - `flow_type` string — The type of project this order is.
  - `chart_finder_config` ChartFinderConfiguration — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
    - `coding` boolean — Does this client use Datavant for coding?
    - `audit_type` integer — Audit type for this project.
    - `review_type` union — Audit type for this project.
      - string
      - integer
    - `idsb_handling_qa` 0 | 1 — IDSB Handling QA for this project.
    - `idsb_retrieving` 0 | 1 — IDSB directly using some retrieval methods without CF for this project.
    - `idsb_retrieving_embedded` 0 | 1 — IDSB directly retrieving for embedded retrieval methods for this project.
    - `account_manager_id` integer — Account Manager ID for this project.
  - `delivery_config` AllDeliveryConfig — Model for the delivery configuration.
    - `pdf` PdfDeliveryConfig — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
      - `filename_template` string
      - `schedule` string[], required
      - `manifest` ManifestDeliveryConfig — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `filename_template` string
        - `file_extension` '.csv' | '.txt' | '.dat'
        - `delimiter` ',' | '|' | '	' | '~'
        - `header_configuration` object[]
        - `template_name` 'ml_standard' | 'provider' | 'ml_merge' | 'arbcbs_pdf_custom' | 'arbcbs_cda_custom' | 'centene_custom' | 'clover_pdf_custom' | 'optum_ioa_custom' | 'bcbsmi_custom', required
      - `email_recipients` string[]
      - `file_transfer_config` S3FileTransferConfig — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `target_type` 's3', required
        - `prefix` string, required
      - `zip` ZipDeliveryConfig — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `filename_template` string
        - `include_manifest` boolean
        - `password` string, password
      - `is_continuous` boolean
      - `merge` boolean
    - `cda` BaseDeliveryConfig — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
      - `filename_template` string
      - `schedule` string[], required
      - `manifest` ManifestDeliveryConfig — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `filename_template` string
        - `file_extension` '.csv' | '.txt' | '.dat'
        - `delimiter` ',' | '|' | '	' | '~'
        - `header_configuration` object[]
        - `template_name` 'ml_standard' | 'provider' | 'ml_merge' | 'arbcbs_pdf_custom' | 'arbcbs_cda_custom' | 'centene_custom' | 'clover_pdf_custom' | 'optum_ioa_custom' | 'bcbsmi_custom', required
      - `email_recipients` string[]
      - `file_transfer_config` S3FileTransferConfig — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `target_type` 's3', required
        - `prefix` string, required
    - `fhir` BaseDeliveryConfig — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
      - `filename_template` string
      - `schedule` string[], required
      - `manifest` ManifestDeliveryConfig — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `filename_template` string
        - `file_extension` '.csv' | '.txt' | '.dat'
        - `delimiter` ',' | '|' | '	' | '~'
        - `header_configuration` object[]
        - `template_name` 'ml_standard' | 'provider' | 'ml_merge' | 'arbcbs_pdf_custom' | 'arbcbs_cda_custom' | 'centene_custom' | 'clover_pdf_custom' | 'optum_ioa_custom' | 'bcbsmi_custom', required
      - `email_recipients` string[]
      - `file_transfer_config` S3FileTransferConfig — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `target_type` 's3', required
        - `prefix` string, required
    - `structured_extraction` StructuredExtractionDeliveryConfig — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
      - `filename_template` string
      - `schedule` string[], required
      - `manifest` ManifestDeliveryConfig — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `filename_template` string
        - `file_extension` '.csv' | '.txt' | '.dat'
        - `delimiter` ',' | '|' | '	' | '~'
        - `header_configuration` object[]
        - `template_name` 'ml_standard' | 'provider' | 'ml_merge' | 'arbcbs_pdf_custom' | 'arbcbs_cda_custom' | 'centene_custom' | 'clover_pdf_custom' | 'optum_ioa_custom' | 'bcbsmi_custom', required
      - `email_recipients` string[]
      - `file_transfer_config` S3FileTransferConfig — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `target_type` 's3', required
        - `prefix` string, required
      - `deliver_automatically` boolean
      - `report` ExtractionDeliveryConfig, required — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `include_npi` boolean, required
        - `include_diagnosis` boolean, required
        - `filter_encounters_by_requested_dos` boolean
        - `write_empty_encounters` boolean
    - `chart_detail_extract` ChartDetailExtractDeliveryConfig — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
      - `filename_template` string
      - `schedule` string[], required
      - `manifest` ManifestDeliveryConfig — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `filename_template` string
        - `file_extension` '.csv' | '.txt' | '.dat'
        - `delimiter` ',' | '|' | '	' | '~'
        - `header_configuration` object[]
        - `template_name` 'ml_standard' | 'provider' | 'ml_merge' | 'arbcbs_pdf_custom' | 'arbcbs_cda_custom' | 'centene_custom' | 'clover_pdf_custom' | 'optum_ioa_custom' | 'bcbsmi_custom', required
      - `email_recipients` string[]
      - `file_transfer_config` S3FileTransferConfig — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
        - `target_type` 's3', required
        - `prefix` string, required
      - `deliver_automatically` boolean
  - `import_review_status` ImportReviewStatus — 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 False (default setting) and we only set enum values to true within the models that have enums we know we need to use the values for.
    - `provider_package_approved` boolean

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `422` — Unprocessable Entity

---

[API](https://skmtc.net/datavant/apis/datavant-rest-api.md) · [All operations](https://skmtc.net/datavant/apis/datavant-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/datavant/datavant-rest-api/revisions/f39a4bfeca8e/schema)