# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elation Health Ccda API
  version: 1.0.0
extends: openapi/elation-health-ccda-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/ccda/'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a CCDA document
      effect: write
      questions:
      - How do I upload a CCDA document into Elation?
      - What format must a CCDA be in when I send it through the API?
      instructions:
      - text: Import the base64-encoded CCDA {base64_ccda}.
        slots:
          base64_ccda: requestBody.base64_ccda
      - text: Upload this CCDA file encoded as {base64_ccda}.
        slots:
          base64_ccda: requestBody.base64_ccda
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ccda/{patient_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a patient's chart as CCDA (legacy)
      effect: read
      questions:
      - How do I export a patient's chart as a CCDA v2.1 document on the legacy endpoint?
      - Can I limit a legacy CCDA export to certain sections and a date range?
      instructions:
      - text: Export legacy CCDA for patient {patient_id} from {start_date} to {end_date}.
        slots:
          patient_id: path.patient_id
          start_date: query.start_date
          end_date: query.end_date
      - text: Export patient {patient_id}'s chart as a CCDA document from the legacy endpoint, limited to sections {sections}.
        slots:
          patient_id: path.patient_id
          sections: query.sections
      method: generated
      generated: '2026-10-02'
- target: $.paths['/ccda/{patient-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a CCDA for CEHRT 2022 certification
      effect: read
      questions:
      - Is there a CEHRT 2022 version of the patient CCDA export?
      - Can I pick a template when exporting a CEHRT 2022 CCDA?
      instructions:
      - text: Export the CEHRT 2022 CCDA for patient {patient_id} using template {template}.
        slots:
          patient_id: path.patient_id
          template: query.template
      - text: Pull a CEHRT 2022 certified CCDA for chart {patient}.
        slots:
          patient: path.patient-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/2.0/ccda/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a patient's CCDA
      effect: read
      questions:
      - How do I retrieve a patient's CCDA through API v2?
      - Can a v2 CCDA be restricted to certain chart sections?
      instructions:
      - text: Get the CCDA for patient {id}.
        slots:
          id: path.id
      - text: Retrieve v2 CCDA for patient {id} covering {start_date} to {end_date} with sections {sections}.
        slots:
          id: path.id
          start_date: query.start_date
          end_date: query.end_date
          sections: query.sections
      method: generated
      generated: '2026-09-26'