# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Drchrono Billing API
  version: 1.0.0
extends: openapi/drchrono-billing-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: 38
- target: $.paths['/api/day_sheet_charges'].get
  update:
    x-apievangelist-phrasing:
      intent: Run the daysheet charges report
      effect: read
      questions:
      - What charges did we post between two dates on the daysheet?
      - Can I filter the daysheet charges report to one office or exam room?
      instructions:
      - text: Run the daysheet charges report from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Show daysheet charges from {start_date} to {end_date} for office {office_id}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
          office_id: query.office_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/eligibility_checks'].get
  update:
    x-apievangelist-phrasing:
      intent: Search past insurance eligibility checks
      effect: read
      questions:
      - Which insurance eligibility checks have been run for a patient?
      - Can I find eligibility checks tied to a particular appointment?
      instructions:
      - text: List eligibility checks for patient {patient}.
        slots:
          patient: query.patient
      - text: Show eligibility checks run for appointment {appointment}.
        slots:
          appointment: query.appointment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/patient_authorizations'].get
  update:
    x-apievangelist-phrasing:
      intent: Search patient insurance authorizations
      effect: read
      questions:
      - Which prior authorizations are on file for a patient?
      - Can I find authorizations active within a date range?
      instructions:
      - text: List authorizations for patient {patient}.
        slots:
          patient: query.patient
      - text: Show patient authorizations in date range {date_range}.
        slots:
          date_range: query.date_range
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom_insurance_plan_names/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a custom insurance plan name
      effect: read
      questions:
      - How do I look up one custom insurance plan name by ID?
      - What does a single custom plan name record contain?
      instructions:
      - text: Get custom insurance plan name {id}.
        slots:
          id: path.id
      - text: Show custom plan name record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/line_items_list'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a batch of billing line items
      effect: read
      questions:
      - Where do I collect the results of a bulk line items request?
      - Can I download the line items batch once it is ready?
      instructions:
      - text: Fetch the line items batch for request {uuid}.
        slots:
          uuid: query.uuid
      - text: Download the prepared billing line items batch.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/line_items_list'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a bulk export of billing line items
      effect: read
      questions:
      - Can I request billing line items in bulk for a service date range?
      - How do I start a batched line items export?
      instructions:
      - text: Request a bulk line items export for service date range {service_date_range}.
        slots:
          service_date_range: query.service_date_range
      - text: Start a batch export of line items posted on {posted_date}.
        slots:
          posted_date: query.posted_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/day_sheet_patient_payments'].get
  update:
    x-apievangelist-phrasing:
      intent: Run the daysheet cash report
      effect: read
      questions:
      - How much cash did patients pay us over a date range?
      - Can I get the daysheet cash collections for a single patient?
      instructions:
      - text: Run the daysheet cash report from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Show patient cash collected between {start_date} and {end_date} for patient {patient_id}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
          patient_id: query.patient_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/eligibility_checks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a past eligibility check
      effect: read
      questions:
      - How do I see the result of one specific eligibility check?
      - What coverage details came back on a given eligibility check?
      instructions:
      - text: Get eligibility check {id}.
        slots:
          id: path.id
      - text: Show the coverage result of eligibility check {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/comm_logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Search phone call logs
      effect: read
      questions:
      - Which phone calls have been logged for a patient?
      - Can I list communication logs recorded since a date?
      instructions:
      - text: List phone call logs for patient {patient}.
        slots:
          patient: query.patient
      - text: Show communication logs since {since}.
        slots:
          since: query.since
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/comm_logs'].post
  update:
    x-apievangelist-phrasing:
      intent: Log a phone call
      effect: write
      questions:
      - How do I record a phone call with a patient?
      - Can I add a communication log entry through the API?
      instructions:
      - text: Log a phone call with a patient.
      - text: Create a new communication log entry.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/day_sheet_credits'].get
  update:
    x-apievangelist-phrasing:
      intent: Run the daysheet credits and adjustments report
      effect: read
      questions:
      - What credits and adjustments were posted in a given period?
      - Can I see daysheet adjustments broken out by claim type?
      instructions:
      - text: Run the daysheet credits and adjustments report from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Show adjustments posted between {start_date} and {end_date} for claim type {claim_type}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
          claim_type: query.claim_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/transactions_list'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a batch of insurance transactions
      effect: read
      questions:
      - Where do I pick up a batched insurance transactions export?
      - Can I retrieve transactions using the UUID from my export request?
      instructions:
      - text: Fetch the transactions batch for request {uuid}.
        slots:
          uuid: query.uuid
      - text: Download transactions batch {uuid}.
        slots:
          uuid: query.uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/transactions_list'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a bulk export of insurance transactions
      effect: read
      questions:
      - Can I request insurance transactions in bulk and collect them later?
      - Is there a verbose option for batched transaction exports?
      instructions:
      - text: Request a bulk transactions export for appointment {appointment}.
        slots:
          appointment: query.appointment
      - text: Start a batch export of transactions since {since} ordered by {order_by}.
        slots:
          since: query.since
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/patient_payments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a patient payment
      effect: read
      questions:
      - How do I look up one patient payment by ID?
      - What method and amount are on a specific patient payment?
      instructions:
      - text: Get patient payment {id}.
        slots:
          id: path.id
      - text: Show the amount and method of patient payment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/patient_payments'].get
  update:
    x-apievangelist-phrasing:
      intent: Search patient payments
      effect: read
      questions:
      - What payments has a patient made?
      - Can I list patient payments posted on a given date?
      instructions:
      - text: List payments made by patient {patient}.
        slots:
          patient: query.patient
      - text: Show patient payments posted on {posted_date}.
        slots:
          posted_date: query.posted_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/patient_payments'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a patient payment
      effect: write
      questions:
      - How do I record a copay a patient paid at the front desk?
      - Can I post a patient payment through the API?
      instructions:
      - text: Record a new patient payment.
      - text: Post a copay payment from a patient.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/clinical_note_field_values_list'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a bulk export of clinical note field values
      effect: read
      questions:
      - Can I pull clinical note field values in bulk for a note template?
      - How do I request clinical note values for one appointment as a batch?
      instructions:
      - text: Request clinical note field values for template {clinical_note_template}.
        slots:
          clinical_note_template: query.clinical_note_template
      - text: Start a batch export of clinical note values for appointment {appointment}.
        slots:
          appointment: query.appointment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/billing_profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List billing profiles
      effect: read
      questions:
      - What billing profiles are set up for our doctors?
      - Can I see billing profiles for one doctor?
      instructions:
      - text: List all billing profiles.
      - text: Show billing profiles for doctor {doctor}.
        slots:
          doctor: query.doctor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/billing_profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a billing profile
      effect: read
      questions:
      - How do I look up one billing profile by ID?
      - Which codes are bundled in a specific billing profile?
      instructions:
      - text: Get billing profile {id}.
        slots:
          id: path.id
      - text: Show the codes in billing profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/line_item_deletions'].get
  update:
    x-apievangelist-phrasing:
      intent: List deleted billing line items
      effect: read
      questions:
      - Which billing line items have been deleted from an appointment?
      - Can I track line item deletions since a date to keep my system in sync?
      instructions:
      - text: List line item deletions for appointment {appointment_id}.
        slots:
          appointment_id: query.appointment_id
      - text: Show billing line items deleted since {since}.
        slots:
          since: query.since
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: Search insurance transactions
      effect: read
      questions:
      - What insurance payments were posted against a line item?
      - Can I list insurance transactions by posted date?
      instructions:
      - text: List insurance transactions for line item {line_item}.
        slots:
          line_item: query.line_item
      - text: Show insurance transactions posted on {posted_date}.
        slots:
          posted_date: query.posted_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom_insurance_plan_names'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom insurance plan names
      effect: read
      questions:
      - What custom insurance plan names has the practice defined?
      - Can I search custom plan names by name?
      instructions:
      - text: List custom insurance plan names.
      - text: Find custom insurance plan names matching {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/day_sheet_totals'].get
  update:
    x-apievangelist-phrasing:
      intent: Run the daysheet totals report
      effect: read
      questions:
      - What are our daysheet totals for the month?
      - Can I group daysheet totals by provider or office?
      instructions:
      - text: Run the daysheet totals report from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Summarize daysheet totals from {start_date} to {end_date} grouped by {group_by}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
          group_by: query.group_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/transactions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an insurance transaction
      effect: read
      questions:
      - How do I look up one insurance transaction by ID?
      - What amounts are on a specific insurance transaction?
      instructions:
      - text: Get insurance transaction {id}.
        slots:
          id: path.id
      - text: Show the paid and adjusted amounts on transaction {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/procedures'].get
  update:
    x-apievangelist-phrasing:
      intent: Search billed procedures
      effect: read
      questions:
      - What procedures were billed for a patient?
      - Can I list procedures by service date or appointment?
      instructions:
      - text: List procedures for patient {patient}.
        slots:
          patient: query.patient
      - text: Show procedures with service date {service_date}.
        slots:
          service_date: query.service_date
      - text: Find procedures for appointment {appointment}.
        slots:
          appointment: query.appointment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/eligibility_checks_list'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a batch of eligibility checks
      effect: read
      questions:
      - Can I pull eligibility checks in bulk batches rather than page by page?
      - How are batched eligibility check results ordered?
      instructions:
      - text: Fetch the eligibility checks batch for request {uuid}.
        slots:
          uuid: query.uuid
      - text: Download eligibility checks in bulk batches.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/procedures/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a billed procedure
      effect: read
      questions:
      - How do I look up one procedure record by ID?
      - What details are stored on a specific procedure?
      instructions:
      - text: Get procedure {id}.
        slots:
          id: path.id
      - text: Show the details of procedure {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/line_items/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a billing line item
      effect: read
      questions:
      - How do I look up one billing line item by ID?
      - What code, price and units are on a specific line item?
      instructions:
      - text: Get billing line item {id}.
        slots:
          id: path.id
      - text: Show the code and price on line item {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/line_items/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a billing line item
      effect: write
      questions:
      - Can I replace every field on an existing billing line item?
      - Is a full overwrite of a line item supported?
      instructions:
      - text: Replace billing line item {id} with corrected values.
        slots:
          id: path.id
      - text: Overwrite all fields on line item {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/line_items/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a billing line item
      effect: destructive
      questions:
      - Can I remove a charge that was added to the wrong appointment?
      - What is kept after a billing line item is deleted?
      instructions:
      - text: Delete billing line item {id}.
        slots:
          id: path.id
      - text: Remove line item {id} from its appointment's bill.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/line_items/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Correct fields on a billing line item
      effect: write
      questions:
      - Can I change just the units or price on a line item?
      - Is a partial update of a billing line item possible?
      instructions:
      - text: Change the price on billing line item {id}.
        slots:
          id: path.id
      - text: Patch a few fields on line item {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/patient_payment_log'].get
  update:
    x-apievangelist-phrasing:
      intent: Search patient payment logs
      effect: read
      questions:
      - Is there an audit trail of changes to patient payments?
      - Can I list patient payment log entries for one office?
      instructions:
      - text: List patient payment log entries for office {office}.
        slots:
          office: query.office
      - text: Show patient payment log entries since {since}.
        slots:
          since: query.since
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/patient_payment_log/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a patient payment log entry
      effect: read
      questions:
      - How do I open a single patient payment log entry?
      - What details are recorded in one payment log entry?
      instructions:
      - text: Get patient payment log entry {id}.
        slots:
          id: path.id
      - text: Show payment log record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/comm_logs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a phone call log
      effect: read
      questions:
      - How do I open one logged phone call by ID?
      - What was noted on a specific communication log?
      instructions:
      - text: Get phone call log {id}.
        slots:
          id: path.id
      - text: Show the notes on communication log {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/comm_logs/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a phone call log
      effect: write
      questions:
      - Can I replace an entire communication log entry?
      - Is a full overwrite of a phone call log supported?
      instructions:
      - text: Replace phone call log {id} with corrected details.
        slots:
          id: path.id
      - text: Overwrite every field on communication log {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/comm_logs/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a phone call log
      effect: write
      questions:
      - Can I add a detail to a logged call without rewriting it?
      - Is a partial update of a communication log possible?
      instructions:
      - text: Update the notes on phone call log {id}.
        slots:
          id: path.id
      - text: Patch one field on communication log {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/line_items'].get
  update:
    x-apievangelist-phrasing:
      intent: Search billing line items
      effect: read
      questions:
      - Which billing line items are attached to an appointment?
      - Can I list line items by service date or posted date?
      instructions:
      - text: List billing line items for appointment {appointment}.
        slots:
          appointment: query.appointment
      - text: Show line items with service date {service_date}.
        slots:
          service_date: query.service_date
      - text: Find billing line items for patient {patient}.
        slots:
          patient: query.patient
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/line_items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a billing line item to an appointment
      effect: write
      questions:
      - How do I add a CPT charge to an appointment's bill?
      - Can the price and modifiers come from the fee schedule automatically?
      instructions:
      - text: Add a billing line item to an appointment.
      - text: Create a line item using fee schedule defaults set to {use_fee_schedule_defaults}.
        slots:
          use_fee_schedule_defaults: query.use_fee_schedule_defaults
      method: generated
      generated: '2026-09-26'