Appointment
Source Object: Appointment
Overview and Usage: The "Appointment" source object in athena EHR is a comprehensive data model that manages and documents patient appointments. It provides a structured approach for scheduling, documenting, and managing patient appointments and associated information. Here's an overview of key fields and their usage:
- Appointment Scheduling: The "Appointment" source object is the primary repository for managing patient appointments. It captures crucial details including appointment ID, status, type, and scheduling details.
- Date and Time: Fields such as "date," "starttime," and "duration" specify the date and time of the appointment, essential for scheduling and patient notification.
- Patient Information: "patientid" links the appointment to the specific patient's record, ensuring accurate patient identification and tracking.
- Provider Details: "providerid," "renderingproviderid," and "supervisingproviderid" associate the appointment with the involved healthcare providers, streamlining patient care coordination.
- Appointment Status: "appointmentstatus" indicates the current status of the appointment (e.g., scheduled, canceled, checked in), aiding in appointment management.
- Appointment Type: "appointmenttype" and "appointmenttypeid" classify the appointment into specific types, such as follow-up, consultation, or regular check-up.
- Appointment Cancellation: "appointmentcancelreasonid" records the reason for appointment cancellation, helping healthcare providers understand patient needs and rescheduling.
- Co-Pay Information: "copay" and "appointmentcopay" detail the co-pay associated with the appointment, supporting financial transactions and patient billing.
- Insurance Information: The source object contains a wealth of insurance-related fields, including details about the patient's insurance coverage, insurance company, and eligibility information.
- Diagnosis and Procedure Codes: Fields like "claims.diagnoses.diagnosiscodeset" and "useexpectedprocedurecodes.procedurecode" provide standardized diagnosis and procedure codes for billing and medical documentation.
- Related to Accident and Injury: Fields like "insurances.relatedtoautoaccidentyn" and "insurances.descriptionofinjury" help identify appointments related to accidents or injuries.
- Custom Fields: "customfields.customfieldid" and "customfields.customfieldvalue" enable the addition of custom data fields, supporting customization based on specific clinic needs.
- Appointment Notes: The source object captures notes related to appointments, including creation and modification details, aiding in communication and record-keeping.
- Confirmation and Patient Case: "donotsendconfirmationemail" and "nopatientcase" indicate preferences regarding appointment confirmation emails and patient case handling.
The "Appointment" source object is a comprehensive solution for managing and documenting patient appointments within athena EHR. It ensures efficient appointment scheduling, detailed documentation, and supports patient care coordination and billing processes. Developers can utilize this source object to build features and applications that enhance appointment management, improve patient care, and streamline administrative workflows.
Mapping Table
Data Field | Example Value | Source Data Field Description | Source Field Data Type | Source Data Field Cardinality | Mapped FHIR++ Resource | Mapped FHIR Data Field | Augmented Mapping | Associated Coding System | Associated FHIR Data Field Extension | Mapping Context |
---|---|---|---|---|---|---|---|---|---|---|
appointmentid | - | Appointment ID of the booked appointment. | String | 1..1 | Appointment | id | - | - | - | Top Level |
appointmentstatus | - | 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). | String | 0..1 | Appointment | status | - | - | - | Top Level |
appointmenttype | - | The practice-friendly (not patient friendly) name for this appointment type. Note that this may \u003Cstrong\u003Enot\u003C/strong\u003E be the same as the booked appointment because of "generic" slots. | String | 0..1 | Appointment | appointmentType.coding[1].display | - | - | - | Top Level |
appointmenttypeid | - | This is the ID for the appointment type. Note that this may \u003Cstrong\u003Enot\u003C/strong\u003E be the same as the booked appointment because of "generic" slots. | String | 0..1 | Appointment | appointmentType.coding[1].code | - | - | - | Top Level |
date | - | The appointment date. | String | 0..1 | Appointment | start | - | - | - | Top Level |
departmentid | - | Department Id. | String | 1..1 | Appointment | participant[*].actor.reference | - | - | department-id | Top Level |
duration | - | In minutes. | String | 0..1 | Appointment | minutesDuration | - | - | - | Top Level |
patientid | - | The athenaNet patient ID for this appointment. | String | 0..1 | Appointment | participant[*].actor.reference | - | - | - | Top Level |
providerid | - | String | 0..1 | Appointment | participant[*].actor.reference | - | - | - | Top Level | |
appointmentcancelreasonid | - | The appointment cancel reason id if the appointment is cancelled. | String | 0..1 | Appointment | cancellationReason.id | - | - | - | Top Level |
appointmentcopay | - | 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. | String | 0..1 | Appointment | extension[*].valueString | - | - | appointment-copay | Top Level |
cancelleddate | - | The appointment cancel date if the appointment is cancelled. | String | 0..1 | Appointment | extension[*].valueString | - | - | cancelled-date | Top Level |
copay | - | 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. | String | 0..1 | Appointment | extension[*].valueString | - | - | copay | Top Level |
frozenyn | - | If true, this appointment slot is frozen. | String | 0..1 | Appointment | extension[*].valueString | - | - | frozen-yn | Top Level |
hl7providerid | - | 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. | Integer | 0..1 | Appointment | extension[*].valueString | - | - | hl7-provider-id | Top Level |
nativeathenatelehealth | - | If true, then this is a native athenatelehealth appointment. | String | 0..1 | Appointment | extension[*].valueString | - | - | native-athena-telehealth | Top Level |
patient | - | As detailed in /patients, if requested. | String | 0..1 | Appointment | participant[*].actor.display | reference=Patient/patientid | - | - | Top Level |
patientappointmenttypename | - | The patient-friendly name for this appointment type. Note that this may \u003Cstrong\u003Enot\u003C/strong\u003E be the same as the booked appointment because of "generic" slots. | String | 0..1 | Appointment | appointmentType.text | - | - | - | Top Level |
referringproviderid | - | The referring provider ID. | Integer | 0..1 | Appointment | participant[*].actor.reference | - | - | - | Top Level |
renderingproviderid | - | The rendering provider ID. | Integer | 0..1 | Appointment | participant[*].actor.reference | - | - | - | Top Level |
rescheduledappointmentid | - | When an appointment is rescheduled, this is the ID of the replacement. appointment. | String | 0..1 | Appointment | extension[*].valueString | - | - | rescheduled-appointmentid | Top Level |
startcheckin | - | 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. | String | 0..1 | Appointment | extension[*].valueString | - | - | start-checkin | Top Level |
stopcheckin | - | The timestamp when the check-in process was finished for this appointment. | String | 0..1 | Appointment | extension[*].valueString | - | - | stop-checkin | Top Level |
supervisingproviderid | - | The supervising provider ID. | String | 0..1 | Appointment | participant[*].actor.reference | - | - | - | Top Level |
urgentyn | - | Urgent flag for the appointment. | String | 0..1 | Appointment | extension[*].valueString | - | - | urgent-yn | Top Level |
claims.appointmentid | - | The appointment ID associated with this claim. | String | 0..1 | Claim | contained[].extensions[].valueId | - | - | appointment-id | Contained |
claims.billedproviderid | - | The provider ID of the billing provider for this claim. | String | 0..1 | Claim | contained[].provider.extensions[].valueString | - | - | billed-provider-id | Contained |
claims.billedservicedate | - | The billed date of service. | String | 0..1 | Claim | contained[*].billablePeriod.end | - | - | billed-service-date | Contained |
claims.chargeamount | - | The total amount billed for all services from this claim. | String | 0..1 | Claim | contained[*].total | - | - | - | Contained |
claims.claimcreateddate | - | The date the claim was created. | String | 0..1 | Claim | contained[*].created | - | - | - | Contained |
claims.claimid | - | athenaNet's internal ID for this claim, specific to the practice. | String | 0..1 | Claim | contained[*].id | - | - | - | Contained |
claims.diagnoses.deleteddiagnosis | - | 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. | String | 0..1 | Claim | contained[].diagnosis.extensions[].valueString | - | - | deleted-diagnosis | Contained |
claims.diagnoses.diagnosiscategory | - | The category for this diagnosis. | String | 0..1 | Claim | diagnosis[].type[].text | - | - | - | Contained |
claims.diagnoses.diagnosiscodeset | - | Either ICD9 or ICD10. | String | 0..1 | Claim | diagnosis[].diagnosisCodeableConcept.coding[].system | - | - | - | Contained |
claims.diagnoses.diagnosisdescription | - | A description of this diagnosis. | String | 0..1 | Claim | diagnosis[].diagnosisCodeableConcept.coding[].display | - | - | - | Contained |
claims.diagnoses.diagnosisid | - | A unique ID related to this diagnosis. | String | 0..1 | Claim | diagnosis[*].diagnosisReference.reference | - | - | - | Contained |
claims.diagnoses.diagnosisrawcode | - | The raw ICD-9 code. This will migrate to ICD-10 in the future. | String | 0..1 | Claim | diagnosis[].diagnosisCodeableConcept.coding[].code | - | - | - | Contained |
claims.patientpayer | - | The status and notes of a responsible payer. This payer is the patient. | String | 0..1 | Claim | contained[].extensions[].valueString | - | - | patient-payer | Contained |
claims.primaryinsurancepayer | - | The status and notes of a responsible payer. This payer is the primary. insurace | String | 0..1 | Claim | contained[*].insurance[0].coverage.reference | - | - | - | Contained |
claims.procedures.allowableamount | - | The total amount expected from payer for all services from this procedure. | String | 0..1 | Claim | contained[].procedure.extensions[].valueString | - | - | allowable-amount | Contained |
claims.procedures.allowablemax | - | The maximum amount expected from payer for all services from this procedure. | String | 0..1 | Claim | contained[].procedure.extensions[].valueString | - | - | allowable-max | Contained |
claims.procedures.allowablemin | - | The minimum amount expected from payer for all services from this procedure. | String | 0..1 | Claim | contained[].procedure.extensions[].valueString | - | - | allowable-min | Contained |
claims.procedures.chargeamount | - | The amount charged for this procedure. | String | 0..1 | Claim | contained[].procedure.extensions[].valueString | - | - | charge-amount | Contained |
claims.procedures.procedurecategory | - | The category name associated with this procedure. | String | 0..1 | Claim | contained[].procedure[].type[*].coding[0].display | - | - | - | Contained |
claims.procedures.procedurecode | - | The CPT code associated with this procedure. | String | 0..1 | Claim | contained[].procedure[].procedureCodeableConcept.coding[0].code | - | - | - | Contained |
claims.procedures.proceduredescription | - | A description of this procedure. | String | 0..1 | Claim | contained[].procedure[].procedureCodeableConcept.coding[*].display | - | - | - | Contained |
claims.procedures.transactionid | - | The ID of the last transaction associated with the claim. | String | 0..1 | Claim | contained[].procedure.extensions[].valueString | - | - | transaction-id | Contained |
claims.referringproviderid | - | The referring provider ID for this claim. See /referringproviders. This is not the same as the ID from the /providers call. | Integer | 0..1 | Claim | contained[].provider.extensions[].valueString | - | - | referring-provider-id | Contained |
claims.secondaryinsurancepayer | - | The status and notes of a responsible payer. This payer is the secondary insurace. | String | 0..1 | Claim | contained[*].insurance[1].coverage.reference | - | - | - | Contained |
claims.transactiondetails | - | 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. | String | 0..1 | Claim | contained[].extensions[].valueString | - | - | transaction-details | Contained |
claims.transactionid | - | A unique ID for the primary transaction this claim represents. May be useful for debugging. | String | 0..1 | Claim | contained[].extensions[].valueId | - | - | transaction-id | Contained |
insurances.adjusterfax | - | CASE POLICY FIELD - Fax for the adjuster on this case policy. Only available for auto insurance or worker's comp case policies. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | adjuster-fax | Contained |
insurances.adjusterfirstname | - | CASE POLICY FIELD - First name of the adjuster on this case policy. Only available for auto insurance or worker's comp case policies. | String | 0..1 | Coverage | contained[].extensions[].valueHumanName.given[1] | - | - | adjuster-first-name | Contained |
insurances.adjusterlastname | - | CASE POLICY FIELD - Last name of the adjuster on this case policy. Only available for auto insurance or worker's comp case policies. | String | 0..1 | Coverage | contained[].extensions[].valueHumanName.family | - | - | adjuster-last-name | Contained |
insurances.adjusterphone | - | 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 | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | adjuster-phone | Contained |
insurances.anotherpartyresponsibleyn | - | CASE POLICY FIELD - Boolean field indicating if another party was responsible for this accident. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | another-party-responsible | Contained |
insurances.autoaccidentstate | - | CASE POLICY FIELD - Two-letter abbreviation for the state in which the auto accident took place. Only meaningful for auto insurance case policies. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | auto-accident-state | Contained |
insurances.cancelled | - | The date in which the insurance was marked cancelled. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | cancelled-date | Contained |
insurances.caseinjurydate | - | CASE POLICY FIELD - Date of the injury. Required for auto insurance, legal, and worker's comp case policies. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | case-injury-date | Contained |
insurances.casepolicytypename | - | CASE POLICY FIELD - The name of this type of case policy. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | case-policy-type-name | Contained |
insurances.ccmstatusid | - | Status ID of current CCM enrollment. | String | 0..1 | Coverage | contained[].extensions[].valueInteger | - | - | ccm-status-id | Contained |
insurances.ccmstatusname | - | The name of current CCM enrollment status. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | ccm-status-name | Contained |
insurances.coinsurancepercent | - | 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. | Integer | 0..1 | Coverage | contained[].extensions[].valueDecimal | - | - | coinsurance-percent | Contained |
insurances.copays | - | 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. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | copays | Contained |
insurances.descriptionofinjury | - | CASE POLICY FIELD - A description of the injury. Only available for auto insurance and worker's comp case policies. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | injury-description | Contained |
insurances.eligibilitylastchecked | - | Date the eligibility was last checked. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | eligibility-last-checked | Contained |
insurances.eligibilitymessage | - | The message, usually from our engine, of the eligibility check. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | eligibility-message | Contained |
insurances.eligibilityreason | - | The source of the current status. athena is our eligibility engine. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | eligibility-reason | Contained |
insurances.eligibilitystatus | - | Current eligibility status of this insurance package. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | eligibility-status | Contained |
insurances.employerid | - | The employer ID associated with the patient's insurance. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | employer-id | Contained |
insurances.expirationdate | - | Date the insurance expires. | String | 0..1 | Coverage | contained[*].period.end | - | - | - | Contained |
insurances.icd10codes | - | CASE POLICY FIELD - See documentation for ICD9CODES. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | icd10codes | Contained |
insurances.icd9codes | - | CASE POLICY FIELD - A list of ICD9 accepted diagnosis codes. Only available for worker's comp case policies. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | icd9codes | Contained |
insurances.injuredbodypart | - | CASE POLICY FIELD - Text field for describing the injured body part. Only available for auto insurance and worker's comp case policies. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | injured-body-part | Contained |
insurances.insuranceclaimnumber | - | CASE POLICY FIELD - The auto insurance claim number or the worker's comp claim number. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | insurance-claim-number | Contained |
insurances.insuranceid | - | The athena insurance policy ID. | String | 0..1 | Coverage | contained[*].id | - | - | - | Contained |
insurances.insuranceidnumber | - | The insurance policy ID number (as presented on the insurance card itself). | String | 0..1 | Coverage | contained[].identifier[].value | identifier[*].type.text=insurance-id-number | - | - | Contained |
insurances.insurancepackageaddress1 | - | Address 1 for the athenaNet insurance Package. | String | 0..1 | Coverage | contained[].extensions[].valueAddress.line[1] | - | - | insurance-package-address-1 | Contained |
insurances.insurancepackageaddress2 | - | Address 2 for the athenaNet insurance Package. | String | 0..1 | Coverage | contained[].extensions[].valueAddress.line[2] | - | - | insurance-package-address-2 | Contained |
insurances.insurancepackagecity | - | City for the athenaNet insurance Package. | String | 0..1 | Coverage | contained[].extensions[].valueAddress.city | - | - | insurance-package-city | Contained |
insurances.insurancepackageid | - | The athenaNet insurance package ID. | Integer | 0..1 | Coverage | contained[].identifier[].value | identifier[*].type.text=insurance-package-id | - | - | Contained |
insurances.insurancepackagestate | - | State of the AthenaNet insurance package. | String | 0..1 | Coverage | contained[].extensions[].valueAddress.state | - | - | insurance-package-state | Contained |
insurances.insurancepackagezip | - | Zip code of the athenaNet insurance package. | String | 0..1 | Coverage | contained[].extensions[].valueAddress.postalcode | - | - | insurance-package-zip | Contained |
insurances.insurancephone | - | 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. | String | 0..1 | Coverage | contained[].extensions[].valueInteger | - | - | insurance-phone | Contained |
insurances.insuranceplandisplayname | - | Superpackagename of the specific insurance package. | String | 0..1 | Coverage | contained[].class.extension[].valueString | - | - | insurance-plan-display-name | Contained |
insurances.insuranceplanname | - | Name of the specific insurance package. | String | 0..1 | Coverage | contained[*].class.name | - | - | - | Contained |
insurances.insurancepolicyholder | - | The full name of the insurance policy holder. | String | 0..1 | Coverage | contained[*].policyholder.reference | - | - | - | Contained |
insurances.insurancepolicyholderaddress1 | - | The first address line of the insurance policy holder. | String | 0..1 | Coverage | contained[].policyholder.extensions[].valueAddress.line[1] | - | - | insurance-policy-holder-address-1 | Contained |
insurances.insurancepolicyholderaddress2 | - | The second address line of the insurance policy holder. | String | 0..1 | Coverage | contained[].policyholder.extensions[].valueAddress.line[2] | - | - | insurance-policy-holder-address-2 | Contained |
insurances.insurancepolicyholdercity | - | "The city of the insurance policy holder. | String | 0..1 | Coverage | contained[].policyholder.extensions[].valueAddress.city | - | - | insurance-policy-holder-city | Contained |
insurances.insurancepolicyholdercountrycode | - | The country code (3 letter) of the insurance policy holder. | String | 0..1 | Coverage | contained[].policyholder.extensions[].valueString | - | - | insurance-policy-holder-country-code | Contained |
insurances.insurancepolicyholdercountryiso3166 | - | The \u003Ca href="http://en.wikipedia.org/wiki/ISO\_3166-1\_alpha-2"\u003EISO 3166\u003C/a\u003E country code of the insurance policy holder. | String | 0..1 | Coverage | contained[].policyholder.extensions[].valueAddress.country | - | - | insurance-policy-holder-country-iso3166 | Contained |
insurances.insurancepolicyholderdob | - | The DOB of the insurance policy holder (mm/dd/yyyy). | String | 0..1 | Coverage | contained[].policyholder.extensions[].valueString | - | - | insurance-policy-holder-dob | Contained |
insurances.insurancepolicyholderfirstname | - | The first name of the insurance policy holder. Except for self-pay, required for new policies. | String | 0..1 | Coverage | policyholder.extensions[*].valueHumanName.given[1] | - | - | insurance-policy-holder-first-name | Contained |
insurances.insurancepolicyholderlastname | - | The last name of the insurance policy holder. Except for self-pay, required for new policies. | String | 0..1 | Coverage | policyholder.extensions[*].valueHumanName.family | - | - | insurance-policy-holder-last-name | Contained |
insurances.insurancepolicyholdermiddlename | - | The middle name of the insurance policy holder. | String | 0..1 | Coverage | policyholder.extensions[*].valueHumanName.given[2] | - | - | insurance-policy-holder-middle-name | Contained |
insurances.insurancepolicyholdersex | - | The sex of the insurance policy holder. Except for self-pay, required for new policies. | String | 0..1 | Coverage | contained[].policyholder.extensions[].valueString | - | - | insurance-policy-holder-sex | Contained |
insurances.insurancepolicyholderssn | - | The SSN of the insurance policy holder. | String | 0..1 | Coverage | contained[].policyholder.extensions[].valueString | - | - | insurance-policy-holder-ssn | Contained |
insurances.insurancepolicyholderstate | - | The state of the insurance policy holder. | String | 0..1 | Coverage | contained[].policyholder.extensions[].valueAddress.state | - | - | insurance-policy-holder-state | Contained |
insurances.insurancepolicyholdersuffix | - | The suffix of the insurance policy holder. | String | 0..1 | Coverage | policyholder.extensions[*].valueHumanName.suffix | - | - | insurance-policy-holder-suffix | Contained |
insurances.insurancepolicyholderzip | - | The zip of the insurance policy holder. | String | 0..1 | Coverage | contained[].policyholder.extensions[].valueAddress.postalCode | - | - | insurance-policy-holder-zip | Contained |
insurances.insuranceproducttype | - | The athenaNet insurance product type. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | insurance-product-type | Contained |
insurances.insurancetype | - | Type of insurance. E.g., Medicare Part B, Group Policy, HMO, etc. | String | 0..1 | Coverage | contained[*].class[1].type.text | - | - | - | Contained |
insurances.insuredentitytypeid | - | The ID of the entity type for this insurance. | Integer | 0..1 | Coverage | contained[].extensions[].valueInteger | - | - | insured-entity-type-id | Contained |
insurances.insuredidnumber | - | The insurance policy ID number of insured. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | insured-id-number | Contained |
insurances.insuredpcp | - | - | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | insured-pcp | Contained |
insurances.insuredpcpnpi | - | The national provider id of the primary care physcian assicated with the insurance. | Integer | 0..1 | Coverage | contained[].extensions[].valueInteger | - | - | insured-pcp-npi | Contained |
insurances.insuredreferringprovider | - | The referring provider that is associated with the insurance. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | insured-referring-provider | Contained |
insurances.ircid | - | Insurance category / company internal ID. | Integer | 0..1 | Coverage | contained[].extensions[].valueInteger | - | - | irc-id | Contained |
insurances.ircname | - | Insurance category / company. E.g., United Healthcare, BCBS-MA, etc. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | irc-name | Contained |
insurances.issuedate | - | Date the insurance was issued. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | issue-date | Contained |
insurances.note | - | The athenaNet insurance notes. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | note | Contained |
insurances.policynumber | - | The insurance group number. This is sometimes present on an insurance card. | String | 0..1 | Coverage | contained[*].class[1].type.coding[1].code | - | - | - | Contained |
insurances.relatedtoautoaccidentyn | - | CASE POLICY FIELD - Boolean field indicating whether this case policy is related to an auto accident. | String | 0..1 | Coverage | contained[].extensions[].valueBoolean | - | - | related-to-auto-accident | Contained |
insurances.relatedtoemploymentyn | - | CASE POLICY FIELD - Boolean field indicating whether this case policy is related to the patient's employer. | String | 0..1 | Coverage | contained[].extensions[].valueBoolean | - | - | related-to-employment | Contained |
insurances.relatedtootheraccidentyn | - | "CASE POLICY FIELD - Boolean field indicating whether this case policy is related to another accident. Only available for worker's comp case policies. | String | 0..1 | Coverage | contained[].extensions[].valueBoolean | - | - | related-to-other-accident | Contained |
insurances.relationshiptoinsured | - | This patient's relationship to the policy holder (text). | String | 0..1 | Coverage | contained[*].relationship.text | - | - | - | Contained |
insurances.relationshiptoinsuredid | - | This patient's relationship to the policy holder (as an ID). See \u003Ca href="/workflows/patient-relationship-mapping"\u003Ethe mapping\u003C/a\u003E | Integer | 0..1 | Coverage | contained[*].relationship.coding[1].code | - | - | - | Contained |
insurances.repricername | - | CASE POLICY FIELD - Name for the repricer. Only available for worker's comp case policies. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | repricer-name | Contained |
insurances.repricerphone | - | CASE POLICY FIELD - Phone number for the repricer. Only available for worker's comp case policies. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | repricer-phone | Contained |
insurances.sequencenumber | - | 1 = primary, 2 = secondary, 3 = tertiary, etc. Must have a primary before a secondary and a secondary before a tertiary, etc. | Integer | 0..1 | Coverage | contained[].extensions[].valueInteger | - | - | sequence-number | Contained |
insurances.slidingfeeplanid | - | If the patient is on a sliding fee plan, this is the ID of that plan. See /slidingfeeplans. | Integer | 0..1 | Coverage | contained[].extensions[].valueInteger | - | - | sliding-fee-plan-id | Contained |
insurances.stateofreportedinjury | - | CASE POLICY FIELD - Two-letter state abbreviation for the state this injury was reported in. Only available for worker's comp case policies. | String | 0..1 | Coverage | contained[].extensions[].valueString | - | - | state-of-reported-injury | Contained |
useexpectedprocedurecodes.procedurecode | - | The ID of the code. | String | 0..1 | Appointment | reasoncode[].coding[].code | - | - | - | Top Level |
useexpectedprocedurecodes.procedurecodedescription | - | The description of the code. | String | 0..1 | Appointment | reasoncode[].coding[].display | - | - | - | Top Level |
donotsendconfirmationemail | - | For clients with athenaCommunicator, certain appointment types can be configured to have an appointment confirmation email sent to the patient at time of appointment booking. If this parameter is set to true, that email will not be sent. This should only be used if you plan on sending a confirmation email via another method. | Boolean | 0..1 | Appointment | extension[*].valueBoolean | - | - | do-not-send-confirmation-email | Top Level |
nopatientcase | - | By default, we create a patient case upon booking an appointment for new patients. Setting this to true bypasses that patient case. | Boolean | 0..1 | Appointment | extension[*].valueBoolean | - | - | no-patient-case | Top Level |
insuranceinfo.insurancegroupid | - | Identifier for the insurance group. | String | 0..1 | Coverage | contained[].identifier[].value | identifier[*].type.text=insurance-group-id | Contained | ||
insuranceinfo.insurancecompany | - | Name of the insurance company. | String | 0..1 | Coverage | contained[].extensions[].valueString | insurance-company | Contained | ||
created(appointment note) | - | The time this note was created (mm/dd/yyyy hh24:mi:ss). | string | 0..1 | Appointment | extension[].valueAnnotation[].time | note | Top Level | ||
createdby(appointment note) | - | The user that created this note. | string | 0..1 | Appointment | extension[].valueAnnotation[].author.authorString | note | Top Level | ||
deleted(appointment note) | - | The time this note was deleted (mm/dd/yyyy hh24:mi:ss). Not present if not deleted. | string | 0..1 | Appointment | extension[].valueAnnotation[].extension.valueDateTime | note | note-deleted | Top Level | |
deletedby(appointment note) | - | If deleted, the username who deleted this note. | string | 0..1 | Appointment | extension[].valueAnnotation[].extension.valueString | note | note-deleted-by | Top Level | |
displayonschedule(appointment note) | - | Determines if an appointment note displays on the homepage schedule view. | string | 0..1 | Appointment | extension[].valueAnnotation[].extension.valueString | note | display-on-schedule | Top Level | |
lastmodified(appointment note) | - | The time this note was updated (mm/dd/yyyy hh24:mi:ss), if the note has been updated. | string | 0..1 | Appointment | extension[].valueAnnotation[].extension.valueDateTime | note | last-modified | Top Level | |
lastmodifiedby(appointment note) | - | If the note has been modified, the username who last modified this note. | string | 0..1 | Appointment | extension[].valueAnnotation[].extension.valueString | note | last-modified-by | Top Level | |
noteid(appointment note) | - | The ID for this note, for use with DELETE and PUT calls. | string | 0..1 | Appointment | extension[].valueAnnotation[].id | note | Top Level | ||
notetext(appointment note) | - | The text of the note itself. | string | 0..1 | Appointment | extension[].valueAnnotation[].text | note | Top Level | ||
customfields.customfieldid | - | Corresponds to the /customfields customfieldid. | String | 0..1 | QuestionnaireResponse | item.linkId | - | - | - | Contained |
customfields.customfieldvalue | - | For a non-select custom field, the value. | String | 0..1 | QuestionnaireResponse | item.answer.valueString/item.answer.valueCoding.display | - | - | - | Contained |
customfields.optionid | - | For a select custom field, the selectid value (from /customfield's selectlist). | String | 0..1 | QuestionnaireResponse | item.answer.valueCoding.code | - | - | Contained |