Brightree integration

Upload Document to Patient

Perform Upload Document to Patient through Brightree.

View as Markdown

brightree_upload_document_to_patient

writebrightree

Inputs

patient_key
expressionrequired
Patient Key
Required literal value or workflow expression.
document_id
expressionrequired
Document Id
Required literal value or workflow expression.
document_type
textrequired
Document Type
Required text value.
deduplicate
boolean
Deduplicate
Optional true-or-false value.
Default: false
verify_count_increase
boolean
Verify Count Increase
Optional true-or-false value.
Default: false
verify_document_types
text
Verify Document Types
Optional text value.
verify_max_attempts
number
Verify Max Attempts
Optional numeric value.
Default: 10
batch_name
text
Batch Name
Optional text value.
batch_id
text
Batch Id
Optional text value.
file_name
expression
File Name
Optional literal value or workflow expression.
notes
textarea
Notes
Optional text value.

Outputs

successSuccess
uploaded_filenameUploaded Filename
uploaded_countUploaded Count
skipped_countSkipped Count
failed_countFailed Count
uploaded_document_idsUploaded Document Ids
count_beforeCount Before
count_afterCount After
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_key",
    "document_id",
    "document_type"
  ],
  "properties": {
    "notes": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "textarea"
    },
    "batch_id": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "file_name": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "batch_name": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "deduplicate": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "document_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_key": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "document_type": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "verify_max_attempts": {
      "type": "number",
      "default": 10,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "verify_count_increase": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "verify_document_types": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "success": {},
    "count_after": {},
    "count_before": {},
    "failed_count": {},
    "skipped_count": {},
    "uploaded_count": {},
    "uploaded_filename": {},
    "uploaded_document_ids": {}
  },
  "additionalProperties": true
}

View all Brightree actions