Skip to documentation
athenahealth integration

Update Patient Usual Provider

Perform Update Patient Usual Provider through athenahealth.

View as Markdown
athena_update_patient_primary_provider
writeathenahealth

Inputs

  • patient_id
    expressionrequired
    Patient Id

    Required literal value or workflow expression.

  • provider_id
    selectrequireddynamic options
    Provider Id

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

  • expected_current_provider_id
    expression
    Expected Current Provider Id

    Optional literal value or workflow expression.

  • write_enabled
    boolean
    Write Enabled

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • submittedSubmitted
  • write_skippedWrite Skipped
  • verifiedVerified
  • patient_idPatient Id
  • previous_provider_idPrevious Provider Id
  • provider_idProvider Id
  • 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",
    "provider_id"
  ],
  "properties": {
    "patient_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "provider_id": {
      "type": "string",
      "description": "Required selected identifier or value. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "select"
    },
    "write_enabled": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "expected_current_provider_id": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "success": {},
    "verified": {},
    "submitted": {},
    "error_code": {},
    "patient_id": {},
    "provider_id": {},
    "error_message": {},
    "failure_phase": {},
    "write_skipped": {},
    "previous_provider_id": {}
  },
  "additionalProperties": true
}
View all athenahealth actions