openapi: 3.2.0
info:
  title: Select Medical FHIR R4 Immunization API
  version: 4.0.1
  summary: HL7 FHIR R4 patient-access API operated by Select Medical on its Epic platform.
  description: Machine-readable description of the Select Medical FHIR R4 server, DERIVED mechanically from the server's own CapabilityStatement at https://epicproxy.et0948.epichosted.com/FhirProxy/api/FHIR/R4/metadata (fetched 2026-08-28, HTTP 200, application/fhir+json).
  contact:
    name: Select Medical
    url: https://www.selectmedical.com/
  license:
    name: HL7 FHIR R4 (4.0.1)
    url: https://hl7.org/fhir/R4/
servers:
- url: https://epicproxy.et0948.epichosted.com/FhirProxy/api/FHIR/R4
  description: Select Medical FHIR R4 production server (Epic FhirProxy, community et0948)
security:
- smartOnFhir: []
tags:
- name: Immunization
  description: 'FHIR R4 Immunization resource as declared by the Select Medical FHIR server CapabilityStatement. Declared US Core profiles: us-core-immunization|6.1.0.'
paths:
  /Immunization:
    get:
      operationId: searchImmunization
      summary: Search Immunization resources
      description: Search for Immunization resources. Declared search parameters come verbatim from the server's CapabilityStatement.
      tags:
      - Immunization
      parameters:
      - name: date
        in: query
        description: Refine a search for Immunization resources by vaccine administration date. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included.
        required: false
        schema:
          type: string
      - name: patient
        in: query
        description: Search for Immunization resources for a specified patient ID.
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: Refine a search for Immunization resources by status.
        required: false
        schema:
          type: string
      - name: _count
        in: query
        description: Number of results per page.
        required: false
        schema:
          type: string
      - name: _id
        in: query
        description: FHIR resource IDs for the desired resources. Can be used in combination with _count, _include, and _revInclude. All others will be ignored.
        required: false
        schema:
          type: string
      - name: identifier
        in: query
        description: FHIR search parameter 'identifier' declared for Immunization.
        required: false
        schema:
          type: string
      - name: location
        in: query
        description: FHIR search parameter 'location' declared for Immunization.
        required: false
        schema:
          type: string
      - name: lot-number
        in: query
        description: FHIR search parameter 'lot-number' declared for Immunization.
        required: false
        schema:
          type: string
      - name: manufacturer
        in: query
        description: FHIR search parameter 'manufacturer' declared for Immunization.
        required: false
        schema:
          type: string
      - name: performer
        in: query
        description: FHIR search parameter 'performer' declared for Immunization.
        required: false
        schema:
          type: string
      - name: reaction
        in: query
        description: FHIR search parameter 'reaction' declared for Immunization.
        required: false
        schema:
          type: string
      - name: reaction-date
        in: query
        description: FHIR search parameter 'reaction-date' declared for Immunization.
        required: false
        schema:
          type: string
      - name: reason-code
        in: query
        description: FHIR search parameter 'reason-code' declared for Immunization.
        required: false
        schema:
          type: string
      - name: reason-reference
        in: query
        description: FHIR search parameter 'reason-reference' declared for Immunization.
        required: false
        schema:
          type: string
      - name: series
        in: query
        description: FHIR search parameter 'series' declared for Immunization.
        required: false
        schema:
          type: string
      - name: status-reason
        in: query
        description: FHIR search parameter 'status-reason' declared for Immunization.
        required: false
        schema:
          type: string
      - name: target-disease
        in: query
        description: FHIR search parameter 'target-disease' declared for Immunization.
        required: false
        schema:
          type: string
      - name: vaccine-code
        in: query
        description: FHIR search parameter 'vaccine-code' declared for Immunization.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: A Bundle of matching Immunization resources.
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/Bundle'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /Immunization/{id}:
    get:
      operationId: readImmunization
      summary: Read a Immunization resource by id
      tags:
      - Immunization
      description: Retrieve a single Immunization resource by its logical id.
      parameters:
      - name: id
        in: path
        required: true
        description: Logical id of the Immunization resource.
        schema:
          type: string
      responses:
        '200':
          description: The requested Immunization resource.
          content:
            application/fhir+json:
              schema:
                $ref: '#/components/schemas/Resource'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Forbidden:
      description: The token does not carry the scope required for this resource.
      content:
        application/fhir+json:
          schema:
            $ref: '#/components/schemas/OperationOutcome'
    NotFound:
      description: No resource of this type with that id.
      content:
        application/fhir+json:
          schema:
            $ref: '#/components/schemas/OperationOutcome'
    Unauthorized:
      description: Missing or invalid OAuth 2.0 access token.
      content:
        application/fhir+json:
          schema:
            $ref: '#/components/schemas/OperationOutcome'
  schemas:
    Resource:
      type: object
      description: A FHIR R4 resource. Structure is defined by HL7 FHIR R4 and the declared US Core profiles.
      properties:
        resourceType:
          type: string
        id:
          type: string
      required:
      - resourceType
    Bundle:
      type: object
      description: A FHIR R4 searchset Bundle.
      properties:
        resourceType:
          type: string
          const: Bundle
        type:
          type: string
        total:
          type: integer
        link:
          type: array
          items:
            type: object
            properties:
              relation:
                type: string
              url:
                type: string
                format: uri
        entry:
          type: array
          items:
            type: object
            properties:
              fullUrl:
                type: string
              resource:
                $ref: '#/components/schemas/Resource'
      required:
      - resourceType
      - type
    OperationOutcome:
      type: object
      description: FHIR R4 OperationOutcome — the error envelope this server returns.
      properties:
        resourceType:
          type: string
          const: OperationOutcome
        issue:
          type: array
          items:
            type: object
            properties:
              severity:
                type: string
                enum:
                - fatal
                - error
                - warning
                - information
              code:
                type: string
              diagnostics:
                type: string
              details:
                type: object
                properties:
                  coding:
                    type: array
                    items:
                      type: object
                      properties:
                        system:
                          type: string
                        code:
                          type: string
                        display:
                          type: string
                  text:
                    type: string
      required:
      - resourceType
      - issue
  securitySchemes:
    smartOnFhir:
      type: oauth2
      description: SMART on FHIR OAuth 2.0 as advertised by the server's .well-known/smart-configuration.
      flows:
        authorizationCode:
          authorizationUrl: https://epicproxy.et0948.epichosted.com/FhirProxy/oauth2/authorize
          tokenUrl: https://epicproxy.et0948.epichosted.com/FhirProxy/oauth2/token
          scopes:
            openid: OpenID Connect authentication
            profile: Profile claims
            fhirUser: Identity of the authorized FHIR user
            launch: EHR launch context
            epic.scanning.dmsusername: Epic document-management scanning username
externalDocs:
  description: HL7 FHIR R4 RESTful API specification
  url: https://hl7.org/fhir/R4/http.html