Appointment Report of Booked Appointments
The Appointment Report of Booked Appointments feature allows users to view a detailed report of all the booked, rescheduled or cancelled appointments they have made within a certain date.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Endpoints
- Primary
Get report of booked
appointments
GET
/v1/{practiceid}/appointments/report
Retrieves calling users appointment details of all booked, rescheduled and cancelled appointments
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
enddate
string
The ending date range of when an appointment was scheduled (inclusive).
startdate
string
The starting date range of when an appointment was scheduled (inclusive).
showexpectedprocedurecodes
boolean
Set this field to true to retrieve expected procedure codes.
Output Parameters
Expand all
cancelled
array
appointmentconfirmationid
string
If there is an appointment confirmation result for this appointment, the numeric ID (global to athenaNet).
appointmentconfirmationname
string
If there is an appointment confirmation result for this appointment, the name (global to athenaNet).
appointmentcopay
string
Detailed information about the copay for this appointment. Gives more detail than the COPAY field. Note: this information is not yet available in all practices, we are rolling this out slowly.
appointmentid
string
Appointment ID of the booked appointment
appointmentnotes
array
An array of appointment notes for this appointment.
displayonschedule
string
Whether the note should be displayed on the schedule.
id
integer
The id of the appointment note.
text
string
The note associated with the appointment.
appointmentstatus
string
The athenaNet appointment status. There are several possible statuses. x=cancelled. f=future. (It can include appointments where were never checked in, even if the appointment date is in the past. It is up to a practice to cancel appointments as a no show when appropriate to do so.) o=open. 2=checked in. 3=checked out. 4=charge entered (i.e. a past appointment).
appointmenttype
string
The practice-friendly (not patient friendly) name for this appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
appointmenttypeid
string
This is the ID for the appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
cancelledby
string
If the appointment has been cancelled, the username who cancelled the appointment.
cancelleddatetime
string
The time (mm/dd/yyyy hh24:mi:ss; Eastern time) that this appointment was cancelled (if cancelled)
cancelreasonid
string
If the appointment was cancelled, the numeric ID (local to the practice) for the cancel reason.
cancelreasonname
string
If the appointment was cancelled, the name (local to the practice) for the cancel reason.
cancelreasonnoshow
string
If the appointment was cancelled, if the cancel reason is marked as a no show reason.
cancelreasonslotavailable
string
If the appointment was cancelled, if the cancel reason is marked as a slot available reason.
chargeentrynotrequired
string
This field will tell if an appointment has been marked as not requiring change entry.
chargeentrynotrequiredreason
string
This field will give the reason that an appointment has been marked as not requiring charge entry.
checkindatetime
string
The time (mm/dd/yyyy hh24:mi:ss) that the appointment was checked in.
checkoutdatetime
string
The time (mm/dd/yyyy hh24:mi:ss) that the appointment was checked out.
claims
array
As detailed in /claims, if requested.
appointmentid
string
The appointment ID associated with this claim.
billedproviderid
string
The provider ID of the billing provider for this claim.
billedservicedate
string
The billed date of service.
chargeamount
string
The total amount billed for all services from this claim.
claimcreateddate
string
The date the claim was created.
claimid
string
athenaNet's internal ID for this claim, specific to the practice.
diagnoses
array
Diagnoses is an array of all diagnoses. Each entry in the array is a hash with several fields. /ccda is a better clinical representation. These fields are:
deleteddiagnosis
string
In certain cases, diagnoses may be added and then removed from a particular claim. In normal circumstances, this will be false. However, if a diagnosis was removed, this will be true.
diagnosiscategory
string
The category for this diagnosis.
diagnosiscodeset
string
Either ICD9 or ICD10.
diagnosisdescription
string
A description of this diagnosis.
diagnosisid
string
A unique ID related to this diagnosis.
diagnosisrawcode
string
The raw ICD-9 code. This will migrate to ICD-10 in the future.
patientpayer
string
The status and notes of a responsible payer. This payer is the patient.
primaryinsurancepayer
string
The status and notes of a responsible payer. This payer is the primary insurace.
procedures
array
Procedures is an array of all procedures. /ccda is a better clinical representation. These fields are:
allowableamount
string
The total amount expected from payer for all services from this procedure.
allowablemax
string
The maximum amount expected from payer for all services from this procedure.
allowablemin
string
The minimum amount expected from payer for all services from this procedure.
chargeamount
string
The amount charged for this procedure.
procedurecategory
string
The category name associated with this procedure.
procedurecode
string
The CPT code associated with this procedure.
proceduredescription
string
A description of this procedure.
transactionid
string
The ID of the last transaction associated with the claim.
referringproviderid
integer
The referring provider ID for this claim. See /referringproviders. This is not the same as the ID from the /providers call.
secondaryinsurancepayer
string
The status and notes of a responsible payer. This payer is the secondary insurace.
transactiondetails
string
A hash of ids ("transactionid") to amounts; these should sum to the chargeamount. Please note that this has been deprecated in lieu of the data being available in the procedures section.
transactionid
string
A unique ID for the primary transaction this claim represents. May be useful for debugging.
coordinatorenterpriseyn
string
If true, the appointment was booked through athenaCoordinator Enterprise.
copay
string
Expected copay for this appointment. Based on the appointment type, the patient's primary insurance, and any copays collected. To see the amounts used in this calculated value, see the APPOINTMENTCOPAY fields.
date
string
The appointment date.
departmentid
string
duration
integer
In minutes
encounterid
string
The encounter id associated with this appointment, useful for certain other calls. Only present for appointments with Clinicals that have been checked in.
encounterstate
string
The status of the clinical encounter associated with this appointment (OPEN, CLOSED, DELETED, PEND, etc.). This differs from encounterstatus, which refers to the status of the patient in the encounter.
encounterstatus
string
The status of this patient in the encounter (READYFORSTAFF, WITHSTAFF, READFORPROVIDER, CHECKEDOUT). Only present for appointments with Clinicals that have been checked in.
finalappointment
string
The current appointment after rescheduling. The encapsulating original appointment may have been rescheduled multiple times.
frozenyn
string
If true, this appointment slot is frozen
hl7providerid
integer
This is the raw provider ID that should be used ONLY if using this appointment in conjunction with an HL7 message and with athenahealth's prior guidance. It is only available in some situations.
insurances
array
List of active patient insurance packages. Only shown for single or multiple booked appointments if SHOWINSURANCE is set.
adjusterfax
string
CASE POLICY FIELD - Fax for the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
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.
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.
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.
anotherpartyresponsibleyn
string
CASE POLICY FIELD - Boolean field indicating if another party was responsible for this accident.
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.
cancelled
string
The date in which the insurance was marked cancelled.
caseinjurydate
string
CASE POLICY FIELD - Date of the injury. Required for auto insurance, legal, and worker's comp case policies.
casepolicytypename
string
CASE POLICY FIELD - The name of this type of case policy.
ccmstatusid
integer
Status ID of current CCM enrollment.
ccmstatusname
string
The name of current CCM enrollment status.
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.
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.
descriptionofinjury
string
CASE POLICY FIELD - A description of the injury. Only available for auto insurance and worker's comp case policies.
eligibilitylastchecked
string
Date the eligibility was last checked.
eligibilitymessage
string
The message, usually from our engine, of the eligibility check.
eligibilityreason
string
The source of the current status. Athena is our eligibility engine.
eligibilitystatus
string
Current eligibility status of this insurance package.
employerid
string
The employer ID associated with the patient's insurance.
expirationdate
string
Date the insurance expires.
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.
injuredbodypart
string
CASE POLICY FIELD - Text field for describing the injured body part. Only available for auto insurance and worker's comp case policies.
insuranceclaimnumber
string
CASE POLICY FIELD - The auto insurance claim number or the worker's comp claim number.
insuranceid
string
The athena insurance policy ID.
insuranceidnumber
string
The insurance policy ID number (as presented on the insurance card itself).
insurancepackageaddress1
string
Address 1 for the AthenaNet insurance Package.
insurancepackageaddress2
string
Address 2 for the AthenaNet insurance Package.
insurancepackagecity
string
City for the AthenaNet insurance Package.
insurancepackageid
integer
The athenaNet insurance package ID.
insurancepackagestate
string
State of the AthenaNet insurance package
insurancepackagezip
string
Zip code of the AthenaNet insurance package
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.
insuranceplandisplayname
string
Superpackagename of the specific insurance package.
insuranceplanname
string
Name of the specific insurance package.
insurancepolicyholder
string
The full name of the insurance policy holder.
insurancepolicyholderaddress1
string
The first address line of the insurance policy holder.
insurancepolicyholderaddress2
string
The second address line of the insurance policy holder.
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.
insurancepolicyholderdob
string
The DOB of the insurance policy holder (mm/dd/yyyy).
insurancepolicyholderfirstname
string
The first name of the insurance policy holder. Except for self-pay, required for new policies.
insurancepolicyholderlastname
string
The last name of the insurance policy holder. Except for self-pay, required for new policies.
insurancepolicyholdermiddlename
string
The middle name of the insurance policy holder.
insurancepolicyholdersex
string
The sex of the insurance policy holder. Except for self-pay, required for new policies.
insurancepolicyholderssn
string
The SSN of the insurance policy holder.
insurancepolicyholderstate
string
The state of the insurance policy holder.
insurancepolicyholdersuffix
string
The suffix of the insurance policy holder.
insurancepolicyholderzip
string
The zip of the insurance policy holder.
insurancetype
string
Type of insurance. E.g., Medicare Part B, Group Policy, HMO, etc.
insuredentitytypeid
integer
The ID of the entity type for this insurance.
insuredpcp
string
insuredpcpnpi
integer
The national provider id of the primary care physcian assicated with the insurance.
ircid
integer
Insurance category / company internal ID
ircname
string
Insurance category / company. E.g., United Healthcare, BCBS-MA, etc.
issuedate
string
Date the insurance was issued.
policynumber
string
The insurance group number. This is sometimes present on an insurance card.
relatedtoautoaccidentyn
string
CASE POLICY FIELD - Boolean field indicating whether this case policy is related to an auto accident.
relatedtoemploymentyn
string
CASE POLICY FIELD - Boolean field indicating whether this case policy is related to the patient's employer.
relatedtootheraccidentyn
string
CASE POLICY FIELD - Boolean field indicating whether this case policy is related to another accident. Only available for worker's comp case policies.
relationshiptoinsured
string
This patient's relationship to the policy holder (text).
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.
repricerphone
string
CASE POLICY FIELD - Phone number for the repricer. Only available for worker's comp case policies.
sequencenumber
integer
1 = primary, 2 = secondary, 3 = tertiary, etc. Must have a primary before a secondary and a secondary before a tertiary, etc.
slidingfeeplanid
integer
If the patient is on a sliding fee plan, this is the ID of that plan. See /slidingfeeplans.
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.
lastmodified
string
The date/time when the appointment was last modified. Note: It may be possible for the lastmodified field to be updated without any other field in the API call being changed. This occurs when appointment fields not included in the API output are updated.
lastmodifiedby
string
The user who last modified the appointment.
patient
string
See /patients for details
patientappointmenttypename
string
The patient-friendly name for this appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
patientid
string
The athenaNet patient ID for this appointment
patientlocationid
string
The location of the patient. See /patientlocation for practice list. Only present for appointments with Clinicals that have been checked in.
providerid
string
reasonid
string
A list of reason IDs that could be used for this slot. Only present if multiple reason IDs are requested.
referringproviderid
integer
The referring provider ID.
reminderdetails
array
Detailed ReminderCall information made for this appointment.
calltime
string
Date and time of the call attempt.
messageresultid
string
Id of the message attempt.
messagetype
string
The type of message that was attempted.
result
string
A description of what happened during the call attempt.
renderingproviderid
integer
The rendering provider ID.
rescheduledappointmentid
string
When an appointment is rescheduled, this is the ID of the replacement appointment.
scheduledby
string
The username who scheduled the appointment.
scheduleddatetime
string
The time (mm/dd/yyyy hh24:mi:ss; Eastern time) that this appointment was scheduled.
startcheckin
string
The timestamp when the appointment started the check in process. If this is set while an appointment is still in status 'f', it means that the check-in process has begun but is not yet completed.
startcheckoutdatetime
string
The time (mm/dd/yyyy hh24:mi:ss) that the appointment check-out was started.
starttime
string
As HH:MM (where HH is the 0-23 hour and MM is the minute). This time is local to the department.
stopcheckin
string
The timestamp when the check-in process was finished for this appointment.
stopexamdatetime
string
The time (mm/dd/yyyy hh24:mi:ss) that the exam was completed.
stopintakedatetime
string
The time (mm/dd/yyyy hh24:mi:ss) that the intake process was completed.
suggestedoverbooking
string
High risk score for Smart Scheduling
supervisingproviderid
integer
The supervising provider ID.
templateappointmentid
string
The original appointment ID. This is useful if an appointment has been cancelled and you want to find the original ID.
templateappointmenttypeid
string
The original appointment type for this slot. This can change for generic appointments.
urgentyn
string
Urgent flag for the appointment.
useexpectedprocedurecodes
array
An array of expected procedure codes attached to this appointment.
procedurecode
string
The ID of the code.
procedurecodedescription
string
The description of the code.
rescheduled
array
appointmentconfirmationid
string
If there is an appointment confirmation result for this appointment, the numeric ID (global to athenaNet).
appointmentconfirmationname
string
If there is an appointment confirmation result for this appointment, the name (global to athenaNet).
appointmentcopay
string
Detailed information about the copay for this appointment. Gives more detail than the COPAY field. Note: this information is not yet available in all practices, we are rolling this out slowly.
appointmentid
string
Appointment ID of the booked appointment
appointmentnotes
array
An array of appointment notes for this appointment.
displayonschedule
string
Whether the note should be displayed on the schedule.
id
integer
The id of the appointment note.
text
string
The note associated with the appointment.
appointmentstatus
string
The athenaNet appointment status. There are several possible statuses. x=cancelled. f=future. (It can include appointments where were never checked in, even if the appointment date is in the past. It is up to a practice to cancel appointments as a no show when appropriate to do so.) o=open. 2=checked in. 3=checked out. 4=charge entered (i.e. a past appointment).
appointmenttype
string
The practice-friendly (not patient friendly) name for this appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
appointmenttypeid
string
This is the ID for the appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
cancelledby
string
If the appointment has been cancelled, the username who cancelled the appointment.
cancelleddatetime
string
The time (mm/dd/yyyy hh24:mi:ss; Eastern time) that this appointment was cancelled (if cancelled)
cancelreasonid
string
If the appointment was cancelled, the numeric ID (local to the practice) for the cancel reason.
cancelreasonname
string
If the appointment was cancelled, the name (local to the practice) for the cancel reason.
cancelreasonnoshow
string
If the appointment was cancelled, if the cancel reason is marked as a no show reason.
cancelreasonslotavailable
string
If the appointment was cancelled, if the cancel reason is marked as a slot available reason.
chargeentrynotrequired
string
This field will tell if an appointment has been marked as not requiring change entry.
chargeentrynotrequiredreason
string
This field will give the reason that an appointment has been marked as not requiring charge entry.
checkindatetime
string
The time (mm/dd/yyyy hh24:mi:ss) that the appointment was checked in.
checkoutdatetime
string
The time (mm/dd/yyyy hh24:mi:ss) that the appointment was checked out.
claims
array
As detailed in /claims, if requested.
appointmentid
string
The appointment ID associated with this claim.
billedproviderid
string
The provider ID of the billing provider for this claim.
billedservicedate
string
The billed date of service.
chargeamount
string
The total amount billed for all services from this claim.
claimcreateddate
string
The date the claim was created.
claimid
string
athenaNet's internal ID for this claim, specific to the practice.
diagnoses
array
Diagnoses is an array of all diagnoses. Each entry in the array is a hash with several fields. /ccda is a better clinical representation. These fields are:
deleteddiagnosis
string
In certain cases, diagnoses may be added and then removed from a particular claim. In normal circumstances, this will be false. However, if a diagnosis was removed, this will be true.
diagnosiscategory
string
The category for this diagnosis.
diagnosiscodeset
string
Either ICD9 or ICD10.
diagnosisdescription
string
A description of this diagnosis.
diagnosisid
string
A unique ID related to this diagnosis.
diagnosisrawcode
string
The raw ICD-9 code. This will migrate to ICD-10 in the future.
patientpayer
string
The status and notes of a responsible payer. This payer is the patient.
primaryinsurancepayer
string
The status and notes of a responsible payer. This payer is the primary insurace.
procedures
array
Procedures is an array of all procedures. /ccda is a better clinical representation. These fields are:
allowableamount
string
The total amount expected from payer for all services from this procedure.
allowablemax
string
The maximum amount expected from payer for all services from this procedure.
allowablemin
string
The minimum amount expected from payer for all services from this procedure.
chargeamount
string
The amount charged for this procedure.
procedurecategory
string
The category name associated with this procedure.
procedurecode
string
The CPT code associated with this procedure.
proceduredescription
string
A description of this procedure.
transactionid
string
The ID of the last transaction associated with the claim.
referringproviderid
integer
The referring provider ID for this claim. See /referringproviders. This is not the same as the ID from the /providers call.
secondaryinsurancepayer
string
The status and notes of a responsible payer. This payer is the secondary insurace.
transactiondetails
string
A hash of ids ("transactionid") to amounts; these should sum to the chargeamount. Please note that this has been deprecated in lieu of the data being available in the procedures section.
transactionid
string
A unique ID for the primary transaction this claim represents. May be useful for debugging.
coordinatorenterpriseyn
string
If true, the appointment was booked through athenaCoordinator Enterprise.
copay
string
Expected copay for this appointment. Based on the appointment type, the patient's primary insurance, and any copays collected. To see the amounts used in this calculated value, see the APPOINTMENTCOPAY fields.
date
string
The appointment date.
departmentid
string
duration
integer
In minutes
encounterid
string
The encounter id associated with this appointment, useful for certain other calls. Only present for appointments with Clinicals that have been checked in.
encounterstate
string
The status of the clinical encounter associated with this appointment (OPEN, CLOSED, DELETED, PEND, etc.). This differs from encounterstatus, which refers to the status of the patient in the encounter.
encounterstatus
string
The status of this patient in the encounter (READYFORSTAFF, WITHSTAFF, READFORPROVIDER, CHECKEDOUT). Only present for appointments with Clinicals that have been checked in.
finalappointment
string
The current appointment after rescheduling. The encapsulating original appointment may have been rescheduled multiple times.
frozenyn
string
If true, this appointment slot is frozen
hl7providerid
integer
This is the raw provider ID that should be used ONLY if using this appointment in conjunction with an HL7 message and with athenahealth's prior guidance. It is only available in some situations.
insurances
array
List of active patient insurance packages. Only shown for single or multiple booked appointments if SHOWINSURANCE is set.
adjusterfax
string
CASE POLICY FIELD - Fax for the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
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.
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.
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.
anotherpartyresponsibleyn
string
CASE POLICY FIELD - Boolean field indicating if another party was responsible for this accident.
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.
cancelled
string
The date in which the insurance was marked cancelled.
caseinjurydate
string
CASE POLICY FIELD - Date of the injury. Required for auto insurance, legal, and worker's comp case policies.
casepolicytypename
string
CASE POLICY FIELD - The name of this type of case policy.
ccmstatusid
integer
Status ID of current CCM enrollment.
ccmstatusname
string
The name of current CCM enrollment status.
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.
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.
descriptionofinjury
string
CASE POLICY FIELD - A description of the injury. Only available for auto insurance and worker's comp case policies.
eligibilitylastchecked
string
Date the eligibility was last checked.
eligibilitymessage
string
The message, usually from our engine, of the eligibility check.
eligibilityreason
string
The source of the current status. Athena is our eligibility engine.
eligibilitystatus
string
Current eligibility status of this insurance package.
employerid
string
The employer ID associated with the patient's insurance.
expirationdate
string
Date the insurance expires.
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.
injuredbodypart
string
CASE POLICY FIELD - Text field for describing the injured body part. Only available for auto insurance and worker's comp case policies.
insuranceclaimnumber
string
CASE POLICY FIELD - The auto insurance claim number or the worker's comp claim number.
insuranceid
string
The athena insurance policy ID.
insuranceidnumber
string
The insurance policy ID number (as presented on the insurance card itself).
insurancepackageaddress1
string
Address 1 for the AthenaNet insurance Package.
insurancepackageaddress2
string
Address 2 for the AthenaNet insurance Package.
insurancepackagecity
string
City for the AthenaNet insurance Package.
insurancepackageid
integer
The athenaNet insurance package ID.
insurancepackagestate
string
State of the AthenaNet insurance package
insurancepackagezip
string
Zip code of the AthenaNet insurance package
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.
insuranceplandisplayname
string
Superpackagename of the specific insurance package.
insuranceplanname
string
Name of the specific insurance package.
insurancepolicyholder
string
The full name of the insurance policy holder.
insurancepolicyholderaddress1
string
The first address line of the insurance policy holder.
insurancepolicyholderaddress2
string
The second address line of the insurance policy holder.
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.
insurancepolicyholderdob
string
The DOB of the insurance policy holder (mm/dd/yyyy).
insurancepolicyholderfirstname
string
The first name of the insurance policy holder. Except for self-pay, required for new policies.
insurancepolicyholderlastname
string
The last name of the insurance policy holder. Except for self-pay, required for new policies.
insurancepolicyholdermiddlename
string
The middle name of the insurance policy holder.
insurancepolicyholdersex
string
The sex of the insurance policy holder. Except for self-pay, required for new policies.
insurancepolicyholderssn
string
The SSN of the insurance policy holder.
insurancepolicyholderstate
string
The state of the insurance policy holder.
insurancepolicyholdersuffix
string
The suffix of the insurance policy holder.
insurancepolicyholderzip
string
The zip of the insurance policy holder.
insurancetype
string
Type of insurance. E.g., Medicare Part B, Group Policy, HMO, etc.
insuredentitytypeid
integer
The ID of the entity type for this insurance.
insuredpcp
string
insuredpcpnpi
integer
The national provider id of the primary care physcian assicated with the insurance.
ircid
integer
Insurance category / company internal ID
ircname
string
Insurance category / company. E.g., United Healthcare, BCBS-MA, etc.
issuedate
string
Date the insurance was issued.
policynumber
string
The insurance group number. This is sometimes present on an insurance card.
relatedtoautoaccidentyn
string
CASE POLICY FIELD - Boolean field indicating whether this case policy is related to an auto accident.
relatedtoemploymentyn
string
CASE POLICY FIELD - Boolean field indicating whether this case policy is related to the patient's employer.
relatedtootheraccidentyn
string
CASE POLICY FIELD - Boolean field indicating whether this case policy is related to another accident. Only available for worker's comp case policies.
relationshiptoinsured
string
This patient's relationship to the policy holder (text).
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.
repricerphone
string
CASE POLICY FIELD - Phone number for the repricer. Only available for worker's comp case policies.
sequencenumber
integer
1 = primary, 2 = secondary, 3 = tertiary, etc. Must have a primary before a secondary and a secondary before a tertiary, etc.
slidingfeeplanid
integer
If the patient is on a sliding fee plan, this is the ID of that plan. See /slidingfeeplans.
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.
lastmodified
string
The date/time when the appointment was last modified. Note: It may be possible for the lastmodified field to be updated without any other field in the API call being changed. This occurs when appointment fields not included in the API output are updated.
lastmodifiedby
string
The user who last modified the appointment.
patient
string
See /patients for details
patientappointmenttypename
string
The patient-friendly name for this appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
patientid
string
The athenaNet patient ID for this appointment
patientlocationid
string
The location of the patient. See /patientlocation for practice list. Only present for appointments with Clinicals that have been checked in.
providerid
string
reasonid
string
A list of reason IDs that could be used for this slot. Only present if multiple reason IDs are requested.
referringproviderid
integer
The referring provider ID.
reminderdetails
array
Detailed ReminderCall information made for this appointment.
calltime
string
Date and time of the call attempt.
messageresultid
string
Id of the message attempt.
messagetype
string
The type of message that was attempted.
result
string
A description of what happened during the call attempt.
renderingproviderid
integer
The rendering provider ID.
rescheduledappointmentid
string
When an appointment is rescheduled, this is the ID of the replacement appointment.
scheduledby
string
The username who scheduled the appointment.
scheduleddatetime
string
The time (mm/dd/yyyy hh24:mi:ss; Eastern time) that this appointment was scheduled.
startcheckin
string
The timestamp when the appointment started the check in process. If this is set while an appointment is still in status 'f', it means that the check-in process has begun but is not yet completed.
startcheckoutdatetime
string
The time (mm/dd/yyyy hh24:mi:ss) that the appointment check-out was started.
starttime
string
As HH:MM (where HH is the 0-23 hour and MM is the minute). This time is local to the department.
stopcheckin
string
The timestamp when the check-in process was finished for this appointment.
stopexamdatetime
string
The time (mm/dd/yyyy hh24:mi:ss) that the exam was completed.
stopintakedatetime
string
The time (mm/dd/yyyy hh24:mi:ss) that the intake process was completed.
suggestedoverbooking
string
High risk score for Smart Scheduling
supervisingproviderid
integer
The supervising provider ID.
templateappointmentid
string
The original appointment ID. This is useful if an appointment has been cancelled and you want to find the original ID.
templateappointmenttypeid
string
The original appointment type for this slot. This can change for generic appointments.
urgentyn
string
Urgent flag for the appointment.
useexpectedprocedurecodes
array
An array of expected procedure codes attached to this appointment.
procedurecode
string
The ID of the code.
procedurecodedescription
string
The description of the code.
scheduled
array
appointmentconfirmationid
string
If there is an appointment confirmation result for this appointment, the numeric ID (global to athenaNet).
appointmentconfirmationname
string
If there is an appointment confirmation result for this appointment, the name (global to athenaNet).
appointmentcopay
string
Detailed information about the copay for this appointment. Gives more detail than the COPAY field. Note: this information is not yet available in all practices, we are rolling this out slowly.
appointmentid
string
Appointment ID of the booked appointment
appointmentnotes
array
An array of appointment notes for this appointment.
displayonschedule
string
Whether the note should be displayed on the schedule.
id
integer
The id of the appointment note.
text
string
The note associated with the appointment.
appointmentstatus
string
The athenaNet appointment status. There are several possible statuses. x=cancelled. f=future. (It can include appointments where were never checked in, even if the appointment date is in the past. It is up to a practice to cancel appointments as a no show when appropriate to do so.) o=open. 2=checked in. 3=checked out. 4=charge entered (i.e. a past appointment).
appointmenttype
string
The practice-friendly (not patient friendly) name for this appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
appointmenttypeid
string
This is the ID for the appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
cancelledby
string
If the appointment has been cancelled, the username who cancelled the appointment.
cancelleddatetime
string
The time (mm/dd/yyyy hh24:mi:ss; Eastern time) that this appointment was cancelled (if cancelled)
cancelreasonid
string
If the appointment was cancelled, the numeric ID (local to the practice) for the cancel reason.
cancelreasonname
string
If the appointment was cancelled, the name (local to the practice) for the cancel reason.
cancelreasonnoshow
string
If the appointment was cancelled, if the cancel reason is marked as a no show reason.
cancelreasonslotavailable
string
If the appointment was cancelled, if the cancel reason is marked as a slot available reason.
chargeentrynotrequired
string
This field will tell if an appointment has been marked as not requiring change entry.
chargeentrynotrequiredreason
string
This field will give the reason that an appointment has been marked as not requiring charge entry.
checkindatetime
string
The time (mm/dd/yyyy hh24:mi:ss) that the appointment was checked in.
checkoutdatetime
string
The time (mm/dd/yyyy hh24:mi:ss) that the appointment was checked out.
claims
array
As detailed in /claims, if requested.
appointmentid
string
The appointment ID associated with this claim.
billedproviderid
string
The provider ID of the billing provider for this claim.
billedservicedate
string
The billed date of service.
chargeamount
string
The total amount billed for all services from this claim.
claimcreateddate
string
The date the claim was created.
claimid
string
athenaNet's internal ID for this claim, specific to the practice.
diagnoses
array
Diagnoses is an array of all diagnoses. Each entry in the array is a hash with several fields. /ccda is a better clinical representation. These fields are:
deleteddiagnosis
string
In certain cases, diagnoses may be added and then removed from a particular claim. In normal circumstances, this will be false. However, if a diagnosis was removed, this will be true.
diagnosiscategory
string
The category for this diagnosis.
diagnosiscodeset
string
Either ICD9 or ICD10.
diagnosisdescription
string
A description of this diagnosis.
diagnosisid
string
A unique ID related to this diagnosis.
diagnosisrawcode
string
The raw ICD-9 code. This will migrate to ICD-10 in the future.
patientpayer
string
The status and notes of a responsible payer. This payer is the patient.
primaryinsurancepayer
string
The status and notes of a responsible payer. This payer is the primary insurace.
procedures
array
Procedures is an array of all procedures. /ccda is a better clinical representation. These fields are:
allowableamount
string
The total amount expected from payer for all services from this procedure.
allowablemax
string
The maximum amount expected from payer for all services from this procedure.
allowablemin
string
The minimum amount expected from payer for all services from this procedure.
chargeamount
string
The amount charged for this procedure.
procedurecategory
string
The category name associated with this procedure.
procedurecode
string
The CPT code associated with this procedure.
proceduredescription
string
A description of this procedure.
transactionid
string
The ID of the last transaction associated with the claim.
referringproviderid
integer
The referring provider ID for this claim. See /referringproviders. This is not the same as the ID from the /providers call.
secondaryinsurancepayer
string
The status and notes of a responsible payer. This payer is the secondary insurace.
transactiondetails
string
A hash of ids ("transactionid") to amounts; these should sum to the chargeamount. Please note that this has been deprecated in lieu of the data being available in the procedures section.
transactionid
string
A unique ID for the primary transaction this claim represents. May be useful for debugging.
coordinatorenterpriseyn
string
If true, the appointment was booked through athenaCoordinator Enterprise.
copay
string
Expected copay for this appointment. Based on the appointment type, the patient's primary insurance, and any copays collected. To see the amounts used in this calculated value, see the APPOINTMENTCOPAY fields.
date
string
The appointment date.
departmentid
string
duration
integer
In minutes
encounterid
string
The encounter id associated with this appointment, useful for certain other calls. Only present for appointments with Clinicals that have been checked in.
encounterstate
string
The status of the clinical encounter associated with this appointment (OPEN, CLOSED, DELETED, PEND, etc.). This differs from encounterstatus, which refers to the status of the patient in the encounter.
encounterstatus
string
The status of this patient in the encounter (READYFORSTAFF, WITHSTAFF, READFORPROVIDER, CHECKEDOUT). Only present for appointments with Clinicals that have been checked in.
finalappointment
string
The current appointment after rescheduling. The encapsulating original appointment may have been rescheduled multiple times.
frozenyn
string
If true, this appointment slot is frozen
hl7providerid
integer
This is the raw provider ID that should be used ONLY if using this appointment in conjunction with an HL7 message and with athenahealth's prior guidance. It is only available in some situations.
insurances
array
List of active patient insurance packages. Only shown for single or multiple booked appointments if SHOWINSURANCE is set.
adjusterfax
string
CASE POLICY FIELD - Fax for the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.
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.
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.
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.
anotherpartyresponsibleyn
string
CASE POLICY FIELD - Boolean field indicating if another party was responsible for this accident.
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.
cancelled
string
The date in which the insurance was marked cancelled.
caseinjurydate
string
CASE POLICY FIELD - Date of the injury. Required for auto insurance, legal, and worker's comp case policies.
casepolicytypename
string
CASE POLICY FIELD - The name of this type of case policy.
ccmstatusid
integer
Status ID of current CCM enrollment.
ccmstatusname
string
The name of current CCM enrollment status.
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.
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.
descriptionofinjury
string
CASE POLICY FIELD - A description of the injury. Only available for auto insurance and worker's comp case policies.
eligibilitylastchecked
string
Date the eligibility was last checked.
eligibilitymessage
string
The message, usually from our engine, of the eligibility check.
eligibilityreason
string
The source of the current status. Athena is our eligibility engine.
eligibilitystatus
string
Current eligibility status of this insurance package.
employerid
string
The employer ID associated with the patient's insurance.
expirationdate
string
Date the insurance expires.
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.
injuredbodypart
string
CASE POLICY FIELD - Text field for describing the injured body part. Only available for auto insurance and worker's comp case policies.
insuranceclaimnumber
string
CASE POLICY FIELD - The auto insurance claim number or the worker's comp claim number.
insuranceid
string
The athena insurance policy ID.
insuranceidnumber
string
The insurance policy ID number (as presented on the insurance card itself).
insurancepackageaddress1
string
Address 1 for the AthenaNet insurance Package.
insurancepackageaddress2
string
Address 2 for the AthenaNet insurance Package.
insurancepackagecity
string
City for the AthenaNet insurance Package.
insurancepackageid
integer
The athenaNet insurance package ID.
insurancepackagestate
string
State of the AthenaNet insurance package
insurancepackagezip
string
Zip code of the AthenaNet insurance package
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.
insuranceplandisplayname
string
Superpackagename of the specific insurance package.
insuranceplanname
string
Name of the specific insurance package.
insurancepolicyholder
string
The full name of the insurance policy holder.
insurancepolicyholderaddress1
string
The first address line of the insurance policy holder.
insurancepolicyholderaddress2
string
The second address line of the insurance policy holder.
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.
insurancepolicyholderdob
string
The DOB of the insurance policy holder (mm/dd/yyyy).
insurancepolicyholderfirstname
string
The first name of the insurance policy holder. Except for self-pay, required for new policies.
insurancepolicyholderlastname
string
The last name of the insurance policy holder. Except for self-pay, required for new policies.
insurancepolicyholdermiddlename
string
The middle name of the insurance policy holder.
insurancepolicyholdersex
string
The sex of the insurance policy holder. Except for self-pay, required for new policies.
insurancepolicyholderssn
string
The SSN of the insurance policy holder.
insurancepolicyholderstate
string
The state of the insurance policy holder.
insurancepolicyholdersuffix
string
The suffix of the insurance policy holder.
insurancepolicyholderzip
string
The zip of the insurance policy holder.
insurancetype
string
Type of insurance. E.g., Medicare Part B, Group Policy, HMO, etc.
insuredentitytypeid
integer
The ID of the entity type for this insurance.
insuredpcp
string
insuredpcpnpi
integer
The national provider id of the primary care physcian assicated with the insurance.
ircid
integer
Insurance category / company internal ID
ircname
string
Insurance category / company. E.g., United Healthcare, BCBS-MA, etc.
issuedate
string
Date the insurance was issued.
policynumber
string
The insurance group number. This is sometimes present on an insurance card.
relatedtoautoaccidentyn
string
CASE POLICY FIELD - Boolean field indicating whether this case policy is related to an auto accident.
relatedtoemploymentyn
string
CASE POLICY FIELD - Boolean field indicating whether this case policy is related to the patient's employer.
relatedtootheraccidentyn
string
CASE POLICY FIELD - Boolean field indicating whether this case policy is related to another accident. Only available for worker's comp case policies.
relationshiptoinsured
string
This patient's relationship to the policy holder (text).
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.
repricerphone
string
CASE POLICY FIELD - Phone number for the repricer. Only available for worker's comp case policies.
sequencenumber
integer
1 = primary, 2 = secondary, 3 = tertiary, etc. Must have a primary before a secondary and a secondary before a tertiary, etc.
slidingfeeplanid
integer
If the patient is on a sliding fee plan, this is the ID of that plan. See /slidingfeeplans.
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.
lastmodified
string
The date/time when the appointment was last modified. Note: It may be possible for the lastmodified field to be updated without any other field in the API call being changed. This occurs when appointment fields not included in the API output are updated.
lastmodifiedby
string
The user who last modified the appointment.
patient
string
See /patients for details
patientappointmenttypename
string
The patient-friendly name for this appointment type. Note that this may not be the same as the booked appointment because of "generic" slots.
patientid
string
The athenaNet patient ID for this appointment
patientlocationid
string
The location of the patient. See /patientlocation for practice list. Only present for appointments with Clinicals that have been checked in.
providerid
string
reasonid
string
A list of reason IDs that could be used for this slot. Only present if multiple reason IDs are requested.
referringproviderid
integer
The referring provider ID.
reminderdetails
array
Detailed ReminderCall information made for this appointment.
calltime
string
Date and time of the call attempt.
messageresultid
string
Id of the message attempt.
messagetype
string
The type of message that was attempted.
result
string
A description of what happened during the call attempt.
renderingproviderid
integer
The rendering provider ID.
rescheduledappointmentid
string
When an appointment is rescheduled, this is the ID of the replacement appointment.
scheduledby
string
The username who scheduled the appointment.
scheduleddatetime
string
The time (mm/dd/yyyy hh24:mi:ss; Eastern time) that this appointment was scheduled.
startcheckin
string
The timestamp when the appointment started the check in process. If this is set while an appointment is still in status 'f', it means that the check-in process has begun but is not yet completed.
startcheckoutdatetime
string
The time (mm/dd/yyyy hh24:mi:ss) that the appointment check-out was started.
starttime
string
As HH:MM (where HH is the 0-23 hour and MM is the minute). This time is local to the department.
stopcheckin
string
The timestamp when the check-in process was finished for this appointment.
stopexamdatetime
string
The time (mm/dd/yyyy hh24:mi:ss) that the exam was completed.
stopintakedatetime
string
The time (mm/dd/yyyy hh24:mi:ss) that the intake process was completed.
suggestedoverbooking
string
High risk score for Smart Scheduling
supervisingproviderid
integer
The supervising provider ID.
templateappointmentid
string
The original appointment ID. This is useful if an appointment has been cancelled and you want to find the original ID.
templateappointmenttypeid
string
The original appointment type for this slot. This can change for generic appointments.
urgentyn
string
Urgent flag for the appointment.
useexpectedprocedurecodes
array
An array of expected procedure codes attached to this appointment.
procedurecode
string
The ID of the code.
procedurecodedescription
string
The description of the code.
Example Code