Skip to documentation
athenahealth integration

Create Patient Case Note

Perform Create Patient Case Note through athenahealth.

View as Markdown
athena_create_patient_case_note
write

Inputs

  • patient_id
    expressionrequired
    Patient Id

    Required literal value or workflow expression.

  • chart_id
    expressionrequired
    Chart Id

    Required literal value or workflow expression.

  • note_text
    textarearequired
    Note Text

    Required text value.

  • subject
    expression
    Subject

    Optional literal value or workflow expression.

  • append_signature
    boolean
    Append Signature

    Optional true-or-false value.

    Default: true

  • write_enabled
    boolean
    Write Enabled

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • submittedSubmitted
  • write_skippedWrite Skipped
  • skip_reasonSkip Reason
  • document_idDocument Id
  • document_classDocument Class
  • patient_idPatient Id
  • chart_idChart Id
  • statusStatus
  • assigned_toAssigned To
  • subjectSubject
  • signed_note_lengthSigned Note Length
  • max_note_lengthMax Note Length
  • failure_phaseFailure Phase
  • error_codeError Code
  • retryableRetryable
  • 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": [
    "patient_id",
    "chart_id",
    "note_text"
  ],
  "properties": {
    "subject": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "chart_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "note_text": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "textarea"
    },
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "write_enabled": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "append_signature": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "status": {},
    "subject": {},
    "success": {},
    "chart_id": {},
    "retryable": {},
    "submitted": {},
    "error_code": {},
    "patient_id": {},
    "assigned_to": {},
    "document_id": {},
    "skip_reason": {},
    "error_message": {},
    "failure_phase": {},
    "write_skipped": {},
    "document_class": {},
    "max_note_length": {},
    "signed_note_length": {}
  },
  "additionalProperties": true
}
View all athenahealth actions