xCaliber healthCare Data Mesh

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 FieldExample ValueSource Data Field DescriptionSource Field Data TypeSource Data Field CardinalityMapped FHIR++ ResourceMapped FHIR Data FieldAugmented MappingAssociated Coding SystemAssociated FHIR Data Field ExtensionMapping Context
appointmentid-Appointment ID of the booked appointment.String1..1Appointmentid---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).String0..1Appointmentstatus---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.String0..1AppointmentappointmentType.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.String0..1AppointmentappointmentType.coding[1].code---Top Level
date-The appointment date.String0..1Appointmentstart---Top Level
departmentid-Department Id.String1..1Appointmentparticipant[*].actor.reference--department-idTop Level
duration-In minutes.String0..1AppointmentminutesDuration---Top Level
patientid-The athenaNet patient ID for this appointment.String0..1Appointmentparticipant[*].actor.reference---Top Level
providerid-String0..1Appointmentparticipant[*].actor.reference---Top Level
appointmentcancelreasonid-The appointment cancel reason id if the appointment is cancelled.String0..1AppointmentcancellationReason.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.String0..1Appointmentextension[*].valueString--appointment-copayTop Level
cancelleddate-The appointment cancel date if the appointment is cancelled.String0..1Appointmentextension[*].valueString--cancelled-dateTop 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.String0..1Appointmentextension[*].valueString--copayTop Level
frozenyn-If true, this appointment slot is frozen.String0..1Appointmentextension[*].valueString--frozen-ynTop 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.Integer0..1Appointmentextension[*].valueString--hl7-provider-idTop Level
nativeathenatelehealth-If true, then this is a native athenatelehealth appointment.String0..1Appointmentextension[*].valueString--native-athena-telehealthTop Level
patient-As detailed in /patients, if requested.String0..1Appointmentparticipant[*].actor.displayreference=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.String0..1AppointmentappointmentType.text---Top Level
referringproviderid-The referring provider ID.Integer0..1Appointmentparticipant[*].actor.reference---Top Level
renderingproviderid-The rendering provider ID.Integer0..1Appointmentparticipant[*].actor.reference---Top Level
rescheduledappointmentid-When an appointment is rescheduled, this is the ID of the replacement. appointment.String0..1Appointmentextension[*].valueString--rescheduled-appointmentidTop 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.String0..1Appointmentextension[*].valueString--start-checkinTop Level
stopcheckin-The timestamp when the check-in process was finished for this appointment.String0..1Appointmentextension[*].valueString--stop-checkinTop Level
supervisingproviderid-The supervising provider ID.String0..1Appointmentparticipant[*].actor.reference---Top Level
urgentyn-Urgent flag for the appointment.String0..1Appointmentextension[*].valueString--urgent-ynTop Level
claims.appointmentid-The appointment ID associated with this claim.String0..1Claimcontained[].extensions[].valueId--appointment-idContained
claims.billedproviderid-The provider ID of the billing provider for this claim.String0..1Claimcontained[].provider.extensions[].valueString--billed-provider-idContained
claims.billedservicedate-The billed date of service.String0..1Claimcontained[*].billablePeriod.end--billed-service-dateContained
claims.chargeamount-The total amount billed for all services from this claim.String0..1Claimcontained[*].total---Contained
claims.claimcreateddate-The date the claim was created.String0..1Claimcontained[*].created---Contained
claims.claimid-athenaNet's internal ID for this claim, specific to the practice.String0..1Claimcontained[*].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.String0..1Claimcontained[].diagnosis.extensions[].valueString--deleted-diagnosisContained
claims.diagnoses.diagnosiscategory-The category for this diagnosis.String0..1Claimdiagnosis[].type[].text---Contained
claims.diagnoses.diagnosiscodeset-Either ICD9 or ICD10.String0..1Claimdiagnosis[].diagnosisCodeableConcept.coding[].system---Contained
claims.diagnoses.diagnosisdescription-A description of this diagnosis.String0..1Claimdiagnosis[].diagnosisCodeableConcept.coding[].display---Contained
claims.diagnoses.diagnosisid-A unique ID related to this diagnosis.String0..1Claimdiagnosis[*].diagnosisReference.reference---Contained
claims.diagnoses.diagnosisrawcode-The raw ICD-9 code. This will migrate to ICD-10 in the future.String0..1Claimdiagnosis[].diagnosisCodeableConcept.coding[].code---Contained
claims.patientpayer-The status and notes of a responsible payer. This payer is the patient.String0..1Claimcontained[].extensions[].valueString--patient-payerContained
claims.primaryinsurancepayer-The status and notes of a responsible payer. This payer is the primary. insuraceString0..1Claimcontained[*].insurance[0].coverage.reference---Contained
claims.procedures.allowableamount-The total amount expected from payer for all services from this procedure.String0..1Claimcontained[].procedure.extensions[].valueString--allowable-amountContained
claims.procedures.allowablemax-The maximum amount expected from payer for all services from this procedure.String0..1Claimcontained[].procedure.extensions[].valueString--allowable-maxContained
claims.procedures.allowablemin-The minimum amount expected from payer for all services from this procedure.String0..1Claimcontained[].procedure.extensions[].valueString--allowable-minContained
claims.procedures.chargeamount-The amount charged for this procedure.String0..1Claimcontained[].procedure.extensions[].valueString--charge-amountContained
claims.procedures.procedurecategory-The category name associated with this procedure.String0..1Claimcontained[].procedure[].type[*].coding[0].display---Contained
claims.procedures.procedurecode-The CPT code associated with this procedure.String0..1Claimcontained[].procedure[].procedureCodeableConcept.coding[0].code---Contained
claims.procedures.proceduredescription-A description of this procedure.String0..1Claimcontained[].procedure[].procedureCodeableConcept.coding[*].display---Contained
claims.procedures.transactionid-The ID of the last transaction associated with the claim.String0..1Claimcontained[].procedure.extensions[].valueString--transaction-idContained
claims.referringproviderid-The referring provider ID for this claim. See /referringproviders. This is not the same as the ID from the /providers call.Integer0..1Claimcontained[].provider.extensions[].valueString--referring-provider-idContained
claims.secondaryinsurancepayer-The status and notes of a responsible payer. This payer is the secondary insurace.String0..1Claimcontained[*].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.String0..1Claimcontained[].extensions[].valueString--transaction-detailsContained
claims.transactionid-A unique ID for the primary transaction this claim represents. May be useful for debugging.String0..1Claimcontained[].extensions[].valueId--transaction-idContained
insurances.adjusterfax-CASE POLICY FIELD - Fax for the adjuster on this case policy. Only available for auto insurance or worker's comp case policies.String0..1Coveragecontained[].extensions[].valueString--adjuster-faxContained
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.String0..1Coveragecontained[].extensions[].valueHumanName.given[1]--adjuster-first-nameContained
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.String0..1Coveragecontained[].extensions[].valueHumanName.family--adjuster-last-nameContained
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 policiesString0..1Coveragecontained[].extensions[].valueString--adjuster-phoneContained
insurances.anotherpartyresponsibleyn-CASE POLICY FIELD - Boolean field indicating if another party was responsible for this accident.String0..1Coveragecontained[].extensions[].valueString--another-party-responsibleContained
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.String0..1Coveragecontained[].extensions[].valueString--auto-accident-stateContained
insurances.cancelled-The date in which the insurance was marked cancelled.String0..1Coveragecontained[].extensions[].valueString--cancelled-dateContained
insurances.caseinjurydate-CASE POLICY FIELD - Date of the injury. Required for auto insurance, legal, and worker's comp case policies.String0..1Coveragecontained[].extensions[].valueString--case-injury-dateContained
insurances.casepolicytypename-CASE POLICY FIELD - The name of this type of case policy.String0..1Coveragecontained[].extensions[].valueString--case-policy-type-nameContained
insurances.ccmstatusid-Status ID of current CCM enrollment.String0..1Coveragecontained[].extensions[].valueInteger--ccm-status-idContained
insurances.ccmstatusname-The name of current CCM enrollment status.String0..1Coveragecontained[].extensions[].valueString--ccm-status-nameContained
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.Integer0..1Coveragecontained[].extensions[].valueDecimal--coinsurance-percentContained
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.String0..1Coveragecontained[].extensions[].valueString--copaysContained
insurances.descriptionofinjury-CASE POLICY FIELD - A description of the injury. Only available for auto insurance and worker's comp case policies.String0..1Coveragecontained[].extensions[].valueString--injury-descriptionContained
insurances.eligibilitylastchecked-Date the eligibility was last checked.String0..1Coveragecontained[].extensions[].valueString--eligibility-last-checkedContained
insurances.eligibilitymessage-The message, usually from our engine, of the eligibility check.String0..1Coveragecontained[].extensions[].valueString--eligibility-messageContained
insurances.eligibilityreason-The source of the current status. athena is our eligibility engine.String0..1Coveragecontained[].extensions[].valueString--eligibility-reasonContained
insurances.eligibilitystatus-Current eligibility status of this insurance package.String0..1Coveragecontained[].extensions[].valueString--eligibility-statusContained
insurances.employerid-The employer ID associated with the patient's insurance.String0..1Coveragecontained[].extensions[].valueString--employer-idContained
insurances.expirationdate-Date the insurance expires.String0..1Coveragecontained[*].period.end---Contained
insurances.icd10codes-CASE POLICY FIELD - See documentation for ICD9CODES.String0..1Coveragecontained[].extensions[].valueString--icd10codesContained
insurances.icd9codes-CASE POLICY FIELD - A list of ICD9 accepted diagnosis codes. Only available for worker's comp case policies.String0..1Coveragecontained[].extensions[].valueString--icd9codesContained
insurances.injuredbodypart-CASE POLICY FIELD - Text field for describing the injured body part. Only available for auto insurance and worker's comp case policies.String0..1Coveragecontained[].extensions[].valueString--injured-body-partContained
insurances.insuranceclaimnumber-CASE POLICY FIELD - The auto insurance claim number or the worker's comp claim number.String0..1Coveragecontained[].extensions[].valueString--insurance-claim-numberContained
insurances.insuranceid-The athena insurance policy ID.String0..1Coveragecontained[*].id---Contained
insurances.insuranceidnumber-The insurance policy ID number (as presented on the insurance card itself).String0..1Coveragecontained[].identifier[].valueidentifier[*].type.text=insurance-id-number--Contained
insurances.insurancepackageaddress1-Address 1 for the athenaNet insurance Package.String0..1Coveragecontained[].extensions[].valueAddress.line[1]--insurance-package-address-1Contained
insurances.insurancepackageaddress2-Address 2 for the athenaNet insurance Package.String0..1Coveragecontained[].extensions[].valueAddress.line[2]--insurance-package-address-2Contained
insurances.insurancepackagecity-City for the athenaNet insurance Package.String0..1Coveragecontained[].extensions[].valueAddress.city--insurance-package-cityContained
insurances.insurancepackageid-The athenaNet insurance package ID.Integer0..1Coveragecontained[].identifier[].valueidentifier[*].type.text=insurance-package-id--Contained
insurances.insurancepackagestate-State of the AthenaNet insurance package.String0..1Coveragecontained[].extensions[].valueAddress.state--insurance-package-stateContained
insurances.insurancepackagezip-Zip code of the athenaNet insurance package.String0..1Coveragecontained[].extensions[].valueAddress.postalcode--insurance-package-zipContained
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.String0..1Coveragecontained[].extensions[].valueInteger--insurance-phoneContained
insurances.insuranceplandisplayname-Superpackagename of the specific insurance package.String0..1Coveragecontained[].class.extension[].valueString--insurance-plan-display-nameContained
insurances.insuranceplanname-Name of the specific insurance package.String0..1Coveragecontained[*].class.name---Contained
insurances.insurancepolicyholder-The full name of the insurance policy holder.String0..1Coveragecontained[*].policyholder.reference---Contained
insurances.insurancepolicyholderaddress1-The first address line of the insurance policy holder.String0..1Coveragecontained[].policyholder.extensions[].valueAddress.line[1]--insurance-policy-holder-address-1Contained
insurances.insurancepolicyholderaddress2-The second address line of the insurance policy holder.String0..1Coveragecontained[].policyholder.extensions[].valueAddress.line[2]--insurance-policy-holder-address-2Contained
insurances.insurancepolicyholdercity-"The city of the insurance policy holder.String0..1Coveragecontained[].policyholder.extensions[].valueAddress.city--insurance-policy-holder-cityContained
insurances.insurancepolicyholdercountrycode-The country code (3 letter) of the insurance policy holder.String0..1Coveragecontained[].policyholder.extensions[].valueString--insurance-policy-holder-country-codeContained
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.String0..1Coveragecontained[].policyholder.extensions[].valueAddress.country--insurance-policy-holder-country-iso3166Contained
insurances.insurancepolicyholderdob-The DOB of the insurance policy holder (mm/dd/yyyy).String0..1Coveragecontained[].policyholder.extensions[].valueString--insurance-policy-holder-dobContained
insurances.insurancepolicyholderfirstname-The first name of the insurance policy holder. Except for self-pay, required for new policies.String0..1Coveragepolicyholder.extensions[*].valueHumanName.given[1]--insurance-policy-holder-first-nameContained
insurances.insurancepolicyholderlastname-The last name of the insurance policy holder. Except for self-pay, required for new policies.String0..1Coveragepolicyholder.extensions[*].valueHumanName.family--insurance-policy-holder-last-nameContained
insurances.insurancepolicyholdermiddlename-The middle name of the insurance policy holder.String0..1Coveragepolicyholder.extensions[*].valueHumanName.given[2]--insurance-policy-holder-middle-nameContained
insurances.insurancepolicyholdersex-The sex of the insurance policy holder. Except for self-pay, required for new policies.String0..1Coveragecontained[].policyholder.extensions[].valueString--insurance-policy-holder-sexContained
insurances.insurancepolicyholderssn-The SSN of the insurance policy holder.String0..1Coveragecontained[].policyholder.extensions[].valueString--insurance-policy-holder-ssnContained
insurances.insurancepolicyholderstate-The state of the insurance policy holder.String0..1Coveragecontained[].policyholder.extensions[].valueAddress.state--insurance-policy-holder-stateContained
insurances.insurancepolicyholdersuffix-The suffix of the insurance policy holder.String0..1Coveragepolicyholder.extensions[*].valueHumanName.suffix--insurance-policy-holder-suffixContained
insurances.insurancepolicyholderzip-The zip of the insurance policy holder.String0..1Coveragecontained[].policyholder.extensions[].valueAddress.postalCode--insurance-policy-holder-zipContained
insurances.insuranceproducttype-The athenaNet insurance product type.String0..1Coveragecontained[].extensions[].valueString--insurance-product-typeContained
insurances.insurancetype-Type of insurance. E.g., Medicare Part B, Group Policy, HMO, etc.String0..1Coveragecontained[*].class[1].type.text---Contained
insurances.insuredentitytypeid-The ID of the entity type for this insurance.Integer0..1Coveragecontained[].extensions[].valueInteger--insured-entity-type-idContained
insurances.insuredidnumber-The insurance policy ID number of insured.String0..1Coveragecontained[].extensions[].valueString--insured-id-numberContained
insurances.insuredpcp--String0..1Coveragecontained[].extensions[].valueString--insured-pcpContained
insurances.insuredpcpnpi-The national provider id of the primary care physcian assicated with the insurance.Integer0..1Coveragecontained[].extensions[].valueInteger--insured-pcp-npiContained
insurances.insuredreferringprovider-The referring provider that is associated with the insurance.String0..1Coveragecontained[].extensions[].valueString--insured-referring-providerContained
insurances.ircid-Insurance category / company internal ID.Integer0..1Coveragecontained[].extensions[].valueInteger--irc-idContained
insurances.ircname-Insurance category / company. E.g., United Healthcare, BCBS-MA, etc.String0..1Coveragecontained[].extensions[].valueString--irc-nameContained
insurances.issuedate-Date the insurance was issued.String0..1Coveragecontained[].extensions[].valueString--issue-dateContained
insurances.note-The athenaNet insurance notes.String0..1Coveragecontained[].extensions[].valueString--noteContained
insurances.policynumber-The insurance group number. This is sometimes present on an insurance card.String0..1Coveragecontained[*].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.String0..1Coveragecontained[].extensions[].valueBoolean--related-to-auto-accidentContained
insurances.relatedtoemploymentyn-CASE POLICY FIELD - Boolean field indicating whether this case policy is related to the patient's employer.String0..1Coveragecontained[].extensions[].valueBoolean--related-to-employmentContained
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.String0..1Coveragecontained[].extensions[].valueBoolean--related-to-other-accidentContained
insurances.relationshiptoinsured-This patient's relationship to the policy holder (text).String0..1Coveragecontained[*].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\u003EInteger0..1Coveragecontained[*].relationship.coding[1].code---Contained
insurances.repricername-CASE POLICY FIELD - Name for the repricer. Only available for worker's comp case policies.String0..1Coveragecontained[].extensions[].valueString--repricer-nameContained
insurances.repricerphone-CASE POLICY FIELD - Phone number for the repricer. Only available for worker's comp case policies.String0..1Coveragecontained[].extensions[].valueString--repricer-phoneContained
insurances.sequencenumber-1 = primary, 2 = secondary, 3 = tertiary, etc. Must have a primary before a secondary and a secondary before a tertiary, etc.Integer0..1Coveragecontained[].extensions[].valueInteger--sequence-numberContained
insurances.slidingfeeplanid-If the patient is on a sliding fee plan, this is the ID of that plan. See /slidingfeeplans.Integer0..1Coveragecontained[].extensions[].valueInteger--sliding-fee-plan-idContained
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.String0..1Coveragecontained[].extensions[].valueString--state-of-reported-injuryContained
useexpectedprocedurecodes.procedurecode-The ID of the code.String0..1Appointmentreasoncode[].coding[].code---Top Level
useexpectedprocedurecodes.procedurecodedescription-The description of the code.String0..1Appointmentreasoncode[].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.Boolean0..1Appointmentextension[*].valueBoolean--do-not-send-confirmation-emailTop Level
nopatientcase-By default, we create a patient case upon booking an appointment for new patients. Setting this to true bypasses that patient case.Boolean0..1Appointmentextension[*].valueBoolean--no-patient-caseTop Level
insuranceinfo.insurancegroupid-Identifier for the insurance group.String0..1Coveragecontained[].identifier[].valueidentifier[*].type.text=insurance-group-idContained
insuranceinfo.insurancecompany-Name of the insurance company.String0..1Coveragecontained[].extensions[].valueStringinsurance-companyContained
created(appointment note)-The time this note was created (mm/dd/yyyy hh24:mi:ss).string0..1Appointmentextension[].valueAnnotation[].timenoteTop Level
createdby(appointment note)-The user that created this note.string0..1Appointmentextension[].valueAnnotation[].author.authorStringnoteTop Level
deleted(appointment note)-The time this note was deleted (mm/dd/yyyy hh24:mi:ss). Not present if not deleted.string0..1Appointmentextension[].valueAnnotation[].extension.valueDateTimenotenote-deletedTop Level
deletedby(appointment note)-If deleted, the username who deleted this note.string0..1Appointmentextension[].valueAnnotation[].extension.valueStringnotenote-deleted-byTop Level
displayonschedule(appointment note)-Determines if an appointment note displays on the homepage schedule view.string0..1Appointmentextension[].valueAnnotation[].extension.valueStringnotedisplay-on-scheduleTop Level
lastmodified(appointment note)-The time this note was updated (mm/dd/yyyy hh24:mi:ss), if the note has been updated.string0..1Appointmentextension[].valueAnnotation[].extension.valueDateTimenotelast-modifiedTop Level
lastmodifiedby(appointment note)-If the note has been modified, the username who last modified this note.string0..1Appointmentextension[].valueAnnotation[].extension.valueStringnotelast-modified-byTop Level
noteid(appointment note)-The ID for this note, for use with DELETE and PUT calls.string0..1Appointmentextension[].valueAnnotation[].idnoteTop Level
notetext(appointment note)-The text of the note itself.string0..1Appointmentextension[].valueAnnotation[].textnoteTop Level
customfields.customfieldid-Corresponds to the /customfields customfieldid.String0..1QuestionnaireResponseitem.linkId---Contained
customfields.customfieldvalue-For a non-select custom field, the value.String0..1QuestionnaireResponseitem.answer.valueString/item.answer.valueCoding.display---Contained
customfields.optionid-For a select custom field, the selectid value (from /customfield's selectlist).String0..1QuestionnaireResponseitem.answer.valueCoding.code--Contained