Skip to documentation
ClaimSoft integration

Add Document

Perform Add Document through ClaimSoft.

View as Markdown
claimsoft_add_document
writeclaimsoft

Inputs

  • patient_id
    expressionrequired
    Patient Id

    Required literal value or workflow expression.

  • document_url
    expression
    Document Url

    Optional literal value or workflow expression.

  • document_id
    expression
    Document Id

    Optional literal value or workflow expression.

  • filename
    textrequired
    Filename

    Required text value.

  • alternate_filenames
    json
    Alternate Filenames

    Optional JSON value.

  • tab
    text
    Tab

    Optional text value.

    Default: "Documents"

Outputs

  • successSuccess
  • patient_idPatient Id
  • filenameFilename
  • skippedSkipped
  • matched_filenameMatched Filename
  • 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": [
    "patient_id",
    "filename"
  ],
  "properties": {
    "tab": {
      "type": "string",
      "default": "Documents",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "filename": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "document_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "document_url": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "alternate_filenames": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "message": {},
    "skipped": {},
    "success": {},
    "filename": {},
    "patient_id": {},
    "matched_filename": {}
  },
  "additionalProperties": true
}
View all ClaimSoft actions