anpheros-com Patient (me) API

openapi: 3.2.0
info:
  title: Anpheros Platform Patient (me) API
  description: 'Health-data platform for developers, clinics and AI agents.


    * **FHIR R4** at `/fhir/R4` — the strict interface (search, history, transactions, Provenance).

    * **REST v1** at `/v1` — the simplified interface for app developers, same data, same ids.

    * **Admin** at `/admin` — organizations, projects, applications and API keys (Firebase user token).

    * **OAuth 2.1 / SMART** at `/oauth/*` — patient consent with PKCE; `/me/*` — the patient''s own connections.


    Authenticate with an API key (`Authorization: Bearer sk_test_…` / `sk_live_…`) or an OAuth access token (`at_…`).

    Every response carries `Anpheros-Request-Id`; POSTs accept `Idempotency-Key`.'
  version: 0.3.0
servers:
- url: https://platform.anpheros.com
  description: Sandbox and production share this address; the key decides the data plane.
tags:
- name: Patient (me)
paths:
  /me/patients/{patient_id}/specialties:
    get:
      tags:
      - Patient (me)
      summary: My record grouped by medical specialty
      operationId: my_specialties_me_patients__patient_id__specialties_get
      parameters:
      - name: patient_id
        in: path
        required: true
        schema:
          type: string
          title: Patient Id
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
  /me/patients:
    get:
      tags:
      - Patient (me)
      summary: My records (and my dependents')
      operationId: my_patients_me_patients_get
      parameters:
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
  /me/patients/{patient_id}/grants:
    get:
      tags:
      - Patient (me)
      summary: Who has access to this record
      operationId: my_grants_me_patients__patient_id__grants_get
      parameters:
      - name: patient_id
        in: path
        required: true
        schema:
          type: string
          title: Patient Id
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: lang
        in: query
        required: false
        schema:
          type: string
          default: en
          title: Lang
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
  /me/patients/{patient_id}/grants/{grant_id}/revoke:
    post:
      tags:
      - Patient (me)
      summary: Revoke an app's access
      operationId: my_revoke_me_patients__patient_id__grants__grant_id__revoke_post
      parameters:
      - name: patient_id
        in: path
        required: true
        schema:
          type: string
          title: Patient Id
      - name: grant_id
        in: path
        required: true
        schema:
          type: string
          title: Grant Id
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/RevokeIn'
              - type: 'null'
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
  /me/patients/{patient_id}/grants/{grant_id}/access-log:
    get:
      tags:
      - Patient (me)
      summary: What this app read or wrote
      operationId: my_access_log_me_patients__patient_id__grants__grant_id__access_log_get
      parameters:
      - name: patient_id
        in: path
        required: true
        schema:
          type: string
          title: Patient Id
      - name: grant_id
        in: path
        required: true
        schema:
          type: string
          title: Grant Id
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          default: 100
          title: Limit
      - name: format
        in: query
        required: false
        schema:
          enum:
          - json
          - fhir
          type: string
          default: json
          title: Format
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
  /me/patients/{patient_id}/shl:
    post:
      tags:
      - Patient (me)
      summary: Create a SMART Health Link (QR) to my summary
      operationId: create_link_me_patients__patient_id__shl_post
      parameters:
      - name: patient_id
        in: path
        required: true
        schema:
          type: string
          title: Patient Id
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShlIn'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
    get:
      tags:
      - Patient (me)
      summary: My SMART Health Links, with how often each was opened
      operationId: list_links_me_patients__patient_id__shl_get
      parameters:
      - name: patient_id
        in: path
        required: true
        schema:
          type: string
          title: Patient Id
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
  /me/patients/{patient_id}/shl/{link_id}/revoke:
    post:
      tags:
      - Patient (me)
      summary: Switch a SMART Health Link off
      operationId: revoke_link_me_patients__patient_id__shl__link_id__revoke_post
      parameters:
      - name: patient_id
        in: path
        required: true
        schema:
          type: string
          title: Patient Id
      - name: link_id
        in: path
        required: true
        schema:
          type: string
          title: Link Id
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
  /me/patients/{patient_id}/preferences/results:
    get:
      tags:
      - Patient (me)
      summary: 'When results from clinics appear: right away or after the doctor saw them'
      operationId: get_pref_me_patients__patient_id__preferences_results_get
      parameters:
      - name: patient_id
        in: path
        required: true
        schema:
          type: string
          title: Patient Id
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
    put:
      tags:
      - Patient (me)
      summary: Choose when results from clinics appear
      operationId: put_pref_me_patients__patient_id__preferences_results_put
      parameters:
      - name: patient_id
        in: path
        required: true
        schema:
          type: string
          title: Patient Id
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReleasePrefIn'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
  /me/patients/{patient_id}/results/held:
    get:
      tags:
      - Patient (me)
      summary: 'Results waiting for the doctor: who sent them and until when (no content)'
      operationId: held_list_me_patients__patient_id__results_held_get
      parameters:
      - name: patient_id
        in: path
        required: true
        schema:
          type: string
          title: Patient Id
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
  /me/patients/{patient_id}/results/held/{resource_id}/release:
    post:
      tags:
      - Patient (me)
      summary: Show a waiting result now („Show it now”)
      operationId: release_now_me_patients__patient_id__results_held__resource_id__release_post
      parameters:
      - name: patient_id
        in: path
        required: true
        schema:
          type: string
          title: Patient Id
      - name: resource_id
        in: path
        required: true
        schema:
          type: string
          title: Resource Id
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
  /me/access-requests:
    get:
      tags:
      - Patient (me)
      summary: Clinics and apps asking for access to my record
      operationId: list_requests_me_access_requests_get
      parameters:
      - name: status
        in: query
        required: false
        schema:
          enum:
          - pending
          - all
          type: string
          default: pending
          title: Status
      - name: lang
        in: query
        required: false
        schema:
          type: string
          default: en
          title: Lang
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
  /me/access-requests/{request_id}/approve:
    post:
      tags:
      - Patient (me)
      summary: Allow the clinic that asked
      operationId: approve_me_access_requests__request_id__approve_post
      parameters:
      - name: request_id
        in: path
        required: true
        schema:
          type: string
          title: Request Id
      - name: lang
        in: query
        required: false
        schema:
          type: string
          default: en
          title: Lang
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/DecisionIn'
              - type: 'null'
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
  /me/access-requests/{request_id}/deny:
    post:
      tags:
      - Patient (me)
      summary: Refuse the clinic that asked
      operationId: deny_me_access_requests__request_id__deny_post
      parameters:
      - name: request_id
        in: path
        required: true
        schema:
          type: string
          title: Request Id
      - name: lang
        in: query
        required: false
        schema:
          type: string
          default: en
          title: Lang
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
  /me/patients/{patient_id}/proposals:
    get:
      tags:
      - Patient (me)
      summary: What AI agents want to write in my record
      operationId: list_proposals_me_patients__patient_id__proposals_get
      parameters:
      - name: patient_id
        in: path
        required: true
        schema:
          type: string
          title: Patient Id
      - name: status
        in: query
        required: false
        schema:
          enum:
          - pending
          - accepted
          - rejected
          - expired
          - all
          type: string
          default: pending
          title: Status
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
  /me/patients/{patient_id}/proposals/{proposal_id}/accept:
    post:
      tags:
      - Patient (me)
      summary: Accept what an AI agent proposed
      operationId: accept_proposal_me_patients__patient_id__proposals__proposal_id__accept_post
      parameters:
      - name: patient_id
        in: path
        required: true
        schema:
          type: string
          title: Patient Id
      - name: proposal_id
        in: path
        required: true
        schema:
          type: string
          title: Proposal Id
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
  /me/patients/{patient_id}/proposals/{proposal_id}/reject:
    post:
      tags:
      - Patient (me)
      summary: Reject what an AI agent proposed
      operationId: reject_proposal_me_patients__patient_id__proposals__proposal_id__reject_post
      parameters:
      - name: patient_id
        in: path
        required: true
        schema:
          type: string
          title: Patient Id
      - name: proposal_id
        in: path
        required: true
        schema:
          type: string
          title: Proposal Id
      - name: environment
        in: query
        required: false
        schema:
          enum:
          - sandbox
          - production
          type: string
          default: production
          title: Environment
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
      security:
      - firebase: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ShlIn:
      properties:
        content:
          type: string
          enum:
          - ips
          - emergency
          - custom
          title: Content
          default: emergency
        include:
          anyOf:
          - $ref: '#/components/schemas/ShlInclude'
          - type: 'null'
        label:
          anyOf:
          - type: string
            maxLength: 80
          - type: 'null'
          title: Label
        lang:
          anyOf:
          - type: string
            maxLength: 8
          - type: 'null'
          title: Lang
        passcode:
          anyOf:
          - type: string
            maxLength: 64
            minLength: 4
          - type: 'null'
          title: Passcode
        expires_in_days:
          anyOf:
          - type: integer
            maximum: 3650.0
            minimum: 1.0
          - type: 'null'
          title: Expires In Days
      type: object
      title: ShlIn
    DecisionIn:
      properties:
        days:
          type: integer
          title: Days
          default: 90
      type: object
      title: DecisionIn
    ReleasePrefIn:
      properties:
        release:
          type: string
          enum:
          - immediate
          - after_review
          title: Release
        max_hold_days:
          type: integer
          maximum: 14.0
          minimum: 1.0
          title: Max Hold Days
          default: 7
      type: object
      required:
      - release
      title: ReleasePrefIn
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    RevokeIn:
      properties:
        reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Reason
      type: object
      title: RevokeIn
    ShlInclude:
      properties:
        sections:
          items:
            type: string
            enum:
            - allergies
            - medications
            - problems
            - immunizations
            - results
            - vitals
          type: array
          maxItems: 6
          title: Sections
        results_since:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Results Since
        observations:
          items:
            type: string
          type: array
          maxItems: 200
          title: Observations
        documents:
          items:
            type: string
          type: array
          maxItems: 20
          title: Documents
        imaging:
          type: boolean
          title: Imaging
          default: false
        specialties:
          items:
            type: string
          type: array
          maxItems: 19
          title: Specialties
        exclude:
          items:
            type: string
          type: array
          maxItems: 200
          title: Exclude
        current_medications:
          type: boolean
          title: Current Medications
          default: false
      type: object
      title: ShlInclude
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: A project API key (`sk_test_…` sandbox, `sk_live_…` production) or an OAuth access token (`at_…`).
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: The same project API key, as a header.
    oauth2:
      type: oauth2
      description: SMART on FHIR v2 scopes; authorization code with PKCE for a person's record, client_credentials for a project.
      flows:
        authorizationCode:
          authorizationUrl: https://platform.anpheros.com/oauth/authorize
          tokenUrl: https://platform.anpheros.com/oauth/token
          refreshUrl: https://platform.anpheros.com/oauth/token
          scopes:
            patient/*.rs: Read the whole record
            patient/Observation.rs: Read measurements and lab results
            patient/Observation.rs?category=laboratory: Read lab results only
            patient/Condition.rs: Read conditions
            patient/MedicationStatement.rs: Read medications
            patient/DocumentReference.rs: Read documents
            patient/AllergyIntolerance.rs: Read allergies
            offline_access: Refresh token
            openid: OpenID Connect
            fhirUser: Identity of the person
            anpheros/patterns: Pattern analysis on production records (separate patient consent)
        clientCredentials:
          tokenUrl: https://platform.anpheros.com/oauth/token
          scopes: {}
    firebase:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Firebase ID token of a developer (dashboard, Admin) or of a patient (/me).