API Evangelist conversational phrasing for Drchrono Clinical API

# 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'


# --- truncated at 32 KB (135 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/drchrono/refs/heads/main/overlays/drchrono-clinical-api-phrasing-overlay.yaml