anpheros-com OAuth API

openapi: 3.2.0
info:
  title: Anpheros Platform OAuth 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: OAuth
paths:
  /oauth/authorize:
    get:
      tags:
      - OAuth
      summary: Consent page (authorization code + PKCE)
      operationId: authorize_oauth_authorize_get
      parameters:
      - name: response_type
        in: query
        required: true
        schema:
          type: string
          title: Response Type
      - name: client_id
        in: query
        required: true
        schema:
          type: string
          title: Client Id
      - name: redirect_uri
        in: query
        required: true
        schema:
          type: string
          title: Redirect Uri
      - name: scope
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Scope
      - name: state
        in: query
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 4096
          title: State
      - name: code_challenge
        in: query
        required: true
        schema:
          type: string
          minLength: 43
          maxLength: 128
          title: Code Challenge
      - name: code_challenge_method
        in: query
        required: false
        schema:
          type: string
          default: S256
          title: Code Challenge Method
      - name: purpose
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Purpose
      - name: patient
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Patient
      - name: lang
        in: query
        required: false
        schema:
          type: string
          default: en
          title: Lang
      - name: resource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Resource
      responses:
        '200':
          description: Successful Response
          content:
            text/html:
              schema:
                type: string
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '401':
          description: 'Missing, invalid, expired or revoked credential (`WWW-Authenticate: Bearer`).'
  /oauth/token:
    post:
      tags:
      - OAuth
      summary: Token endpoint
      operationId: token_oauth_token_post
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Body_token_oauth_token_post'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /oauth/revoke:
    post:
      tags:
      - OAuth
      summary: Revoke an access or refresh token
      operationId: revoke_oauth_revoke_post
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Body_revoke_oauth_revoke_post'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Body_token_oauth_token_post:
      properties:
        grant_type:
          type: string
          title: Grant Type
        client_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Client Id
        client_secret:
          anyOf:
          - type: string
          - type: 'null'
          title: Client Secret
        code:
          anyOf:
          - type: string
          - type: 'null'
          title: Code
        code_verifier:
          anyOf:
          - type: string
          - type: 'null'
          title: Code Verifier
        redirect_uri:
          anyOf:
          - type: string
          - type: 'null'
          title: Redirect Uri
        refresh_token:
          anyOf:
          - type: string
          - type: 'null'
          title: Refresh Token
        scope:
          anyOf:
          - type: string
          - type: 'null'
          title: Scope
        subject_token:
          anyOf:
          - type: string
          - type: 'null'
          title: Subject Token
        patient:
          anyOf:
          - type: string
          - type: 'null'
          title: Patient
        auth_req_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Auth Req Id
      type: object
      required:
      - grant_type
      title: Body_token_oauth_token_post
    Body_revoke_oauth_revoke_post:
      properties:
        token:
          type: string
          title: Token
        client_id:
          type: string
          title: Client Id
        client_secret:
          anyOf:
          - type: string
          - type: 'null'
          title: Client Secret
      type: object
      required:
      - token
      - client_id
      title: Body_revoke_oauth_revoke_post
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
  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).