# 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 Clinical Documents API
  version: 1.0.0
extends: openapi/elation-health-clinical-documents-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: 7
- target: $.paths['/clinical_documents/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find clinical documents (legacy endpoint)
      effect: read
      questions:
      - What CCDA clinical documents have been imported, according to the legacy lookup?
      - Can I pull every clinical document with the older endpoint?
      instructions:
      - text: Using the legacy lookup, find all clinical documents.
      - text: Show the old-path clinical document imports.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/clinical_documents/'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a clinical document (legacy endpoint)
      effect: write
      questions:
      - How do I import a patient's CCDA XML file through the legacy endpoint?
      - Which data format must I declare when posting a clinical document the old way?
      instructions:
      - text: Via the legacy endpoint, import clinical document {xml_file} for patient {patient} from practice {authoring_practice} in format {data_format}.
        slots:
          xml_file: requestBody.xml_file
          patient: requestBody.patient
          authoring_practice: requestBody.authoring_practice
          data_format: requestBody.data_format
      - text: Post an old-path {data_format} clinical document for patient {patient} authored by {authoring_practice}.
        slots:
          data_format: requestBody.data_format
          patient: requestBody.patient
          authoring_practice: requestBody.authoring_practice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/clinical_documents/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a clinical document (legacy endpoint)
      effect: read
      questions:
      - Can I open one imported clinical document on the legacy path?
      - Does the older lookup say which practice authored a clinical document?
      instructions:
      - text: Open clinical document {id} using the legacy endpoint.
        slots:
          id: path.id
      - text: Show the authoring practice of old-path clinical document {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/clinical_documents/'].get
  update:
    x-apievangelist-phrasing:
      intent: List clinical documents in API 2.0
      effect: read
      questions:
      - How do I list a patient's imported clinical documents in the 2.0 API?
      - Can API 2.0 sort clinical documents and page through them?
      instructions:
      - text: List 2.0 clinical documents for patient {patient}.
        slots:
          patient: query.patient
      - text: List API 2.0 clinical documents ordered by {order_by}, {limit} per page.
        slots:
          order_by: query.order_by
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/clinical_documents/'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a clinical document in API 2.0
      effect: write
      questions:
      - How do I upload a CCDA XML file for a patient with the 2.0 API?
      - Can I record which sections, like medications or allergies, were imported from a clinical document?
      instructions:
      - text: In API 2.0, import XML file {xml_file} for patient {patient} from practice {authoring_practice}.
        slots:
          xml_file: requestBody.xml_file
          patient: requestBody.patient
          authoring_practice: requestBody.authoring_practice
      - text: Create a 2.0 clinical document {xml_file} for patient {patient} by {authoring_practice}, author {author_name}.
        slots:
          xml_file: requestBody.xml_file
          patient: requestBody.patient
          authoring_practice: requestBody.authoring_practice
          author_name: requestBody.author_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/clinical_documents/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a clinical document in API 2.0
      effect: read
      questions:
      - How do I retrieve a clinical document by ID in API 2.0?
      - Does a 2.0 clinical document show whether its labs and vitals were imported?
      instructions:
      - text: Retrieve API 2.0 clinical document {id}.
        slots:
          id: path.id
      - text: Get which sections were imported from 2.0 clinical document {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/clinical_documents/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a clinical document in API 2.0
      effect: destructive
      questions:
      - How do I delete an imported clinical document in the 2.0 API?
      - Can I remove a CCDA uploaded to the wrong patient?
      instructions:
      - text: Delete API 2.0 clinical document {id}.
        slots:
          id: path.id
      - text: Remove misfiled 2.0 clinical document {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'