Skip to documentation
Consignment Intake integration

Prepare Consignment Order Create

Perform Prepare Consignment Order Create through Consignment Intake.

View as Markdown
prepare_consignment_order_create
write

Inputs

  • packet_context
    jsonrequired
    Packet Context

    Required JSON value.

  • as_of_date
    daterequired
    As Of Date

    Required date in YYYY-MM-DD format.

  • billing_location_ids
    jsonrequired
    Billing Location Ids

    Required JSON value.

  • patient_save_result
    jsonrequired
    Patient Save Result

    Required JSON value.

  • insurance_save_result
    jsonrequired
    Insurance Save Result

    Required JSON value.

  • order_defaults
    jsonrequired
    Order Defaults

    Required JSON value.

  • extracted_salesperson
    text
    Extracted Salesperson

    Optional text value.

  • semantic_items
    json
    Semantic Items

    Optional JSON value.

  • accident_details
    json
    Accident Details

    Optional JSON value.

Outputs

  • successSuccess
  • ready_for_order_createReady For Order Create
  • review_requiredReview Required
  • review_reasonReview Reason
  • review_reasonsReview Reasons
  • idempotency_keyIdempotency Key
  • patient_idPatient Id
  • date_of_service_fromDate Of Service From
  • date_of_service_toDate Of Service To
  • locationLocation
  • diagnosis_codesDiagnosis Codes
  • physician_idPhysician Id
  • physicianPhysician
  • referral_source_idReferral Source Id
  • referral_sourceReferral Source
  • psr_idPsr Id
  • sales_rep_idSales Rep Id
  • sales_repSales Rep
  • warehouseWarehouse
  • place_of_servicePlace Of Service
  • signatureSignature
  • rendering_provider_idRendering Provider Id
  • rendering_providerRendering Provider
  • semantic_itemsSemantic Items
  • is_accidentIs Accident
  • accident_dateAccident Date
  • accident_state_idAccident State Id
  • accident_descriptionAccident Description
  • prescription_datePrescription Date
  • errorError
  • error_kindError Kind

Output schema completeness: best_effort_declared

Safety

External effect
write
Confirmation recommended
No
Retry safe
No
Dry run supported
No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema
{
  "type": "object",
  "required": [
    "packet_context",
    "as_of_date",
    "billing_location_ids",
    "patient_save_result",
    "insurance_save_result",
    "order_defaults"
  ],
  "properties": {
    "as_of_date": {
      "type": "string",
      "format": "date",
      "description": "Required date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "order_defaults": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    },
    "packet_context": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    },
    "semantic_items": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "accident_details": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "patient_save_result": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    },
    "billing_location_ids": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    },
    "extracted_salesperson": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "insurance_save_result": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "psr_id": {},
    "success": {},
    "location": {},
    "physician": {},
    "sales_rep": {},
    "signature": {},
    "warehouse": {},
    "error_kind": {},
    "patient_id": {},
    "is_accident": {},
    "physician_id": {},
    "sales_rep_id": {},
    "accident_date": {},
    "review_reason": {},
    "review_reasons": {},
    "semantic_items": {},
    "diagnosis_codes": {},
    "idempotency_key": {},
    "referral_source": {},
    "review_required": {},
    "place_of_service": {},
    "accident_state_id": {},
    "prescription_date": {},
    "date_of_service_to": {},
    "referral_source_id": {},
    "rendering_provider": {},
    "accident_description": {},
    "date_of_service_from": {},
    "rendering_provider_id": {},
    "ready_for_order_create": {}
  },
  "additionalProperties": true
}
View all Consignment Intake actions