athenahealth Encounters API

The Encounters API from athenahealth — 2 operation(s) for encounters.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

athena-health-encounters-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: athenahealth athenaOne REST AllergyIntolerance Encounters API
  description: 'The athenaOne proprietary REST API exposes the full provider, patient,

    scheduling, clinical, and biller workflow surface of the athenahealth

    cloud-based EHR and practice management platform. All resources are

    scoped to a practice via the practiceid path parameter.

    '
  version: 1.0.0
  contact:
    name: athenahealth Developer Support
    url: https://docs.athenahealth.com/api/support
  license:
    name: athenahealth API Terms
    url: https://www.athenahealth.com/legal/terms
servers:
- url: https://api.platform.athenahealth.com/v1/{practiceid}
  description: Production athenaOne API
  variables:
    practiceid:
      default: '195900'
      description: athenaOne practice identifier
- url: https://api.preview.platform.athenahealth.com/v1/{practiceid}
  description: Preview (sandbox) athenaOne API
  variables:
    practiceid:
      default: '195900'
      description: athenaOne preview practice identifier
security:
- oauth2: []
tags:
- name: Encounters
paths:
  /chart/{patientid}/encounters:
    get:
      summary: List Patient Encounters
      operationId: listPatientEncounters
      tags:
      - Encounters
      parameters:
      - name: patientid
        in: path
        required: true
        schema:
          type: integer
      - name: departmentid
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: Encounters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EncounterList'
  /chart/encounter/{encounterid}:
    get:
      summary: Get Encounter
      operationId: getEncounter
      tags:
      - Encounters
      parameters:
      - name: encounterid
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Encounter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Encounter'
components:
  schemas:
    EncounterList:
      type: array
      items:
        $ref: '#/components/schemas/Encounter'
    Encounter:
      type: object
      properties:
        encounterid:
          type: string
        patientid:
          type: string
        appointmentid:
          type: string
        encountertype:
          type: string
        encounterdate:
          type: string
          format: date
        providerid:
          type: integer
        departmentid:
          type: integer
        status:
          type: string
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.platform.athenahealth.com/oauth2/v1/token
          scopes:
            athena/service/Athenanet.MDP.*: athenahealth MDP scope
        authorizationCode:
          authorizationUrl: https://api.platform.athenahealth.com/oauth2/v1/authorize
          tokenUrl: https://api.platform.athenahealth.com/oauth2/v1/token
          scopes:
            athena/service/Athenanet.MDP.*: athenahealth MDP scope