athenahealth integration

Create Patient

Perform Create Patient through athenahealth.

View as Markdown

athena_create_patient

writeathenahealth

Inputs

first_name
expressionrequired
First Name
Required literal value or workflow expression.
last_name
expressionrequired
Last Name
Required literal value or workflow expression.
date_of_birth
expressionrequired
Date Of Birth
Required literal value or workflow expression.
middle_initial
expression
Middle Initial
Optional literal value or workflow expression.
name_suffix
expression
Name Suffix
Optional literal value or workflow expression.
preferred_name
expression
Preferred Name
Optional literal value or workflow expression.
sex
select
Sex
Optional selected identifier or value.
Options: Leave unset (""), Female ("F"), Male ("M")
ssn
expression
Ssn
Optional literal value or workflow expression.
marital_status
select
Marital Status
Optional selected identifier or value.
Options: Leave unset (""), UNKNOWN ("U"), MARRIED ("M"), SINGLE ("S"), DIVORCED ("D"), SEPARATED ("X"), WIDOWED ("W"), PARTNER ("P")
assigned_sex_at_birth
select
Assigned Sex At Birth
Optional selected identifier or value.
Options: Leave unset (""), Male ("M"), Female ("F"), Choose not to disclose ("N"), Unknown ("U")
gender_identity
select
Gender Identity
Optional selected identifier or value.
Options: Leave unset (""), Identifies as Male ("1"), Identifies as Female ("2"), Non-binary gender identity ("21"), Unknown ("22"), Transgender Male/Female-to-Male (FTM) ("3"), Transgender Female/Male-to-Female (MTF) ("4"), Gender non-conforming (neither exclusively male nor female) ("5"), Additional gender category / other, please specify ("6"), Choose not to disclose ("7")
sexual_orientation
select
Sexual Orientation
Optional selected identifier or value.
Options: Leave unset (""), Lesbian, gay or homosexual ("1"), Straight or heterosexual ("2"), Bisexual ("3"), Something else, please describe ("4"), Don't know ("5"), Choose not to disclose ("6")
preferred_pronouns
select
Preferred Pronouns
Optional selected identifier or value.
Options: Leave unset (""), he/him ("he/him"), she/her ("she/her"), they/them ("they/them")
address_line_1
expressionrequired
Address Line 1
Required literal value or workflow expression.
address_line_2
expression
Address Line 2
Optional literal value or workflow expression.
city
expressionrequired
City
Required literal value or workflow expression.
state
selectrequired
State
Required selected identifier or value.
Options: Leave unset (""), AA-Armed Forces Americas ("AA"), AE-Armed Forces Africa ("AE"), AK-Alaska ("AK"), AL-Alabama ("AL"), AP-Armed Forces Pacific ("AP"), AR-Arkansas ("AR"), AS-American Samoa ("AS"), AZ-Arizona ("AZ"), CA-California ("CA"), CO-Colorado ("CO"), CT-Connecticut ("CT"), DC-District of Columbia ("DC"), DE-Delaware ("DE"), FL-Florida ("FL"), FM-Federated States of Micronesia ("FM"), GA-Georgia ("GA"), GU-Guam ("GU"), HI-Hawaii ("HI"), IA-Iowa ("IA"), ID-Idaho ("ID"), IL-Illinois ("IL"), IN-Indiana ("IN"), KS-Kansas ("KS"), KY-Kentucky ("KY"), LA-Louisiana ("LA"), MA-Massachusetts ("MA"), MD-Maryland ("MD"), ME-Maine ("ME"), MH-Marshall Islands ("MH"), MI-Michigan ("MI"), MN-Minnesota ("MN"), MO-Missouri ("MO"), MP-Northern Mariana Islands ("MP"), MS-Mississippi ("MS"), MT-Montana ("MT"), NC-North Carolina ("NC"), ND-North Dakota ("ND"), NE-Nebraska ("NE"), NH-New Hampshire ("NH"), NJ-New Jersey ("NJ"), NM-New Mexico ("NM"), NV-Nevada ("NV"), NY-New York ("NY"), OH-Ohio ("OH"), OK-Oklahoma ("OK"), OR-Oregon ("OR"), PA-Pennsylvania ("PA"), PR-Puerto Rico ("PR"), PW-Palau ("PW"), RI-Rhode Island ("RI"), SC-South Carolina ("SC"), SD-South Dakota ("SD"), TN-Tennessee ("TN"), TX-Texas ("TX"), UT-Utah ("UT"), VA-Virginia ("VA"), VI-Virgin Islands ("VI"), VT-Vermont ("VT"), WA-Washington ("WA"), WI-Wisconsin ("WI"), WV-West Virginia ("WV"), WY-Wyoming ("WY")
zip_code
expressionrequired
Zip Code
Required literal value or workflow expression.
email
expression
Email
Optional literal value or workflow expression.
mobile_phone
expression
Mobile Phone
Optional literal value or workflow expression.
home_phone
expression
Home Phone
Optional literal value or workflow expression.
work_phone
expression
Work Phone
Optional literal value or workflow expression.
contact_preference
expression
Contact Preference
Optional literal value or workflow expression.
privacy_notice_given
boolean
Privacy Notice Given
Optional true-or-false value.
Default: true
patient_signature_on_file
boolean
Patient Signature On File
Optional true-or-false value.
Default: true
insured_signature_on_file
boolean
Insured Signature On File
Optional true-or-false value.
Default: true
medication_history_consent
boolean
Medication History Consent
Optional true-or-false value.
Default: true
consent_to_call
boolean
Consent To Call
Optional true-or-false value.
Default: true
consent_to_text
boolean
Consent To Text
Optional true-or-false value.
Default: true
registration_date
expression
Registration Date
Optional literal value or workflow expression.
registration_department_id
selectdynamic options
Registration Department Id
Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
primary_provider_id
selectdynamic options
Primary Provider Id
Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
referral_source_id
selectdynamic options
Referral Source Id
Optional selected identifier or value. Retrieve allowed values from the dynamic options endpoint.
notes
textarea
Notes
Optional text value.
guarantor_is_self
boolean
Guarantor Is Self
Optional true-or-false value.
Default: true
additional_form_fields
json
Additional Form Fields
Optional JSON value.
duplicate_check
boolean
Duplicate Check
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
patient_idPatient Id
athenaAthena
previous_operationPrevious Operation
duplicate_foundDuplicate Found
duplicate_patient_idsDuplicate Patient Ids
duplicate_countDuplicate Count
submitted_field_countSubmitted Field Count
errorError
error_messageError Message
failure_phaseFailure Phase
error_codeError Code
retryableRetryable

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": [
    "first_name",
    "last_name",
    "date_of_birth",
    "address_line_1",
    "city",
    "state",
    "zip_code"
  ],
  "properties": {
    "sex": {
      "enum": [
        "",
        "F",
        "M"
      ],
      "type": "string",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "ssn": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "city": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "email": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "notes": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "textarea"
    },
    "state": {
      "enum": [
        "",
        "AA",
        "AE",
        "AK",
        "AL",
        "AP",
        "AR",
        "AS",
        "AZ",
        "CA",
        "CO",
        "CT",
        "DC",
        "DE",
        "FL",
        "FM",
        "GA",
        "GU",
        "HI",
        "IA",
        "ID",
        "IL",
        "IN",
        "KS",
        "KY",
        "LA",
        "MA",
        "MD",
        "ME",
        "MH",
        "MI",
        "MN",
        "MO",
        "MP",
        "MS",
        "MT",
        "NC",
        "ND",
        "NE",
        "NH",
        "NJ",
        "NM",
        "NV",
        "NY",
        "OH",
        "OK",
        "OR",
        "PA",
        "PR",
        "PW",
        "RI",
        "SC",
        "SD",
        "TN",
        "TX",
        "UT",
        "VA",
        "VI",
        "VT",
        "WA",
        "WI",
        "WV",
        "WY"
      ],
      "type": "string",
      "description": "Required selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "zip_code": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "last_name": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "first_name": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "home_phone": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "work_phone": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "name_suffix": {
      "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"
    },
    "date_of_birth": {
      "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"
    },
    "address_line_1": {
      "description": "Required 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"
    },
    "marital_status": {
      "enum": [
        "",
        "U",
        "M",
        "S",
        "D",
        "X",
        "W",
        "P"
      ],
      "type": "string",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "middle_initial": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "preferred_name": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "consent_to_call": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "consent_to_text": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "duplicate_check": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "gender_identity": {
      "enum": [
        "",
        "1",
        "2",
        "21",
        "22",
        "3",
        "4",
        "5",
        "6",
        "7"
      ],
      "type": "string",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "guarantor_is_self": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "registration_date": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "contact_preference": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "preferred_pronouns": {
      "enum": [
        "",
        "he/him",
        "she/her",
        "they/them"
      ],
      "type": "string",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "referral_source_id": {
      "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"
    },
    "sexual_orientation": {
      "enum": [
        "",
        "1",
        "2",
        "3",
        "4",
        "5",
        "6"
      ],
      "type": "string",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "primary_provider_id": {
      "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"
    },
    "privacy_notice_given": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "assigned_sex_at_birth": {
      "enum": [
        "",
        "M",
        "F",
        "N",
        "U"
      ],
      "type": "string",
      "description": "Optional selected identifier or value.",
      "x-workflow-field-type": "select"
    },
    "additional_form_fields": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "insured_signature_on_file": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "patient_signature_on_file": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "medication_history_consent": {
      "type": "boolean",
      "default": true,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "registration_department_id": {
      "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"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "error": {},
    "athena": {},
    "success": {},
    "retryable": {},
    "submitted": {},
    "error_code": {},
    "patient_id": {},
    "skip_reason": {},
    "error_message": {},
    "failure_phase": {},
    "write_skipped": {},
    "duplicate_count": {},
    "duplicate_found": {},
    "previous_operation": {},
    "duplicate_patient_ids": {},
    "submitted_field_count": {}
  },
  "additionalProperties": true
}

View all athenahealth actions