August Health

August Health Immunizations (v1) API

The Immunizations (v1) API from August Health — 2 operation(s) for immunizations (v1).

GitHub OpenAPI

Operations 2

GET /v1/organizations/{orgId}/facilities/{facilityId}/people/{personId}/immunizations List a resident's immunizations #
GET /v1/organizations/{orgId}/facilities/{facilityId}/people/{personId}/immunizations/{id} Get an immunization #

Documentation

📖
Documentation
https://developer.augusthealth.com
📖
APIReference
https://developer.augusthealth.com/reference
📖
GettingStarted
https://developer.augusthealth.com/docs/getting-started
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/august-health/refs/heads/main/authentication/august-health-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/august-health/refs/heads/main/rate-limits/august-health-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/august-health/refs/heads/main/openapi/august-health-immunizations-v1-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/august-health/refs/heads/main/json-schema/august-health-com-august-api-integrations-models-people-v1-person-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/august-health/refs/heads/main/json-schema/august-health-com-august-api-integrations-models-care-v1-routine-administration-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/august-health/refs/heads/main/json-schema/august-health-com-august-api-integrations-models-census-v1-census-person-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/august-health/refs/heads/main/json-schema/august-health-com-august-api-integrations-models-medication-orders-v1-medication-order-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/august-health/refs/heads/main/json-schema/august-health-com-august-api-integrations-models-people-v1-create-person-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/august-health/refs/heads/main/json-schema/august-health-com-august-api-integrations-models-medication-administrations-v1-medication-administration-schema.json

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/august-health/refs/heads/main/asyncapi/august-health-events-asyncapi.yml
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/august-health/refs/heads/main/llms/august-health-llms.txt

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/august-health:august-health-immunizations-v1-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

august-health-immunizations-v1-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: August Health Integrations Immunizations (v1) API
  version: '1.0'
servers:
- url: https://integrations.staging.augusthealth.com
security:
- BearerAuth: []
tags:
- name: Immunizations (v1)
paths:
  /v1/organizations/{orgId}/facilities/{facilityId}/people/{personId}/immunizations:
    get:
      description: Lists all immunizations recorded for a resident.
      operationId: listImmunizationsV1
      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
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/com.august.api.integrations.models.immunizations.v1.Immunization'
                    type: array
                type: object
          description: Successfully listed the resident's immunizations.
        '401':
          description: Authentication required
        '403':
          description: User lacks permission to read immunizations for this person
      summary: List a resident's immunizations
      tags:
      - Immunizations (v1)
  /v1/organizations/{orgId}/facilities/{facilityId}/people/{personId}/immunizations/{id}:
    get:
      description: Retrieves a single immunization by ID for a resident.
      operationId: getImmunizationV1
      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: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/com.august.api.integrations.models.immunizations.v1.Immunization'
                type: object
          description: Successfully retrieved the immunization.
        '401':
          description: Authentication required
        '403':
          description: User lacks permission to read immunizations for this person
        '404':
          description: Immunization or person not found
      summary: Get an immunization
      tags:
      - Immunizations (v1)
components:
  schemas:
    com.august.api.integrations.models.common_metadata.v1.UserReference:
      properties:
        userId:
          description: The user's ID
          type: string
        userName:
          $ref: '#/components/schemas/com.august.api.integrations.models.common_metadata.v1.HumanName'
          description: The user's name
    com.august.api.integrations.models.contacts.v1.GenericOrganizationContact:
      properties:
        address:
          $ref: '#/components/schemas/com.august.api.integrations.models.common_metadata.v1.Address'
        name:
          $ref: '#/components/schemas/com.august.api.integrations.models.common_metadata.v1.HumanName'
        telecom:
          items:
            $ref: '#/components/schemas/com.august.api.integrations.models.contacts.v1.ContactPoint'
          type: array
      required:
      - telecom
    com.august.protos.address.Address.AddressUse:
      enum:
      - ADDRESS_USE_HOME
      - ADDRESS_USE_WORK
      - ADDRESS_USE_TEMP
      - ADDRESS_USE_OLD
      - ADDRESS_USE_BILLING
      type: string
    com.august.api.integrations.models.medication_orders.v1.Coding:
      properties:
        code:
          description: The code value within the system
          type: string
        display:
          description: Human-readable description of the code
          type: string
        system:
          $ref: '#/components/schemas/com.august.protos.codeable_concept.SystemUrl'
          description: The coding system (e.g., RXNORM, NDC, SNOMED_CT)
      required:
      - system
      - code
      - display
    com.august.protos.contact_point.ContactPoint.ContactPointSystem:
      enum:
      - CONTACT_POINT_SYSTEM_PHONE
      - CONTACT_POINT_SYSTEM_FAX
      - CONTACT_POINT_SYSTEM_EMAIL
      type: string
    com.august.protos.human_name.HumanName.Pronouns:
      enum:
      - PRONOUNS_SHE_HER
      - PRONOUNS_HE_HIM
      - PRONOUNS_THEY_THEM
      - PRONOUNS_SHE_THEY
      - PRONOUNS_HE_THEY
      - PRONOUNS_ZE_HIR
      type: string
    com.august.api.integrations.models.medication_orders.v1.CodeableConcept:
      properties:
        coding:
          description: Structured identifiers from coding systems (e.g., NDC, RxNorm, SNOMED CT)
          items:
            $ref: '#/components/schemas/com.august.api.integrations.models.medication_orders.v1.Coding'
            description: Structured identifiers from coding systems (e.g., NDC, RxNorm, SNOMED CT)
          type: array
        text:
          description: Human-readable display name
          type: string
      required:
      - coding
      - text
    com.august.api.integrations.models.immunizations.v1.Immunization:
      properties:
        id:
          description: The immunization's ID
          type: string
        lotNumber:
          description: The vaccine lot number
          type: string
        manufacturer:
          $ref: '#/components/schemas/com.august.api.integrations.models.immunizations.v1.Manufacturer'
          description: The organization that manufactured the vaccine
        note:
          $ref: '#/components/schemas/com.august.api.integrations.models.immunizations.v1.Note'
          description: A free-text note about the immunization
        occurrenceDate:
          example: '2020-01-01'
          format: date
          type: string
        performer:
          description: The person who administered the immunization
          type: string
        personId:
          description: The resident this immunization belongs to
          type: string
        protocolApplied:
          $ref: '#/components/schemas/com.august.api.integrations.models.immunizations.v1.Protocol'
          description: The immunization protocol that was followed
        route:
          $ref: '#/components/schemas/com.august.api.integrations.models.medication_orders.v1.CodeableConcept'
          description: The route by which the immunization was administered
        site:
          $ref: '#/components/schemas/com.august.api.integrations.models.medication_orders.v1.CodeableConcept'
          description: The body site where the immunization was administered
      required:
      - id
      - personId
      - occurrenceDate
      - protocolApplied
    com.august.protos.codeable_concept.SystemUrl:
      enum:
      - SYSTEM_URL_RXNORM
      - SYSTEM_URL_SNOMED_CT
      - SYSTEM_URL_NDC
      - SYSTEM_URL_ICD_10
      - SYSTEM_URL_DEA
      - SYSTEM_URL_EDQM
      - SYSTEM_URL_GPI
      - SYSTEM_URL_NPI
      - SYSTEM_URL_UPC
      type: string
    com.august.api.integrations.models.immunizations.v1.Note:
      properties:
        author:
          $ref: '#/components/schemas/com.august.api.integrations.models.common_metadata.v1.UserReference'
          description: The user who wrote the note
        text:
          description: The note text
          type: string
        time:
          description: When the note was written
          format: date-time
          type: string
    com.august.api.integrations.models.contacts.v1.ContactPoint:
      properties:
        rank:
          format: int32
          type: integer
        system:
          $ref: '#/components/schemas/com.august.protos.contact_point.ContactPoint.ContactPointSystem'
        use:
          $ref: '#/components/schemas/com.august.protos.contact_point.ContactPoint.ContactPointUse'
        value:
          type: string
      required:
      - system
      - use
    com.august.protos.immunization.DoseNumber:
      enum:
      - DOSE_NUMBER_1
      - DOSE_NUMBER_2
      - DOSE_NUMBER_BOOSTER
      - DOSE_NUMBER_BOOSTER_2
      - DOSE_NUMBER_BOOSTER_3
      - DOSE_NUMBER_BOOSTER_4
      type: string
    com.august.api.integrations.models.immunizations.v1.Protocol:
      properties:
        doseNumber:
          $ref: '#/components/schemas/com.august.protos.immunization.DoseNumber'
          description: The dose number within the series
        seriesDoses:
          description: The total number of doses in the series
          format: int32
          type: integer
        targetDisease:
          $ref: '#/components/schemas/com.august.api.integrations.models.medication_orders.v1.CodeableConcept'
          description: The disease the immunization targets
      required:
      - targetDisease
    com.august.api.integrations.models.common_metadata.v1.Address:
      properties:
        city:
          type: string
        line:
          items:
            type: string
          type: array
        postalCode:
          type: string
        state:
          type: string
        text:
          type: string
        use:
          $ref: '#/components/schemas/com.august.protos.address.Address.AddressUse'
      required:
      - line
    com.august.protos.contact_point.ContactPoint.ContactPointUse:
      enum:
      - CONTACT_POINT_USE_HOME
      - CONTACT_POINT_USE_WORK
      - CONTACT_POINT_USE_MOBILE
      - CONTACT_POINT_USE_PAGER
      - CONTACT_POINT_USE_EMERGENCY
      type: string
    com.august.api.integrations.models.common_metadata.v1.HumanName:
      properties:
        family:
          type: string
        given:
          items:
            type: string
          type: array
        maiden:
          type: string
        preferredName:
          type: string
        prefix:
          type: string
        pronouns:
          $ref: '#/components/schemas/com.august.protos.human_name.HumanName.Pronouns'
        suffix:
          type: string
      required:
      - given
    com.august.api.integrations.models.immunizations.v1.Manufacturer:
      properties:
        address:
          description: Addresses for the manufacturer
          items:
            $ref: '#/components/schemas/com.august.api.integrations.models.common_metadata.v1.Address'
            description: Addresses for the manufacturer
          type: array
        contact:
          description: Named contacts at the manufacturer for a specific purpose
          items:
            $ref: '#/components/schemas/com.august.api.integrations.models.contacts.v1.GenericOrganizationContact'
            description: Named contacts at the manufacturer for a specific purpose
          type: array
        name:
          description: The manufacturer's name
          type: string
        telecom:
          description: Contact details (phone, email, etc.) for the manufacturer
          items:
            $ref: '#/components/schemas/com.august.api.integrations.models.contacts.v1.ContactPoint'
            description: Contact details (phone, email, etc.) for the manufacturer
          type: array
  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