# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Medplum - OpenAPI 3.0 Fhir API
  version: 1.0.0
extends: openapi/medplum-fhir-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: 8
- target: $.paths['/fhir/R4/{resourceType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Search FHIR resources of a given type
      effect: read
      questions:
      - How do I list all the Patient resources stored in my Medplum project?
      - Can I pull back every Observation of one resource type in a single FHIR search?
      - What endpoint returns a search bundle for a FHIR resource type?
      instructions:
      - text: Search all {resourceType} resources in the FHIR store.
        slots:
          resourceType: path.resourceType
      - text: Return a search bundle of every Practitioner record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fhir/R4/{resourceType}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new FHIR resource
      effect: write
      questions:
      - How do I add a brand-new Patient record to the FHIR server?
      - Can I post a new Encounter resource and have the server assign its id?
      - Which call stores a new FHIR resource that doesn't exist yet?
      instructions:
      - text: Create a new {resourceType} resource in the FHIR store.
        slots:
          resourceType: path.resourceType
      - text: Add a new Patient record for the person I'm registering.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fhir/R4/{resourceType}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch one FHIR resource by its id
      effect: read
      questions:
      - How do I fetch a single Patient by its FHIR id?
      - What does the current version of a specific FHIR resource look like right now?
      instructions:
      - text: Get the current {resourceType} with id {id}.
        slots:
          resourceType: path.resourceType
          id: path.id
      - text: Open Patient {id} and show me its details.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fhir/R4/{resourceType}/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an existing FHIR resource
      effect: write
      questions:
      - How do I overwrite an existing FHIR resource with a complete new copy?
      - Can I send the whole updated Patient body to replace the stored one?
      instructions:
      - text: Replace {resourceType} {id} with the full updated resource I provide.
        slots:
          resourceType: path.resourceType
          id: path.id
      - text: Save my fully edited version of Patient {id} over the stored record.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fhir/R4/{resourceType}/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a FHIR resource
      effect: destructive
      questions:
      - How do I remove a FHIR resource from my Medplum project?
      - Can I delete a duplicate Patient record by its id?
      instructions:
      - text: Delete {resourceType} {id}.
        slots:
          resourceType: path.resourceType
          id: path.id
      - text: Remove the duplicate Patient with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fhir/R4/{resourceType}/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a FHIR resource
      effect: write
      questions:
      - How do I change just one field on a FHIR resource without resending the whole thing?
      - Can I update only a couple of fields on an existing Observation in place?
      instructions:
      - text: Patch only the changed fields on {resourceType} {id}.
        slots:
          resourceType: path.resourceType
          id: path.id
      - text: Apply a partial patch to Patient {id} to fix its phone number.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fhir/R4/{resourceType}/{id}/_history'].get
  update:
    x-apievangelist-phrasing:
      intent: List the version history of a FHIR resource
      effect: read
      questions:
      - How can I see every change ever made to a Patient record?
      - Which past versions exist for a given FHIR resource?
      instructions:
      - text: Show the full version history of {resourceType} {id}.
        slots:
          resourceType: path.resourceType
          id: path.id
      - text: List all past revisions of Patient {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fhir/R4/{resourceType}/{id}/_history/{versionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a specific past version of a FHIR resource
      effect: read
      questions:
      - How do I retrieve an older version of a FHIR resource by its version id?
      - Can I see exactly what a Patient record looked like at a particular revision?
      instructions:
      - text: Get version {versionId} of {resourceType} {id}.
        slots:
          versionId: path.versionId
          resourceType: path.resourceType
          id: path.id
      - text: Show me Patient {id} as it was at version {versionId}.
        slots:
          id: path.id
          versionId: path.versionId
      method: generated
      generated: '2026-09-26'