ExaPACS integration

Get Completed Studies Report

Perform Get Completed Studies Report through ExaPACS.

View as Markdown

exapacs_export_completed_studies_report

writeexapacs

Inputs

from_date
daterequired
From Date
Required date in YYYY-MM-DD format.
to_date
daterequired
To Date
Required date in YYYY-MM-DD format.
facility_id
text
Facility Id
Optional text value.
date_basis
select
Date Basis
Optional selected identifier or value.
Default: "scheduled"
Options: Scheduled Date ("scheduled"), Approved Date ("approved")
output_path
text
Output Path
Optional text value.

Outputs

statusStatus
document_idDocument Id
filenameFilename
mime_typeMime Type
report_typeReport Type
filtersFilters
output_pathOutput Path
size_bytesSize Bytes
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": [
    "from_date",
    "to_date"
  ],
  "properties": {
    "to_date": {
      "type": "string",
      "format": "date",
      "description": "Required date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "from_date": {
      "type": "string",
      "format": "date",
      "description": "Required date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "date_basis": {
      "enum": [
        "scheduled",
        "approved"
      ],
      "type": "string",
      "default": "scheduled",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "facility_id": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "output_path": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "status": {},
    "filters": {},
    "filename": {},
    "mime_type": {},
    "size_bytes": {},
    "document_id": {},
    "output_path": {},
    "report_type": {}
  },
  "additionalProperties": true
}

View all ExaPACS actions