Skip to documentation
ClaimSoft integration

Create Order

Perform Create Order through ClaimSoft.

View as Markdown
claimsoft_create_order
writeclaimsoft

Inputs

  • idempotency_key
    textrequired
    Idempotency Key

    Required text value.

  • write_idempotency_to_original_ref_no
    boolean
    Write Idempotency To Original Ref No

    Optional true-or-false value.

    Default: true

  • patient_id
    expressionrequired
    Patient Id

    Required literal value or workflow expression.

  • date_of_service_from
    textrequired
    Date Of Service From

    Required text value.

  • date_of_service_to
    textrequired
    Date Of Service To

    Required text value.

  • location
    textrequired
    Location

    Required text value.

  • diagnosis_codes
    jsonrequired
    Diagnosis Codes

    Required JSON value.

  • physician_id
    numberrequired
    Physician Id

    Required numeric value.

  • physician
    textrequired
    Physician

    Required text value.

  • referral_source_id
    number
    Referral Source Id

    Optional numeric value.

  • referral_source
    text
    Referral Source

    Optional text value.

  • psr_id
    numberrequired
    Psr Id

    Required numeric value.

  • sales_rep_id
    number
    Sales Rep Id

    Optional numeric value.

  • sales_rep
    text
    Sales Rep

    Optional text value.

  • warehouse
    number
    Warehouse

    Optional numeric value.

  • place_of_service
    number
    Place Of Service

    Optional numeric value.

  • signature
    number
    Signature

    Optional numeric value.

  • rendering_provider_id
    number
    Rendering Provider Id

    Optional numeric value.

  • rendering_provider
    text
    Rendering Provider

    Optional text value.

  • semantic_items
    json
    Semantic Items

    Optional JSON value.

  • is_accident
    boolean
    Is Accident

    Optional true-or-false value.

  • accident_date
    text
    Accident Date

    Optional text value.

  • accident_state_id
    text
    Accident State Id

    Optional text value.

  • accident_description
    text
    Accident Description

    Optional text value.

  • prescription_date
    text
    Prescription Date

    Optional text value.

  • order_override
    json
    Order Override

    Optional JSON value.

Outputs

  • successSuccess
  • order_idOrder Id
  • createdCreated
  • duplicate_preventedDuplicate Prevented
  • match_basisMatch Basis
  • idempotency_keyIdempotency Key
  • messageMessage
  • error_kindError Kind
  • errorError

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": [
    "idempotency_key",
    "patient_id",
    "date_of_service_from",
    "date_of_service_to",
    "location",
    "diagnosis_codes",
    "physician_id",
    "physician",
    "psr_id"
  ],
  "properties": {
    "psr_id": {
      "type": "number",
      "description": "Required numeric value.",
      "x-workflow-field-type": "number"
    },
    "location": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "physician": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "sales_rep": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "signature": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "warehouse": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "is_accident": {
      "type": "boolean",
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "physician_id": {
      "type": "number",
      "description": "Required numeric value.",
      "x-workflow-field-type": "number"
    },
    "sales_rep_id": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "accident_date": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "order_override": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "semantic_items": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "diagnosis_codes": {
      "description": "Required JSON value.",
      "x-workflow-field-type": "json"
    },
    "idempotency_key": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "referral_source": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "place_of_service": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "accident_state_id": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "prescription_date": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "date_of_service_to": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "referral_source_id": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "rendering_provider": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "accident_description": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "date_of_service_from": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "rendering_provider_id": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "write_idempotency_to_original_ref_no": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "created": {},
    "message": {},
    "success": {},
    "order_id": {},
    "error_kind": {},
    "match_basis": {},
    "idempotency_key": {},
    "duplicate_prevented": {}
  },
  "additionalProperties": true
}
View all ClaimSoft actions