---
title: "Create a project"
method: POST
path: "/projects/"
tags: ["Projects"]
---

# Create a project

`POST /projects/`

Create a Project.

## Headers

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

## Request body

- CreateProjectRequest — Fields used to create a new project.
  - `id` string, required — The user-provided identifier for this project.
  - `name` string, required — A friendly name for this project.
  - `config_options` ConfigOptions — The full list of options that are available for configuration. Which configuration options you are allowed to configure is determined on your account type and the configuration level (e.g., customer configuration vs project configuration). This limitation needs to be enforced when configuration preferences are written using the `is_valid` method. To make this work, all of the options need to be marked as optional. Any "required" fields should be handled by other business logic (probably at the order/query validation level). In the OPTION_* settings below, the keys that are specified should match exactly the values in our data models. For order-level settings, this means matching the names of the attributes on the Order model. For the supporting_documents, this means matching the names of the types of supporting documents.
    - `type` 'attorney' | 'datavant' | 'disability' | 'continuing_care' | 'copya' | 'copyi' | 'facility' | 'government' | 'insurance' | 'patient' | 'payd' | 'payi' | 'pro' | 'fac' — An enumeration.
    - `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' — 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.
    - `retrieval_sources` RetrievalSources[] — List of one or more Identified Switchboard sources to use when retrieving records. api: Leverage our FHIR API connections directly to provider EMRs. embedded_manual: Leverage our embedded manual connections. nonembedded_manual: Leverage our non-embedded manual connections. athena: Leverage our vendor connection with Athena. ses: Leverage our vendor connection with SES. veradigm: Leverage our vendor connection with Veradigm. particle: Leverage our vendor connection with Particle. healthjump: Leverage our vendor connection with Healthjump. moxe: Leverage our vendor connection with Moxe.
    - `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.
    - `due_date` union — The number of days after submission of an order that records for that order must be delivered or an absolute datetime.
      - integer
      - string, date-time
    - `metadata` OrderMetadata — Pre-determined fields that can be passed to orders. Right now these can only be set at the Project level, but in theory we could also set them at the customer level. To do that, we'd just want to introduce some merge functionality so that we can prioritize the individual metadata key/value pairs the same way we prioritize the higher-level fields.
      - `hs_requester_id` string
      - `od_client_id` string
      - `od_client_username` string
      - `od_client_password` string, password
    - `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
    - `alternate_delivery` AlternateDelivery — Delivery to an alternate entity separate from the primary requester.
      - `alternate` union — The alternate entity to deliver to.
        - Mail — 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.
          - `method` 'mail', required
          - `entity` LegalEntity, 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.
            - `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.
              - …
            - `health_plan` string
        - Sftp — 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.
          - `method` 'sftp', required
          - `entity` LegalEntity, 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.
            - `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.
              - …
            - `health_plan` string
      - `use_only_alternate` boolean — Whether to deliver only to the alternate entity.
    - `merge_charts` boolean
    - `delivery_type` DeliveryType[]
    - `delivery_location` 'api' | 'sftp' | 's3' — Additional delivery locations for documents (besides API)
    - `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_file_extension` '.csv' | '.txt' | '.dat' — file extension for delivery manifests.
    - `delivery_manifest_delimiter` ',' | '|' | '	' | '~' — delimiter for delivery manifests.
    - `delivery_manifest_included` boolean — Whether to include a manifest with the delivery.
    - `delivery_manifest_filename_template` string — file naming template for delivery manifests.
    - `delivery_zip_filename_template` string — file naming template for zip file for when charts need to be zipped.
    - `coding_required` boolean
    - `coding_required_v2` boolean
    - `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
    - `provider_information_included` boolean — Whether provider information is included in the input file.
    - `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.
    - `zip_password` string, password — User can specify a password that will be applied to the zip file encryption on delivery
    - `delivery_manifest_configuration` unknown
    - `is_traditional_project` boolean — Traditional project flag
    - `client` ClientInfo — 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.
      - `id` integer
      - `name` string
    - `wave` integer — This field is used to provide information to ChartFinder for traditional projects.Wave must be an integer between 1 and 99.
    - `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.
    - `project_type` integer — Project Type selected for Traditional Project
    - `ticket_number` string — Ticket Number
    - `coding_configuration` CodingConfiguration — 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.
      - `deliver_records` boolean, required — Whether to deliver records to the customer in addition to the coding output.
      - `deliver_only_codeable_records` boolean — Whether to deliver only codeable records to the customer.
      - `deliver_records_before_coding` boolean — Whether to deliver records to the customer before the coding project is finished.
    - `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.
    - `validation_failures_threshold` integer — Maximum percentage of start file validation failures that should be ignored
    - `qa_workflow_id` integer — The ID of the QA workflow associated with the Project/Order
  - `delivery_email_recipients` string[] — Email recipients for order delivery notifications.

## Response `201`

Successful Response

- ProjectResponse — Fields that comprise an Identified Switchboard project.
  - `pk_id` integer — The user-provided identifier for this project.
  - `uuid` string, uuid4, required — Unique identifier for the object.
  - `id` string, required — The user-provided identifier for this project.
  - `name` string, required — A friendly name for this project.
  - `config_options` ConfigOptions, required — The full list of options that are available for configuration. Which configuration options you are allowed to configure is determined on your account type and the configuration level (e.g., customer configuration vs project configuration). This limitation needs to be enforced when configuration preferences are written using the `is_valid` method. To make this work, all of the options need to be marked as optional. Any "required" fields should be handled by other business logic (probably at the order/query validation level). In the OPTION_* settings below, the keys that are specified should match exactly the values in our data models. For order-level settings, this means matching the names of the attributes on the Order model. For the supporting_documents, this means matching the names of the types of supporting documents.
    - `type` 'attorney' | 'datavant' | 'disability' | 'continuing_care' | 'copya' | 'copyi' | 'facility' | 'government' | 'insurance' | 'patient' | 'payd' | 'payi' | 'pro' | 'fac' — An enumeration.
    - `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' — 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.
    - `retrieval_sources` RetrievalSources[] — List of one or more Identified Switchboard sources to use when retrieving records. api: Leverage our FHIR API connections directly to provider EMRs. embedded_manual: Leverage our embedded manual connections. nonembedded_manual: Leverage our non-embedded manual connections. athena: Leverage our vendor connection with Athena. ses: Leverage our vendor connection with SES. veradigm: Leverage our vendor connection with Veradigm. particle: Leverage our vendor connection with Particle. healthjump: Leverage our vendor connection with Healthjump. moxe: Leverage our vendor connection with Moxe.
    - `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.
    - `due_date` union — The number of days after submission of an order that records for that order must be delivered or an absolute datetime.
      - integer
      - string, date-time
    - `metadata` OrderMetadata — Pre-determined fields that can be passed to orders. Right now these can only be set at the Project level, but in theory we could also set them at the customer level. To do that, we'd just want to introduce some merge functionality so that we can prioritize the individual metadata key/value pairs the same way we prioritize the higher-level fields.
      - `hs_requester_id` string
      - `od_client_id` string
      - `od_client_username` string
      - `od_client_password` string, password
    - `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
    - `alternate_delivery` AlternateDelivery — Delivery to an alternate entity separate from the primary requester.
      - `alternate` union — The alternate entity to deliver to.
        - Mail — 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.
          - `method` 'mail', required
          - `entity` LegalEntity, 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.
            - `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.
              - …
            - `health_plan` string
        - Sftp — 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.
          - `method` 'sftp', required
          - `entity` LegalEntity, 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.
            - `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.
              - …
            - `health_plan` string
      - `use_only_alternate` boolean — Whether to deliver only to the alternate entity.
    - `merge_charts` boolean
    - `delivery_type` DeliveryType[]
    - `delivery_location` 'api' | 'sftp' | 's3' — Additional delivery locations for documents (besides API)
    - `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_file_extension` '.csv' | '.txt' | '.dat' — file extension for delivery manifests.
    - `delivery_manifest_delimiter` ',' | '|' | '	' | '~' — delimiter for delivery manifests.
    - `delivery_manifest_included` boolean — Whether to include a manifest with the delivery.
    - `delivery_manifest_filename_template` string — file naming template for delivery manifests.
    - `delivery_zip_filename_template` string — file naming template for zip file for when charts need to be zipped.
    - `coding_required` boolean
    - `coding_required_v2` boolean
    - `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
    - `provider_information_included` boolean — Whether provider information is included in the input file.
    - `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.
    - `zip_password` string, password — User can specify a password that will be applied to the zip file encryption on delivery
    - `delivery_manifest_configuration` unknown
    - `is_traditional_project` boolean — Traditional project flag
    - `client` ClientInfo — 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.
      - `id` integer
      - `name` string
    - `wave` integer — This field is used to provide information to ChartFinder for traditional projects.Wave must be an integer between 1 and 99.
    - `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.
    - `project_type` integer — Project Type selected for Traditional Project
    - `ticket_number` string — Ticket Number
    - `coding_configuration` CodingConfiguration — 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.
      - `deliver_records` boolean, required — Whether to deliver records to the customer in addition to the coding output.
      - `deliver_only_codeable_records` boolean — Whether to deliver only codeable records to the customer.
      - `deliver_records_before_coding` boolean — Whether to deliver records to the customer before the coding project is finished.
    - `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.
    - `validation_failures_threshold` integer — Maximum percentage of start file validation failures that should be ignored
    - `qa_workflow_id` integer — The ID of the QA workflow associated with the Project/Order
  - `delivery_email_recipients` string[] — Email recipients for order delivery notifications.
  - `created_at` string, date-time, required — 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.
  - `order_count` integer
  - `package_configuration_pk_id` integer

## Other responses

- `400` — Bad Request
- `409` — Project with specified ID already exists
- `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)