Patient Information / Searching

These API calls allow the user to create, update and retrieve various pieces of patient information. These also allow the user to search for patients that match a set of criteria.

*Note '/patients/bestmatch' is being deprecated in favor of '/patients/enhancedbestmatch'

 

API Coverage

This section documents the following endpoints:


Gets a set of patients or creates a patient. - POST /v1/{practiceid}/patients

Gets a set of patients or creates a patient. - GET /v1/{practiceid}/patients

Patient that best matches the specified inputs. - GET /v1/{practiceid}/patients/enhancedbestmatch

Patients that matches a custom field value. - GET /v1/{practiceid}/patients/customfields/{customfieldid}/{customfieldvalue}

Full view/update of patient demographics. - PUT /v1/{practiceid}/patients/{patientid}

Full view/update of patient demographics. - GET /v1/{practiceid}/patients/{patientid}

Search for patients in a context, optionally with user permissions. - GET /v1/{practiceid}/patients/search

Returns the list of possible search types to utilize with the /patients/search endpoint. - GET /v1/{practiceid}/configuration/patients/searchtypes

 

Gets a set of patients or creates a patient. - POST /v1/{practiceid}/patients

Create a patient Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments.

 

Output Parameters

Name Type Description
patientid integer Please remember to never disclose this ID to patients since it may result in inadvertant disclosure that a patient exists in a practice already.
errormessage string Error message will be returned if show error message flag is set to true and patient match found.

 

Gets a set of patients or creates a patient. - GET /v1/{practiceid}/patients

Patient information, creation, and updating Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments.

 

Output Parameters

Name Type Description
confidentialitycode string Gives the confidentiality code for the patient. Only returned when IGNORERESTRICTIONS is set to true and COLCR_RETURN_CONFIDENTIALITY_CODE is ON
driverslicenseexpirationdate string
driverslicensenumber string
driverslicensestateid integer
homeboundyn boolean If the patient is homebound, this is true.
deceaseddate string If present, the date on which a patient died.
industrycode integer Industry of the patient, using the US Census industry code (code system 2.16.840.1.113883.6.310). "other" can be used as well.
donotcallyn boolean Warning! This patient will not receive any communication from the practice if this field is set to true.
ethnicitycode integer Ethnicity of the patient, using the 2.16.840.1.113883.5.50 codeset. See http://www.hl7.org/implement/standards/fhir/terminologies-v3.html Special case: use "declined" to indicate that the patient declined to answer.
language6392code integer Language of the patient, using the ISO 639.2 code. (http://www.loc.gov/standards/iso639-2/php/code_list.php; "T" or terminology code) Special case: use "declined" to indicate that the patient declined to answer.
race string The patient race, using the 2.16.840.1.113883.5.104 codeset. See http://www.hl7.org/implement/standards/fhir/terminologies-v3.html Special case: use "declined" to indicate that the patient declined to answer. Multiple values or a tab-seperated list of codes is acceptable for multiple races for input. The first race will be considered "primary". Note: you must update all values at once if you update any.
firstappointment string The first appointment for this patient, excluding cancelled or no-show appointments. (mm/dd/yyyy h24:mi)
primaryproviderid integer The "primary" provider for this patient, if set.
lastappointment string The last appointment for this patient (before today), excluding cancelled or no-show appointments. (mm/dd/yyyy h24:mi)
primarydepartmentid integer The patient's "current" department. This field is not always set by the practice.
status string The "status" of the patient, one of active, inactive, prospective, or deleted.
hierarchicalcode string The patient race hierarchical code
lastemail string Tthe last email for this patient on file.
emailexistsyn boolean True if email exists. False if patient declined. Null if status is unknown.
occupationcode integer Occupation of the patient, using the US Census occupation code (code system 2.16.840.1.113883.6.240). "other" can be used as well.
patientid integer Please remember to never disclose this ID to patients since it may result in inadvertant disclosure that a patient exists in a practice already.
firstname string Patient's first name
middlename string Patient's middle name
lastname string Patient's last name
suffix string Patient's name suffix
preferredname string The patient's preferred name (i.e. nickname).
address1 string Patient's address - 1st line
address2 string Patient's address - 2nd line
city string Patient's city
state string Patient's state (2 letter abbreviation)
zip string Patient's zip. Matching occurs on first 5 characters.
countrycode string Patient's country code
countrycode3166 string Patient's country code (ISO 3166-1)
homephone string The patient's home phone number. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
mobilephone string The patient's mobile phone number. On input, 'declined' can be used to indicate no number. (Alternatively, hasmobile can also be set to false. "declined" simply does this for you.) Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
hasmobileyn boolean Set to false if a client has declined a phone number.
workphone string The patient's work phone number. Generally not used to contact a patient. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
email string Patient's email address. 'declined' can be used to indicate just that.
ssn string
racename string The patient's primary race name. See race for more complete details.
sex string Patient's sex (M/F)
dob string Patient's DOB (mm/dd/yyyy)
maritalstatus integer Marital Status (D=Divorced, M=Married, S=Single, U=Unknown, W=Widowed, X=Separated, P=Partner)
contactpreference string The MU-required field for "preferred contact method". This is not used by any automated systems.
contactname string The name of the (emergency) person to contact about the patient. The contactname, contactrelationship, contacthomephone, and contactmobilephone fields are all related to the emergency contact for the patient. They are NOT related to the contractpreference_* fields.
contactrelationship string Emergency contact relationship (one of SPOUSE, PARENT, CHILD, SIBLING, FRIEND, COUSIN, GUARDIAN, OTHER)
contacthomephone string Emergency contact home phone. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
contactmobilephone string Emergency contact mobile phone. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
nextkinname string The full name of the next of kin.
nextkinrelationship string The next of kin relationship (one of SPOUSE, PARENT, CHILD, SIBLING, FRIEND, COUSIN, GUARDIAN, OTHER)
nextkinphone string The next of kin phone number. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
guardianfirstname string The first name of the patient's guardian.
guardianmiddlename string The middle name of the patient's guardian.
guardianlastname string The last name of the patient's guardian.
guardiansuffix string The suffix of the patient's guardian.
guarantorfirstname string Guarantor's first name
guarantormiddlename string Guarantor's middle name
guarantorlastname string Guarantor's last name
guarantorsuffix string Guarantor's name suffix
guarantoraddress1 string Guarantor's address
guarantoraddress2 string Guarantor's address - line 2
guarantorcity string Guarantor's city
guarantorstate string Guarantor's state (2 letter abbreviation)
guarantorzip string Guarantor's zip
guarantorcountrycode string Guarantor's country code
guarantorcountrycode3166 string Guarantor's country code (ISO 3166-1)
guarantordob string Guarantor's DOB (mm/dd/yyyy)
guarantorssn string Guarantor's SSN
guarantoremail string Guarantor's email address
guarantorphone string Guarantor's phone number. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
guarantorrelationshiptopatient integer The guarantor's relationship to the patient
guarantoraddresssameaspatient boolean The address of the guarantor is the same as the patient.
registrationdate string Date the patient was registered.
departmentid integer Primary (registration) department ID.
portaltermsonfile boolean
portalsignatureonfile boolean
privacyinformationverified boolean This flag is set if the patient's privacy information has been verified. Privacy information returns True if all of the items referenced in GET /patients/{patientid}/privacyinformationverified are true. Privacy information returns false if any of the items referenced in the GET /patients/{patientid}/privacyinformationverified API are false or expired.
medicationhistoryconsentverified boolean Medication history consent status. If a practice doesn't have RXHub or Surescripts enabled, this will be null
balances array List of balances owed by the patient, broken down by provider (financial) group.
 
providergroupid integer Athena ID for this financial group.
departmentids string Comma separated list of department IDs that belong to this group
balance string Balance for this provider group.
cleanbalance string Indicates whether the balance is associated with a contract, payment plan, or collections agency.
contracts array Information related to existing credit card contracts.
 
availablebalance string The available balance on this contract.
contractclass integer The type of contract. For example, "ONEYEAR,"
maxamount string The maximum allowed amount for this contract.
collectionsbalance string The outstanding amount associated with a collections agency.
paymentplanbalance string The outstanding amount associated with a payment plan.
maritalstatusname string The long version of the marital status.
employerid integer The patient's employer's ID (from /employers call)
employerphone string The patient's employer's phone number. Normally, this is set by setting employerid. However, setting this value can be used to override this on an individual patient. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
guarantoremployerid integer The guaranror's employer's ID (from /employers call)
employername string The patient's employer's name.
employeraddress string The patient's employer's address.
employercity string The patient's employer's city.
portalaccessgiven boolean This flag is set if the patient has been given access to the portal. This may be set by the API user if a patient has been given access to the portal "by providing a preprinted brochure or flyer showing the URL where patients can access their Patient Care Summaries." The practiceinfo endpoint can provide the portal URL. While technically allowed, it would be very unusual to set this to false via the API.
insurances array List of active patient insurance packages. Only shown for a single patient and if SHOWINSURANCE is set.
 
insurancepolicyholder string The full name of the insurance policy holder.
ccmstatusname string The name of current CCM enrollment status.
insurancepolicyholderaddress2 string The second address line of the insurance policy holder.
caseinjurydate string CASE POLICY FIELD - Date of the injury. Required for auto insurance, legal, and worker's comp case policies.
insurancepolicyholderfirstname string The first name of the insurance policy holder. Except for self-pay, required for new policies.
expirationdate date Date the insurance expires.
insurancepolicyholderlastname string The last name of the insurance policy holder. Except for self-pay, required for new policies.
cancelled date The date in which the insurance was marked cancelled.
insurancepolicyholdersex string The sex of the insurance policy holder. Except for self-pay, required for new policies.
sequencenumber integer 1 = primary, 2 = secondary, 3 = tertiary, etc. Must have a primary before a secondary and a secondary before a tertiary, etc.
adjusterfirstname string CASE POLICY FIELD - First name of the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
anotherpartyresponsibleyn boolean CASE POLICY FIELD - Boolean field indicating if another party was responsible for this accident.
descriptionofinjury string CASE POLICY FIELD - A description of the injury. Only available for auto insurance and worker's comp case policies.
eligibilityreason string The source of the current status. Athena is our eligibility engine.
icd10codes string CASE POLICY FIELD - See documentation for ICD9CODES.
 
icd9codes string CASE POLICY FIELD - A list of ICD9 accepted diagnosis codes. Only available for worker's comp case policies.
 
insuranceclaimnumber string CASE POLICY FIELD - The auto insurance claim number or the worker's comp claim number.
insuranceid integer The athena insurance policy ID.
insuranceplandisplayname string Superpackagename of the specific insurance package.
insurancepolicyholdercity string The city of the insurance policy holder.
insurancepolicyholdercountrycode string The country code (3 letter) of the insurance policy holder.
insurancepolicyholdercountryiso3166 string The ISO 3166 country code of the insurance policy holder.
insurancepolicyholdermiddlename string The middle name of the insurance policy holder.
insurancepolicyholderstate string The state of the insurance policy holder.
insurancepolicyholderzip string The zip of the insurance policy holder.
relatedtootheraccidentyn boolean CASE POLICY FIELD - Boolean field indicating whether this case policy is related to another accident. Only available for worker's comp case policies.
policynumber string The insurance group number. This is sometimes present on an insurance card.
slidingfeeplanid integer If the patient is on a sliding fee plan, this is the ID of that plan. See /slidingfeeplans.
adjusterfax string CASE POLICY FIELD - Fax for the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
relationshiptoinsured string This patient's relationship to the policy holder (text).
stateofreportedinjury string CASE POLICY FIELD - Two-letter state abbreviation for the state this injury was reported in. Only available for worker's comp case policies.
relatedtoautoaccidentyn boolean CASE POLICY FIELD - Boolean field indicating whether this case policy is related to an auto accident.
eligibilitymessage string The message, usually from our engine, of the eligibility check.
insuranceidnumber string The insurance policy ID number (as presented on the insurance card itself).
adjusterphone string CASE POLICY FIELD - Phone number/other contact info for the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
insurancepackageaddress1 string Address 1 for the AthenaNet insurance Package.
insurancepolicyholderaddress1 string The first address line of the insurance policy holder.
ccmstatusid integer Status ID of current CCM enrollment.
coinsurancepercent number The coinsurance percentage for this insurance. If you've just POSTed a new insurance you will have to wait for the auto eligbility check before this field populates.
insurancepolicyholdersuffix string The suffix of the insurance policy holder.
insuredpcpnpi integer The national provider id of the primary care physcian assicated with the insurance.
injuredbodypart string CASE POLICY FIELD - Text field for describing the injured body part. Only available for auto insurance and worker's comp case policies.
eligibilitylastchecked date Date the eligibility was last checked.
insuredpcp string
insurancepackageaddress2 string Address 2 for the AthenaNet insurance Package.
autoaccidentstate string CASE POLICY FIELD - Two-letter abbreviation for the state in which the auto accident took place. Only meaningful for auto insurance case policies.
adjusterlastname string CASE POLICY FIELD - Last name of the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
copays string Details about the copays for this insurance package. If you've just POSTed a new insurance you will have to wait for the auto eligbility check before these populate.
 
copaytype number What the copay amount applies to.
copayamount string The amount of the copay.
insurancepackagezip string Zip code of the AthenaNet insurance package
insurancepackagecity string City for the AthenaNet insurance Package.
insurancepolicyholderssn string The SSN of the insurance policy holder.
insurancetype string Type of insurance. E.g., Medicare Part B, Group Policy, HMO, etc.
ircname string Insurance category / company. E.g., United Healthcare, BCBS-MA, etc.
casepolicytypename string CASE POLICY FIELD - The name of this type of case policy.
repricerphone string CASE POLICY FIELD - Phone number for the repricer. Only available for worker's comp case policies.
ircid integer Insurance category / company internal ID
insurancepackagestate string State of the AthenaNet insurance package
insuranceplanname string Name of the specific insurance package.
insurancepackageid integer The athenaNet insurance package ID.
eligibilitystatus string Current eligibility status of this insurance package.
relatedtoemploymentyn boolean CASE POLICY FIELD - Boolean field indicating whether this case policy is related to the patient's employer.
insurancephone string The phone number for the insurance company. Note: This defaults to the insurance package phone number. If this is set, it will override it. Likewise if blanked out, it will go back to default.
relationshiptoinsuredid integer This patient's relationship to the policy holder (as an ID). See the mapping.
repricername string CASE POLICY FIELD - Name for the repricer. Only available for worker's comp case policies.
insuredentitytypeid integer The ID of the entity type for this insurance.
issuedate date Date the insurance was issued.
employerid string The employer ID associated with the patient's insurance.
insurancepolicyholderdob string The DOB of the insurance policy holder (mm/dd/yyyy).
employerstate string The patient's employer's state.
onlinestatementonlyyn boolean Set to true if a patient wishes to get e-statements instead of paper statements. Should only be set for patients with an email address and clients with athenaCommunicator. The language we use in the portal is, "Future billing statements will be sent to you securely via your Patient Portal account. You will receive an email notice when new statements are available." This language is not required, but it is given as a suggestion.
employerzip string The patient's employer's zip.
consenttocall boolean The flag is used to record the consent of a patient to receive automated calls per FCC requirements. The requested legal language is 'Entry of any telephone contact number constitutes written consent to receive any automated, prerecorded, and artificial voice telephone calls initiated by the Practice. To alter or revoke this consent, visit the Patient Portal "Contact Preferences" page.'
consenttotext boolean The flag is used to record the consent of a patient to receive text messages per FCC requirements. In order for this to be true, a valid mobile phone number must be set and the practice setting "Hide SMS Opt-in option" must be set to Off.
referralsourceid integer The referral / "how did you hear about us" ID.
caresummarydeliverypreference string The patient's preference for care summary delivery.
employerfax string The patient's employer's fax.
defaultpharmacyncpdpid integer The NCPDP ID of the patient's preferred pharmacy. See http://www.ncpdp.org/ for details. Note: if updating this field, please make sure to have a CLINICALORDERTYPEGROUPID field as well.
mobilecarrierid integer The ID of the mobile carrier, from /mobilecarriers or the list below.
notes string Notes associated with this patient.
portalstatus string Portal status details. See /patients/{patientid}/portalstatus for details.
 
lastloginentity string Either "PATIENT" or "FAMILY", the last entity who accessed this patient.
familyregisteredyn boolean Is there a family member registered with access to this patient.
noportalyn boolean The privacy setting for blocking the patient from the portal is set.
portalregistrationdate string The date the patient registered for the portal.
entitytodisplay string Either "FAMILY" or "PATIENT".
termsaccepted boolean Has this patient accepted the portal's Terms and Conditions. This is a good indicator if the patient has actually logged in to the portal or simply is registered without ever having logged in.
registeredyn boolean If this patient is registered or not for the portal.
blockedfailedloginsyn boolean Is this patient blocked from the portal due to failed login attempts.
lastlogindate string The last login date.
familyblockedfailedloginsyn boolean Is this patient's family blocked from the portal due to failed login attempts.
status string The status of the patient. Possible statuses:
  • REGISTERED: The patient is registered for the portal.
  • NOTREGISTERED: The patient is not registered for the portal.
  • FAMILYLOGIN: This patient is set up for a family member to login.
  • NOPORTAL: The privacy setting for blocking the patient from the portal is set.
  • BLOCKEDFAILEDLOGINS: The patient is blocked because of failed login attempts.
  • FAMILYBLOCKEDFAILEDLOGINS: The family member is blocked because of failed login attempts.
  • patientphotoyn boolean True if the patient has a photo uploaded
    patientphotourl string The URL to the patient photo
    povertylevelfamilysize string Patient's family size (used for determining poverty level). Only settable if client has Federal Poverty Level fields turned on.
    povertylevelcalculated string Patient's poverty level (% of the Federal Poverty Level), as calculated from family size, income per pay period, pay period, and state. Typically only valued if client has Federal Poverty Level fields turned on.
    povertylevelfamilysizedeclined boolean Indicates if the patient delcines to provide "povertylevelfamilysize". Should be set to Yes if the patient declines.
    povertylevelincomeperpayperiod string Patient's income per specified pay period (used for determining poverty level). Only settable if client has Federal Poverty Level fields turned on.
    povertylevelincomerangedeclined boolean Indicates whether or not the patient declines to provide an income level.
    povertylevelincomedeclined boolean Indicates if the patient delcines to provide "povertylevelincomeperpayperiod". Should be set to Yes if the patient declines.
    povertylevelincomepayperiod string Patient's pay period (used for determining poverty level). Only settable if client has Federal Poverty Level fields turned on.
    driverslicenseyn boolean True if the patient has a driver's license uploaded
    agriculturalworker string Used to identify this patient as an agricultural worker. Only settable if client has Social Determinant fields turned on.
    agriculturalworkertype string For patients that are agricultural workers, identifies the type of worker. Only settable if client has Social Determinant fields turned on.
    homeless string Used to identify this patient as homeless. Only settable if client has Social Determinant fields turned on.
    homelesstype string For patients that are homeless, provides more detail regarding the patient's homeless situation. Only settable if client has Social Determinant fields turned on.
    veteran string Used to identify this patient as a veteran. Only settable if client has Social Determinant fields turned on.
    schoolbasedhealthcenter string Used to identify this patient as school-based health center patient. Only settable if client has Social Determinant fields turned on.
    publichousing string Used to identify this patient as living in public housing. Only settable if client has Social Determinant fields turned on.
    driverslicenseurl string The URL to the patient's driver's license
    customfields array Same as /patients/{patientid}/customfields call, but without the department ID. Depending on setup, and only in large practices, the custom field values may or may not be the same between departments. If this is a concern, using the /patients/{patientid}/customfields call is preferred. Only for a single patient when showcustomfields is set to true.
     
    customfieldid integer Corresponds to the /customfields customfieldid.
    customfieldvalue string For a non-select custom field, the value.
    optionid integer For a select custom field, the selectid value (from /customfield's selectlist).
    claimbalancedetails string Claim level details on patient balances. (This is only included when SHOWBALANCEDETAILS is set.)
     
    claimdetails string Information related to claims for the patient.
     
    chargeleveldetail array Detailed information on charges associated with the claim.
     
    servicedate date Date of service for the charge.
    transactions array Detailed information on transactions associated with the charge.
     
    date date The date of the transaction.
    id number The athenaNet ID of the transaction.
    amount number The amount associated with the transaction.
    type string The type of the transaction. For charge, payment, adjustment, etc.
    epaymentid number The epayment ID of the payment receipt associated with this payment transaction. Applicable only for e-payments.
    description number Information related to the type of transaction. (For example, a co-pay.).
    transfertype string The party responsible for the parent charge of this transaction. For example, '1' (primary), '2' (secondary), or 'p' (patient).
    id number The athenaNet ID of the charge.
    amount number The billed amount for the charge.
    description string Description of the service.
    cleanbalance string Indicates whether the balance is associated with a contract or payment plan.
    amount number The amount billed for the claim.
    servicedate date The date the service was rendered.
    supervisingproviderid number The ID of the supervising provider who rendered the service.
    departmentid number The ID of the department where the service was rendered.
    claimid number The ID of the claim.
    patientbalance number The outstanding amount owed by the patient.
    providergroupid number The ID of the provider group for the claim.
    departmentids string Comma separated list of department IDs that belong to this provider group
    contactpreference_announcement_email boolean If set, the patient has indicated a preference to get or not get "announcement" communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal.
    contactpreference_announcement_sms boolean If set, the patient has indicated a preference to get or not get "announcement" communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user.
    contactpreference_announcement_phone boolean If set, the patient has indicated a preference to get or not get "announcement" communications delivered via phone. Note that this will not be present if the practice or patient has not set it.
    contactpreference_appointment_email boolean If set, the patient has indicated a preference to get or not get "appointment" communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal.
    contactpreference_appointment_sms boolean If set, the patient has indicated a preference to get or not get "appointment" communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user.
    contactpreference_appointment_phone boolean If set, the patient has indicated a preference to get or not get "appointment" communications delivered via phone. Note that this will not be present if the practice or patient has not set it.
    contactpreference_billing_email boolean If set, the patient has indicated a preference to get or not get "billing" communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal.
    contactpreference_billing_sms boolean If set, the patient has indicated a preference to get or not get "billing" communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user.
    contactpreference_billing_phone boolean If set, the patient has indicated a preference to get or not get "billing" communications delivered via phone. Note that this will not be present if the practice or patient has not set it.
    contactpreference_lab_email boolean If set, the patient has indicated a preference to get or not get "lab" communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal.
    contactpreference_lab_sms boolean If set, the patient has indicated a preference to get or not get "lab" communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user.
    contactpreference_lab_phone boolean If set, the patient has indicated a preference to get or not get "lab" communications delivered via phone. Note that this will not be present if the practice or patient has not set it.

     

    Patient that best matches the specified inputs. - GET /v1/{practiceid}/patients/enhancedbestmatch

    These fields describe a patient that was searched for based off of specific demographics that were passed. It can return multiple patients and will rank each one based off of how sure it is that this patient is the one you are looking for. For many of the fields (such as the name fields) the matching is fuzzy. Additionally there is the capability to do soundex matching if that parameter is passed in.

     

    Output Parameters

    Name Type Description
    altfirstname string Alternate first name that differs from legal name.
    ethnicitycode integer Ethnicity of the patient, using the 2.16.840.1.113883.5.50 codeset. See http://www.hl7.org/implement/standards/fhir/terminologies-v3.html Special case: use "declined" to indicate that the patient declined to answer.
    industrycode integer Industry of the patient, using the US Census industry code (code system 2.16.840.1.113883.6.310). "other" can be used as well.
    homeboundyn boolean If the patient is homebound, this is true.
    language6392code integer Language of the patient, using the ISO 639.2 code. (http://www.loc.gov/standards/iso639-2/php/code_list.php; "T" or terminology code) Special case: use "declined" to indicate that the patient declined to answer.
    race string The patient race, using the 2.16.840.1.113883.5.104 codeset. See http://www.hl7.org/implement/standards/fhir/terminologies-v3.html Special case: use "declined" to indicate that the patient declined to answer. Multiple values or a tab-seperated list of codes is acceptable for multiple races for input. The first race will be considered "primary". Note: you must update all values at once if you update any.
    localpatientid string 'Given showlocalpatientid is true, comma separated local patient id will be returned, if patient id is enterprise id else given patient id will be displayed.'
    deceaseddate string If present, the date on which a patient died.
    firstappointment string The first appointment for this patient, excluding cancelled or no-show appointments. (mm/dd/yyyy h24:mi)
    previouspatientids string The IDs of the patient this one was merged from.
     
    primaryproviderid integer The "primary" provider for this patient, if set.
    genderidentityother string If a patient does not identify with any prescribed gender identity choice, this field stores the patient-provided description of gender identity.
    assignedsexatbirth string Sex that this patient was assigned at birth.
    confidentialitycode string Gives the confidentiality code for the patient. Only returned when IGNORERESTRICTIONS is set to true and COLCR_RETURN_CONFIDENTIALITY_CODE is ON
    portalstatus string Portal status details. See /patients/{patientid}/portalstatus for details.
     
    familyregisteredyn boolean Is there a family member registered with access to this patient.
    lastloginentity string Either "PATIENT" or "FAMILY", the last entity who accessed this patient.
    noportalyn boolean The privacy setting for blocking the patient from the portal is set.
    portalregistrationdate string The date the patient registered for the portal.
    entitytodisplay string Either "FAMILY" or "PATIENT".
    status string The status of the patient. Possible statuses:
  • REGISTERED: The patient is registered for the portal.
  • NOTREGISTERED: The patient is not registered for the portal.
  • FAMILYLOGIN: This patient is set up for a family member to login.
  • NOPORTAL: The privacy setting for blocking the patient from the portal is set.
  • BLOCKEDFAILEDLOGINS: The patient is blocked because of failed login attempts.
  • FAMILYBLOCKEDFAILEDLOGINS: The family member is blocked because of failed login attempts.
  • termsaccepted boolean Has this patient accepted the portal's Terms and Conditions. This is a good indicator if the patient has actually logged in to the portal or simply is registered without ever having logged in.
    registeredyn boolean If this patient is registered or not for the portal.
    blockedfailedloginsyn boolean Is this patient blocked from the portal due to failed login attempts.
    lastlogindate string The last login date.
    familyblockedfailedloginsyn boolean Is this patient's family blocked from the portal due to failed login attempts.
    preferredpronouns string Pronoun this patient uses.
    lastappointment string The last appointment for this patient (before today), excluding cancelled or no-show appointments. (mm/dd/yyyy h24:mi)
    claimbalancedetails string Claim level details on patient balances. (This is only included when SHOWBALANCEDETAILS is set.)
     
    claimdetails string Information related to claims for the patient.
     
    chargeleveldetail string Detailed information on charges associated with the claim.
     
    id number The athenaNet ID of the charge.
    transactions string Detailed information on transactions associated with the charge.
     
    date date The date of the transaction.
    id number The athenaNet ID of the transaction.
    amount number The amount associated with the transaction.
    type string The type of the transaction. For charge, payment, adjustment, etc.
    epaymentid number The epayment ID of the payment receipt associated with this payment transaction. Applicable only for e-payments.
    description number Information related to the type of transaction. (For example, a co-pay.).
    transfertype string The party responsible for the parent charge of this transaction. For example, '1' (primary), '2' (secondary), or 'p' (patient).
    procedurecodeothermodifier string The modifiers for the procedure code.
    amount number The billed amount for the charge.
    description string Description of the service.
    procedurecode string The CPT code associated with this charge.
    procedurecodesubmitted string The procedure code that would be submitted as part of the claim.
    servicedate date Date of service for the charge.
    cleanbalance boolean Indicates whether the balance is associated with a contract or payment plan.
    amount number The amount billed for the claim.
    servicedate date The date the service was rendered.
    supervisingproviderid number The ID of the supervising provider who rendered the service.
    departmentid number The ID of the department where the service was rendered.
    claimid number The ID of the claim.
    patientbalance number The outstanding amount owed by the patient.
    providergroupid number The ID of the provider group for the claim.
    departmentids string Comma separated list of department IDs that belong to this provider group
    allpatientstatuses string
     
    departmentid integer The ID of a department that this patient is registered in.
    primaryproviderid string The "primary" provider for this patient, if set.
    status string The "status" of the patient, one of active, inactive, prospective, or deleted.
    donotcallyn boolean Warning! This patient will not receive any communication from the practice if this field is set to true.
    primarydepartmentid integer The patient's "current" department. This field is not always set by the practice.
    status string The "status" of the patient, one of active, inactive, prospective, or deleted.
    insurances string List of active patient insurance packages. Only shown for a single patient and if SHOWINSURANCE is set.
     
    insurancepolicyholder string The full name of the insurance policy holder.
    ccmstatusname string The name of current CCM enrollment status.
    insurancepolicyholderaddress2 string The second address line of the insurance policy holder.
    caseinjurydate string CASE POLICY FIELD - Date of the injury. Required for auto insurance, legal, and worker's comp case policies.
    insurancepolicyholderfirstname string The first name of the insurance policy holder. Except for self-pay, required for new policies.
    expirationdate date Date the insurance expires.
    insurancepolicyholderlastname string The last name of the insurance policy holder. Except for self-pay, required for new policies.
    cancelled date The date in which the insurance was marked cancelled.
    insurancepolicyholdersex string The sex of the insurance policy holder. Except for self-pay, required for new policies.
    sequencenumber integer 1 = primary, 2 = secondary, 3 = tertiary, etc. Must have a primary before a secondary and a secondary before a tertiary, etc.
    adjusterfirstname string CASE POLICY FIELD - First name of the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
    anotherpartyresponsibleyn boolean CASE POLICY FIELD - Boolean field indicating if another party was responsible for this accident.
    descriptionofinjury string CASE POLICY FIELD - A description of the injury. Only available for auto insurance and worker's comp case policies.
    eligibilityreason string The source of the current status. Athena is our eligibility engine.
    icd10codes string CASE POLICY FIELD - See documentation for ICD9CODES.
     
    icd9codes string CASE POLICY FIELD - A list of ICD9 accepted diagnosis codes. Only available for worker's comp case policies.
     
    insuranceclaimnumber string CASE POLICY FIELD - The auto insurance claim number or the worker's comp claim number.
    insuranceid integer The athena insurance policy ID.
    insuranceplandisplayname string Superpackagename of the specific insurance package.
    insurancepolicyholdercity string The city of the insurance policy holder.
    insurancepolicyholdercountrycode string The country code (3 letter) of the insurance policy holder.
    insurancepolicyholdercountryiso3166 string The ISO 3166 country code of the insurance policy holder.
    insurancepolicyholdermiddlename string The middle name of the insurance policy holder.
    insurancepolicyholderstate string The state of the insurance policy holder.
    insurancepolicyholderzip string The zip of the insurance policy holder.
    relatedtootheraccidentyn boolean CASE POLICY FIELD - Boolean field indicating whether this case policy is related to another accident. Only available for worker's comp case policies.
    policynumber string The insurance group number. This is sometimes present on an insurance card.
    slidingfeeplanid integer If the patient is on a sliding fee plan, this is the ID of that plan. See /slidingfeeplans.
    adjusterfax string CASE POLICY FIELD - Fax for the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
    relationshiptoinsured string This patient's relationship to the policy holder (text).
    stateofreportedinjury string CASE POLICY FIELD - Two-letter state abbreviation for the state this injury was reported in. Only available for worker's comp case policies.
    relatedtoautoaccidentyn boolean CASE POLICY FIELD - Boolean field indicating whether this case policy is related to an auto accident.
    eligibilitymessage string The message, usually from our engine, of the eligibility check.
    insuranceidnumber string The insurance policy ID number (as presented on the insurance card itself).
    adjusterphone string CASE POLICY FIELD - Phone number/other contact info for the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
    insurancepackageaddress1 string Address 1 for the AthenaNet insurance Package.
    insurancepolicyholderaddress1 string The first address line of the insurance policy holder.
    ccmstatusid integer Status ID of current CCM enrollment.
    coinsurancepercent number The coinsurance percentage for this insurance. If you've just POSTed a new insurance you will have to wait for the auto eligbility check before this field populates.
    insurancepolicyholdersuffix string The suffix of the insurance policy holder.
    insuredpcpnpi integer The national provider id of the primary care physcian assicated with the insurance.
    injuredbodypart string CASE POLICY FIELD - Text field for describing the injured body part. Only available for auto insurance and worker's comp case policies.
    eligibilitylastchecked date Date the eligibility was last checked.
    insuredpcp string
    insurancepackageaddress2 string Address 2 for the AthenaNet insurance Package.
    autoaccidentstate string CASE POLICY FIELD - Two-letter abbreviation for the state in which the auto accident took place. Only meaningful for auto insurance case policies.
    adjusterlastname string CASE POLICY FIELD - Last name of the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
    copays string Details about the copays for this insurance package. If you've just POSTed a new insurance you will have to wait for the auto eligbility check before these populate.
     
    copaytype number What the copay amount applies to.
    copayamount string The amount of the copay.
    insurancepackagezip string Zip code of the AthenaNet insurance package
    insurancepackagecity string City for the AthenaNet insurance Package.
    insurancepolicyholderssn string The SSN of the insurance policy holder.
    insurancetype string Type of insurance. E.g., Medicare Part B, Group Policy, HMO, etc.
    ircname string Insurance category / company. E.g., United Healthcare, BCBS-MA, etc.
    casepolicytypename string CASE POLICY FIELD - The name of this type of case policy.
    repricerphone string CASE POLICY FIELD - Phone number for the repricer. Only available for worker's comp case policies.
    ircid integer Insurance category / company internal ID
    insurancepackagestate string State of the AthenaNet insurance package
    insuranceplanname string Name of the specific insurance package.
    insurancepackageid integer The athenaNet insurance package ID.
    eligibilitystatus string Current eligibility status of this insurance package.
    relatedtoemploymentyn boolean CASE POLICY FIELD - Boolean field indicating whether this case policy is related to the patient's employer.
    insurancephone string The phone number for the insurance company. Note: This defaults to the insurance package phone number. If this is set, it will override it. Likewise if blanked out, it will go back to default.
    relationshiptoinsuredid integer This patient's relationship to the policy holder (as an ID). See the mapping.
    repricername string CASE POLICY FIELD - Name for the repricer. Only available for worker's comp case policies.
    insuredentitytypeid integer The ID of the entity type for this insurance.
    issuedate date Date the insurance was issued.
    employerid string The employer ID associated with the patient's insurance.
    insurancepolicyholderdob string The DOB of the insurance policy holder (mm/dd/yyyy).
    balances string List of balances owed by the patient, broken down by provider (financial) group.
     
    contracts string Information related to existing credit card contracts.
     
    availablebalance string The available balance on this contract.
    contractclass integer The type of contract. For example, "ONEYEAR,"
    maxamount string The maximum allowed amount for this contract.
    providergroupid integer Athena ID for this financial group.
    departmentlist string Comma separated list of department IDs that belong to this group
    balance string Balance for this provider group.
    cleanbalance boolean Indicates whether the balance is associated with a contract, payment plan, or collections agency.
    collectionsbalance string The outstanding amount associated with a collections agency.
    paymentplanbalance string The outstanding amount associated with a payment plan.
    lastemail string The last email for this patient on file.
    customfields string Same as /patients/{patientid}/customfields call, but without the department ID. Depending on setup, and only in large practices, the custom field values may or may not be the same between departments. If this is a concern, using the /patients/{patientid}/customfields call is preferred. Only for a single patient when showcustomfields is set to true.
     
    customfieldid integer Corresponds to the /customfields customfieldid.
    customfieldvalue string For a non-select custom field, the value.
    optionid integer For a select custom field, the selectid value (from /customfield's selectlist).
    racecode string The patient race hierarchical code as specified in Race & Ethnicity - CDC * (2.16.840.1.113883.1.11.14914)
    sexualorientation string Sexual orientation of this patient.
    genderidentity string Gender with which this patient identifies.
    score number This is the patient's matching score. This indicates how likely this patient is to be the patient you are searching for given the demographics input. A score of 26 indicates the patient is automatically assumed to be the same. A score under 16 indicates that this is almost guaranteed to NOT be the patient you are looking for (we will never return any patient with a score under 16). A score of around 23 is the maximum you can get if the only parameters you pass in are the required parameters.
    sexualorientationother string If a patient does not identify with any prescribed sexual orientation choice, this field stores the patient-provided description of sexual orientation.
    emailexistsyn boolean True if email exists. False if patient declined. Null if status is unknown.
    occupationcode integer Occupation of the patient, using the US Census occupation code (code system 2.16.840.1.113883.6.240). "other" can be used as well.
    patientid integer Please remember to never disclose this ID to patients since it may result in inadvertant disclosure that a patient exists in a practice already.
    firstname string Patient's first name
    middlename string Patient's middle name
    lastname string Patient's last name
    suffix string Patient's name suffix
    preferredname string The patient's preferred name (i.e. nickname).
    address1 string Patient's address - 1st line
    address2 string Patient's address - 2nd line
    city string Patient's city
    state string Patient's state (2 letter abbreviation)
    zip string Patient's zip. Matching occurs on first 5 characters.
    countrycode string Patient's country code
    countrycode3166 string Patient's country code (ISO 3166-1)
    homephone string The patient's home phone number. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    mobilephone string The patient's mobile phone number. On input, 'declined' can be used to indicate no number. (Alternatively, hasmobile can also be set to false. "declined" simply does this for you.) Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    hasmobileyn boolean Set to false if a client has declined a phone number.
    workphone string The patient's work phone number. Generally not used to contact a patient. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    email string Patient's email address. 'declined' can be used to indicate just that.
    ssn string The patient's SSN
    racename string The patient's primary race name. See race for more complete details.
    sex string Patient's sex (M/F)
    dob string Patient's DOB (mm/dd/yyyy)
    maritalstatus integer Marital Status (D=Divorced, M=Married, S=Single, U=Unknown, W=Widowed, X=Separated, P=Partner)
    contactpreference string The MU-required field for "preferred contact method". This is not used by any automated systems.
    contactname string The name of the (emergency) person to contact about the patient. The contactname, contactrelationship, contacthomephone, and contactmobilephone fields are all related to the emergency contact for the patient. They are NOT related to the contractpreference_* fields.
    contactrelationship string Emergency contact relationship (one of SPOUSE, PARENT, CHILD, SIBLING, FRIEND, COUSIN, GUARDIAN, OTHER)
    contacthomephone string Emergency contact home phone. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    contactmobilephone string Emergency contact mobile phone. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    nextkinname string The full name of the next of kin.
    nextkinrelationship string The next of kin relationship (one of SPOUSE, PARENT, CHILD, SIBLING, FRIEND, COUSIN, GUARDIAN, OTHER)
    nextkinphone string The next of kin phone number. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    guardianfirstname string The first name of the patient's guardian.
    guardianmiddlename string The middle name of the patient's guardian.
    guardianlastname string The last name of the patient's guardian.
    guardiansuffix string The suffix of the patient's guardian.
    guarantorfirstname string Guarantor's first name
    guarantormiddlename string Guarantor's middle name
    guarantorlastname string Guarantor's last name
    guarantorsuffix string Guarantor's name suffix
    guarantoraddress1 string Guarantor's address
    guarantoraddress2 string Guarantor's address - line 2
    guarantorcity string Guarantor's city
    guarantorstate string Guarantor's state (2 letter abbreviation)
    guarantorzip string Guarantor's zip
    guarantorcountrycode string Guarantor's country code
    guarantorcountrycode3166 string Guarantor's country code (ISO 3166-1)
    guarantordob string Guarantor's DOB (mm/dd/yyyy)
    guarantorssn string Guarantor's SSN
    guarantoremail string Guarantor's email address
    guarantorphone string Guarantor's phone number. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    guarantorrelationshiptopatient integer The guarantor's relationship to the patient
    guarantoraddresssameaspatient boolean The address of the guarantor is the same as the patient.
    registrationdate date Date the patient was registered.
    departmentid integer Primary (registration) department ID.
    portaltermsonfile boolean Flag determining whether or not the patient has accepted the Terms and Conditions for the patient portal.
    portalsignatureonfile boolean This flag is set if the patient's signature is on file
    privacyinformationverified boolean This flag is set if the patient's privacy information has been verified. Privacy information returns True if all of the items referenced in GET /patients/{patientid}/privacyinformationverified are true. Privacy information returns false if any of the items referenced in the GET /patients/{patientid}/privacyinformationverified API are false or expired.
    medicationhistoryconsentverified boolean Medication history consent status. If a practice doesn't have RXHub or Surescripts enabled, this will be null
    maritalstatusname string The long version of the marital status.
    employerid integer The patient's employer's ID (from /employers call)
    employerphone string The patient's employer's phone number. Normally, this is set by setting employerid. However, setting this value can be used to override this on an individual patient. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    guarantoremployerid integer The guaranror's employer's ID (from /employers call)
    employername string The patient's employer's name.
    employeraddress string The patient's employer's address.
    employercity string The patient's employer's city.
    portalaccessgiven boolean This flag is set if the patient has been given access to the portal. This may be set by the API user if a patient has been given access to the portal "by providing a preprinted brochure or flyer showing the URL where patients can access their Patient Care Summaries." The practiceinfo endpoint can provide the portal URL. While technically allowed, it would be very unusual to set this to false via the API.
    employerstate string The patient's employer's state.
    onlinestatementonlyyn boolean Set to true if a patient wishes to get e-statements instead of paper statements. Should only be set for patients with an email address and clients with athenaCommunicator. The language we use in the portal is, "Future billing statements will be sent to you securely via your Patient Portal account. You will receive an email notice when new statements are available." This language is not required, but it is given as a suggestion.
    employerzip string The patient's employer's zip.
    consenttocall boolean The flag is used to record the consent of a patient to receive automated calls per FCC requirements. The requested legal language is 'Entry of any telephone contact number constitutes written consent to receive any automated, prerecorded, and artificial voice telephone calls initiated by the Practice. To alter or revoke this consent, visit the Patient Portal "Contact Preferences" page.'
    consenttotext boolean The flag is used to record the consent of a patient to receive text messages per FCC requirements. In order for this to be true, a valid mobile phone number must be set and the practice setting "Hide SMS Opt-in option" must be set to Off.
    smsoptindate date The date on which the patient's consent to receive text messages as per FCC requirements was recorded. In order for this to be valid, a valid mobile phone number must be set and the practice setting 'Hide SMS Opt-in option' must be set to Off.
    referralsourceid integer The referral / "how did you hear about us" ID.
    referralsourceother string If choosing "other" for referral source, this is the text field that can be filled out.
    caresummarydeliverypreference string The patient's preference for care summary delivery.
    employerfax string The patient's employer's fax.
    defaultpharmacyncpdpid integer The NCPDP ID of the patient's preferred pharmacy. See http://www.ncpdp.org/ for details. Note: if updating this field, please make sure to have a CLINICALORDERTYPEGROUPID field as well.
    mobilecarrierid integer The ID of the mobile carrier, from /mobilecarriers or the list below.
    notes string Notes associated with this patient.
    patientphotoyn boolean True if the patient has a photo uploaded
    driverslicensenumber string The number of the patient's driver's license
    driverslicensestateid string The state of the patient's driver's license. This is in the form of a 2 letter state code.
    patientphotourl string The URL to the patient photo
    driverslicenseexpirationdate date The expiration date of the patient's driver's license.
    povertylevelfamilysize string Patient's family size (used for determining poverty level). Only settable if client has Federal Poverty Level fields turned on.
    povertylevelcalculated integer Patient's poverty level (% of the Federal Poverty Level), as calculated from family size, income per pay period, pay period, and state. Typically only valued if client has Federal Poverty Level fields turned on.
    povertylevelfamilysizedeclined boolean Indicates if the patient delcines to provide "povertylevelfamilysize". Should be set to Yes if the patient declines.
    povertylevelincomeperpayperiod string Patient's income per specified pay period (used for determining poverty level). Only settable if client has Federal Poverty Level fields turned on.
    povertylevelincomedeclined boolean Indicates if the patient delcines to provide "povertylevelincomeperpayperiod". Should be set to Yes if the patient declines.
    povertylevelincomepayperiod string Patient's pay period (used for determining poverty level). Only settable if client has Federal Poverty Level fields turned on.
    povertylevelincomerangedeclined boolean Indicates if the patient declines to provide an income range level. True if the patient declines.
    driverslicenseyn boolean True if the patient has a driver's license uploaded
    agriculturalworker string Used to identify this patient as an agricultural worker. Only settable if client has Social Determinant fields turned on.
    agriculturalworkertype string For patients that are agricultural workers, identifies the type of worker. Only settable if client has Social Determinant fields turned on.
    homeless string Used to identify this patient as homeless. Only settable if client has Social Determinant fields turned on.
    homelesstype string For patients that are homeless, provides more detail regarding the patient's homeless situation. Only settable if client has Social Determinant fields turned on.
    veteran string Used to identify this patient as a veteran. Only settable if client has Social Determinant fields turned on.
    schoolbasedhealthcenter string Used to identify this patient as school-based health center patient. Only settable if client has Social Determinant fields turned on.
    publichousing string Used to identify this patient as living in public housing. Only settable if client has Social Determinant fields turned on.
    driverslicenseurl string The URL to the patient's driver's license
    contactpreference_announcement_email boolean If set, the patient has indicated a preference to get or not get "announcement" communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal.
    contactpreference_announcement_sms boolean If set, the patient has indicated a preference to get or not get "announcement" communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user.
    contactpreference_announcement_phone boolean If set, the patient has indicated a preference to get or not get "announcement" communications delivered via phone. Note that this will not be present if the practice or patient has not set it.
    contactpreference_appointment_email boolean If set, the patient has indicated a preference to get or not get "appointment" communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal.
    contactpreference_appointment_sms boolean If set, the patient has indicated a preference to get or not get "appointment" communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user.
    contactpreference_appointment_phone boolean If set, the patient has indicated a preference to get or not get "appointment" communications delivered via phone. Note that this will not be present if the practice or patient has not set it.
    contactpreference_billing_email boolean If set, the patient has indicated a preference to get or not get "billing" communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal.
    contactpreference_billing_sms boolean If set, the patient has indicated a preference to get or not get "billing" communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user.
    contactpreference_billing_phone boolean If set, the patient has indicated a preference to get or not get "billing" communications delivered via phone. Note that this will not be present if the practice or patient has not set it.
    contactpreference_lab_email boolean If set, the patient has indicated a preference to get or not get "lab" communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal.
    contactpreference_lab_sms boolean If set, the patient has indicated a preference to get or not get "lab" communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user.
    contactpreference_lab_phone boolean If set, the patient has indicated a preference to get or not get "lab" communications delivered via phone. Note that this will not be present if the practice or patient has not set it.

     

    Patients that matches a custom field value. - GET /v1/{practiceid}/patients/customfields/{customfieldid}/{customfieldvalue}

    Patient information, creation, and updating

     

    Output Parameters

    Name Type Description
    confidentialitycode string Gives the confidentiality code for the patient. Only returned when IGNORERESTRICTIONS is set to true and COLCR_RETURN_CONFIDENTIALITY_CODE is ON
    driverslicenseexpirationdate string
    driverslicensenumber string
    driverslicensestateid integer
    homeboundyn boolean If the patient is homebound, this is true.
    deceaseddate string If present, the date on which a patient died.
    industrycode integer Industry of the patient, using the US Census industry code (code system 2.16.840.1.113883.6.310). "other" can be used as well.
    donotcallyn boolean Warning! This patient will not receive any communication from the practice if this field is set to true.
    ethnicitycode integer Ethnicity of the patient, using the 2.16.840.1.113883.5.50 codeset. See http://www.hl7.org/implement/standards/fhir/terminologies-v3.html Special case: use "declined" to indicate that the patient declined to answer.
    language6392code integer Language of the patient, using the ISO 639.2 code. (http://www.loc.gov/standards/iso639-2/php/code_list.php; "T" or terminology code) Special case: use "declined" to indicate that the patient declined to answer.
    race string The patient race, using the 2.16.840.1.113883.5.104 codeset. See http://www.hl7.org/implement/standards/fhir/terminologies-v3.html Special case: use "declined" to indicate that the patient declined to answer. Multiple values or a tab-seperated list of codes is acceptable for multiple races for input. The first race will be considered "primary". Note: you must update all values at once if you update any.
    firstappointment string The first appointment for this patient, excluding cancelled or no-show appointments. (mm/dd/yyyy h24:mi)
    primaryproviderid integer The "primary" provider for this patient, if set.
    lastappointment string The last appointment for this patient (before today), excluding cancelled or no-show appointments. (mm/dd/yyyy h24:mi)
    primarydepartmentid integer The patient's "current" department. This field is not always set by the practice.
    status string The "status" of the patient, one of active, inactive, prospective, or deleted.
    hierarchicalcode string The patient race hierarchical code
    lastemail string Tthe last email for this patient on file.
    emailexistsyn boolean True if email exists. False if patient declined. Null if status is unknown.
    occupationcode integer Occupation of the patient, using the US Census occupation code (code system 2.16.840.1.113883.6.240). "other" can be used as well.
    patientid integer Please remember to never disclose this ID to patients since it may result in inadvertant disclosure that a patient exists in a practice already.
    firstname string Patient's first name
    middlename string Patient's middle name
    lastname string Patient's last name
    suffix string Patient's name suffix
    preferredname string The patient's preferred name (i.e. nickname).
    address1 string Patient's address - 1st line
    address2 string Patient's address - 2nd line
    city string Patient's city
    state string Patient's state (2 letter abbreviation)
    zip string Patient's zip. Matching occurs on first 5 characters.
    countrycode string Patient's country code
    countrycode3166 string Patient's country code (ISO 3166-1)
    homephone string The patient's home phone number. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    mobilephone string The patient's mobile phone number. On input, 'declined' can be used to indicate no number. (Alternatively, hasmobile can also be set to false. "declined" simply does this for you.) Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    hasmobileyn boolean Set to false if a client has declined a phone number.
    workphone string The patient's work phone number. Generally not used to contact a patient. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    email string Patient's email address. 'declined' can be used to indicate just that.
    ssn string
    racename string The patient's primary race name. See race for more complete details.
    sex string Patient's sex (M/F)
    dob string Patient's DOB (mm/dd/yyyy)
    maritalstatus integer Marital Status (D=Divorced, M=Married, S=Single, U=Unknown, W=Widowed, X=Separated, P=Partner)
    contactpreference string The MU-required field for "preferred contact method". This is not used by any automated systems.
    contactname string The name of the (emergency) person to contact about the patient. The contactname, contactrelationship, contacthomephone, and contactmobilephone fields are all related to the emergency contact for the patient. They are NOT related to the contractpreference_* fields.
    contactrelationship string Emergency contact relationship (one of SPOUSE, PARENT, CHILD, SIBLING, FRIEND, COUSIN, GUARDIAN, OTHER)
    contacthomephone string Emergency contact home phone. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    contactmobilephone string Emergency contact mobile phone. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    nextkinname string The full name of the next of kin.
    nextkinrelationship string The next of kin relationship (one of SPOUSE, PARENT, CHILD, SIBLING, FRIEND, COUSIN, GUARDIAN, OTHER)
    nextkinphone string The next of kin phone number. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    guardianfirstname string The first name of the patient's guardian.
    guardianmiddlename string The middle name of the patient's guardian.
    guardianlastname string The last name of the patient's guardian.
    guardiansuffix string The suffix of the patient's guardian.
    guarantorfirstname string Guarantor's first name
    guarantormiddlename string Guarantor's middle name
    guarantorlastname string Guarantor's last name
    guarantorsuffix string Guarantor's name suffix
    guarantoraddress1 string Guarantor's address
    guarantoraddress2 string Guarantor's address - line 2
    guarantorcity string Guarantor's city
    guarantorstate string Guarantor's state (2 letter abbreviation)
    guarantorzip string Guarantor's zip
    guarantorcountrycode string Guarantor's country code
    guarantorcountrycode3166 string Guarantor's country code (ISO 3166-1)
    guarantordob string Guarantor's DOB (mm/dd/yyyy)
    guarantorssn string Guarantor's SSN
    guarantoremail string Guarantor's email address
    guarantorphone string Guarantor's phone number. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    guarantorrelationshiptopatient integer The guarantor's relationship to the patient
    guarantoraddresssameaspatient boolean The address of the guarantor is the same as the patient.
    registrationdate string Date the patient was registered.
    departmentid integer Primary (registration) department ID.
    portaltermsonfile boolean
    portalsignatureonfile boolean
    privacyinformationverified boolean This flag is set if the patient's privacy information has been verified. Privacy information returns True if all of the items referenced in GET /patients/{patientid}/privacyinformationverified are true. Privacy information returns false if any of the items referenced in the GET /patients/{patientid}/privacyinformationverified API are false or expired.
    medicationhistoryconsentverified boolean Medication history consent status. If a practice doesn't have RXHub or Surescripts enabled, this will be null
    balances array List of balances owed by the patient, broken down by provider (financial) group.
     
    providergroupid integer Athena ID for this financial group.
    departmentids string Comma separated list of department IDs that belong to this group
    balance string Balance for this provider group.
    cleanbalance string Indicates whether the balance is associated with a contract, payment plan, or collections agency.
    contracts array Information related to existing credit card contracts.
     
    availablebalance string The available balance on this contract.
    contractclass integer The type of contract. For example, "ONEYEAR,"
    maxamount string The maximum allowed amount for this contract.
    collectionsbalance string The outstanding amount associated with a collections agency.
    paymentplanbalance string The outstanding amount associated with a payment plan.
    maritalstatusname string The long version of the marital status.
    employerid integer The patient's employer's ID (from /employers call)
    employerphone string The patient's employer's phone number. Normally, this is set by setting employerid. However, setting this value can be used to override this on an individual patient. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    guarantoremployerid integer The guaranror's employer's ID (from /employers call)
    employername string The patient's employer's name.
    employeraddress string The patient's employer's address.
    employercity string The patient's employer's city.
    portalaccessgiven boolean This flag is set if the patient has been given access to the portal. This may be set by the API user if a patient has been given access to the portal "by providing a preprinted brochure or flyer showing the URL where patients can access their Patient Care Summaries." The practiceinfo endpoint can provide the portal URL. While technically allowed, it would be very unusual to set this to false via the API.
    insurances array List of active patient insurance packages. Only shown for a single patient and if SHOWINSURANCE is set.
     
    insurancepolicyholder string The full name of the insurance policy holder.
    ccmstatusname string The name of current CCM enrollment status.
    insurancepolicyholderaddress2 string The second address line of the insurance policy holder.
    caseinjurydate string CASE POLICY FIELD - Date of the injury. Required for auto insurance, legal, and worker's comp case policies.
    insurancepolicyholderfirstname string The first name of the insurance policy holder. Except for self-pay, required for new policies.
    expirationdate date Date the insurance expires.
    insurancepolicyholderlastname string The last name of the insurance policy holder. Except for self-pay, required for new policies.
    cancelled date The date in which the insurance was marked cancelled.
    insurancepolicyholdersex string The sex of the insurance policy holder. Except for self-pay, required for new policies.
    sequencenumber integer 1 = primary, 2 = secondary, 3 = tertiary, etc. Must have a primary before a secondary and a secondary before a tertiary, etc.
    adjusterfirstname string CASE POLICY FIELD - First name of the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
    anotherpartyresponsibleyn boolean CASE POLICY FIELD - Boolean field indicating if another party was responsible for this accident.
    descriptionofinjury string CASE POLICY FIELD - A description of the injury. Only available for auto insurance and worker's comp case policies.
    eligibilityreason string The source of the current status. Athena is our eligibility engine.
    icd10codes string CASE POLICY FIELD - See documentation for ICD9CODES.
     
    icd9codes string CASE POLICY FIELD - A list of ICD9 accepted diagnosis codes. Only available for worker's comp case policies.
     
    insuranceclaimnumber string CASE POLICY FIELD - The auto insurance claim number or the worker's comp claim number.
    insuranceid integer The athena insurance policy ID.
    insuranceplandisplayname string Superpackagename of the specific insurance package.
    insurancepolicyholdercity string The city of the insurance policy holder.
    insurancepolicyholdercountrycode string The country code (3 letter) of the insurance policy holder.
    insurancepolicyholdercountryiso3166 string The ISO 3166 country code of the insurance policy holder.
    insurancepolicyholdermiddlename string The middle name of the insurance policy holder.
    insurancepolicyholderstate string The state of the insurance policy holder.
    insurancepolicyholderzip string The zip of the insurance policy holder.
    relatedtootheraccidentyn boolean CASE POLICY FIELD - Boolean field indicating whether this case policy is related to another accident. Only available for worker's comp case policies.
    policynumber string The insurance group number. This is sometimes present on an insurance card.
    slidingfeeplanid integer If the patient is on a sliding fee plan, this is the ID of that plan. See /slidingfeeplans.
    adjusterfax string CASE POLICY FIELD - Fax for the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
    relationshiptoinsured string This patient's relationship to the policy holder (text).
    stateofreportedinjury string CASE POLICY FIELD - Two-letter state abbreviation for the state this injury was reported in. Only available for worker's comp case policies.
    relatedtoautoaccidentyn boolean CASE POLICY FIELD - Boolean field indicating whether this case policy is related to an auto accident.
    eligibilitymessage string The message, usually from our engine, of the eligibility check.
    insuranceidnumber string The insurance policy ID number (as presented on the insurance card itself).
    adjusterphone string CASE POLICY FIELD - Phone number/other contact info for the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
    insurancepackageaddress1 string Address 1 for the AthenaNet insurance Package.
    insurancepolicyholderaddress1 string The first address line of the insurance policy holder.
    ccmstatusid integer Status ID of current CCM enrollment.
    coinsurancepercent number The coinsurance percentage for this insurance. If you've just POSTed a new insurance you will have to wait for the auto eligbility check before this field populates.
    insurancepolicyholdersuffix string The suffix of the insurance policy holder.
    insuredpcpnpi integer The national provider id of the primary care physcian assicated with the insurance.
    injuredbodypart string CASE POLICY FIELD - Text field for describing the injured body part. Only available for auto insurance and worker's comp case policies.
    eligibilitylastchecked date Date the eligibility was last checked.
    insuredpcp string
    insurancepackageaddress2 string Address 2 for the AthenaNet insurance Package.
    autoaccidentstate string CASE POLICY FIELD - Two-letter abbreviation for the state in which the auto accident took place. Only meaningful for auto insurance case policies.
    adjusterlastname string CASE POLICY FIELD - Last name of the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
    copays string Details about the copays for this insurance package. If you've just POSTed a new insurance you will have to wait for the auto eligbility check before these populate.
     
    copaytype number What the copay amount applies to.
    copayamount string The amount of the copay.
    insurancepackagezip string Zip code of the AthenaNet insurance package
    insurancepackagecity string City for the AthenaNet insurance Package.
    insurancepolicyholderssn string The SSN of the insurance policy holder.
    insurancetype string Type of insurance. E.g., Medicare Part B, Group Policy, HMO, etc.
    ircname string Insurance category / company. E.g., United Healthcare, BCBS-MA, etc.
    casepolicytypename string CASE POLICY FIELD - The name of this type of case policy.
    repricerphone string CASE POLICY FIELD - Phone number for the repricer. Only available for worker's comp case policies.
    ircid integer Insurance category / company internal ID
    insurancepackagestate string State of the AthenaNet insurance package
    insuranceplanname string Name of the specific insurance package.
    insurancepackageid integer The athenaNet insurance package ID.
    eligibilitystatus string Current eligibility status of this insurance package.
    relatedtoemploymentyn boolean CASE POLICY FIELD - Boolean field indicating whether this case policy is related to the patient's employer.
    insurancephone string The phone number for the insurance company. Note: This defaults to the insurance package phone number. If this is set, it will override it. Likewise if blanked out, it will go back to default.
    relationshiptoinsuredid integer This patient's relationship to the policy holder (as an ID). See the mapping.
    repricername string CASE POLICY FIELD - Name for the repricer. Only available for worker's comp case policies.
    insuredentitytypeid integer The ID of the entity type for this insurance.
    issuedate date Date the insurance was issued.
    employerid string The employer ID associated with the patient's insurance.
    insurancepolicyholderdob string The DOB of the insurance policy holder (mm/dd/yyyy).
    employerstate string The patient's employer's state.
    onlinestatementonlyyn boolean Set to true if a patient wishes to get e-statements instead of paper statements. Should only be set for patients with an email address and clients with athenaCommunicator. The language we use in the portal is, "Future billing statements will be sent to you securely via your Patient Portal account. You will receive an email notice when new statements are available." This language is not required, but it is given as a suggestion.
    employerzip string The patient's employer's zip.
    consenttocall boolean The flag is used to record the consent of a patient to receive automated calls per FCC requirements. The requested legal language is 'Entry of any telephone contact number constitutes written consent to receive any automated, prerecorded, and artificial voice telephone calls initiated by the Practice. To alter or revoke this consent, visit the Patient Portal "Contact Preferences" page.'
    consenttotext boolean The flag is used to record the consent of a patient to receive text messages per FCC requirements. In order for this to be true, a valid mobile phone number must be set and the practice setting "Hide SMS Opt-in option" must be set to Off.
    referralsourceid integer The referral / "how did you hear about us" ID.
    caresummarydeliverypreference string The patient's preference for care summary delivery.
    employerfax string The patient's employer's fax.
    defaultpharmacyncpdpid integer The NCPDP ID of the patient's preferred pharmacy. See http://www.ncpdp.org/ for details. Note: if updating this field, please make sure to have a CLINICALORDERTYPEGROUPID field as well.
    mobilecarrierid integer The ID of the mobile carrier, from /mobilecarriers or the list below.
    notes string Notes associated with this patient.
    portalstatus string Portal status details. See /patients/{patientid}/portalstatus for details.
     
    lastloginentity string Either "PATIENT" or "FAMILY", the last entity who accessed this patient.
    familyregisteredyn boolean Is there a family member registered with access to this patient.
    noportalyn boolean The privacy setting for blocking the patient from the portal is set.
    portalregistrationdate string The date the patient registered for the portal.
    entitytodisplay string Either "FAMILY" or "PATIENT".
    termsaccepted boolean Has this patient accepted the portal's Terms and Conditions. This is a good indicator if the patient has actually logged in to the portal or simply is registered without ever having logged in.
    registeredyn boolean If this patient is registered or not for the portal.
    blockedfailedloginsyn boolean Is this patient blocked from the portal due to failed login attempts.
    lastlogindate string The last login date.
    familyblockedfailedloginsyn boolean Is this patient's family blocked from the portal due to failed login attempts.
    status string The status of the patient. Possible statuses:
  • REGISTERED: The patient is registered for the portal.
  • NOTREGISTERED: The patient is not registered for the portal.
  • FAMILYLOGIN: This patient is set up for a family member to login.
  • NOPORTAL: The privacy setting for blocking the patient from the portal is set.
  • BLOCKEDFAILEDLOGINS: The patient is blocked because of failed login attempts.
  • FAMILYBLOCKEDFAILEDLOGINS: The family member is blocked because of failed login attempts.
  • patientphotoyn boolean True if the patient has a photo uploaded
    patientphotourl string The URL to the patient photo
    povertylevelfamilysize string Patient's family size (used for determining poverty level). Only settable if client has Federal Poverty Level fields turned on.
    povertylevelcalculated string Patient's poverty level (% of the Federal Poverty Level), as calculated from family size, income per pay period, pay period, and state. Typically only valued if client has Federal Poverty Level fields turned on.
    povertylevelfamilysizedeclined boolean Indicates if the patient delcines to provide "povertylevelfamilysize". Should be set to Yes if the patient declines.
    povertylevelincomeperpayperiod string Patient's income per specified pay period (used for determining poverty level). Only settable if client has Federal Poverty Level fields turned on.
    povertylevelincomerangedeclined boolean Indicates whether or not the patient declines to provide an income level.
    povertylevelincomedeclined boolean Indicates if the patient delcines to provide "povertylevelincomeperpayperiod". Should be set to Yes if the patient declines.
    povertylevelincomepayperiod string Patient's pay period (used for determining poverty level). Only settable if client has Federal Poverty Level fields turned on.
    driverslicenseyn boolean True if the patient has a driver's license uploaded
    agriculturalworker string Used to identify this patient as an agricultural worker. Only settable if client has Social Determinant fields turned on.
    agriculturalworkertype string For patients that are agricultural workers, identifies the type of worker. Only settable if client has Social Determinant fields turned on.
    homeless string Used to identify this patient as homeless. Only settable if client has Social Determinant fields turned on.
    homelesstype string For patients that are homeless, provides more detail regarding the patient's homeless situation. Only settable if client has Social Determinant fields turned on.
    veteran string Used to identify this patient as a veteran. Only settable if client has Social Determinant fields turned on.
    schoolbasedhealthcenter string Used to identify this patient as school-based health center patient. Only settable if client has Social Determinant fields turned on.
    publichousing string Used to identify this patient as living in public housing. Only settable if client has Social Determinant fields turned on.
    driverslicenseurl string The URL to the patient's driver's license
    customfields array Same as /patients/{patientid}/customfields call, but without the department ID. Depending on setup, and only in large practices, the custom field values may or may not be the same between departments. If this is a concern, using the /patients/{patientid}/customfields call is preferred. Only for a single patient when showcustomfields is set to true.
     
    customfieldid integer Corresponds to the /customfields customfieldid.
    customfieldvalue string For a non-select custom field, the value.
    optionid integer For a select custom field, the selectid value (from /customfield's selectlist).
    claimbalancedetails string Claim level details on patient balances. (This is only included when SHOWBALANCEDETAILS is set.)
     
    claimdetails string Information related to claims for the patient.
     
    chargeleveldetail array Detailed information on charges associated with the claim.
     
    servicedate date Date of service for the charge.
    transactions array Detailed information on transactions associated with the charge.
     
    date date The date of the transaction.
    id number The athenaNet ID of the transaction.
    amount number The amount associated with the transaction.
    type string The type of the transaction. For charge, payment, adjustment, etc.
    epaymentid number The epayment ID of the payment receipt associated with this payment transaction. Applicable only for e-payments.
    description number Information related to the type of transaction. (For example, a co-pay.).
    transfertype string The party responsible for the parent charge of this transaction. For example, '1' (primary), '2' (secondary), or 'p' (patient).
    id number The athenaNet ID of the charge.
    amount number The billed amount for the charge.
    description string Description of the service.
    cleanbalance string Indicates whether the balance is associated with a contract or payment plan.
    amount number The amount billed for the claim.
    servicedate date The date the service was rendered.
    supervisingproviderid number The ID of the supervising provider who rendered the service.
    departmentid number The ID of the department where the service was rendered.
    claimid number The ID of the claim.
    patientbalance number The outstanding amount owed by the patient.
    providergroupid number The ID of the provider group for the claim.
    departmentids string Comma separated list of department IDs that belong to this provider group
    contactpreference_announcement_email boolean If set, the patient has indicated a preference to get or not get "announcement" communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal.
    contactpreference_announcement_sms boolean If set, the patient has indicated a preference to get or not get "announcement" communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user.
    contactpreference_announcement_phone boolean If set, the patient has indicated a preference to get or not get "announcement" communications delivered via phone. Note that this will not be present if the practice or patient has not set it.
    contactpreference_appointment_email boolean If set, the patient has indicated a preference to get or not get "appointment" communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal.
    contactpreference_appointment_sms boolean If set, the patient has indicated a preference to get or not get "appointment" communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user.
    contactpreference_appointment_phone boolean If set, the patient has indicated a preference to get or not get "appointment" communications delivered via phone. Note that this will not be present if the practice or patient has not set it.
    contactpreference_billing_email boolean If set, the patient has indicated a preference to get or not get "billing" communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal.
    contactpreference_billing_sms boolean If set, the patient has indicated a preference to get or not get "billing" communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user.
    contactpreference_billing_phone boolean If set, the patient has indicated a preference to get or not get "billing" communications delivered via phone. Note that this will not be present if the practice or patient has not set it.
    contactpreference_lab_email boolean If set, the patient has indicated a preference to get or not get "lab" communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal.
    contactpreference_lab_sms boolean If set, the patient has indicated a preference to get or not get "lab" communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user.
    contactpreference_lab_phone boolean If set, the patient has indicated a preference to get or not get "lab" communications delivered via phone. Note that this will not be present if the practice or patient has not set it.

     

    Full view/update of patient demographics. - PUT /v1/{practiceid}/patients/{patientid}

    Update a patient

     

    Output Parameters

    Name Type Description
    patientid integer Please remember to never disclose this ID to patients since it may result in inadvertant disclosure that a patient exists in a practice already.

     

    Full view/update of patient demographics. - GET /v1/{practiceid}/patients/{patientid}

    Get the info for a single patient. Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments.

     

    Output Parameters

    Name Type Description
    altfirstname string Alternate first name that differs from legal name.
    ethnicitycode integer Ethnicity of the patient, using the 2.16.840.1.113883.5.50 codeset. See http://www.hl7.org/implement/standards/fhir/terminologies-v3.html Special case: use "declined" to indicate that the patient declined to answer.
    industrycode integer Industry of the patient, using the US Census industry code (code system 2.16.840.1.113883.6.310). "other" can be used as well.
    homeboundyn boolean If the patient is homebound, this is true.
    language6392code integer Language of the patient, using the ISO 639.2 code. (http://www.loc.gov/standards/iso639-2/php/code_list.php; "T" or terminology code) Special case: use "declined" to indicate that the patient declined to answer.
    race string The patient race, using the 2.16.840.1.113883.5.104 codeset. See http://www.hl7.org/implement/standards/fhir/terminologies-v3.html Special case: use "declined" to indicate that the patient declined to answer. Multiple values or a tab-seperated list of codes is acceptable for multiple races for input. The first race will be considered "primary". Note: you must update all values at once if you update any.
    localpatientid string 'Given showlocalpatientid is true, comma separated local patient id will be returned, if patient id is enterprise id else given patient id will be displayed.'
    deceaseddate string If present, the date on which a patient died.
    firstappointment string The first appointment for this patient, excluding cancelled or no-show appointments. (mm/dd/yyyy h24:mi)
    previouspatientids string The IDs of the patient this one was merged from.
     
    primaryproviderid integer The "primary" provider for this patient, if set.
    genderidentityother string If a patient does not identify with any prescribed gender identity choice, this field stores the patient-provided description of gender identity.
    assignedsexatbirth string Sex that this patient was assigned at birth.
    confidentialitycode string Gives the confidentiality code for the patient. Only returned when IGNORERESTRICTIONS is set to true and COLCR_RETURN_CONFIDENTIALITY_CODE is ON
    portalstatus string Portal status details. See /patients/{patientid}/portalstatus for details.
     
    familyregisteredyn boolean Is there a family member registered with access to this patient.
    lastloginentity string Either "PATIENT" or "FAMILY", the last entity who accessed this patient.
    noportalyn boolean The privacy setting for blocking the patient from the portal is set.
    portalregistrationdate string The date the patient registered for the portal.
    entitytodisplay string Either "FAMILY" or "PATIENT".
    status string The status of the patient. Possible statuses:
  • REGISTERED: The patient is registered for the portal.
  • NOTREGISTERED: The patient is not registered for the portal.
  • FAMILYLOGIN: This patient is set up for a family member to login.
  • NOPORTAL: The privacy setting for blocking the patient from the portal is set.
  • BLOCKEDFAILEDLOGINS: The patient is blocked because of failed login attempts.
  • FAMILYBLOCKEDFAILEDLOGINS: The family member is blocked because of failed login attempts.
  • termsaccepted boolean Has this patient accepted the portal's Terms and Conditions. This is a good indicator if the patient has actually logged in to the portal or simply is registered without ever having logged in.
    registeredyn boolean If this patient is registered or not for the portal.
    blockedfailedloginsyn boolean Is this patient blocked from the portal due to failed login attempts.
    lastlogindate string The last login date.
    familyblockedfailedloginsyn boolean Is this patient's family blocked from the portal due to failed login attempts.
    preferredpronouns string Pronoun this patient uses.
    lastappointment string The last appointment for this patient (before today), excluding cancelled or no-show appointments. (mm/dd/yyyy h24:mi)
    claimbalancedetails string Claim level details on patient balances. (This is only included when SHOWBALANCEDETAILS is set.)
     
    claimdetails string Information related to claims for the patient.
     
    chargeleveldetail string Detailed information on charges associated with the claim.
     
    id number The athenaNet ID of the charge.
    transactions string Detailed information on transactions associated with the charge.
     
    date date The date of the transaction.
    id number The athenaNet ID of the transaction.
    amount number The amount associated with the transaction.
    type string The type of the transaction. For charge, payment, adjustment, etc.
    epaymentid number The epayment ID of the payment receipt associated with this payment transaction. Applicable only for e-payments.
    description number Information related to the type of transaction. (For example, a co-pay.).
    transfertype string The party responsible for the parent charge of this transaction. For example, '1' (primary), '2' (secondary), or 'p' (patient).
    procedurecodeothermodifier string The modifiers for the procedure code.
    amount number The billed amount for the charge.
    description string Description of the service.
    procedurecode string The CPT code associated with this charge.
    procedurecodesubmitted string The procedure code that would be submitted as part of the claim.
    servicedate date Date of service for the charge.
    cleanbalance boolean Indicates whether the balance is associated with a contract or payment plan.
    amount number The amount billed for the claim.
    servicedate date The date the service was rendered.
    supervisingproviderid number The ID of the supervising provider who rendered the service.
    departmentid number The ID of the department where the service was rendered.
    claimid number The ID of the claim.
    patientbalance number The outstanding amount owed by the patient.
    providergroupid number The ID of the provider group for the claim.
    departmentids string Comma separated list of department IDs that belong to this provider group
    allpatientstatuses string
     
    departmentid integer The ID of a department that this patient is registered in.
    primaryproviderid string The "primary" provider for this patient, if set.
    status string The "status" of the patient, one of active, inactive, prospective, or deleted.
    donotcallyn boolean Warning! This patient will not receive any communication from the practice if this field is set to true.
    primarydepartmentid integer The patient's "current" department. This field is not always set by the practice.
    status string The "status" of the patient, one of active, inactive, prospective, or deleted.
    insurances string List of active patient insurance packages. Only shown for a single patient and if SHOWINSURANCE is set.
     
    insurancepolicyholder string The full name of the insurance policy holder.
    ccmstatusname string The name of current CCM enrollment status.
    insurancepolicyholderaddress2 string The second address line of the insurance policy holder.
    caseinjurydate string CASE POLICY FIELD - Date of the injury. Required for auto insurance, legal, and worker's comp case policies.
    insurancepolicyholderfirstname string The first name of the insurance policy holder. Except for self-pay, required for new policies.
    expirationdate date Date the insurance expires.
    insurancepolicyholderlastname string The last name of the insurance policy holder. Except for self-pay, required for new policies.
    cancelled date The date in which the insurance was marked cancelled.
    insurancepolicyholdersex string The sex of the insurance policy holder. Except for self-pay, required for new policies.
    sequencenumber integer 1 = primary, 2 = secondary, 3 = tertiary, etc. Must have a primary before a secondary and a secondary before a tertiary, etc.
    adjusterfirstname string CASE POLICY FIELD - First name of the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
    anotherpartyresponsibleyn boolean CASE POLICY FIELD - Boolean field indicating if another party was responsible for this accident.
    descriptionofinjury string CASE POLICY FIELD - A description of the injury. Only available for auto insurance and worker's comp case policies.
    eligibilityreason string The source of the current status. Athena is our eligibility engine.
    icd10codes string CASE POLICY FIELD - See documentation for ICD9CODES.
     
    icd9codes string CASE POLICY FIELD - A list of ICD9 accepted diagnosis codes. Only available for worker's comp case policies.
     
    insuranceclaimnumber string CASE POLICY FIELD - The auto insurance claim number or the worker's comp claim number.
    insuranceid integer The athena insurance policy ID.
    insuranceplandisplayname string Superpackagename of the specific insurance package.
    insurancepolicyholdercity string The city of the insurance policy holder.
    insurancepolicyholdercountrycode string The country code (3 letter) of the insurance policy holder.
    insurancepolicyholdercountryiso3166 string The ISO 3166 country code of the insurance policy holder.
    insurancepolicyholdermiddlename string The middle name of the insurance policy holder.
    insurancepolicyholderstate string The state of the insurance policy holder.
    insurancepolicyholderzip string The zip of the insurance policy holder.
    relatedtootheraccidentyn boolean CASE POLICY FIELD - Boolean field indicating whether this case policy is related to another accident. Only available for worker's comp case policies.
    policynumber string The insurance group number. This is sometimes present on an insurance card.
    slidingfeeplanid integer If the patient is on a sliding fee plan, this is the ID of that plan. See /slidingfeeplans.
    adjusterfax string CASE POLICY FIELD - Fax for the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
    relationshiptoinsured string This patient's relationship to the policy holder (text).
    stateofreportedinjury string CASE POLICY FIELD - Two-letter state abbreviation for the state this injury was reported in. Only available for worker's comp case policies.
    relatedtoautoaccidentyn boolean CASE POLICY FIELD - Boolean field indicating whether this case policy is related to an auto accident.
    eligibilitymessage string The message, usually from our engine, of the eligibility check.
    insuranceidnumber string The insurance policy ID number (as presented on the insurance card itself).
    adjusterphone string CASE POLICY FIELD - Phone number/other contact info for the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
    insurancepackageaddress1 string Address 1 for the AthenaNet insurance Package.
    insurancepolicyholderaddress1 string The first address line of the insurance policy holder.
    ccmstatusid integer Status ID of current CCM enrollment.
    coinsurancepercent number The coinsurance percentage for this insurance. If you've just POSTed a new insurance you will have to wait for the auto eligbility check before this field populates.
    insurancepolicyholdersuffix string The suffix of the insurance policy holder.
    insuredpcpnpi integer The national provider id of the primary care physcian assicated with the insurance.
    injuredbodypart string CASE POLICY FIELD - Text field for describing the injured body part. Only available for auto insurance and worker's comp case policies.
    eligibilitylastchecked date Date the eligibility was last checked.
    insuredpcp string
    insurancepackageaddress2 string Address 2 for the AthenaNet insurance Package.
    autoaccidentstate string CASE POLICY FIELD - Two-letter abbreviation for the state in which the auto accident took place. Only meaningful for auto insurance case policies.
    adjusterlastname string CASE POLICY FIELD - Last name of the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
    copays string Details about the copays for this insurance package. If you've just POSTed a new insurance you will have to wait for the auto eligbility check before these populate.
     
    copaytype number What the copay amount applies to.
    copayamount string The amount of the copay.
    insurancepackagezip string Zip code of the AthenaNet insurance package
    insurancepackagecity string City for the AthenaNet insurance Package.
    insurancepolicyholderssn string The SSN of the insurance policy holder.
    insurancetype string Type of insurance. E.g., Medicare Part B, Group Policy, HMO, etc.
    ircname string Insurance category / company. E.g., United Healthcare, BCBS-MA, etc.
    casepolicytypename string CASE POLICY FIELD - The name of this type of case policy.
    repricerphone string CASE POLICY FIELD - Phone number for the repricer. Only available for worker's comp case policies.
    ircid integer Insurance category / company internal ID
    insurancepackagestate string State of the AthenaNet insurance package
    insuranceplanname string Name of the specific insurance package.
    insurancepackageid integer The athenaNet insurance package ID.
    eligibilitystatus string Current eligibility status of this insurance package.
    relatedtoemploymentyn boolean CASE POLICY FIELD - Boolean field indicating whether this case policy is related to the patient's employer.
    insurancephone string The phone number for the insurance company. Note: This defaults to the insurance package phone number. If this is set, it will override it. Likewise if blanked out, it will go back to default.
    relationshiptoinsuredid integer This patient's relationship to the policy holder (as an ID). See the mapping.
    repricername string CASE POLICY FIELD - Name for the repricer. Only available for worker's comp case policies.
    insuredentitytypeid integer The ID of the entity type for this insurance.
    issuedate date Date the insurance was issued.
    employerid string The employer ID associated with the patient's insurance.
    insurancepolicyholderdob string The DOB of the insurance policy holder (mm/dd/yyyy).
    balances string List of balances owed by the patient, broken down by provider (financial) group.
     
    contracts string Information related to existing credit card contracts.
     
    availablebalance string The available balance on this contract.
    contractclass integer The type of contract. For example, "ONEYEAR,"
    maxamount string The maximum allowed amount for this contract.
    providergroupid integer Athena ID for this financial group.
    departmentlist string Comma separated list of department IDs that belong to this group
    balance string Balance for this provider group.
    cleanbalance boolean Indicates whether the balance is associated with a contract, payment plan, or collections agency.
    collectionsbalance string The outstanding amount associated with a collections agency.
    paymentplanbalance string The outstanding amount associated with a payment plan.
    lastemail string The last email for this patient on file.
    customfields string Same as /patients/{patientid}/customfields call, but without the department ID. Depending on setup, and only in large practices, the custom field values may or may not be the same between departments. If this is a concern, using the /patients/{patientid}/customfields call is preferred. Only for a single patient when showcustomfields is set to true.
     
    customfieldid integer Corresponds to the /customfields customfieldid.
    customfieldvalue string For a non-select custom field, the value.
    optionid integer For a select custom field, the selectid value (from /customfield's selectlist).
    racecode string The patient race hierarchical code as specified in Race & Ethnicity - CDC * (2.16.840.1.113883.1.11.14914)
    sexualorientation string Sexual orientation of this patient.
    genderidentity string Gender with which this patient identifies.
    sexualorientationother string If a patient does not identify with any prescribed sexual orientation choice, this field stores the patient-provided description of sexual orientation.
    emailexistsyn boolean True if email exists. False if patient declined. Null if status is unknown.
    occupationcode integer Occupation of the patient, using the US Census occupation code (code system 2.16.840.1.113883.6.240). "other" can be used as well.
    patientid integer Please remember to never disclose this ID to patients since it may result in inadvertant disclosure that a patient exists in a practice already.
    firstname string Patient's first name
    middlename string Patient's middle name
    lastname string Patient's last name
    suffix string Patient's name suffix
    preferredname string The patient's preferred name (i.e. nickname).
    address1 string Patient's address - 1st line
    address2 string Patient's address - 2nd line
    city string Patient's city
    state string Patient's state (2 letter abbreviation)
    zip string Patient's zip. Matching occurs on first 5 characters.
    countrycode string Patient's country code
    countrycode3166 string Patient's country code (ISO 3166-1)
    homephone string The patient's home phone number. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    mobilephone string The patient's mobile phone number. On input, 'declined' can be used to indicate no number. (Alternatively, hasmobile can also be set to false. "declined" simply does this for you.) Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    hasmobileyn boolean Set to false if a client has declined a phone number.
    workphone string The patient's work phone number. Generally not used to contact a patient. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    email string Patient's email address. 'declined' can be used to indicate just that.
    ssn string The patient's SSN
    racename string The patient's primary race name. See race for more complete details.
    sex string Patient's sex (M/F)
    dob string Patient's DOB (mm/dd/yyyy)
    maritalstatus integer Marital Status (D=Divorced, M=Married, S=Single, U=Unknown, W=Widowed, X=Separated, P=Partner)
    contactpreference string The MU-required field for "preferred contact method". This is not used by any automated systems.
    contactname string The name of the (emergency) person to contact about the patient. The contactname, contactrelationship, contacthomephone, and contactmobilephone fields are all related to the emergency contact for the patient. They are NOT related to the contractpreference_* fields.
    contactrelationship string Emergency contact relationship (one of SPOUSE, PARENT, CHILD, SIBLING, FRIEND, COUSIN, GUARDIAN, OTHER)
    contacthomephone string Emergency contact home phone. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    contactmobilephone string Emergency contact mobile phone. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    nextkinname string The full name of the next of kin.
    nextkinrelationship string The next of kin relationship (one of SPOUSE, PARENT, CHILD, SIBLING, FRIEND, COUSIN, GUARDIAN, OTHER)
    nextkinphone string The next of kin phone number. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    guardianfirstname string The first name of the patient's guardian.
    guardianmiddlename string The middle name of the patient's guardian.
    guardianlastname string The last name of the patient's guardian.
    guardiansuffix string The suffix of the patient's guardian.
    guarantorfirstname string Guarantor's first name
    guarantormiddlename string Guarantor's middle name
    guarantorlastname string Guarantor's last name
    guarantorsuffix string Guarantor's name suffix
    guarantoraddress1 string Guarantor's address
    guarantoraddress2 string Guarantor's address - line 2
    guarantorcity string Guarantor's city
    guarantorstate string Guarantor's state (2 letter abbreviation)
    guarantorzip string Guarantor's zip
    guarantorcountrycode string Guarantor's country code
    guarantorcountrycode3166 string Guarantor's country code (ISO 3166-1)
    guarantordob string Guarantor's DOB (mm/dd/yyyy)
    guarantorssn string Guarantor's SSN
    guarantoremail string Guarantor's email address
    guarantorphone string Guarantor's phone number. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    guarantorrelationshiptopatient integer The guarantor's relationship to the patient
    guarantoraddresssameaspatient boolean The address of the guarantor is the same as the patient.
    registrationdate date Date the patient was registered.
    departmentid integer Primary (registration) department ID.
    portaltermsonfile boolean Flag determining whether or not the patient has accepted the Terms and Conditions for the patient portal.
    portalsignatureonfile boolean This flag is set if the patient's signature is on file
    privacyinformationverified boolean This flag is set if the patient's privacy information has been verified. Privacy information returns True if all of the items referenced in GET /patients/{patientid}/privacyinformationverified are true. Privacy information returns false if any of the items referenced in the GET /patients/{patientid}/privacyinformationverified API are false or expired.
    medicationhistoryconsentverified boolean Medication history consent status. If a practice doesn't have RXHub or Surescripts enabled, this will be null
    maritalstatusname string The long version of the marital status.
    employerid integer The patient's employer's ID (from /employers call)
    employerphone string The patient's employer's phone number. Normally, this is set by setting employerid. However, setting this value can be used to override this on an individual patient. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error.
    guarantoremployerid integer The guaranror's employer's ID (from /employers call)
    employername string The patient's employer's name.
    employeraddress string The patient's employer's address.
    employercity string The patient's employer's city.
    portalaccessgiven boolean This flag is set if the patient has been given access to the portal. This may be set by the API user if a patient has been given access to the portal "by providing a preprinted brochure or flyer showing the URL where patients can access their Patient Care Summaries." The practiceinfo endpoint can provide the portal URL. While technically allowed, it would be very unusual to set this to false via the API.
    employerstate string The patient's employer's state.
    onlinestatementonlyyn boolean Set to true if a patient wishes to get e-statements instead of paper statements. Should only be set for patients with an email address and clients with athenaCommunicator. The language we use in the portal is, "Future billing statements will be sent to you securely via your Patient Portal account. You will receive an email notice when new statements are available." This language is not required, but it is given as a suggestion.
    employerzip string The patient's employer's zip.
    consenttocall boolean The flag is used to record the consent of a patient to receive automated calls per FCC requirements. The requested legal language is 'Entry of any telephone contact number constitutes written consent to receive any automated, prerecorded, and artificial voice telephone calls initiated by the Practice. To alter or revoke this consent, visit the Patient Portal "Contact Preferences" page.'
    consenttotext boolean The flag is used to record the consent of a patient to receive text messages per FCC requirements. In order for this to be true, a valid mobile phone number must be set and the practice setting "Hide SMS Opt-in option" must be set to Off.
    smsoptindate date The date on which the patient's consent to receive text messages as per FCC requirements was recorded. In order for this to be valid, a valid mobile phone number must be set and the practice setting 'Hide SMS Opt-in option' must be set to Off.
    referralsourceid integer The referral / "how did you hear about us" ID.
    referralsourceother string If choosing "other" for referral source, this is the text field that can be filled out.
    caresummarydeliverypreference string The patient's preference for care summary delivery.
    employerfax string The patient's employer's fax.
    defaultpharmacyncpdpid integer The NCPDP ID of the patient's preferred pharmacy. See http://www.ncpdp.org/ for details. Note: if updating this field, please make sure to have a CLINICALORDERTYPEGROUPID field as well.
    mobilecarrierid integer The ID of the mobile carrier, from /mobilecarriers or the list below.
    notes string Notes associated with this patient.
    patientphotoyn boolean True if the patient has a photo uploaded
    driverslicensenumber string The number of the patient's driver's license
    driverslicensestateid string The state of the patient's driver's license. This is in the form of a 2 letter state code.
    patientphotourl string The URL to the patient photo
    driverslicenseexpirationdate date The expiration date of the patient's driver's license.
    povertylevelfamilysize string Patient's family size (used for determining poverty level). Only settable if client has Federal Poverty Level fields turned on.
    povertylevelcalculated integer Patient's poverty level (% of the Federal Poverty Level), as calculated from family size, income per pay period, pay period, and state. Typically only valued if client has Federal Poverty Level fields turned on.
    povertylevelfamilysizedeclined boolean Indicates if the patient delcines to provide "povertylevelfamilysize". Should be set to Yes if the patient declines.
    povertylevelincomeperpayperiod string Patient's income per specified pay period (used for determining poverty level). Only settable if client has Federal Poverty Level fields turned on.
    povertylevelincomedeclined boolean Indicates if the patient delcines to provide "povertylevelincomeperpayperiod". Should be set to Yes if the patient declines.
    povertylevelincomepayperiod string Patient's pay period (used for determining poverty level). Only settable if client has Federal Poverty Level fields turned on.
    povertylevelincomerangedeclined boolean Indicates if the patient declines to provide an income range level. True if the patient declines.
    driverslicenseyn boolean True if the patient has a driver's license uploaded
    agriculturalworker string Used to identify this patient as an agricultural worker. Only settable if client has Social Determinant fields turned on.
    agriculturalworkertype string For patients that are agricultural workers, identifies the type of worker. Only settable if client has Social Determinant fields turned on.
    homeless string Used to identify this patient as homeless. Only settable if client has Social Determinant fields turned on.
    homelesstype string For patients that are homeless, provides more detail regarding the patient's homeless situation. Only settable if client has Social Determinant fields turned on.
    veteran string Used to identify this patient as a veteran. Only settable if client has Social Determinant fields turned on.
    schoolbasedhealthcenter string Used to identify this patient as school-based health center patient. Only settable if client has Social Determinant fields turned on.
    publichousing string Used to identify this patient as living in public housing. Only settable if client has Social Determinant fields turned on.
    driverslicenseurl string The URL to the patient's driver's license
    contactpreference_announcement_email boolean If set, the patient has indicated a preference to get or not get "announcement" communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal.
    contactpreference_announcement_sms boolean If set, the patient has indicated a preference to get or not get "announcement" communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user.
    contactpreference_announcement_phone boolean If set, the patient has indicated a preference to get or not get "announcement" communications delivered via phone. Note that this will not be present if the practice or patient has not set it.
    contactpreference_appointment_email boolean If set, the patient has indicated a preference to get or not get "appointment" communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal.
    contactpreference_appointment_sms boolean If set, the patient has indicated a preference to get or not get "appointment" communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user.
    contactpreference_appointment_phone boolean If set, the patient has indicated a preference to get or not get "appointment" communications delivered via phone. Note that this will not be present if the practice or patient has not set it.
    contactpreference_billing_email boolean If set, the patient has indicated a preference to get or not get "billing" communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal.
    contactpreference_billing_sms boolean If set, the patient has indicated a preference to get or not get "billing" communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user.
    contactpreference_billing_phone boolean If set, the patient has indicated a preference to get or not get "billing" communications delivered via phone. Note that this will not be present if the practice or patient has not set it.
    contactpreference_lab_email boolean If set, the patient has indicated a preference to get or not get "lab" communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal.
    contactpreference_lab_sms boolean If set, the patient has indicated a preference to get or not get "lab" communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user.
    contactpreference_lab_phone boolean If set, the patient has indicated a preference to get or not get "lab" communications delivered via phone. Note that this will not be present if the practice or patient has not set it.

     

    Search for patients in a context, optionally with user permissions. - GET /v1/{practiceid}/patients/search

     

    Output Parameters

    Name Type Description
    patients array List of patients matching the search criteria
     
    city string
    contextid number
    previouslastname string
    currentdepartmentid number
    patientid number
    middleinitial string
    outstandingp number
    currentdepartment string
    localpatientid number
    ssn string The masked SSN
    providergroupid number
    blockpatientyn string
    preferredname string
    unappliedamount number
    lastname string
    zip number
    dob string
    firstname string
    state string
    address1 string
    namesuffix string

     

    BETA: Returns the list of possible search types to utilize with the /patients/search endpoint. - GET /v1/{practiceid}/configuration/patients/searchtypes

    Returns the list of possible search types to utilize with the /patients/search endpoint.

     

    Output Parameters

    Name Type Description
    displayname string Display name of the type
    name string The name of the type of search. This will also be the value of the searchtype parameter in the /patients/search endpoint',