August Health Care (v1) API

openapi: 3.2.0
info:
  title: August Health Integrations Care (v1) API
  version: '1.0'
servers:
- url: https://integrations.staging.augusthealth.com
security:
- BearerAuth: []
tags:
- name: Care (v1)
paths:
  /v1/organizations/{orgId}/facilities/{facilityId}/people/{personId}/routineAdministrations:
    get:
      operationId: listRoutineAdministrationsV1
      parameters:
      - in: path
        name: orgId
        required: true
        schema:
          type: string
      - in: path
        name: facilityId
        required: true
        schema:
          type: string
      - in: path
        name: personId
        required: true
        schema:
          type: string
      - in: query
        name: startShiftDate
        required: true
        schema:
          example: '2020-01-01'
          format: date
          type: string
      - in: query
        name: shiftId
        required: true
        schema:
          type: string
      - description: Include unscheduled (PRN) care in addition to scheduled care. Defaults to false.
        in: query
        name: includePrn
        required: false
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/com.august.api.integrations.models.care.v1.RoutineAdministration'
                    type: array
                type: object
          description: Successfully lists routine administrations.
      summary: List routine administrations for a person
      tags:
      - Care (v1)
  /v1/organizations/{orgId}/facilities/{facilityId}/people/{personId}/routineAdministrations/bulkChart:
    post:
      operationId: bulkChartRoutineAdministrationsV1
      parameters:
      - in: path
        name: orgId
        required: true
        schema:
          type: string
      - in: path
        name: facilityId
        required: true
        schema:
          type: string
      - in: path
        name: personId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                actions:
                  items:
                    discriminator:
                      mapping:
                        ADMINISTER: '#/components/schemas/com.august.api.integrations.models.care.v1.ChartingRequest.ChartMarkComplete'
                        EXCEPTION: '#/components/schemas/com.august.api.integrations.models.care.v1.ChartingRequest.ChartMarkException'
                        PRN: '#/components/schemas/com.august.api.integrations.models.care.v1.ChartingRequest.ChartPrn'
                      propertyName: type
                    oneOf:
                    - $ref: '#/components/schemas/com.august.api.integrations.models.care.v1.ChartingRequest.ChartMarkComplete'
                    - $ref: '#/components/schemas/com.august.api.integrations.models.care.v1.ChartingRequest.ChartMarkException'
                    - $ref: '#/components/schemas/com.august.api.integrations.models.care.v1.ChartingRequest.ChartPrn'
                  type: array
                shiftId:
                  type: string
                startShiftDate:
                  format: date
                  type: string
                userId:
                  type: string
                userName:
                  type: string
                voiceTranscript:
                  type: string
              required:
              - actions
              - startShiftDate
              - shiftId
              - userName
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/com.august.api.integrations.models.care.v1.RoutineAdministration'
                    type: array
                type: object
          description: Successfully returns updated routine administrations.
        '403':
          description: User lacks permission to chart.
      summary: Bulk chart routine administrations for a person
      tags:
      - Care (v1)
  /v1/organizations/{orgId}/facilities/{facilityId}/prnCareCategories:
    get:
      description: Returns the PRN (extra care) categories and subcategories available at a facility.
      operationId: listPrnCareCategoriesV1
      parameters:
      - in: path
        name: orgId
        required: true
        schema:
          type: string
      - in: path
        name: facilityId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/com.august.api.integrations.models.care.v1.PrnCareCategory'
                    type: array
                type: object
          description: Successfully lists PRN care categories.
        '401':
          description: Authentication required
        '403':
          description: User lacks permission to read PRN care categories at this facility
      summary: List PRN care categories for a facility
      tags:
      - Care (v1)
  /v1/organizations/{orgId}/facilities/{facilityId}/routineAdministrations:
    get:
      description: Returns a paginated list of routine administrations for all residents at a facility for a given shift occurrence.
      operationId: listFacilityRoutineAdministrationsV1
      parameters:
      - in: path
        name: orgId
        required: true
        schema:
          type: string
      - in: path
        name: facilityId
        required: true
        schema:
          type: string
      - description: The shift occurrence date to list administrations for
        in: query
        name: startShiftDate
        required: true
        schema:
          example: '2020-01-01'
          format: date
          type: string
      - description: The shift to list administrations for
        in: query
        name: shiftId
        required: true
        schema:
          format: int64
          type: integer
      - description: Maximum number of results to return (default 1000, max 5000)
        in: query
        name: limit
        required: false
        schema:
          default: 1000
          format: int32
          maximum: 5000
          type: integer
      - description: Number of results to skip (default 0)
        in: query
        name: offset
        required: false
        schema:
          default: 0
          format: int32
          type: integer
      - description: Include unscheduled (PRN) care in addition to scheduled care. Defaults to false.
        in: query
        name: includePrn
        required: false
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/com.august.api.integrations.models.care.v1.RoutineAdministration'
                    type: array
                  meta:
                    $ref: '#/components/schemas/com.august.api.integrations.models.common.ApiResponseMetadata'
                type: object
          description: Successfully lists routine administrations for the facility.
        '400':
          description: Invalid request parameters
        '401':
          description: Authentication required
        '403':
          description: User lacks permission to read routine administrations at this facility
      summary: List routine administrations for a facility
      tags:
      - Care (v1)
components:
  schemas:
    com.august.api.integrations.models.common.ApiResponseMetadata:
      properties:
        limit:
          description: The limit used for a paginated request for the query
          format: int32
          type: integer
        offset:
          description: The offset used for a paginated request for the query
          format: int32
          type: integer
        total:
          description: The total number of available items for the query
          format: int32
          type: integer
      required:
      - total
      - limit
      - offset
    com.august.api.integrations.models.care.v1.RoutineAdministrationExceptionReason:
      oneOf:
      - enum:
        - ROUTINE_ADMINISTRATION_EXCEPTION_REASON_RESIDENT_UNAVAILABLE
        - ROUTINE_ADMINISTRATION_EXCEPTION_REASON_RESIDENT_REFUSED
        - ROUTINE_ADMINISTRATION_EXCEPTION_REASON_RESCHEDULE_REQUESTED
        - ROUTINE_ADMINISTRATION_EXCEPTION_REASON_AWAY
        - ROUTINE_ADMINISTRATION_EXCEPTION_REASON_WRONG_SCHEDULE
        - ROUTINE_ADMINISTRATION_EXCEPTION_REASON_OTHER
        title: values
        type: string
      - deprecated: true
        enum:
        - ROUTINE_ADMINISTRATION_EXCEPTION_REASON_NOT_ENOUGH_TIME
        title: deprecated values
        type: string
    com.august.api.integrations.models.care.v1.ChartingRequest.ChartPrn:
      properties:
        categoryKey:
          $ref: '#/components/schemas/com.august.protos.service_plan.ServicePlan.PlanCategoryKey'
          description: Care category key, from the facility's PRN care categories
        id:
          format: uuid
          type: string
        subcategoryId:
          format: uuid
          type: string
        type:
          enum:
          - PRN
          type: string
      required:
      - type
      - id
      - categoryKey
    com.august.api.integrations.models.care.v1.ChartingRequest.ChartMarkComplete:
      properties:
        effortLevel:
          format: int32
          type: integer
        note:
          type: string
        routineAdministrationId:
          type: string
        type:
          enum:
          - ADMINISTER
          type: string
      required:
      - type
      - routineAdministrationId
    com.august.api.integrations.models.care.v1.RoutineAdministration:
      properties:
        adlCategoryKey:
          $ref: '#/components/schemas/com.august.protos.service_plan.ServicePlan.PlanCategoryKey'
          description: ADL category key. Omitted if not linked to a standard ADL category.
        adlCustomKey:
          description: Custom ADL key for facility-defined categories. Only present if adlCategoryKey is PLAN_CATEGORY_KEY_CUSTOM.
          type: string
        beginAdministrationWindow:
          description: Start of the window when this can be charted, in facility local time
          format: date-time
          type: string
        beginScheduledTime:
          description: Scheduled start time in facility local time. Equals endScheduledTime for time dependent routines. Omitted if unscheduled.
          format: date-time
          type: string
        effortLevel:
          description: 'Effort relative to normal: -1 for less, 0 for same, 1 for more. Omitted if not recorded.'
          format: int32
          type: integer
        endAdministrationWindow:
          description: End of the window when this can be charted, in facility local time
          format: date-time
          type: string
        endScheduledTime:
          description: Scheduled end time in facility local time. Omitted if unscheduled.
          format: date-time
          type: string
        id:
          description: Unique identifier for this administration
          type: string
        interventionEntries:
          description: Individual care tasks covered by this administration. Empty for single-task administrations; populated for grouped administrations.
          items:
            $ref: '#/components/schemas/com.august.api.integrations.models.care.v1.InterventionEntryResponse'
            description: Individual care tasks covered by this administration. Empty for single-task administrations; populated for grouped administrations.
          type: array
        isPrn:
          description: Whether this is unscheduled (PRN) care
          type: boolean
        isTwoPerson:
          description: Whether this routine requires two-person assistance
          type: boolean
        note:
          description: Free-text note documented by the caregiver when charting the administration
          type: string
        occurredAt:
          description: When the administration took place. Omitted if not yet charted.
          format: date-time
          type: string
        orderName:
          description: Name of the routine. For PRN care, the care category name.
          type: string
        personId:
          description: Person ID of the resident
          type: string
        prnSubcategory:
          $ref: '#/components/schemas/com.august.api.integrations.models.care.v1.PrnCareSubcategory'
          description: Subcategory chosen for PRN care. Omitted for scheduled care and for PRN care without a subcategory.
        reasonForException:
          $ref: '#/components/schemas/com.august.api.integrations.models.care.v1.RoutineAdministrationExceptionReason'
          description: Why the routine was not administered. Present only when the status is ROUTINE_ADMINISTRATION_STATUS_EXCEPTION.
        routineName:
          description: Name of the routine category; may be used to group routines
          type: string
        shiftId:
          description: The shift ID
          type: string
        shiftOccurrenceDate:
          example: '2020-01-01'
          format: date
          type: string
        status:
          $ref: '#/components/schemas/com.august.protos.routine_administration.RoutineAdministrationStatus'
          description: Current administration status
      required:
      - id
      - orderName
      - routineName
      - personId
      - status
      - shiftId
      - shiftOccurrenceDate
      - isTwoPerson
      - interventionEntries
      - isPrn
    com.august.api.integrations.models.care.v1.ChartingRequest.ChartMarkException:
      properties:
        note:
          type: string
        reason:
          $ref: '#/components/schemas/com.august.api.integrations.models.care.v1.RoutineAdministrationExceptionReason'
        routineAdministrationId:
          type: string
        type:
          enum:
          - EXCEPTION
          type: string
      required:
      - type
      - routineAdministrationId
      - reason
    com.august.api.integrations.models.care.v1.InterventionEntryResponse:
      properties:
        categoryKey:
          $ref: '#/components/schemas/com.august.protos.service_plan.ServicePlan.PlanCategoryKey'
        customKey:
          type: string
        interventionKey:
          type: string
        interventionName:
          type: string
        interventionNote:
          type: string
      required:
      - interventionKey
      - interventionName
    com.august.api.integrations.models.care.v1.PrnCareCategory:
      properties:
        key:
          $ref: '#/components/schemas/com.august.protos.service_plan.ServicePlan.PlanCategoryKey'
        name:
          description: Display name of the category, as shown to caregivers
          type: string
        subcategories:
          description: Subcategories configured for this category. Empty if none are configured.
          items:
            $ref: '#/components/schemas/com.august.api.integrations.models.care.v1.PrnCareSubcategory'
            description: Subcategories configured for this category. Empty if none are configured.
          type: array
      required:
      - key
      - name
      - subcategories
    com.august.protos.routine_administration.RoutineAdministrationStatus:
      enum:
      - ROUTINE_ADMINISTRATION_STATUS_ADMINISTERED
      - ROUTINE_ADMINISTRATION_STATUS_EXCEPTION
      - ROUTINE_ADMINISTRATION_STATUS_ENTERED_IN_ERROR
      - ROUTINE_ADMINISTRATION_STATUS_ON_HOLD
      - ROUTINE_ADMINISTRATION_STATUS_AWAY
      type: string
    com.august.api.integrations.models.care.v1.PrnCareSubcategory:
      properties:
        id:
          format: uuid
          type: string
        name:
          type: string
      required:
      - id
      - name
    com.august.protos.service_plan.ServicePlan.PlanCategoryKey:
      enum:
      - PLAN_CATEGORY_KEY_BATHING
      - PLAN_CATEGORY_KEY_CARE_COORDINATION
      - PLAN_CATEGORY_KEY_DRESSING
      - PLAN_CATEGORY_KEY_GROOMING
      - PLAN_CATEGORY_KEY_DENTAL
      - PLAN_CATEGORY_KEY_TOILETING
      - PLAN_CATEGORY_KEY_TRANSFER_AND_MOBILITY
      - PLAN_CATEGORY_KEY_HEARING
      - PLAN_CATEGORY_KEY_VISION
      - PLAN_CATEGORY_KEY_MEALS_AND_NUTRITION
      - PLAN_CATEGORY_KEY_SPECIAL_CARE_NEEDS
      - PLAN_CATEGORY_KEY_COGNITIVE
      - PLAN_CATEGORY_KEY_WANDERING_AND_ELOPEMENT
      - PLAN_CATEGORY_KEY_DISPOSITION_AND_BEHAVIORS
      - PLAN_CATEGORY_KEY_SLEEP
      - PLAN_CATEGORY_KEY_COMMUNICATION
      - PLAN_CATEGORY_KEY_PSYCHO_SOCIAL_ENGAGEMENT
      - PLAN_CATEGORY_KEY_MEDICATION_MANAGEMENT
      - PLAN_CATEGORY_KEY_TRANSFER
      - PLAN_CATEGORY_KEY_MOBILITY
      - PLAN_CATEGORY_KEY_ADDITIONAL_SERVICES
      - PLAN_CATEGORY_KEY_CUSTOM
      type: string
  securitySchemes:
    BearerAuth:
      scheme: bearer
      type: http
x-provenance:
  method: searched
  source: https://developer.augusthealth.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.augusthealth.com/reference/bulkchartroutineadministrationsv1.md
  - https://developer.augusthealth.com/reference/createcontactv1-1.md
  - https://developer.augusthealth.com/reference/createincidentv1.md
  - https://developer.augusthealth.com/reference/createpersonv1-1.md
  - https://developer.augusthealth.com/reference/createresidentbiographyv1.md
  - https://developer.augusthealth.com/reference/createtokenv1.md
  - https://developer.augusthealth.com/reference/createvisitorlogv1.md
  - https://developer.augusthealth.com/reference/createvitalv1.md
  - https://developer.augusthealth.com/reference/createwebhooksportalaccessurlv1.md
  - https://developer.augusthealth.com/reference/deletevisitorlogv1.md
  - https://developer.augusthealth.com/reference/extractresidentbiographyv1.md
  - https://developer.augusthealth.com/reference/getadmissionagreementpdfv1.md
  - https://developer.augusthealth.com/reference/getadmissionagreementv1.md
  - https://developer.augusthealth.com/reference/getadmissionhistoryv1.md
  - https://developer.augusthealth.com/reference/getassessmentv1.md
  - https://developer.augusthealth.com/reference/getbillingsummaryv1.md
  - https://developer.augusthealth.com/reference/getcensuspersonv1.md
  - https://developer.augusthealth.com/reference/getcontactv1-1.md
  - https://developer.augusthealth.com/reference/getfacilityadmissionhistoryv1.md
  - https://developer.augusthealth.com/reference/getfacilitybedassignmenthistoryv1.md
  - https://developer.augusthealth.com/reference/getimmunizationv1.md
  - https://developer.augusthealth.com/reference/getincidentv1.md
  - https://developer.augusthealth.com/reference/getlatestadmissionagreementv1.md
  - https://developer.augusthealth.com/reference/getlatestassessmentv1.md
  - https://developer.augusthealth.com/reference/getlatestresidentbiographyv1.md
  - https://developer.augusthealth.com/reference/getpersonprofilephotov1.md
  - https://developer.augusthealth.com/reference/getpersonv1-1.md
  - https://developer.augusthealth.com/reference/getstatementpdfv1.md
  - https://developer.augusthealth.com/reference/getvitalv1.md
  - https://developer.augusthealth.com/reference/listbedassignmentsv1.md
  - https://developer.augusthealth.com/reference/listcensusv1.md
  - https://developer.augusthealth.com/reference/listcontactsv1-1.md
  - https://developer.augusthealth.com/reference/listfacilitiesv1-1.md
  - https://developer.augusthealth.com/reference/listfacilitybillingsummariesv1.md
  - https://developer.augusthealth.com/reference/listfacilityincidentsv1.md
  - https://developer.augusthealth.com/reference/listfacilitymedicationadministrationsv1.md
  - https://developer.augusthealth.com/reference/listfacilitymedicationordersv1.md
  - https://developer.augusthealth.com/reference/listfacilityroutineadministrationsv1.md
  - https://developer.augusthealth.com/reference/listimmunizationsv1.md
  - https://developer.augusthealth.com/reference/listmedpassesv1.md
  - https://developer.augusthealth.com/reference/listorganizationsv1.md
  - https://developer.augusthealth.com/reference/listpeoplev1-1.md
  - https://developer.augusthealth.com/reference/listpersonincidentsv1.md
  - https://developer.augusthealth.com/reference/listpersonmedicationadministrationsv1.md
  - https://developer.augusthealth.com/reference/listpersonmedicationordersv1.md
  - https://developer.augusthealth.com/reference/listprncarecategoriesv1.md
  - https://developer.augusthealth.com/reference/listresidentbillingtransactionsv1.md
  - https://developer.augusthealth.com/reference/listroomsv1.md
  - https://developer.augusthealth.com/reference/listroutineadministrationsv1.md
  - https://developer.augusthealth.com/reference/listshiftsv1.md
  - https://developer.augusthealth.com/reference/listtasksv1.md
  - https://developer.augusthealth.com/reference/listusersv1.md
  - https://developer.augusthealth.com/reference/listvisitorlogsv1.md
  - https://developer.augusthealth.com/reference/listvitalsv1.md
  - https://developer.augusthealth.com/reference/patchpersonv1.md
  - https://developer.augusthealth.com/reference/recordchargesv1.md
  - https://developer.augusthealth.com/reference/recorddepositv1.md
  - https://developer.augusthealth.com/reference/searchstatementsv1.md
  - https://developer.augusthealth.com/reference/setresponsiblepersonv1-1.md
  - https://developer.augusthealth.com/reference/updateincidentv1.md
  - https://developer.augusthealth.com/reference/updatevitalv1.md
  merge:
    pages: 61
    deduped: 634
    conflicts_kept_first: 0