Create Alert
Perform Create Alert through ClaimSoft.
claimsoft_create_alertwriteclaimsoft
Inputs
- Order Id
order_idexpressionrequiredRequired literal value or workflow expression.
- Comment Text
comment_texttextarearequiredRequired text value.
- Patient Id
patient_idexpressionOptional literal value or workflow expression.
- Document Id
document_idexpressionOptional literal value or workflow expression.
- Alert Type Id
alert_type_idtextrequiredRequired text value.
- User
usertextOptional text value.
Default:
"GenHealth AI"
Outputs
successSuccesspatient_idPatient Idorder_idOrder IdmessageMessageerrorError
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
}