Skip to documentation
ExaPACS integration

Download Patient Documents

Perform Download Patient Documents through ExaPACS.

View as Markdown
exapacs_download_patient_documents
writeexapacs

Inputs

  • patient_id
    expressionrequired
    Patient Id

    Required literal value or workflow expression.

  • order_id
    expressionrequired
    Order Id

    Required literal value or workflow expression.

  • exa_doc_ids
    expressionrequired
    Exa Doc Ids

    Required literal value or workflow expression.

  • output_path
    text
    Output Path

    Optional text value.

Outputs

  • statusStatus
  • documentsDocuments
  • downloaded_countDownloaded Count
  • failed_countFailed Count
  • 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",
    "order_id",
    "exa_doc_ids"
  ],
  "properties": {
    "order_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "exa_doc_ids": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "output_path": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "status": {},
    "documents": {},
    "failed_count": {},
    "downloaded_count": {}
  },
  "additionalProperties": true
}
View all ExaPACS actions