ClaimSoft integration

Ensure Patient Alert

Perform Ensure Patient Alert through ClaimSoft.

View as Markdown

claimsoft_ensure_patient_alert

writeclaimsoft

Inputs

patient_id
expressionrequired
Patient Id
Required literal value or workflow expression.
alert_type_id
textrequired
Alert Type Id
Required text value.
comment_marker
textrequired
Comment Marker
Required text value.
comment_text
textrequired
Comment Text
Required text value.
document_id
text
Document Id
Optional text value.

Outputs

successSuccess
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": [
    "patient_id",
    "alert_type_id",
    "comment_marker",
    "comment_text"
  ],
  "properties": {
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "document_id": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "comment_text": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "alert_type_id": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "comment_marker": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "success": {}
  },
  "additionalProperties": true
}

View all ClaimSoft actions