Skip to documentation
ExaPACS integration

Download Patient Document

Perform Download Patient Document through ExaPACS.

View as Markdown
exapacs_download_patient_document
writeexapacs

Inputs

  • exa_doc_id
    expressionrequired
    Exa Doc Id

    Required literal value or workflow expression.

  • patient_id
    expressionrequired
    Patient Id

    Required literal value or workflow expression.

  • order_id
    expressionrequired
    Order Id

    Required literal value or workflow expression.

  • output_path
    text
    Output Path

    Optional text value.

Outputs

  • statusStatus
  • document_idDocument Id
  • s3_keyS3 Key
  • filenameFilename
  • mime_typeMime Type
  • byte_countByte Count
  • output_pathOutput Path
  • skippedSkipped
  • 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": [
    "exa_doc_id",
    "patient_id",
    "order_id"
  ],
  "properties": {
    "order_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "exa_doc_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"
    },
    "output_path": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "s3_key": {},
    "status": {},
    "skipped": {},
    "filename": {},
    "mime_type": {},
    "byte_count": {},
    "document_id": {},
    "output_path": {}
  },
  "additionalProperties": true
}
View all ExaPACS actions