Skip to documentation
ClaimSoft integration

Create Alert

Perform Create Alert through ClaimSoft.

View as Markdown
claimsoft_create_alert
writeclaimsoft

Inputs

  • order_id
    expressionrequired
    Order Id

    Required literal value or workflow expression.

  • comment_text
    textarearequired
    Comment Text

    Required text value.

  • patient_id
    expression
    Patient Id

    Optional literal value or workflow expression.

  • document_id
    expression
    Document Id

    Optional literal value or workflow expression.

  • alert_type_id
    textrequired
    Alert Type Id

    Required text value.

  • user
    text
    User

    Optional text value.

    Default: "GenHealth AI"

Outputs

  • successSuccess
  • patient_idPatient Id
  • order_idOrder Id
  • messageMessage
  • 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": [
    "order_id",
    "comment_text",
    "alert_type_id"
  ],
  "properties": {
    "user": {
      "type": "string",
      "default": "GenHealth AI",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "order_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "document_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "comment_text": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "textarea"
    },
    "alert_type_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "message": {},
    "success": {},
    "order_id": {},
    "patient_id": {}
  },
  "additionalProperties": true
}
View all ClaimSoft actions