Skip to documentation
Brightree integration

Get Documents from Patient

Perform Get Documents from Patient through Brightree.

View as Markdown
brightree_fetch_patient_documents
writebrightree

Inputs

  • patient_key
    expressionrequired
    Patient Key

    Required literal value or workflow expression.

  • document_types
    multi_selectdynamic options
    Document Types

    Optional list of selected values. Retrieve allowed values from the dynamic options endpoint.

  • document_types_expression
    expression
    Document Types Expression

    Optional literal value or workflow expression.

  • max_documents
    number
    Max Documents

    Optional numeric value.

    Default: 50

  • patient_id
    expression
    Patient Id

    Optional literal value or workflow expression.

Outputs

  • successSuccess
  • document_idsDocument Ids
  • documentsDocuments
  • missing_typesMissing Types
  • available_typesAvailable Types
  • errorsErrors
  • 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"
  ],
  "properties": {
    "patient_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_key": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "max_documents": {
      "type": "number",
      "default": 50,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "document_types": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional list of selected values. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "multi_select"
    },
    "document_types_expression": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "errors": {},
    "success": {},
    "documents": {},
    "document_ids": {},
    "missing_types": {},
    "available_types": {}
  },
  "additionalProperties": true
}
View all Brightree actions