# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Drchrono Clinical API version: 1.0.0 extends: openapi/drchrono-clinical-api-openapi.yml actions: - target: $.info update: x-apievangelist-phrasing: method: generated generated: '2026-09-26' generator: build-phrasing.py label: Generated by API Evangelist operations: 231 - target: $.paths['/api/claim_billing_notes'].get update: x-apievangelist-phrasing: intent: List claim billing notes effect: read questions: - Can I see the billing notes attached to a patient's claim? - Which billing notes has a given doctor left on appointments? instructions: - text: List billing notes for appointment {appointment}. slots: appointment: query.appointment - text: Show claim billing notes written for doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/claim_billing_notes'].post update: x-apievangelist-phrasing: intent: Add a billing note to a claim effect: write questions: - How do I add a billing note to an appointment's claim in drchrono? - Can I attach a note for the billing team to a visit's claim? instructions: - text: Add a claim billing note to appointment {appointment}. slots: appointment: query.appointment - text: Create a billing note on appointment {appointment} for doctor {doctor}. slots: appointment: query.appointment doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/signed_consent_forms'].get update: x-apievangelist-phrasing: intent: List signed consent forms effect: read questions: - Which consent forms has a patient already signed? - Can I list every signed consent form for one doctor's patients? instructions: - text: List the consent forms patient {patient} has signed. slots: patient: query.patient - text: Show signed consent forms for doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/signed_consent_forms'].post update: x-apievangelist-phrasing: intent: Record a patient's consent form signature effect: write questions: - How do I record that a patient signed a consent form for an appointment? - Can I upload a patient's signature image with the consent record? instructions: - text: Record that patient {patient} signed consent form {consent_form} for appointment {appointment}. slots: patient: query.patient consent_form: query.consent_form appointment: query.appointment - text: Save signature {signature_file} for patient {patient} on consent form {consent_form} at appointment {appointment}. slots: signature_file: query.signature_file patient: query.patient consent_form: query.consent_form appointment: query.appointment method: generated generated: '2026-09-26' - target: $.paths['/api/signed_consent_forms'].patch update: x-apievangelist-phrasing: intent: Update or archive a consent signature effect: write questions: - Can I archive a patient's consent form signature? - How do I move an existing consent signature to a different appointment? instructions: - text: Archive consent signature {signature_id}. slots: signature_id: query.id - text: Reassign consent signature {signature_id} to appointment {appointment}. slots: signature_id: query.id appointment: requestBody.appointment method: generated generated: '2026-09-26' - target: $.paths['/api/custom_appointment_fields'].get update: x-apievangelist-phrasing: intent: List custom appointment fields effect: read questions: - What custom fields have we added to appointments? - Which extra appointment fields has a doctor configured? instructions: - text: List the custom appointment fields. - text: Show custom appointment fields set up by doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/custom_appointment_fields'].post update: x-apievangelist-phrasing: intent: Create a custom appointment field effect: write questions: - How do I add my own field to appointments? - Can I create an extra data field to capture on each visit? instructions: - text: Create a custom appointment field for doctor {doctor}. slots: doctor: query.doctor - text: Add a new custom field to the appointment form. method: generated generated: '2026-09-26' - target: $.paths['/api/lab_orders/{id}'].get update: x-apievangelist-phrasing: intent: Get a lab order effect: read questions: - Can I pull up a single lab order and its status? - What tests were requested on a specific lab order? instructions: - text: Show lab order {order_id}. slots: order_id: path.id - text: Get the status of lab order {order_id}. slots: order_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_orders/{id}'].put update: x-apievangelist-phrasing: intent: Replace a lab order effect: write questions: - How do I overwrite a lab order with fully updated details? - Can I resend a complete lab order record to replace the old one? instructions: - text: Replace lab order {order_id} with the full updated order. slots: order_id: path.id - text: Overwrite all fields of lab order {order_id}. slots: order_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_orders/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a lab order effect: destructive questions: - Can I remove a lab order that was submitted by mistake? - What happens if I delete a lab order? instructions: - text: Delete lab order {order_id}. slots: order_id: path.id - text: Remove the mistaken lab order {order_id}. slots: order_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_orders/{id}'].patch update: x-apievangelist-phrasing: intent: Update a lab order's status effect: write questions: - How do I mark a lab order as having results in? - Can I change only the status on a lab order? instructions: - text: Set the status of lab order {order_id} to resulted. slots: order_id: path.id - text: Patch just the status field on lab order {order_id}. slots: order_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/clinical_notes_list'].get update: x-apievangelist-phrasing: intent: Fetch a batch of clinical notes effect: read questions: - How do I collect the results of a clinical notes batch I already requested? - Is my bulk clinical notes export ready yet? instructions: - text: Fetch the clinical notes batch {uuid}. slots: uuid: query.uuid - text: Check the status of clinical notes batch request {uuid}. slots: uuid: query.uuid method: generated generated: '2026-09-26' - target: $.paths['/api/clinical_notes_list'].post update: x-apievangelist-phrasing: intent: Request a batch export of clinical notes effect: read questions: - How do I export a large history of clinical notes in batches? - Can I queue a bulk clinical notes request for one doctor since a date? instructions: - text: Start a batch clinical notes request for doctor {doctor} since {since}. slots: doctor: query.doctor since: query.since - text: Queue a bulk export of clinical notes for patient {patient}. slots: patient: query.patient method: generated generated: '2026-09-26' - target: $.paths['/api/custom_vitals/{id}'].get update: x-apievangelist-phrasing: intent: Get a custom vital type effect: read questions: - How is a particular custom vital sign defined? - Can I look up one custom vital type by ID? instructions: - text: Show custom vital type {vital_id}. slots: vital_id: path.id - text: Get the definition of custom vital {vital_id}. slots: vital_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/sublabs/{id}'].get update: x-apievangelist-phrasing: intent: Get a lab sub-vendor effect: read questions: - Can I look up one sublab's details? - What is configured for a particular lab sub-vendor? instructions: - text: Show sublab {sublab_id}. slots: sublab_id: path.id - text: Get details of lab sub-vendor {sublab_id}. slots: sublab_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/sublabs/{id}'].put update: x-apievangelist-phrasing: intent: Replace a lab sub-vendor effect: write questions: - How do I overwrite all details of a sublab? - Can I fully replace a lab sub-vendor record? instructions: - text: Replace sublab {sublab_id} with new details. slots: sublab_id: path.id - text: Overwrite every field of lab sub-vendor {sublab_id}. slots: sublab_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/sublabs/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a lab sub-vendor effect: destructive questions: - Can I remove a sublab we no longer use? - How do I delete a lab sub-vendor? instructions: - text: Delete sublab {sublab_id}. slots: sublab_id: path.id - text: Remove lab sub-vendor {sublab_id}. slots: sublab_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/sublabs/{id}'].patch update: x-apievangelist-phrasing: intent: Rename or tweak a lab sub-vendor effect: write questions: - Can I rename a sublab without resending everything? - How do I change one detail of a lab sub-vendor? instructions: - text: Rename sublab {sublab_id}. slots: sublab_id: path.id - text: Patch one field of lab sub-vendor {sublab_id}. slots: sublab_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patients/{id}/qrda1'].get update: x-apievangelist-phrasing: intent: Download a patient's QRDA I report effect: read questions: - How do I get a QRDA Category I file for quality reporting? - Can I export a patient's QRDA1 for CQM submission? instructions: - text: Download the QRDA1 for patient {patient_id}. slots: patient_id: path.id - text: Export patient {patient_id}'s QRDA Category I report. slots: patient_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/problems'].get update: x-apievangelist-phrasing: intent: List patient problems effect: read questions: - What's on a patient's problem list? - Can I see the diagnoses a doctor has charted as problems? instructions: - text: List the problems for patient {patient}. slots: patient: query.patient - text: Show problem list entries charted by doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/problems'].post update: x-apievangelist-phrasing: intent: Add a problem to a patient's chart effect: write questions: - How do I add a diagnosis to a patient's problem list? - Can I record a new chronic condition for a patient? instructions: - text: Add a problem to patient {patient}'s problem list. slots: patient: query.patient - text: Chart a new condition for patient {patient} under doctor {doctor}. slots: patient: query.patient doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/staff'].get update: x-apievangelist-phrasing: intent: List practice staff effect: read questions: - Who are the staff members in my practice? - Can I list staff that work for a given doctor? instructions: - text: List the practice's staff members. - text: Show staff working for doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/patient_messages/{id}'].get update: x-apievangelist-phrasing: intent: Get a patient message effect: read questions: - Can I open one patient message and its thread? - What did a specific message to a patient say? instructions: - text: Show patient message {message_id}. slots: message_id: path.id - text: Open message {message_id} in thread {thread}. slots: message_id: path.id thread: query.thread method: generated generated: '2026-09-26' - target: $.paths['/api/patient_messages/{id}'].put update: x-apievangelist-phrasing: intent: Replace a patient message effect: write questions: - How do I overwrite a patient message record entirely? - Can I resend a full patient message to replace it? instructions: - text: Replace patient message {message_id}. slots: message_id: path.id - text: Overwrite all fields of patient message {message_id}. slots: message_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_messages/{id}'].patch update: x-apievangelist-phrasing: intent: Edit part of a patient message effect: write questions: - Can I mark a patient message as read? - How do I change one field on a message sent to a patient? instructions: - text: Correct part of patient message {message_id}. slots: message_id: path.id - text: Patch one field on patient message {message_id}. slots: message_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/medications'].get update: x-apievangelist-phrasing: intent: List patient medications effect: read questions: - What medications is a patient taking? - Can I list the prescriptions a doctor has on file? instructions: - text: List medications for patient {patient}. slots: patient: query.patient - text: Show medications prescribed by doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/medications'].post update: x-apievangelist-phrasing: intent: Add a medication to a patient's chart effect: write questions: - How do I add a medication to a patient's med list? - Can I record a prescription a patient is already on? instructions: - text: Add a medication to patient {patient}'s chart. slots: patient: query.patient - text: Record a new medication for patient {patient} by doctor {doctor}. slots: patient: query.patient doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/custom_demographics'].get update: x-apievangelist-phrasing: intent: List custom demographics fields effect: read questions: - What custom demographic fields exist for patient records? - Which extra patient demographic fields has a doctor defined? instructions: - text: List custom demographics fields. - text: Show custom demographics fields for doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/custom_demographics'].post update: x-apievangelist-phrasing: intent: Create a custom demographics field effect: write questions: - How do I capture an extra demographic detail on patients? - Can I define a new custom demographics field for my practice? instructions: - text: Create a custom demographics field for doctor {doctor}. slots: doctor: query.doctor - text: Add a new custom patient demographics field. method: generated generated: '2026-09-26' - target: $.paths['/api/appointments_list'].get update: x-apievangelist-phrasing: intent: Page through the appointments list endpoint effect: read questions: - Is there a separate appointments list endpoint for paging large result sets? - Can I page the appointments list feed by status and office? instructions: - text: Page the appointments list feed for office {office} on {date}. slots: office: query.office date: query.date - text: Pull the appointments list feed with status {status} since {since}. slots: status: query.status since: query.since method: generated generated: '2026-09-26' - target: $.paths['/api/appointments_list'].post update: x-apievangelist-phrasing: intent: Request a batch export of appointments effect: read questions: - How do I bulk export appointments in batches? - Can I queue a batch appointment request sorted a particular way? instructions: - text: Start a batch appointments request for doctor {doctor} over {date_range}. slots: doctor: query.doctor date_range: query.date_range - text: Queue a bulk appointment export for patient {patient} ordered by {order_by}. slots: patient: query.patient order_by: query.order_by method: generated generated: '2026-09-26' - target: $.paths['/api/appointment_profiles'].get update: x-apievangelist-phrasing: intent: List appointment profiles effect: read questions: - What visit types are set up on a doctor's calendar? - Can I see the appointment profiles with their default durations? instructions: - text: List appointment profiles for doctor {doctor}. slots: doctor: query.doctor - text: Show all visit type profiles. method: generated generated: '2026-09-26' - target: $.paths['/api/appointment_profiles'].post update: x-apievangelist-phrasing: intent: Create an appointment profile effect: write questions: - How do I add a new visit type like a 30-minute follow-up? - Can I create an appointment profile for a doctor's calendar? instructions: - text: Create an appointment profile for doctor {doctor}. slots: doctor: query.doctor - text: Add a 30-minute follow-up visit type. method: generated generated: '2026-09-26' - target: $.paths['/api/patient_communications'].get update: x-apievangelist-phrasing: intent: List CQM patient communications effect: read questions: - Which provider-to-patient communications are logged for quality measures? - Can I list CQM communications for one patient? instructions: - text: List CQM communications for patient {patient}. slots: patient: query.patient - text: Show patient communications logged by doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/patient_communications'].post update: x-apievangelist-phrasing: intent: Record a CQM patient communication effect: write questions: - How do I log that we communicated results to a patient for CQM? - Can I record a patient communication for quality reporting? instructions: - text: Record a CQM communication with patient {patient}. slots: patient: query.patient - text: Log a provider communication to patient {patient} by doctor {doctor}. slots: patient: query.patient doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/appointment_profiles/{id}'].get update: x-apievangelist-phrasing: intent: Get an appointment profile effect: read questions: - Can I look up one visit type's settings? - What duration and color does a specific appointment profile use? instructions: - text: Show appointment profile {profile_id}. slots: profile_id: path.id - text: Get the duration of visit type {profile_id}. slots: profile_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/appointment_profiles/{id}'].put update: x-apievangelist-phrasing: intent: Replace an appointment profile effect: write questions: - How do I overwrite a visit type's settings completely? - Can I redefine an entire appointment profile? instructions: - text: Replace appointment profile {profile_id}. slots: profile_id: path.id - text: Overwrite every setting of visit type {profile_id}. slots: profile_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/appointment_profiles/{id}'].delete update: x-apievangelist-phrasing: intent: Delete an appointment profile effect: destructive questions: - Can I remove a visit type we no longer offer? - How do I delete an appointment profile? instructions: - text: Delete appointment profile {profile_id}. slots: profile_id: path.id - text: Remove visit type {profile_id}. slots: profile_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/appointment_profiles/{id}'].patch update: x-apievangelist-phrasing: intent: Tweak an appointment profile effect: write questions: - Can I change just the duration of a visit type? - How do I recolor an appointment profile? instructions: - text: Change the duration of appointment profile {profile_id}. slots: profile_id: path.id - text: Recolor visit type {profile_id}. slots: profile_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/clinical_note_field_values/{id}'].get update: x-apievangelist-phrasing: intent: Get a clinical note field value effect: read questions: - Can I look up one value entered into a clinical note? - What was recorded in a specific note field value? instructions: - text: Show clinical note field value {value_id}. slots: value_id: path.id - text: Get recorded note value {value_id}. slots: value_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/clinical_note_field_values/{id}'].put update: x-apievangelist-phrasing: intent: Replace a clinical note field value effect: write questions: - How do I overwrite a value entered into a clinical note field? - Can I fully replace a recorded note field value? instructions: - text: Replace clinical note field value {value_id}. slots: value_id: path.id - text: Overwrite the whole record for note value {value_id}. slots: value_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/clinical_note_field_values/{id}'].patch update: x-apievangelist-phrasing: intent: Change a clinical note field's text effect: write questions: - Can I correct just the text in one clinical note field? - How do I edit a single value already recorded on a note? instructions: - text: Change the text of note field value {value_id}. slots: value_id: path.id - text: Correct only the value on clinical note entry {value_id}. slots: value_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/fee_schedules_v2'].get update: x-apievangelist-phrasing: intent: List v2 fee schedules effect: read questions: - Which v2 fee schedules apply to a payer plan? - Can I find fee schedules effective on a given date? instructions: - text: List v2 fee schedules for plan {plan_name}. slots: plan_name: query.plan_name - text: Show v2 fee schedules effective {effective_date} for payer {payer_id}. slots: effective_date: query.effective_date payer_id: query.payer_id method: generated generated: '2026-09-26' - target: $.paths['/api/care_team_members'].get update: x-apievangelist-phrasing: intent: List care team members effect: read questions: - Who is on a patient's care team? - Can I see the care team assigned for an appointment? instructions: - text: List care team members for patient {patient}. slots: patient: query.patient - text: Show the care team on appointment {appointment}. slots: appointment: query.appointment method: generated generated: '2026-09-26' - target: $.paths['/api/consent_forms/{id}/unapply_from_appointment'].post update: x-apievangelist-phrasing: intent: Remove a consent form from an appointment effect: write questions: - Can I take a consent form off an appointment it was assigned to? - How do I stop asking a patient to sign a form at their visit? instructions: - text: Unapply consent form {form_id} from the appointment. slots: form_id: path.id - text: Unassign consent form {form_id} from a visit. slots: form_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/consent_forms/{id}/apply_to_appointment'].post update: x-apievangelist-phrasing: intent: Assign a consent form to an appointment effect: write questions: - How do I attach a consent form to an upcoming appointment so the patient signs it? - Can I require a specific consent form for a visit? instructions: - text: Apply consent form {form_id} to the appointment. slots: form_id: path.id - text: Assign consent form {form_id} to a visit for doctor {doctor}. slots: form_id: path.id doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/consent_forms'].get update: x-apievangelist-phrasing: intent: List consent form templates effect: read questions: - What consent forms does my practice have set up? - Which consent form templates belong to a given doctor? instructions: - text: List the practice's consent forms. - text: Show consent forms owned by doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/consent_forms'].post update: x-apievangelist-phrasing: intent: Create a consent form effect: write questions: - How do I add a new consent form patients can sign? - Can I set up a consent form for a specific doctor? instructions: - text: Create a new consent form for doctor {doctor}. slots: doctor: query.doctor - text: Add a consent form template to the practice. method: generated generated: '2026-09-26' - target: $.paths['/api/reminder_profiles/{id}'].get update: x-apievangelist-phrasing: intent: Get a reminder profile effect: read questions: - Can I look up how one reminder profile is configured? - When does a specific reminder profile send its reminders? instructions: - text: Show reminder profile {reminder_id}. slots: reminder_id: path.id - text: Get the schedule of reminder profile {reminder_id}. slots: reminder_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/reminder_profiles/{id}'].put update: x-apievangelist-phrasing: intent: Replace a reminder profile effect: write questions: - How do I overwrite a reminder profile completely? - Can I redefine all reminders in a profile at once? instructions: - text: Replace reminder profile {reminder_id}. slots: reminder_id: path.id - text: Overwrite every reminder in profile {reminder_id}. slots: reminder_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/reminder_profiles/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a reminder profile effect: destructive questions: - Can I delete a reminder profile we stopped using? - How do I remove a reminder schedule? instructions: - text: Delete reminder profile {reminder_id}. slots: reminder_id: path.id - text: Remove reminder schedule {reminder_id}. slots: reminder_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/reminder_profiles/{id}'].patch update: x-apievangelist-phrasing: intent: Adjust a reminder profile effect: write questions: - Can I rename a reminder profile without redefining it? - How do I change one setting on a reminder profile? instructions: - text: Rename reminder profile {reminder_id}. slots: reminder_id: path.id - text: Patch one setting of reminder profile {reminder_id}. slots: reminder_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patients_list'].get update: x-apievangelist-phrasing: intent: Fetch a batch of patients effect: read questions: - How do I retrieve a patient batch I requested with a UUID? - Is my bulk patient export ready to download? instructions: - text: Fetch patient batch {uuid}. slots: uuid: query.uuid - text: Check the status of patient list request {uuid}. slots: uuid: query.uuid method: generated generated: '2026-09-26' - target: $.paths['/api/patients_list'].post update: x-apievangelist-phrasing: intent: Request a batch export of patients effect: read questions: - How do I bulk load a large historical list of patients? - Can I queue a batch patient request filtered by last name or date of birth? instructions: - text: Start a batch patient list request for patients updated since {since}. slots: since: query.since - text: Queue a bulk patient export for last name {last_name}. slots: last_name: query.last_name method: generated generated: '2026-09-26' - target: $.paths['/api/patient_interventions'].get update: x-apievangelist-phrasing: intent: List CQM patient interventions effect: read questions: - What interventions have been logged for a patient's quality measures? - Can I list CQM interventions recorded by a doctor? instructions: - text: List CQM interventions for patient {patient}. slots: patient: query.patient - text: Show interventions logged by doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/patient_interventions'].post update: x-apievangelist-phrasing: intent: Record a CQM intervention effect: write questions: - How do I record counseling or another intervention for CQM? - Can I log a tobacco cessation intervention for a patient? instructions: - text: Record a CQM intervention for patient {patient}. slots: patient: query.patient - text: Log a counseling intervention for patient {patient} by doctor {doctor}. slots: patient: query.patient doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/patient_messages'].get update: x-apievangelist-phrasing: intent: List patient messages effect: read questions: - What messages have been sent to a patient through the portal? - Can I see patient messages since a certain date? instructions: - text: List messages for patient {patient}. slots: patient: query.patient - text: Show patient messages since {since}. slots: since: query.since method: generated generated: '2026-09-26' - target: $.paths['/api/patient_messages'].post update: x-apievangelist-phrasing: intent: Send a message to a patient effect: write questions: - How do I send a secure message to a patient? - Can a doctor message a patient through the API? instructions: - text: Send a message to patient {patient}. slots: patient: query.patient - text: Message patient {patient} on behalf of doctor {doctor}. slots: patient: query.patient doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/patient_physical_exams/{id}'].get update: x-apievangelist-phrasing: intent: Get a CQM physical exam effect: read questions: - Can I look up one physical exam logged for CQM? - What result was recorded on a specific CQM exam? instructions: - text: Show physical exam {exam_id}. slots: exam_id: path.id - text: Get CQM exam record {exam_id}. slots: exam_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_physical_exams/{id}'].put update: x-apievangelist-phrasing: intent: Replace a CQM physical exam effect: write questions: - How do I overwrite a CQM physical exam record entirely? - Can I resend a full physical exam entry to replace it? instructions: - text: Replace physical exam {exam_id}. slots: exam_id: path.id - text: Overwrite all fields of CQM exam {exam_id}. slots: exam_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_physical_exams/{id}'].patch update: x-apievangelist-phrasing: intent: Correct part of a CQM physical exam effect: write questions: - Can I fix just the value on a CQM physical exam? - How do I change the exam date on a quality-measure exam? instructions: - text: Correct the value on physical exam {exam_id}. slots: exam_id: path.id - text: Change the date of CQM exam {exam_id}. slots: exam_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/clinical_note_field_values'].get update: x-apievangelist-phrasing: intent: List clinical note field values effect: read questions: - What values were entered into note fields for an appointment? - Can I see the answers recorded for one clinical note template field? instructions: - text: List clinical note field values for appointment {appointment}. slots: appointment: query.appointment - text: Show values entered for note field {clinical_note_field}. slots: clinical_note_field: query.clinical_note_field method: generated generated: '2026-09-26' - target: $.paths['/api/clinical_note_field_values'].post update: x-apievangelist-phrasing: intent: Record a clinical note field value effect: write questions: - How do I fill in a field on a patient's clinical note? - Can I write a value into a template field for an appointment? instructions: - text: Record a value for note field {clinical_note_field} on appointment {appointment}. slots: clinical_note_field: query.clinical_note_field appointment: query.appointment - text: Fill in a clinical note field on appointment {appointment}. slots: appointment: query.appointment method: generated generated: '2026-09-26' - target: $.paths['/api/patients'].get update: x-apievangelist-phrasing: intent: List or search patients effect: read questions: - How do I find a patient by name and date of birth? - Can I search patients by email or chart ID? - Which patients were added or changed since a date? instructions: - text: Find patients named {first_name} {last_name}. slots: first_name: query.first_name last_name: query.last_name - text: Look up the patient with chart ID {chart_id}. slots: chart_id: query.chart_id - text: List patients updated since {since}. slots: since: query.since method: generated generated: '2026-09-26' - target: $.paths['/api/patients'].post update: x-apievangelist-phrasing: intent: Register a new patient effect: write questions: - How do I create a new patient record in drchrono? - Can I add a patient even if they look like a duplicate? instructions: - text: Create a patient {first_name} {last_name} born {date_of_birth} for doctor {doctor}. slots: first_name: query.first_name last_name: query.last_name date_of_birth: query.date_of_birth doctor: query.doctor - text: Register patient {first_name} {last_name} and allow duplicates. slots: first_name: query.first_name last_name: query.last_name method: generated generated: '2026-09-26' - target: $.paths['/api/implantable_devices/{id}'].get update: x-apievangelist-phrasing: intent: Get an implantable device effect: read questions: - Can I look up one implanted device's details? - What is the device identifier on a patient's implant record? instructions: - text: Show implantable device {device_id}. slots: device_id: path.id - text: Get the implant record {device_id}. slots: device_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_communications/{id}'].get update: x-apievangelist-phrasing: intent: Get a CQM patient communication effect: read questions: - Can I look up one logged CQM communication? - What was recorded on a specific patient communication entry? instructions: - text: Show patient communication {communication_id}. slots: communication_id: path.id - text: Get CQM communication {communication_id}. slots: communication_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_communications/{id}'].put update: x-apievangelist-phrasing: intent: Replace a CQM patient communication effect: write questions: - How do I overwrite a logged patient communication in full? - Can I resend a complete CQM communication to replace it? instructions: - text: Replace patient communication {communication_id}. slots: communication_id: path.id - text: Overwrite all fields of CQM communication {communication_id}. slots: communication_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_communications/{id}'].patch update: x-apievangelist-phrasing: intent: Correct part of a CQM communication effect: write questions: - Can I fix one field on a logged patient communication? - How do I change the date of a CQM communication? instructions: - text: Correct one field on patient communication {communication_id}. slots: communication_id: path.id - text: Change the date of CQM communication {communication_id}. slots: communication_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/prescription_messages/{id}'].get update: x-apievangelist-phrasing: intent: Get a prescription message effect: read questions: - Can I open one e-prescribing message? - What did a specific pharmacy message say? instructions: - text: Show prescription message {message_id}. slots: message_id: path.id - text: Open pharmacy message {message_id}. slots: message_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/implantable_devices'].get update: x-apievangelist-phrasing: intent: List implantable devices effect: read questions: - What implanted devices does a patient have? - Can I list implantable devices for a meaningful-use date range? instructions: - text: List implantable devices for patient {patient}. slots: patient: query.patient - text: Show implantable devices within MU date range {mu_date_range}. slots: mu_date_range: query.mu_date_range method: generated generated: '2026-09-26' - target: $.paths['/api/patient_risk_assessments'].get update: x-apievangelist-phrasing: intent: List patient risk assessments effect: read questions: - What risk assessments have been done for a patient? - Can I list risk assessments recorded by a doctor? instructions: - text: List risk assessments for patient {patient}. slots: patient: query.patient - text: Show risk assessments recorded by doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/patient_risk_assessments'].post update: x-apievangelist-phrasing: intent: Record a patient risk assessment effect: write questions: - How do I log a fall-risk or other risk assessment for a patient? - Can I add a risk assessment to a patient's chart? instructions: - text: Record a risk assessment for patient {patient}. slots: patient: query.patient - text: Add a risk assessment for patient {patient} by doctor {doctor}. slots: patient: query.patient doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/patients_summary'].get update: x-apievangelist-phrasing: intent: List patient summaries effect: read questions: - Is there a lightweight patient list with just names and birthdays? - Can I search patient summaries by gender or date of birth? instructions: - text: List patient summaries for doctor {doctor}. slots: doctor: query.doctor - text: Find patient summaries born on {date_of_birth}. slots: date_of_birth: query.date_of_birth method: generated generated: '2026-09-26' - target: $.paths['/api/patients_summary'].post update: x-apievangelist-phrasing: intent: Create a patient from summary fields effect: write questions: - Can I create a patient with only basic summary details? - How do I add a patient using just name, gender and birth date? instructions: - text: Create a summary patient {first_name} {last_name} born {date_of_birth}. slots: first_name: query.first_name last_name: query.last_name date_of_birth: query.date_of_birth - text: Add a basic patient summary record for doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/documents/{id}'].get update: x-apievangelist-phrasing: intent: Get a patient document effect: read questions: - Can I download one document from a patient's chart? - What is the description and date of a specific document? instructions: - text: Show document {document_id}. slots: document_id: path.id - text: Download patient document {document_id}. slots: document_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/documents/{id}'].put update: x-apievangelist-phrasing: intent: Replace a patient document effect: write questions: - How do I replace a chart document with a new file? - Can I overwrite a patient document record in full? instructions: - text: Replace document {document_id} with a new file. slots: document_id: path.id - text: Overwrite all fields of patient document {document_id}. slots: document_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/documents/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a patient document effect: destructive questions: - Can I delete a document uploaded to the wrong patient? - How do I remove a file from a patient's chart? instructions: - text: Delete document {document_id}. slots: document_id: path.id - text: Remove patient document {document_id} from the chart. slots: document_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/documents/{id}'].patch update: x-apievangelist-phrasing: intent: Edit a patient document's details effect: write questions: - Can I rename or re-describe a chart document without re-uploading it? - How do I change the date on a patient document? instructions: - text: Change the description of document {document_id}. slots: document_id: path.id - text: Update the date on patient document {document_id}. slots: document_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patients/{id}/onpatient_access'].get update: x-apievangelist-phrasing: intent: Check a patient's onpatient invites effect: read questions: - Has a patient already been invited to the onpatient portal? - Can I see pending onpatient access invites for a patient? instructions: - text: Show onpatient invites for patient {patient_id}. slots: patient_id: path.id - text: Check whether patient {patient_id} has portal access. slots: patient_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patients/{id}/onpatient_access'].post update: x-apievangelist-phrasing: intent: Invite a patient to onpatient effect: write questions: - How do I invite a patient to the onpatient portal? - Can I send a portal invitation to a patient's email? instructions: - text: Send an onpatient invite to patient {patient_id}. slots: patient_id: path.id - text: Invite patient {patient_id} to the portal at {email}. slots: patient_id: path.id email: query.email method: generated generated: '2026-09-26' - target: $.paths['/api/patients/{id}/onpatient_access'].delete update: x-apievangelist-phrasing: intent: Revoke a patient's onpatient invites effect: destructive questions: - Can I cancel an onpatient invite I sent by mistake? - How do I revoke a patient's portal invitations? instructions: - text: Revoke onpatient invites for patient {patient_id}. slots: patient_id: path.id - text: Cancel the portal invitation sent to patient {patient_id}. slots: patient_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_results/{id}'].get update: x-apievangelist-phrasing: intent: Get a lab result effect: read questions: - Can I look up a single lab result value? - What was the value and range on a specific lab result? instructions: - text: Show lab result {result_id}. slots: result_id: path.id - text: Get the value and reference range of lab result {result_id}. slots: result_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_results/{id}'].put update: x-apievangelist-phrasing: intent: Replace a lab result effect: write questions: - How do I overwrite a lab result with a corrected full record? - Can I resend an entire lab result to replace it? instructions: - text: Replace lab result {result_id} with the corrected record. slots: result_id: path.id - text: Overwrite all fields of lab result {result_id}. slots: result_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_results/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a lab result effect: destructive questions: - Can I remove a lab result that was posted in error? - Is it possible to delete a single lab result value? instructions: - text: Delete lab result {result_id}. slots: result_id: path.id - text: Remove the erroneous lab result {result_id}. slots: result_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_results/{id}'].patch update: x-apievangelist-phrasing: intent: Correct part of a lab result effect: write questions: - Can I fix just the value on a lab result? - How do I flag an existing lab result as abnormal? instructions: - text: Correct the value on lab result {result_id}. slots: result_id: path.id - text: Mark lab result {result_id} as abnormal. slots: result_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/medications/{id}'].get update: x-apievangelist-phrasing: intent: Get a patient medication effect: read questions: - Can I look up one medication's dosage and instructions? - What are the details of a specific prescription on file? instructions: - text: Show medication {medication_id}. slots: medication_id: path.id - text: Get dosage details for medication {medication_id}. slots: medication_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/medications/{id}'].put update: x-apievangelist-phrasing: intent: Replace a patient medication effect: write questions: - How do I overwrite a medication record in full? - Can I resend an entire prescription record to replace it? instructions: - text: Replace medication {medication_id}. slots: medication_id: path.id - text: Overwrite all fields of medication record {medication_id}. slots: medication_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/medications/{id}'].patch update: x-apievangelist-phrasing: intent: Change a medication's dose or status effect: write questions: - Can I discontinue a patient's medication? - How do I change the dosage on an existing medication? instructions: - text: Discontinue medication {medication_id}. slots: medication_id: path.id - text: Change the dosage on medication {medication_id}. slots: medication_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/medications/{id}/append_to_pharmacy_note'].patch update: x-apievangelist-phrasing: intent: Append to a prescription's pharmacy note effect: write questions: - Can I add a message to the pharmacy note on a prescription? - How do I append instructions for the pharmacist without overwriting the note? instructions: - text: Append a paragraph to the pharmacy note on medication {medication_id}. slots: medication_id: path.id - text: Add a pharmacist message to prescription {medication_id}'s pharmacy note. slots: medication_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_vaccine_records/{id}'].get update: x-apievangelist-phrasing: intent: Get a vaccine record effect: read questions: - Can I look up one immunization record? - When and where was a specific vaccine administered? instructions: - text: Show vaccine record {record_id}. slots: record_id: path.id - text: Get immunization record {record_id}. slots: record_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_vaccine_records/{id}'].put update: x-apievangelist-phrasing: intent: Replace a vaccine record effect: write questions: - How do I overwrite an immunization record in full? - Can I resend a whole vaccine record to correct it? instructions: - text: Replace vaccine record {record_id}. slots: record_id: path.id - text: Overwrite all fields of immunization record {record_id}. slots: record_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_vaccine_records/{id}'].patch update: x-apievangelist-phrasing: intent: Correct part of a vaccine record effect: write questions: - Can I fix just the lot number on a vaccine record? - How do I update the administration date of a vaccination? instructions: - text: Correct the lot number on vaccine record {record_id}. slots: record_id: path.id - text: Update the administered date of immunization {record_id}. slots: record_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_flag_types/{id}'].get update: x-apievangelist-phrasing: intent: Get a patient flag type effect: read questions: - Can I look up how one patient flag is configured? - What color and name does a specific flag type have? instructions: - text: Show patient flag type {flag_type_id}. slots: flag_type_id: path.id - text: Get flag type {flag_type_id}. slots: flag_type_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_flag_types/{id}'].put update: x-apievangelist-phrasing: intent: Replace a patient flag type effect: write questions: - How do I overwrite a patient flag type completely? - Can I redefine every setting of a flag type? instructions: - text: Replace patient flag type {flag_type_id}. slots: flag_type_id: path.id - text: Overwrite all settings of flag type {flag_type_id}. slots: flag_type_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_flag_types/{id}'].patch update: x-apievangelist-phrasing: intent: Rename or recolor a patient flag type effect: write questions: - Can I rename a patient flag without redefining it? - How do I change the color of a flag type? instructions: - text: Rename patient flag type {flag_type_id}. slots: flag_type_id: path.id - text: Change the color of flag type {flag_type_id}. slots: flag_type_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/clinical_note_field_types/{id}'].get update: x-apievangelist-phrasing: intent: Get a clinical note field type effect: read questions: - Can I look up how one clinical note field is defined? - What kind of input does a specific note field expect? instructions: - text: Show clinical note field type {field_type_id}. slots: field_type_id: path.id - text: Get the definition of note field {field_type_id}. slots: field_type_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/clinical_note_field_types/{id}'].patch update: x-apievangelist-phrasing: intent: Resize a FreeDraw note field image effect: write questions: - Can I change the image size of a FreeDraw field on a clinical note? - What size options are there for a free-draw note field? instructions: - text: Set FreeDraw field {field_type_id} image size to {freedraw_image_size}. slots: field_type_id: path.id freedraw_image_size: requestBody.freedraw_image_size - text: Make the free-draw image on field {field_type_id} medium sized. slots: field_type_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/fee_schedules'].get update: x-apievangelist-phrasing: intent: List fee schedules effect: read questions: - What does my practice charge for a procedure code? - Can I list fee schedule entries for a specific payer? instructions: - text: List fee schedule entries for code {code}. slots: code: query.code - text: Show fees charged to payer {payer_id}. slots: payer_id: query.payer_id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_risk_assessments/{id}'].get update: x-apievangelist-phrasing: intent: Get a patient risk assessment effect: read questions: - Can I look up one risk assessment? - What was the outcome of a specific risk assessment? instructions: - text: Show risk assessment {assessment_id}. slots: assessment_id: path.id - text: Get the result of risk assessment {assessment_id}. slots: assessment_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_risk_assessments/{id}'].put update: x-apievangelist-phrasing: intent: Replace a patient risk assessment effect: write questions: - How do I overwrite a risk assessment record entirely? - Can I resend a full risk assessment to replace it? instructions: - text: Replace risk assessment {assessment_id}. slots: assessment_id: path.id - text: Overwrite all fields of risk assessment {assessment_id}. slots: assessment_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_risk_assessments/{id}'].patch update: x-apievangelist-phrasing: intent: Correct part of a risk assessment effect: write questions: - Can I fix one field on a patient's risk assessment? - How do I update the outcome of a risk assessment? instructions: - text: Correct one field on risk assessment {assessment_id}. slots: assessment_id: path.id - text: Update the outcome of risk assessment {assessment_id}. slots: assessment_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_documents/{id}'].get update: x-apievangelist-phrasing: intent: Get a lab result document effect: read questions: - Can I download one lab order document? - What file is attached to a specific lab document record? instructions: - text: Show lab document {document_id}. slots: document_id: path.id - text: Get the file for lab order document {document_id}. slots: document_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_documents/{id}'].put update: x-apievangelist-phrasing: intent: Replace a lab result document effect: write questions: - How do I replace a lab report PDF with a corrected version? - Can I overwrite a lab document record entirely? instructions: - text: Replace lab document {document_id} with the corrected PDF. slots: document_id: path.id - text: Overwrite all fields of lab document {document_id}. slots: document_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_documents/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a lab result document effect: destructive questions: - Can I delete a lab report PDF uploaded to the wrong order? - How do I remove a lab order document? instructions: - text: Delete lab document {document_id}. slots: document_id: path.id - text: Remove lab order document {document_id}. slots: document_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_documents/{id}'].patch update: x-apievangelist-phrasing: intent: Edit part of a lab document effect: write questions: - Can I change the type on a lab document without re-uploading it? - How do I update one field of a lab order document? instructions: - text: Change the document type on lab document {document_id}. slots: document_id: path.id - text: Patch one field of lab document {document_id}. slots: document_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/appointment_templates/{id}'].get update: x-apievangelist-phrasing: intent: Get an appointment template effect: read questions: - Can I look up one calendar template's time slots? - Which days and hours does a specific appointment template cover? instructions: - text: Show appointment template {template_id}. slots: template_id: path.id - text: Get the hours of calendar template {template_id}. slots: template_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/appointment_templates/{id}'].put update: x-apievangelist-phrasing: intent: Replace an appointment template effect: write questions: - How do I overwrite a calendar template entirely? - Can I redefine all the settings of an appointment template? instructions: - text: Replace appointment template {template_id}. slots: template_id: path.id - text: Overwrite every setting of calendar template {template_id}. slots: template_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/appointment_templates/{id}'].delete update: x-apievangelist-phrasing: intent: Delete an appointment template effect: destructive questions: - Can I remove a calendar template we no longer use? - How do I delete an appointment template? instructions: - text: Delete appointment template {template_id}. slots: template_id: path.id - text: Remove calendar template {template_id}. slots: template_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/appointment_templates/{id}'].patch update: x-apievangelist-phrasing: intent: Adjust an appointment template effect: write questions: - Can I change just the hours on a calendar template? - How do I tweak one setting of an appointment template? instructions: - text: Change the hours on appointment template {template_id}. slots: template_id: path.id - text: Patch one setting of calendar template {template_id}. slots: template_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_interventions/{id}'].get update: x-apievangelist-phrasing: intent: Get a CQM intervention effect: read questions: - Can I look up one intervention recorded for quality reporting? - What code was used on a specific CQM intervention? instructions: - text: Show intervention {intervention_id}. slots: intervention_id: path.id - text: Get CQM intervention {intervention_id}. slots: intervention_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_interventions/{id}'].put update: x-apievangelist-phrasing: intent: Replace a CQM intervention effect: write questions: - How do I overwrite a CQM intervention record in full? - Can I resend an entire intervention entry to replace it? instructions: - text: Replace intervention {intervention_id}. slots: intervention_id: path.id - text: Overwrite all fields of CQM intervention {intervention_id}. slots: intervention_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_interventions/{id}'].patch update: x-apievangelist-phrasing: intent: Correct part of a CQM intervention effect: write questions: - Can I fix one field on a recorded intervention? - How do I change the date of a CQM intervention? instructions: - text: Correct one field on intervention {intervention_id}. slots: intervention_id: path.id - text: Change the date of CQM intervention {intervention_id}. slots: intervention_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/allergies/{id}'].get update: x-apievangelist-phrasing: intent: Get a patient allergy effect: read questions: - Can I look up one allergy and its reaction? - What reaction is noted for a specific allergy entry? instructions: - text: Show allergy {allergy_id}. slots: allergy_id: path.id - text: Get the reaction noted on allergy {allergy_id}. slots: allergy_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/allergies/{id}'].put update: x-apievangelist-phrasing: intent: Replace a patient allergy effect: write questions: - How do I overwrite an allergy entry completely? - Can I resend a full allergy record to replace it? instructions: - text: Replace allergy {allergy_id}. slots: allergy_id: path.id - text: Overwrite every field of allergy entry {allergy_id}. slots: allergy_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/allergies/{id}'].patch update: x-apievangelist-phrasing: intent: Edit a patient allergy effect: write questions: - Can I mark an allergy as inactive? - How do I change the reaction on an existing allergy? instructions: - text: Mark allergy {allergy_id} as inactive. slots: allergy_id: path.id - text: Change the reaction recorded on allergy {allergy_id}. slots: allergy_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patients/{id}/ccda'].get update: x-apievangelist-phrasing: intent: Download a patient's CCDA effect: read questions: - How do I export a patient's continuity of care document? - Can I get a C-CDA XML for a patient to send to another provider? instructions: - text: Download the CCDA for patient {patient_id}. slots: patient_id: path.id - text: Export patient {patient_id}'s continuity of care document. slots: patient_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_orders_summary'].get update: x-apievangelist-phrasing: intent: List lab order summaries effect: read questions: - Is there a lighter-weight summary view of a patient's lab orders? - Can I get a quick summary of lab orders changed since a date? instructions: - text: List lab order summaries for patient {patient}. slots: patient: query.patient - text: Show lab order summaries updated since {since}. slots: since: query.since method: generated generated: '2026-09-26' - target: $.paths['/api/clinical_note_field_values_list'].get update: x-apievangelist-phrasing: intent: Fetch a batch of SOAP note values effect: read questions: - How do I retrieve a batch of SOAP note values I requested? - Can I page through clinical note values in bulk using a batch token? instructions: - text: Fetch SOAP note value batch {uuid}. slots: uuid: query.uuid - text: Get the clinical note values batch for token {uuid}. slots: uuid: query.uuid method: generated generated: '2026-09-26' - target: $.paths['/api/care_plans/{id}'].get update: x-apievangelist-phrasing: intent: Get a care plan effect: read questions: - Can I open a single care plan? - What goals and instructions are in a specific care plan? instructions: - text: Show care plan {plan_id}. slots: plan_id: path.id - text: Get the goals in care plan {plan_id}. slots: plan_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/fee_schedules/{id}'].get update: x-apievangelist-phrasing: intent: Get a fee schedule entry effect: read questions: - Can I look up a single fee schedule entry? - What price is set on a specific fee schedule record? instructions: - text: Show fee schedule entry {fee_id}. slots: fee_id: path.id - text: Get the price on fee schedule record {fee_id}. slots: fee_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/appointments/{id}'].get update: x-apievangelist-phrasing: intent: Get an appointment effect: read questions: - Can I pull up the details of a single appointment? - What status and exam room is set on a specific visit? instructions: - text: Show appointment {appointment_id}. slots: appointment_id: path.id - text: Get the status and time of appointment {appointment_id}. slots: appointment_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/appointments/{id}'].put update: x-apievangelist-phrasing: intent: Replace an appointment effect: write questions: - How do I resend a complete appointment record to replace it? - Can I overwrite every field of an existing appointment in one call? instructions: - text: Replace appointment {appointment_id} with patient {patient}, doctor {doctor} at {scheduled_time}. slots: appointment_id: path.id patient: requestBody.patient doctor: requestBody.doctor scheduled_time: requestBody.scheduled_time - text: Overwrite appointment {appointment_id} fully, moving it to exam room {exam_room} at office {office}. slots: appointment_id: path.id exam_room: requestBody.exam_room office: requestBody.office method: generated generated: '2026-09-26' - target: $.paths['/api/appointments/{id}'].delete update: x-apievangelist-phrasing: intent: Cancel and delete an appointment effect: destructive questions: - Can I delete an appointment or break from the calendar? - What happens to a visit when I delete it? instructions: - text: Delete appointment {appointment_id}. slots: appointment_id: path.id - text: Remove break {appointment_id} from the doctor's calendar. slots: appointment_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/appointments/{id}'].patch update: x-apievangelist-phrasing: intent: Reschedule or update an appointment effect: write questions: - How do I reschedule a patient's appointment to a new time? - Can I mark a patient as arrived or checked in? instructions: - text: Move appointment {appointment_id} to {scheduled_time}. slots: appointment_id: path.id scheduled_time: requestBody.scheduled_time - text: Set the status of appointment {appointment_id} to {status}. slots: appointment_id: path.id status: requestBody.status - text: Add note {notes} to appointment {appointment_id}. slots: notes: requestBody.notes appointment_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/telehealth_appointments'].get update: x-apievangelist-phrasing: intent: List telehealth appointments effect: read questions: - Which appointments are set up as video visits? - Can I find the telehealth session for a given appointment? instructions: - text: List telehealth appointments for doctor {doctor}. slots: doctor: query.doctor - text: Show the telehealth session for appointment {appointment}. slots: appointment: query.appointment method: generated generated: '2026-09-26' - target: $.paths['/api/telehealth_appointments'].post update: x-apievangelist-phrasing: intent: Set up a telehealth visit effect: write questions: - How do I turn an appointment into a video visit? - Can I create a telehealth session for a scheduled appointment? instructions: - text: Create a telehealth session for appointment {appointment}. slots: appointment: query.appointment - text: Make appointment {appointment} a video visit for doctor {doctor}. slots: appointment: query.appointment doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/care_plans'].get update: x-apievangelist-phrasing: intent: List care plans effect: read questions: - What care plans are in place for a patient? - Can I filter care plans by plan type? instructions: - text: List care plans for patient {patient}. slots: patient: query.patient - text: Show care plans of type {plan_type}. slots: plan_type: query.plan_type method: generated generated: '2026-09-26' - target: $.paths['/api/patient_physical_exams'].get update: x-apievangelist-phrasing: intent: List CQM physical exams effect: read questions: - Which physical exams are recorded for a patient's quality measures? - Can I list CQM physical exam entries for a doctor? instructions: - text: List CQM physical exams for patient {patient}. slots: patient: query.patient - text: Show physical exam records for doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/patient_physical_exams'].post update: x-apievangelist-phrasing: intent: Record a CQM physical exam effect: write questions: - How do I record a physical exam for clinical quality reporting? - Can I log a BMI or blood pressure exam for CQM? instructions: - text: Record a CQM physical exam for patient {patient}. slots: patient: query.patient - text: Log a quality-measure exam for patient {patient} by doctor {doctor}. slots: patient: query.patient doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/signed_consent_forms/{id}'].get update: x-apievangelist-phrasing: intent: Get one signed consent form record effect: read questions: - Can I pull up a single signed consent record by its ID? - When was a particular consent form signature captured? instructions: - text: Show signed consent record {signature_id}. slots: signature_id: path.id - text: Get the signature details for signed consent form {signature_id}. slots: signature_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/clinical_note_templates/{id}'].get update: x-apievangelist-phrasing: intent: Get a clinical note template effect: read questions: - Can I view one clinical note template's setup? - Which sections are in a particular note template? instructions: - text: Show clinical note template {template_id}. slots: template_id: path.id - text: Get note template {template_id}. slots: template_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_results'].get update: x-apievangelist-phrasing: intent: List lab results effect: read questions: - What lab results came back for a lab order? - Can I list all lab result values a doctor has received? instructions: - text: List lab results for lab order {order}. slots: order: query.order - text: Show lab results for doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/lab_results'].post update: x-apievangelist-phrasing: intent: Submit lab result values effect: write questions: - How do I post lab result data back to an order once results arrive? - Can a lab push structured results into drchrono? instructions: - text: Submit lab result values for lab order {order}. slots: order: query.order - text: Record new lab results on order {order} for doctor {doctor}. slots: order: query.order doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/problems/{id}'].get update: x-apievangelist-phrasing: intent: Get a patient problem effect: read questions: - Can I look up one entry on a problem list? - When was a particular problem diagnosed? instructions: - text: Show problem {problem_id}. slots: problem_id: path.id - text: Get problem list entry {problem_id}. slots: problem_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/problems/{id}'].put update: x-apievangelist-phrasing: intent: Replace a patient problem effect: write questions: - How do I overwrite a problem list entry completely? - Can I resend a full problem record to replace it? instructions: - text: Replace problem {problem_id}. slots: problem_id: path.id - text: Overwrite every field of problem entry {problem_id}. slots: problem_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/problems/{id}'].patch update: x-apievangelist-phrasing: intent: Resolve or edit a patient problem effect: write questions: - Can I mark a problem as resolved? - How do I change the status of a problem on the list? instructions: - text: Mark problem {problem_id} as resolved. slots: problem_id: path.id - text: Change the status of problem {problem_id} to inactive. slots: problem_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/amendments'].get update: x-apievangelist-phrasing: intent: List patient record amendments effect: read questions: - Which amendments has my app made to a patient's clinical record? - Can I list amendments tied to a specific appointment? instructions: - text: List amendments for patient {patient}. slots: patient: query.patient - text: Show record amendments on appointment {appointment}. slots: appointment: query.appointment method: generated generated: '2026-09-26' - target: $.paths['/api/amendments'].post update: x-apievangelist-phrasing: intent: Amend a patient's clinical record effect: write questions: - How do I file an amendment to a patient's clinical record? - Can I attach an amendment to a particular visit? instructions: - text: Create an amendment to patient {patient}'s record. slots: patient: query.patient - text: File a record amendment for patient {patient} on appointment {appointment}. slots: patient: query.patient appointment: query.appointment method: generated generated: '2026-09-26' - target: $.paths['/api/lab_orders'].get update: x-apievangelist-phrasing: intent: List lab orders effect: read questions: - What lab orders are open for a patient? - Can I list lab orders changed since a certain date? instructions: - text: List lab orders for patient {patient}. slots: patient: query.patient - text: Show lab orders updated since {since}. slots: since: query.since method: generated generated: '2026-09-26' - target: $.paths['/api/lab_orders'].post update: x-apievangelist-phrasing: intent: Submit a lab order effect: write questions: - How do I push an incoming lab order into drchrono so doctors can see it? - Can a lab integration submit new orders for a doctor? instructions: - text: Submit a new lab order for doctor {doctor}. slots: doctor: query.doctor - text: Create a lab order so the ordering doctor sees it in their chart. method: generated generated: '2026-09-26' - target: $.paths['/api/patient_flag_types'].get update: x-apievangelist-phrasing: intent: List patient flag types effect: read questions: - What patient flags has the practice defined? - Can I see the flag types a doctor uses to mark patients? instructions: - text: List patient flag types. - text: Show patient flag types for doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/patient_flag_types'].post update: x-apievangelist-phrasing: intent: Create a patient flag type effect: write questions: - How do I create a new flag to mark patients, like VIP or balance due? - Can I define a custom patient flag for a doctor? instructions: - text: Create a patient flag type for doctor {doctor}. slots: doctor: query.doctor - text: Add a new 'balance due' patient flag type. method: generated generated: '2026-09-26' - target: $.paths['/api/recurring_appointment_instances'].get update: x-apievangelist-phrasing: intent: List occurrences of a recurring appointment effect: read questions: - How do I see every occurrence of a recurring appointment series? - Can I tell which recurring instances are virtual and not yet saved? instructions: - text: List instances of recurring series {base} between {start_date} and {end_date}. slots: base: query.base_recurring_appointment start_date: query.start_date end_date: query.end_date - text: Show all occurrences of recurring appointment {base}. slots: base: query.base_recurring_appointment method: generated generated: '2026-09-26' - target: $.paths['/api/custom_appointment_fields/{id}'].get update: x-apievangelist-phrasing: intent: Get a custom appointment field effect: read questions: - Can I look up how one custom appointment field is defined? - What type is a particular custom appointment field? instructions: - text: Show custom appointment field {field_id}. slots: field_id: path.id - text: Get the definition of appointment field {field_id}. slots: field_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/custom_appointment_fields/{id}'].put update: x-apievangelist-phrasing: intent: Replace a custom appointment field effect: write questions: - How do I completely redefine an existing custom appointment field? - Can I overwrite all settings of an appointment custom field? instructions: - text: Replace custom appointment field {field_id}. slots: field_id: path.id - text: Overwrite every setting of appointment field {field_id}. slots: field_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/custom_appointment_fields/{id}'].patch update: x-apievangelist-phrasing: intent: Rename or tweak a custom appointment field effect: write questions: - Can I rename a custom appointment field without redefining it? - How do I change one setting on an appointment custom field? instructions: - text: Rename custom appointment field {field_id}. slots: field_id: path.id - text: Patch one setting on appointment field {field_id}. slots: field_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/eobs'].get update: x-apievangelist-phrasing: intent: List explanations of benefits effect: read questions: - What EOBs have we received from insurers? - Can I list explanation of benefits records for a doctor? instructions: - text: List EOBs. - text: Show explanations of benefits for doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/eobs'].post update: x-apievangelist-phrasing: intent: Record an explanation of benefits effect: write questions: - How do I post an EOB from an insurer? - Can I upload an explanation of benefits for a doctor's claims? instructions: - text: Create an EOB for doctor {doctor}. slots: doctor: query.doctor - text: Record a new explanation of benefits. method: generated generated: '2026-09-26' - target: $.paths['/api/insurances'].get update: x-apievangelist-phrasing: intent: Search insurance payers effect: read questions: - How do I find an insurance payer by name or payer ID? - Which payers are available for a given clearinghouse payer type? instructions: - text: Search {payer_type} insurance payers for {term}. slots: payer_type: query.payer_type term: query.term - text: Find payers in state {term} from the {payer_type} list. slots: term: query.term payer_type: query.payer_type method: generated generated: '2026-09-26' - target: $.paths['/api/telehealth_appointment_history'].get update: x-apievangelist-phrasing: intent: List telehealth session history effect: read questions: - What happened during past video visits, like join and leave times? - Can I review telehealth session history for a doctor? instructions: - text: List telehealth history for doctor {doctor}. slots: doctor: query.doctor - text: Show past video visit session logs. method: generated generated: '2026-09-26' - target: $.paths['/api/telehealth_appointment_history'].post update: x-apievangelist-phrasing: intent: Log a telehealth history event effect: write questions: - How do I record an event in a video visit's history? - Can I add a telehealth session log entry? instructions: - text: Log a telehealth history event for doctor {doctor}. slots: doctor: query.doctor - text: Add an entry to the video visit history. method: generated generated: '2026-09-26' - target: $.paths['/api/patients_summary/{id}'].get update: x-apievangelist-phrasing: intent: Get a patient summary effect: read questions: - Can I get the short summary view of one patient? - What basic details does a patient summary include? instructions: - text: Show patient summary {patient_id}. slots: patient_id: path.id - text: Get the condensed summary of patient {patient_id}. slots: patient_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patients_summary/{id}'].put update: x-apievangelist-phrasing: intent: Replace a patient summary effect: write questions: - How do I overwrite a patient's summary details completely? - Can I replace the whole summary record of a patient? instructions: - text: Replace patient summary {patient_id}. slots: patient_id: path.id - text: Overwrite all summary fields of patient {patient_id}. slots: patient_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patients_summary/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a patient via summary effect: destructive questions: - Can I delete a patient through the summary endpoint? - Is deleting a patient summary permanent? instructions: - text: Delete patient summary {patient_id}. slots: patient_id: path.id - text: Remove summary patient record {patient_id}. slots: patient_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patients_summary/{id}'].patch update: x-apievangelist-phrasing: intent: Edit a patient summary effect: write questions: - Can I fix just the gender or birth date on a patient summary? - How do I change one summary field for a patient? instructions: - text: Correct the birth date on patient summary {patient_id}. slots: patient_id: path.id - text: Patch one field of patient summary {patient_id}. slots: patient_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_documents'].get update: x-apievangelist-phrasing: intent: List lab result documents effect: read questions: - Where can I find the PDF reports attached to lab orders? - Can I list lab documents for a patient? instructions: - text: List lab order documents for patient {patient}. slots: patient: query.patient - text: Show lab documents uploaded since {since}. slots: since: query.since method: generated generated: '2026-09-26' - target: $.paths['/api/lab_documents'].post update: x-apievangelist-phrasing: intent: Upload a lab result document effect: write questions: - How do I upload the PDF of lab results for an order? - Can a lab attach its result report file to drchrono? instructions: - text: Upload a lab result PDF for doctor {doctor}. slots: doctor: query.doctor - text: Attach a lab report document to the lab order. method: generated generated: '2026-09-26' - target: $.paths['/api/consent_forms/{id}'].get update: x-apievangelist-phrasing: intent: Get a consent form effect: read questions: - Can I view the details of one consent form template? - What is in a consent form before patients sign it? instructions: - text: Show consent form {form_id}. slots: form_id: path.id - text: Open consent form template {form_id}. slots: form_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/consent_forms/{id}'].put update: x-apievangelist-phrasing: intent: Replace a consent form effect: write questions: - How do I overwrite all the details of an existing consent form? - Can I fully replace a consent form template's contents? instructions: - text: Replace consent form {form_id} with a new version. slots: form_id: path.id - text: Overwrite every field of consent form {form_id}. slots: form_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/consent_forms/{id}'].patch update: x-apievangelist-phrasing: intent: Edit part of a consent form effect: write questions: - Can I change just the title of a consent form without resending everything? - How do I tweak one field on a consent form template? instructions: - text: Change only the title of consent form {form_id}. slots: form_id: path.id - text: Patch a single field on consent form {form_id}. slots: form_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_tests/{id}'].get update: x-apievangelist-phrasing: intent: Get a lab test effect: read questions: - Can I view the details of one test on a lab order? - What is the status of a specific lab test? instructions: - text: Show lab test {test_id}. slots: test_id: path.id - text: Get the status of lab test {test_id}. slots: test_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_tests/{id}'].put update: x-apievangelist-phrasing: intent: Replace a lab test effect: write questions: - How do I overwrite a lab test with a complete updated record? - Can I resend a full lab test to replace the stored one? instructions: - text: Replace lab test {test_id} with the full record. slots: test_id: path.id - text: Overwrite all fields of lab test {test_id}. slots: test_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_tests/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a lab test effect: destructive questions: - Can I drop a test from a lab order? - How do I delete a lab test added by mistake? instructions: - text: Delete lab test {test_id}. slots: test_id: path.id - text: Remove lab test {test_id} from its order. slots: test_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_tests/{id}'].patch update: x-apievangelist-phrasing: intent: Update part of a lab test effect: write questions: - Can I change only the status of one lab test? - How do I update a single field on a lab test? instructions: - text: Set the status of lab test {test_id} to completed. slots: test_id: path.id - text: Patch one field on lab test {test_id}. slots: test_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/prescription_messages_list'].get update: x-apievangelist-phrasing: intent: Fetch a batch of prescription messages effect: read questions: - How do I retrieve a prescription messages batch I requested earlier? - Is my bulk prescription message export finished? instructions: - text: Fetch prescription messages batch {uuid}. slots: uuid: query.uuid - text: Check the status of prescription messages batch {uuid}. slots: uuid: query.uuid method: generated generated: '2026-09-26' - target: $.paths['/api/prescription_messages_list'].post update: x-apievangelist-phrasing: intent: Request a batch export of prescription messages effect: read questions: - How do I bulk export prescription messages in batches? - Can I queue a batch of prescription messages since a date? instructions: - text: Start a batch prescription messages request since {since}. slots: since: query.since - text: Queue a bulk export of prescription messages for patient {patient}. slots: patient: query.patient method: generated generated: '2026-09-26' - target: $.paths['/api/patients/{id}'].get update: x-apievangelist-phrasing: intent: Get a patient's full record effect: read questions: - Can I pull up everything on one patient's demographic record? - What contact and insurance details are on file for a patient? instructions: - text: Show patient {patient_id}. slots: patient_id: path.id - text: Get the full demographic record for patient {patient_id}. slots: patient_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patients/{id}'].put update: x-apievangelist-phrasing: intent: Replace a patient record effect: write questions: - How do I overwrite a patient's demographic record in full? - Can I resend a complete patient record to replace the stored one? instructions: - text: Replace the record for patient {patient_id}. slots: patient_id: path.id - text: Overwrite every demographic field of patient {patient_id}. slots: patient_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patients/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a patient effect: destructive questions: - Can I delete a patient record created by mistake? - What happens when a patient is deleted? instructions: - text: Delete patient {patient_id}. slots: patient_id: path.id - text: Remove the duplicate patient record {patient_id}. slots: patient_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patients/{id}'].patch update: x-apievangelist-phrasing: intent: Update a patient's details effect: write questions: - Can I change just a patient's phone number or address? - How do I update a patient's email without touching the rest? instructions: - text: Update the phone number of patient {patient_id}. slots: patient_id: path.id - text: Change the email on file for patient {patient_id}. slots: patient_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patients/{id}/ccda_async'].get update: x-apievangelist-phrasing: intent: Generate a patient's CCDA asynchronously effect: read questions: - Can I request a patient's CCDA without waiting for it synchronously? - Is there an async way to build a large C-CDA export? instructions: - text: Generate the CCDA for patient {patient_id} asynchronously. slots: patient_id: path.id - text: Request an async care summary export for patient {patient_id}. slots: patient_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/custom_vitals'].get update: x-apievangelist-phrasing: intent: List custom vital types effect: read questions: - Which custom vital signs does the practice track? - Can I see the custom vital types a doctor has defined? instructions: - text: List custom vital types. - text: Show custom vital types for doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/schedule_blocks'].get update: x-apievangelist-phrasing: intent: List schedule blocks effect: read questions: - What time is blocked off on a provider's calendar for lunch or PTO? - Can I list schedule blocks for an office over a date range? instructions: - text: List schedule blocks for doctor {doctor} on {date}. slots: doctor: query.doctor date: query.date - text: Show blocked-off time at office {office} during {date_range}. slots: office: query.office date_range: query.date_range method: generated generated: '2026-09-26' - target: $.paths['/api/schedule_blocks'].post update: x-apievangelist-phrasing: intent: Block off time on a calendar effect: write questions: - How do I block a provider's calendar for a meeting so no one books it? - Can I add a PTO block that prevents appointments? instructions: - text: Block provider {provider}'s calendar at office {office} from {start_time} to {end_time}. slots: provider: requestBody.provider office: requestBody.office start_time: requestBody.start_time end_time: requestBody.end_time - text: Add a {description} block for provider {provider} at office {office} from {start_time} until {end_time}. slots: description: requestBody.description provider: requestBody.provider office: requestBody.office start_time: requestBody.start_time end_time: requestBody.end_time method: generated generated: '2026-09-26' - target: $.paths['/api/care_team_members/{id}'].get update: x-apievangelist-phrasing: intent: Get a care team member effect: read questions: - Can I look up one care team member's details? - What role does a particular care team member have? instructions: - text: Show care team member {member_id}. slots: member_id: path.id - text: Get the role of care team member {member_id}. slots: member_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/claim_billing_notes/{id}'].get update: x-apievangelist-phrasing: intent: Get one claim billing note effect: read questions: - What does a specific claim billing note say? - Can I look up a single billing note by its ID? instructions: - text: Show claim billing note {note_id}. slots: note_id: path.id - text: Open billing note {note_id} and tell me what it says. slots: note_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_lab_results/{id}'].get update: x-apievangelist-phrasing: intent: Get a patient lab result effect: read questions: - Can I open one lab result from a patient's chart? - What are the details of a specific patient lab result? instructions: - text: Show patient lab result {result_id}. slots: result_id: path.id - text: Open chart lab result {result_id}. slots: result_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_lab_results/{id}'].put update: x-apievangelist-phrasing: intent: Replace a patient lab result effect: write questions: - How do I overwrite a lab result on a patient's chart entirely? - Can I replace a charted patient lab result with a new full record? instructions: - text: Replace patient lab result {result_id}. slots: result_id: path.id - text: Overwrite every field of chart lab result {result_id}. slots: result_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_lab_results/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a patient lab result effect: destructive questions: - Can I remove a lab result from a patient's chart? - How do I delete a patient lab result entered in error? instructions: - text: Delete patient lab result {result_id}. slots: result_id: path.id - text: Remove chart lab result {result_id} from the patient's record. slots: result_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_lab_results/{id}'].patch update: x-apievangelist-phrasing: intent: Edit part of a patient lab result effect: write questions: - Can I fix one field on a lab result in a patient's chart? - How do I update the date on a charted patient lab result? instructions: - text: Correct the date on patient lab result {result_id}. slots: result_id: path.id - text: Patch one field of chart lab result {result_id}. slots: result_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/amendments/{id}'].get update: x-apievangelist-phrasing: intent: Get a record amendment effect: read questions: - Can I view one amendment my app filed? - What did a specific clinical record amendment change? instructions: - text: Show amendment {amendment_id}. slots: amendment_id: path.id - text: Get record amendment {amendment_id}. slots: amendment_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/amendments/{id}'].put update: x-apievangelist-phrasing: intent: Replace a record amendment effect: write questions: - How do I fully rewrite an amendment my app created? - Can I overwrite an existing record amendment? instructions: - text: Replace amendment {amendment_id}. slots: amendment_id: path.id - text: Overwrite all fields of record amendment {amendment_id}. slots: amendment_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/amendments/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a record amendment effect: destructive questions: - Can I withdraw an amendment my app filed? - How do I delete a clinical record amendment? instructions: - text: Delete amendment {amendment_id}. slots: amendment_id: path.id - text: Withdraw record amendment {amendment_id}. slots: amendment_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/amendments/{id}'].patch update: x-apievangelist-phrasing: intent: Edit part of a record amendment effect: write questions: - Can I change just the comments on an amendment? - How do I update one field of a record amendment? instructions: - text: Update the comments on amendment {amendment_id}. slots: amendment_id: path.id - text: Patch one field of record amendment {amendment_id}. slots: amendment_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/lab_tests'].get update: x-apievangelist-phrasing: intent: List lab tests effect: read questions: - Which tests are on a lab order? - Can I list the individual lab tests ordered by a doctor? instructions: - text: List the lab tests on order {order}. slots: order: query.order - text: Show lab tests for doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/lab_tests'].post update: x-apievangelist-phrasing: intent: Add a test to a lab order effect: write questions: - How do I add an individual test to a lab order? - Can a lab submit the tests it is running for an order? instructions: - text: Add a lab test to order {order}. slots: order: query.order - text: Create a lab test on order {order} for doctor {doctor}. slots: order: query.order doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/appointments_list/{id}'].get update: x-apievangelist-phrasing: intent: Get an appointment via the list endpoint effect: read questions: - Can I fetch one record from the appointments list feed? - How do I read a single appointment from the appointments_list resource? instructions: - text: Get appointments list record {appointment_id}. slots: appointment_id: path.id - text: Fetch entry {appointment_id} from the appointments list feed. slots: appointment_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/appointments_list/{id}'].put update: x-apievangelist-phrasing: intent: Replace an appointment via the list endpoint effect: write questions: - Can I fully replace a record through the appointments list resource? - How do I overwrite an appointments_list entry? instructions: - text: Replace appointments list record {appointment_id}. slots: appointment_id: path.id - text: Overwrite entry {appointment_id} in the appointments list feed. slots: appointment_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/appointments_list/{id}'].delete update: x-apievangelist-phrasing: intent: Delete an appointment via the list endpoint effect: destructive questions: - Can I delete a record through the appointments list resource? - How do I remove an appointments_list entry? instructions: - text: Delete appointments list record {appointment_id}. slots: appointment_id: path.id - text: Remove entry {appointment_id} from the appointments list feed. slots: appointment_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/appointments_list/{id}'].patch update: x-apievangelist-phrasing: intent: Edit an appointment via the list endpoint effect: write questions: - Can I patch a single field through the appointments list resource? - How do I partially update an appointments_list entry? instructions: - text: Patch appointments list record {appointment_id}. slots: appointment_id: path.id - text: Change one field on appointments list entry {appointment_id}. slots: appointment_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/patient_lab_results'].get update: x-apievangelist-phrasing: intent: List a patient's lab results effect: read questions: - What lab results are on file for a patient? - Can I filter patient lab results by the ordering doctor? instructions: - text: List patient lab results for patient {patient}. slots: patient: query.patient - text: Show patient lab results ordered by doctor {ordering_doctor}. slots: ordering_doctor: query.ordering_doctor method: generated generated: '2026-09-26' - target: $.paths['/api/patient_lab_results'].post update: x-apievangelist-phrasing: intent: Add a lab result to a patient's chart effect: write questions: - How do I record an outside lab result directly on a patient's chart? - Can I add a patient lab result without a lab order? instructions: - text: Add a patient lab result for patient {patient}. slots: patient: query.patient - text: Record a lab result on patient {patient}'s chart ordered by {ordering_doctor}. slots: patient: query.patient ordering_doctor: query.ordering_doctor method: generated generated: '2026-09-26' - target: $.paths['/api/fee_schedules_v2/{id}'].get update: x-apievangelist-phrasing: intent: Get a v2 fee schedule effect: read questions: - Can I open a single v2 fee schedule with its assignees? - What plan and dates are set on a specific v2 fee schedule? instructions: - text: Show v2 fee schedule {schedule_id}. slots: schedule_id: path.id - text: Get the plan and effective dates of v2 fee schedule {schedule_id}. slots: schedule_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/insurances/{id}'].get update: x-apievangelist-phrasing: intent: Get an insurance payer effect: read questions: - Can I look up one insurance payer's details? - What is the payer ID and name for a specific insurer record? instructions: - text: Show insurance payer {insurance_id} from the {payer_type} list. slots: insurance_id: path.id payer_type: query.payer_type - text: Get payer details for {insurance_id}. slots: insurance_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/clinical_notes'].get update: x-apievangelist-phrasing: intent: List clinical notes effect: read questions: - Which clinical notes were written for a patient's visits? - Can I pull clinical notes for an office over a date range? instructions: - text: List clinical notes for patient {patient}. slots: patient: query.patient - text: Show clinical notes at office {office} between {date_range}. slots: office: query.office date_range: query.date_range method: generated generated: '2026-09-26' - target: $.paths['/api/eligibility_checks_list'].post update: x-apievangelist-phrasing: intent: Request a batch export of eligibility checks effect: read questions: - How do I bulk export insurance eligibility checks? - Can I queue a batch of eligibility checks for appointments in a date range? instructions: - text: Start a batch eligibility checks request for patient {patient}. slots: patient: query.patient - text: Queue eligibility checks for appointments in {appointment_date_range}. slots: appointment_date_range: query.appointment_date_range method: generated generated: '2026-09-26' - target: $.paths['/api/telehealth_appointment_history/{id}'].get update: x-apievangelist-phrasing: intent: Get a telehealth history entry effect: read questions: - Can I look up one entry in the telehealth session history? - What was logged in a specific video visit history record? instructions: - text: Show telehealth history entry {history_id}. slots: history_id: path.id - text: Get video visit log record {history_id}. slots: history_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/clinical_notes/{id}'].get update: x-apievangelist-phrasing: intent: Get a clinical note effect: read questions: - Can I open the clinical note for one appointment? - Is the note for a given visit locked or still open? instructions: - text: Show clinical note {note_id}. slots: note_id: path.id - text: Open clinical note {note_id} and summarize it. slots: note_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/clinical_note_field_types'].get update: x-apievangelist-phrasing: intent: List clinical note field types effect: read questions: - What fields make up a clinical note template? - Can I list the field types defined on one note template? instructions: - text: List field types on clinical note template {clinical_note_template}. slots: clinical_note_template: query.clinical_note_template - text: Show clinical note field types for doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/documents'].get update: x-apievangelist-phrasing: intent: List patient documents effect: read questions: - What documents are stored in a patient's chart? - Can I list documents added since a certain date? instructions: - text: List documents for patient {patient}. slots: patient: query.patient - text: Show patient documents added since {since}. slots: since: query.since method: generated generated: '2026-09-26' - target: $.paths['/api/documents'].post update: x-apievangelist-phrasing: intent: Upload a patient document effect: write questions: - How do I upload a scanned document to a patient's chart? - Can I attach a file like an insurance card to a patient? instructions: - text: Upload a document to patient {patient}'s chart. slots: patient: query.patient - text: Attach a scanned file for patient {patient} under doctor {doctor}. slots: patient: query.patient doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/staff/{id}'].get update: x-apievangelist-phrasing: intent: Get a staff member effect: read questions: - Can I look up one staff member's details? - What role does a particular staff member have? instructions: - text: Show staff member {staff_id}. slots: staff_id: path.id - text: Get the details of staff member {staff_id}. slots: staff_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/schedule_blocks/{id}'].get update: x-apievangelist-phrasing: intent: Get a schedule block effect: read questions: - Can I look up one schedule block by ID? - When does a specific calendar block start and end? instructions: - text: Show schedule block {block_id}. slots: block_id: path.id - text: Get the start and end of calendar block {block_id}. slots: block_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/schedule_blocks/{id}'].put update: x-apievangelist-phrasing: intent: Replace a schedule block effect: write questions: - How do I overwrite a schedule block with all new details? - Can I resend every field of a calendar block to replace it? instructions: - text: Replace schedule block {block_id} with provider {provider}, office {office}, {start_time} to {end_time}. slots: block_id: path.id provider: requestBody.provider office: requestBody.office start_time: requestBody.start_time end_time: requestBody.end_time - text: Fully overwrite calendar block {block_id}. slots: block_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/schedule_blocks/{id}'].delete update: x-apievangelist-phrasing: intent: Remove a schedule block effect: destructive questions: - Can I unblock time so appointments can be booked again? - How do I delete a PTO block from a provider's calendar? instructions: - text: Delete schedule block {block_id}. slots: block_id: path.id - text: Unblock the time held by calendar block {block_id}. slots: block_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/schedule_blocks/{id}'].patch update: x-apievangelist-phrasing: intent: Move or edit a schedule block effect: write questions: - Can I push a lunch block to a later time? - How do I change the description or color of a calendar block? instructions: - text: Move schedule block {block_id} to {start_time} through {end_time}. slots: block_id: path.id start_time: requestBody.start_time end_time: requestBody.end_time - text: Change the description of block {block_id} to {description}. slots: block_id: path.id description: requestBody.description method: generated generated: '2026-09-26' - target: $.paths['/api/lab_orders_summary/{id}'].get update: x-apievangelist-phrasing: intent: Get a lab order summary effect: read questions: - Can I get just the summary of one lab order? - What is the condensed view of a specific lab order? instructions: - text: Show the summary of lab order {order_id}. slots: order_id: path.id - text: Get lab order summary {order_id}. slots: order_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/custom_demographics/{id}'].get update: x-apievangelist-phrasing: intent: Get a custom demographics field effect: read questions: - Can I view how a single custom demographics field is set up? - What does custom demographics field look like by ID? instructions: - text: Show custom demographics field {field_id}. slots: field_id: path.id - text: Get demographics field definition {field_id}. slots: field_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/custom_demographics/{id}'].put update: x-apievangelist-phrasing: intent: Replace a custom demographics field effect: write questions: - How do I fully redefine a custom demographics field? - Can I overwrite every property of a demographics field? instructions: - text: Replace custom demographics field {field_id}. slots: field_id: path.id - text: Overwrite all settings of demographics field {field_id}. slots: field_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/custom_demographics/{id}'].patch update: x-apievangelist-phrasing: intent: Edit part of a custom demographics field effect: write questions: - Can I rename a custom demographics field without changing the rest? - How do I adjust a single option on a demographics field? instructions: - text: Rename custom demographics field {field_id}. slots: field_id: path.id - text: Patch one property of demographics field {field_id}. slots: field_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/eobs/{id}'].get update: x-apievangelist-phrasing: intent: Get an explanation of benefits effect: read questions: - Can I open one EOB record? - What payment details are on a specific explanation of benefits? instructions: - text: Show EOB {eob_id}. slots: eob_id: path.id - text: Get explanation of benefits {eob_id}. slots: eob_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/allergies'].get update: x-apievangelist-phrasing: intent: List patient allergies effect: read questions: - What is a patient allergic to? - Can I list allergies charted by a doctor? instructions: - text: List allergies for patient {patient}. slots: patient: query.patient - text: Show allergies recorded by doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/allergies'].post update: x-apievangelist-phrasing: intent: Record a patient allergy effect: write questions: - How do I add a drug allergy to a patient's chart? - Can I record a new allergy for a patient? instructions: - text: Add an allergy to patient {patient}'s chart. slots: patient: query.patient - text: Record a penicillin allergy for patient {patient}. slots: patient: query.patient method: generated generated: '2026-09-26' - target: $.paths['/api/appointments'].get update: x-apievangelist-phrasing: intent: List appointments and breaks effect: read questions: - What appointments are on the schedule for a given day? - Can I include archived or deleted appointments when searching? - Why do I need a date or since filter when listing appointments? instructions: - text: List appointments on {date} for doctor {doctor}. slots: date: query.date doctor: query.doctor - text: Show appointments for patient {patient} between {date_range}. slots: patient: query.patient date_range: query.date_range - text: List appointments at office {office} changed since {since}, including archived ones. slots: office: query.office since: query.since method: generated generated: '2026-09-26' - target: $.paths['/api/appointments'].post update: x-apievangelist-phrasing: intent: Book an appointment or break effect: write questions: - How do I book an appointment for a patient on a doctor's calendar? - Can I schedule a recurring appointment or a break instead of a visit? instructions: - text: Book patient {patient} with doctor {doctor} at {scheduled_time} in exam room {exam_room}, office {office}. slots: patient: requestBody.patient doctor: requestBody.doctor scheduled_time: requestBody.scheduled_time exam_room: requestBody.exam_room office: requestBody.office - text: Schedule a {duration}-minute visit for patient {patient} at {scheduled_time} for reason {reason}. slots: duration: requestBody.duration patient: requestBody.patient scheduled_time: requestBody.scheduled_time reason: requestBody.reason method: generated generated: '2026-09-26' - target: $.paths['/api/clinical_note_templates'].get update: x-apievangelist-phrasing: intent: List clinical note templates effect: read questions: - What clinical note templates does my practice use? - Which note templates are available to a given doctor? instructions: - text: List clinical note templates. - text: Show note templates for doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/reminder_profiles'].get update: x-apievangelist-phrasing: intent: List reminder profiles effect: read questions: - What appointment reminder schedules do we have? - Can I list reminder profiles for a doctor? instructions: - text: List reminder profiles. - text: Show reminder profiles for doctor {doctor}. slots: doctor: query.doctor method: generated generated: '2026-09-26' - target: $.paths['/api/reminder_profiles'].post update: x-apievangelist-phrasing: intent: Create a reminder profile effect: write questions: - How do I set up automatic appointment reminders? - Can I create a reminder profile that texts patients a day ahead? instructions: - text: Create a reminder profile for doctor {doctor}. slots: doctor: query.doctor - text: Add a reminder profile that emails patients the day before. method: generated generated: '2026-09-26' - target: $.paths['/api/appointment_templates'].get update: x-apievangelist-phrasing: intent: List appointment templates effect: read questions: - What recurring availability templates are on a doctor's calendar? - Can I find templates available on certain weekdays at an office? instructions: - text: List appointment templates for doctor {doctor} at office {office}. slots: doctor: query.doctor office: query.office - text: Show available templates on {week_days}. slots: week_days: query.week_days method: generated generated: '2026-09-26' - target: $.paths['/api/appointment_templates'].post update: x-apievangelist-phrasing: intent: Create an appointment template effect: write questions: - How do I block out a recurring slot type on a doctor's calendar? - Can I create an appointment template tied to a visit profile? instructions: - text: Create an appointment template for doctor {doctor} at office {office}. slots: doctor: query.doctor office: query.office - text: Add a calendar template using profile {profile}. slots: profile: query.profile method: generated generated: '2026-09-26' - target: $.paths['/api/patient_vaccine_records'].get update: x-apievangelist-phrasing: intent: List patient vaccine records effect: read questions: - Which vaccines has a patient received? - Can I find patients given a vaccine by its CVX code? instructions: - text: List vaccine records for patient {patient}. slots: patient: query.patient - text: Show vaccine records with CVX code {cvx_code}. slots: cvx_code: query.cvx_code method: generated generated: '2026-09-26' - target: $.paths['/api/patient_vaccine_records'].post update: x-apievangelist-phrasing: intent: Record a vaccination effect: write questions: - How do I log an immunization for a patient? - Can I record a vaccine given using its CVX code? instructions: - text: Record a vaccination for patient {patient} with CVX code {cvx_code}. slots: patient: query.patient cvx_code: query.cvx_code - text: Log an immunization on patient {patient}'s chart. slots: patient: query.patient method: generated generated: '2026-09-26' - target: $.paths['/api/telehealth_appointments/{id}'].get update: x-apievangelist-phrasing: intent: Get a telehealth appointment effect: read questions: - Can I look up one telehealth session's details? - What is the status of a particular video visit? instructions: - text: Show telehealth appointment {telehealth_id}. slots: telehealth_id: path.id - text: Get the status of video visit {telehealth_id}. slots: telehealth_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/telehealth_appointments/{id}'].put update: x-apievangelist-phrasing: intent: Replace a telehealth appointment effect: write questions: - How do I overwrite a telehealth session record entirely? - Can I resend a full video visit record to replace it? instructions: - text: Replace telehealth appointment {telehealth_id}. slots: telehealth_id: path.id - text: Overwrite all fields of video visit {telehealth_id}. slots: telehealth_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/telehealth_appointments/{id}'].patch update: x-apievangelist-phrasing: intent: Edit a telehealth appointment effect: write questions: - Can I change one setting on a video visit? - How do I partially update a telehealth session? instructions: - text: Patch one field of telehealth appointment {telehealth_id}. slots: telehealth_id: path.id - text: Update a single setting on video visit {telehealth_id}. slots: telehealth_id: path.id method: generated generated: '2026-09-26' - target: $.paths['/api/prescription_messages'].get update: x-apievangelist-phrasing: intent: List prescription messages effect: read questions: - What e-prescribing messages have come in for a patient? - Can I see pharmacy replies to a prescription message? instructions: - text: List prescription messages for patient {patient}. slots: patient: query.patient - text: Show replies to prescription message {parent_message}. slots: parent_message: query.parent_message method: generated generated: '2026-09-26' - target: $.paths['/api/sublabs'].get update: x-apievangelist-phrasing: intent: List lab sub-vendors effect: read questions: - Which sub-vendor labs are registered for my lab integration? - Can I see all the sublabs we send orders through? instructions: - text: List lab sub-vendors. - text: Show all registered sublabs. method: generated generated: '2026-09-26' - target: $.paths['/api/sublabs'].post update: x-apievangelist-phrasing: intent: Register a lab sub-vendor effect: write questions: - How do I register a new sub-vendor lab? - Can I add a sublab to route lab orders to? instructions: - text: Create a new lab sub-vendor. - text: Register a sublab for our lab integration. method: generated generated: '2026-09-26' - target: $.paths['/api/yellow_notepad'].get update: x-apievangelist-phrasing: intent: Read the yellow notepad for a visit effect: read questions: - How do I read the yellow notepad text for an appointment? - Can I see the notepad content saved for a template on a visit? instructions: - text: Get the yellow notepad for appointment {appointment_id} and template {template_id}. slots: appointment_id: query.appointment_id template_id: query.template_id - text: Show notepad text on template {template_id} for visit {appointment_id}. slots: template_id: query.template_id appointment_id: query.appointment_id method: generated generated: '2026-09-26' - target: $.paths['/api/yellow_notepad'].post update: x-apievangelist-phrasing: intent: Write yellow notepad content effect: write questions: - Can I save free-text yellow notepad content on a visit's note? - Is medications and allergies notepad content shared across a patient's appointments? instructions: - text: Set the yellow notepad for appointment {appointment_id}, template {template_id} to {content}. slots: appointment_id: query.appointment_id template_id: query.template_id content: requestBody.content - text: Clear the yellow notepad on template {template_id} for visit {appointment_id}. slots: template_id: query.template_id appointment_id: query.appointment_id method: generated generated: '2026-09-26'