Skip to documentation
athenahealth integration

Process CCDA Document

Perform Process CCDA Document through athenahealth.

View as Markdown
athena_process_ccda_document
writeathenahealth

Use in a workflow

Copy the discovered node config and fill its params from the input contract. Validate the complete graph before publishing. Integration results use {{node_id.default.field}}. Check business success before dependent writes; completion alone does not prove success.

{
  "_group": "athenahealth",
  "params": {
    "action": "leave",
    "urgent": false,
    "link_patient": false,
    "write_enabled": false
  },
  "handler": "athena_process_ccda_document"
}

Action contracts and connections · Run recovery

Inputs

  • document_id
    expressionrequired
    Document Id

    Required literal value or workflow expression.

  • patient_id
    expressionrequired
    Patient Id

    Required literal value or workflow expression.

  • chart_id
    expressionrequired
    Chart Id

    Required literal value or workflow expression.

  • link_patient
    boolean
    Link Patient

    Optional true-or-false value.

    Default: false

  • internal_note
    textarea
    Internal Note

    Optional text value.

  • urgent
    boolean
    Urgent

    Optional true-or-false value.

    Default: false

  • order_type_id
    remote_search_selectdynamic options
    Order Type Id

    Optional value. Retrieve allowed values from the dynamic options endpoint.

  • assigned_to
    selectdynamic options
    Assigned To

    Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.

  • provider_username
    expression
    Provider Username

    Optional literal value or workflow expression.

  • action
    select
    Action

    Optional selected identifier or value.

    Default: "leave"

    Options: Leave in current status ("leave"), Close ("close")

  • action_note
    textarea
    Action Note

    Optional text value.

  • write_enabled
    boolean
    Write Enabled

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • write_skippedWrite Skipped
  • submittedSubmitted
  • verifiedVerified
  • outcomeOutcome
  • document_idDocument Id
  • patient_idPatient Id
  • chart_idChart Id
  • status_beforeStatus Before
  • statusStatus
  • priorityPriority
  • order_type_idOrder Type Id
  • assigned_toAssigned To
  • provider_usernameProvider Username
  • internal_note_writtenInternal Note Written
  • patient_linkedPatient Linked
  • errorError
  • error_messageError Message

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": [
    "document_id",
    "patient_id",
    "chart_id"
  ],
  "properties": {
    "action": {
      "enum": [
        "leave",
        "close"
      ],
      "type": "string",
      "default": "leave",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "urgent": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "chart_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"
    },
    "action_note": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "textarea"
    },
    "assigned_to": {
      "type": "string",
      "description": "Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "select"
    },
    "document_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "link_patient": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "internal_note": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "textarea"
    },
    "order_type_id": {
      "description": "Optional value. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "remote_search_select"
    },
    "write_enabled": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "provider_username": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "status": {},
    "outcome": {},
    "success": {},
    "chart_id": {},
    "priority": {},
    "verified": {},
    "submitted": {},
    "patient_id": {},
    "assigned_to": {},
    "document_id": {},
    "error_message": {},
    "order_type_id": {},
    "status_before": {},
    "write_skipped": {},
    "patient_linked": {},
    "provider_username": {},
    "internal_note_written": {}
  },
  "additionalProperties": true
}
View all athenahealth actions