Sign in
latestOpenAPI 3.1.02026-08-0854104180.4 KB

f39a4bfeca8e

Orders

Create an order

Create an Order. Returns HTTP_409_CONFLICT if order with the same ID already exists for the given customer ID.

post/orders/

Headers

version-datavantstring

Version of the Orders API to use with this call

Version of the Orders API to use with this call

Request body

delivery_typeDeliveryType[]

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_templatestring

file naming template for charts to be delivered.

delivery_manifest_includedboolean

Whether to include a manifest with the delivery.

delivery_manifest_filename_templatestring

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_templatestring

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_schedulestring[]

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_recipientsstring[]

Email recipients for order delivery notifications.

{"stackTrail":"components:schemas:CreateOrderRequest:properties:delivery_manifest_configuration","oasType":"schema","type":"unknown","title":"Delivery Manifest Configuration","description":"Allows to specify custom column headers and rearrange columns in the resulting CSV document"}
zip_passwordstring password

User can specify a password that will be applied to the zip file encryption on delivery

merge_chartsboolean
idstring 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.
namestring

User-friendly name for the order.

project_idstring

ID for the project with which you want to associate the order.

type'attorney' | 'datavant' | 'disability' | 'continuing_care' | 'copya' | 'copyi' | 'facility' | 'government' | 'insurance' | 'patient' | 'payd' | 'payi' | 'pro' | 'fac' required

An enumeration.

due_datestring date-time

Date by which record delivery should be complete. Default is 90 days from order submission.

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.

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.

metadataobject

Miscellaneous configuration related to order that may be used for scheduling, reporting, billing purposes. Also used to store information on whether to use experimental matches in Routing

sourcesRetrievalSources[]

DEPRECATED: use 'retrieval_sources'.

retrieval_sourcesRetrievalSources[]

List of one or more Identified Switchboard sources to use when retrieving records.

Default retrieval sources are based on configuration.

manual_qaboolean

Flag to indicate if manual QA is required

coding_requiredboolean

Flag to indicate if coding is required

coding_required_v2boolean

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.

provider_information_includedboolean

Is provider information included?

demand_idinteger

This field is used to link forecasts to Orders. DemandID can be a dummy value (99999) and does not have to be unique.

waveinteger

This field is used to provide information to ChartFinder for traditional projects.Wave must be an integer between 1 and 9999.

chart_review_yearinteger

This field is used to provide information to ChartFinder for traditional projects.Chart Review Year must be an integer between 2022 and 2025.

target_yieldnumber

This field is used to provide information to ChartFinder for traditional projects.Target Yield must be a float between 0 and 1.

yield_typeinteger

This field is used to provide information to ChartFinder for traditional projects.Must be an integer between 1 and 3.

ticket_numberstring
is_traditionalboolean

Traditional Project flag.

flow_type'unknown' | 'patient' | 'provider' | 'prematch_provider'

An enumeration.

Response

Successful Response

delivery_typeDeliveryType[]

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_templatestring

file naming template for charts to be delivered.

delivery_manifest_includedboolean

Whether to include a manifest with the delivery.

delivery_manifest_filename_templatestring

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_templatestring

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_schedulestring[]

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_recipientsstring[]

Email recipients for order delivery notifications.

{"stackTrail":"components:schemas:OrderResponse:properties:delivery_manifest_configuration","oasType":"schema","type":"unknown","title":"Delivery Manifest Configuration","description":"Allows to specify custom column headers and rearrange columns in the resulting CSV document"}
zip_passwordstring password

User can specify a password that will be applied to the zip file encryption on delivery

merge_chartsboolean

Flag to indicate if merged charts per patient is required

uuidstring uuid4 required

Unique identifier for the object.

idstring 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.
namestring

User-friendly name for the order.

project_idstring

ID of the project associated with the order.

project_uuidstring uuid4

UUID of the project associated with the order.

project_namestring

Name of the project associated with the order.

project_config_optionsobject
package_configuration_pk_idinteger
package_configuration_pk_id_for_project_typeinteger
type'attorney' | 'datavant' | 'disability' | 'continuing_care' | 'copya' | 'copyi' | 'facility' | 'government' | 'insurance' | 'patient' | 'payd' | 'payi' | 'pro' | 'fac' required

An enumeration.

due_datestring 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.

metaobject

Miscellaneous configuration related to order that may be used for scheduling, reporting or billing purposes.

retrieval_sourcesRetrievalSources[]

List of one or more Identified Switchboard sources to use when retrieving records.

Default retrieval sources are based on configuration.

manual_qaboolean

Flag to indicate if manual QA is required

coding_requiredboolean

Flag to indicate if coding is required

coding_required_v2boolean

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_queriesinteger

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_atstring date-time

The ISO8601 formatted timestamp for when the object was created.

updated_atstring date-time

The ISO8601 formatted timestamp for when the object was last updated.

demand_idinteger

This field is used to link forecasts to Orders. DemandID can be a dummy value (99999) and does not have to be unique.

waveinteger

This field is used to provide information to ChartFinder for traditional projects.Wave must be an integer between 1 and 9999.

chart_review_yearinteger

This field is used to provide information to ChartFinder for traditional projects.Chart Review Year must be an integer between 2022 and 2025.

target_yieldnumber

This field is used to provide information to ChartFinder for traditional projects.Target Yield must be a float between 0 and 1.

yield_typeinteger

This field is used to provide information to ChartFinder for traditional projects.Must be an integer between 1 and 3.

ticket_numberstring
flow_typestring

The type of project this order is.