Consignment Intake integration

Prepare Consignment Write Payload

Perform Prepare Consignment Write Payload through Consignment Intake.

View as Markdown

prepare_consignment_write_payload

write

Inputs

order_mapping
jsonrequired
Order Mapping
Required JSON value.
extracted_fields
jsonrequired
Extracted Fields
Required JSON value.
document_text
expression
Document Text
Optional literal value or workflow expression.
packet_context
jsonrequired
Packet Context
Required JSON value.
billing_location_resolution
jsonrequired
Billing Location Resolution
Required JSON value.
policyholder_resolution
json
Policyholder Resolution
Optional JSON value.
as_of_date
date
As Of Date
Optional date in YYYY-MM-DD format.
existing_patient_id
text
Existing Patient Id
Optional text value.
salesperson_name
expression
Salesperson Name
Optional literal value or workflow expression.
clean_path_mode
select
Clean Path Mode
Optional selected identifier or value.
Default: "review_for_billing"
Options: Review for billing ("review_for_billing"), Submitted (explicit opt-in) ("submitted")
patient_name_format
select
Patient Name Format
Optional selected identifier or value.
Options: Given name then family name ("given_family"), Given Family or Family, Given ("given_family_or_family_comma_given")

Outputs

successSuccess
ready_for_patient_insurance_writeReady For Patient Insurance Write
payload_not_ready_reasonPayload Not Ready Reason
review_requiredReview Required
review_reasonReview Reason
review_reasonsReview Reasons
review_detailsReview Details
patient_dataPatient Data
patient_name_resolved_from_fallbackPatient Name Resolved From Fallback
patient_name_resolved_from_configured_formatPatient Name Resolved From Configured Format
policy_dataPolicy Data
billing_location_idsBilling Location Ids
billing_location_resolutionBilling Location Resolution
billing_locationBilling Location
patient_statePatient State
payer_planPayer Plan
payer_card_statePayer Card State
payer_name_truncatedPayer Name Truncated
card_insurance_typeCard Insurance Type
member_numberMember Number
insurance_sequenceInsurance Sequence
packet_contextPacket Context
guarantor_dataGuarantor Data
guarantor_write_requiredGuarantor Write Required
guarantor_first_nameGuarantor First Name
guarantor_last_nameGuarantor Last Name
guarantor_relationship_idGuarantor Relationship Id
guarantor_date_of_birthGuarantor Date Of Birth
accident_detailsAccident Details
existing_patient_idExisting Patient Id
patient_write_modePatient Write Mode
clean_path_modeClean Path Mode
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": [
    "order_mapping",
    "extracted_fields",
    "packet_context",
    "billing_location_resolution"
  ],
  "properties": {
    "as_of_date": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "document_text": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "order_mapping": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    },
    "packet_context": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    },
    "clean_path_mode": {
      "enum": [
        "review_for_billing",
        "submitted"
      ],
      "type": "string",
      "default": "review_for_billing",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "extracted_fields": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    },
    "salesperson_name": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "existing_patient_id": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "patient_name_format": {
      "enum": [
        "given_family",
        "given_family_or_family_comma_given"
      ],
      "type": "string",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "policyholder_resolution": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "billing_location_resolution": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "success": {},
    "error_kind": {},
    "payer_plan": {},
    "policy_data": {},
    "patient_data": {},
    "member_number": {},
    "patient_state": {},
    "review_reason": {},
    "guarantor_data": {},
    "packet_context": {},
    "review_details": {},
    "review_reasons": {},
    "clean_path_mode": {},
    "review_required": {},
    "accident_details": {},
    "billing_location": {},
    "payer_card_state": {},
    "insurance_sequence": {},
    "patient_write_mode": {},
    "card_insurance_type": {},
    "existing_patient_id": {},
    "guarantor_last_name": {},
    "billing_location_ids": {},
    "guarantor_first_name": {},
    "payer_name_truncated": {},
    "guarantor_date_of_birth": {},
    "guarantor_write_required": {},
    "payload_not_ready_reason": {},
    "guarantor_relationship_id": {},
    "billing_location_resolution": {},
    "ready_for_patient_insurance_write": {},
    "patient_name_resolved_from_fallback": {},
    "patient_name_resolved_from_configured_format": {}
  },
  "additionalProperties": true
}

View all Consignment Intake actions