athenahealth integration

Update Patient

Perform Update Patient through athenahealth.

View as Markdown

athena_update_patient

writeathenahealth

Inputs

patient_id
expressionrequired
Patient Id
Required literal value or workflow expression.
note_to_append
textarea
Note To Append
Optional text value.
email
expression
Email
Optional literal value or workflow expression.
address_line_1
expression
Address Line 1
Optional literal value or workflow expression.
address_line_2
expression
Address Line 2
Optional literal value or workflow expression.
city
expression
City
Optional literal value or workflow expression.
state
expression
State
Optional literal value or workflow expression.
zip_code
expression
Zip Code
Optional literal value or workflow expression.
home_phone
expression
Home Phone
Optional literal value or workflow expression.
mobile_phone
expression
Mobile Phone
Optional literal value or workflow expression.
work_phone
expression
Work Phone
Optional literal value or workflow expression.
contact_preference
select
Contact Preference
Optional selected identifier or value.
Options: Leave unchanged (""), Mobile Phone ("MOBILEPHONE"), Home Phone ("HOMEPHONE"), Work Phone ("WORKPHONE")
consent_to_call
select
Consent To Call
Optional selected identifier or value.
Options: Leave unchanged (""), Yes ("Y"), No ("N")
consent_to_text
select
Consent To Text
Optional selected identifier or value.
Options: Leave unchanged (""), Yes ("Y"), No ("N")
timezone
expression
Timezone
Optional literal value or workflow expression.
Default: "America/Chicago"
write_enabled
boolean
Write Enabled
Optional true-or-false value.
Default: false

Outputs

successSuccess
submittedSubmitted
write_skippedWrite Skipped
verifiedVerified
patient_idPatient Id
changed_fieldsChanged Fields
note_appendedNote Appended
errorError
error_messageError Message
failure_phaseFailure Phase
error_codeError Code

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"
  ],
  "properties": {
    "city": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "email": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "state": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "timezone": {
      "default": "America/Chicago",
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "zip_code": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "home_phone": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "work_phone": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "mobile_phone": {
      "description": "Optional 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"
    },
    "address_line_1": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "address_line_2": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "note_to_append": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "textarea"
    },
    "consent_to_call": {
      "enum": [
        "",
        "Y",
        "N"
      ],
      "type": "string",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "consent_to_text": {
      "enum": [
        "",
        "Y",
        "N"
      ],
      "type": "string",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "contact_preference": {
      "enum": [
        "",
        "MOBILEPHONE",
        "HOMEPHONE",
        "WORKPHONE"
      ],
      "type": "string",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "success": {},
    "verified": {},
    "submitted": {},
    "error_code": {},
    "patient_id": {},
    "error_message": {},
    "failure_phase": {},
    "note_appended": {},
    "write_skipped": {},
    "changed_fields": {}
  },
  "additionalProperties": true
}

View all athenahealth actions