# 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 Family Histories API
  version: 1.0.0
extends: openapi/elation-health-family-histories-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: 8
- target: $.paths['/family_histories/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a family history entry (Get)
      effect: read
      questions:
      - How do I get one family history entry for a patient?
      - Can I get the relationship on a family history record?
      instructions:
      - text: Get family history {id}.
        slots:
          id: path.id
      - text: Get the relative and condition on family history {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/family_histories/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a family history entry (legacy)
      effect: destructive
      questions:
      - How do I delete a family history entry with the older call?
      - Can I remove a wrong family history item?
      instructions:
      - text: Delete family history {id} with the legacy call.
        slots:
          id: path.id
      - text: Remove incorrect family history item {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/family_histories/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a patient's family history
      effect: read
      questions:
      - What conditions run in a patient's family?
      - Can I find all family history entries for one patient on the legacy endpoint?
      instructions:
      - text: Find family history for patient {patient}.
        slots:
          patient: query.patient
      - text: Find what conditions relatives of {patient} had.
        slots:
          patient: query.patient
      method: generated
      generated: '2026-10-02'
- target: $.paths['/family_histories/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a family history entry (legacy)
      effect: write
      questions:
      - How do I add a relative's condition with a SNOMED code using the older create?
      - Can I rank family history entries when adding them?
      instructions:
      - text: 'Add family history for {patient} via the legacy endpoint: {relationship} had {text}.'
        slots:
          patient: requestBody.patient
          relationship: requestBody.relationship
          text: requestBody.text
      - text: Legacy-add family history for {patient}, relative {relationship}, SNOMED {snomed_code}, rank {rank}.
        slots:
          patient: requestBody.patient
          relationship: requestBody.relationship
          snomed_code: requestBody.snomed_code
          rank: requestBody.rank
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/2.0/family_histories/'].get
  update:
    x-apievangelist-phrasing:
      intent: List family histories with paging
      effect: read
      questions:
      - Can I page through family histories across a practice?
      - How do I list family history entries sorted by rank in the v2.0 API?
      instructions:
      - text: List family histories for practice {practice}, {limit} per page.
        slots:
          practice: query.practice
          limit: query.limit
      - text: List family histories of {patient} ordered by {order_by}.
        slots:
          patient: query.patient
          order_by: query.order_by
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/2.0/family_histories/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a family history entry
      effect: write
      questions:
      - Do I send text or an ICD-9 code when creating a family history in the v2.0 API?
      - What happens if I send both text and a code for a family history entry?
      instructions:
      - text: 'Create family history for {patient}: {relationship}, ICD-9 {icd9_code}.'
        slots:
          patient: requestBody.patient
          relationship: requestBody.relationship
          icd9_code: requestBody.icd9_code
      - text: 'Create a free-text family history for {patient}, {relationship}: {text}.'
        slots:
          patient: requestBody.patient
          relationship: requestBody.relationship
          text: requestBody.text
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/2.0/family_histories/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a family history entry
      effect: read
      questions:
      - Can I retrieve one family history entry with its codes?
      - Where do I retrieve a family history's ICD-9 or SNOMED code?
      instructions:
      - text: Retrieve family history {id}.
        slots:
          id: path.id
      - text: Retrieve the codes on family history {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/family_histories/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a family history entry
      effect: destructive
      questions:
      - How do I delete an existing family history by id?
      - Can a family history record be destroyed?
      instructions:
      - text: Delete existing family history {id}.
        slots:
          id: path.id
      - text: Destroy family history record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'