Shepherd Veterinary Software Patient Vaccine API

openapi: 3.2.0
info:
  version: v1
  title: Shepherd Open API (v2.248.0.39) Patient Vaccine API
  description: 'Production Base URL: https://open-api.shepherd.vet/pav2/


    Production App URL: https://app.shepherd.vet/


    Production Documentation URL: https://app.shepherd.vet/swagger/


    Sandbox Base URL: https://demo-open-api.shepherd.vet/pav2/


    Sandbox App URL: https://demo.shepherd.vet/


    Sandbox Documentation URL: https://demo.shepherd.vet/swagger


    Authorization: The integration is authorized by providing two headers in the API call


    X-Integration-Private-Key - this contains the private key from your credentials

    X-Integration-Public-Key - this contains the public key from your credentials


    Additionally, for all requests other than Clinic, the X-Clinic-Id header must be provided with the value of the clinic entity id for which you are running the API requests. You can get the entity id by calling the Clinic endpoint. If authorization fails, the request returns HTTP status 401 and the response body is one of the messages below. Missing X-Integration-Public-Key header - the public key header is absent from the request. Missing X-Integration-Private-Key header - the private key header is absent from the request. Missing X-Clinic-Id header - the clinic identifier header is absent, and the endpoint is clinic scoped. Incorrect API keys provided - both key headers were supplied, but the public key matches no integration, or the private key is not valid for that integration. Integration not enabled for the provided clinic - the key pair is valid, but the integration is not enabled and active for the clinic supplied in X-Clinic-Id. NEW: Each API call will count against your RPH and RPM limits. Once you exhaust those limits, requests will start returning HTTP status 429. The RPH is set to 12000 and RPM to 800 (subject to change). Where an endpoint supports searchQuery, a query longer than 500 characters may return HTTP status 400 with ERROR_MESSAGES.SEARCH_PHRASE.TOO_LONG, and a query with more than 10 words may return HTTP status 400 with ERROR_MESSAGES.SEARCH_PHRASE.TOO_MANY_PHRASES. NOTE: Since this API is WIP, we would be happy to hear any feedback and to implement additional filtering/sorting options etc. **Endpoints:

    All endpoints are POST requests that accept JSON bodies. The common request properties for all endpoints are:**


    rpp::int - The number of items to return per page. The max is 1000. Defaults to 10. page::int - The page number. Defaults to 1. sort::string - Which field to sort by. Needs to be in "field|order" format, where order is either "asc" or "desc". All top-level properties should be sortable, only some nested-fields work and you should probably not use them until this API reaches production and we settle on which nested-field sortings we will support. Default depends on endpoint, usually "id|asc". embed::string - Comma-separated values for nested-fields you want to fetch (eg. "clientPhones,clientPhones.phoneType" on Client endpoint). If a specific embed is not requested, the response will contain either null or an empty array for that value. No default. dateCreatedFrom::date

    dateCreatedTo::date

    dateUpdatedFrom::date

    dateUpdatedTo::date

    - Date range filters for either the creation date or last update date. - You can pass in either one end or both of them. *


    * Only the date filters listed on an endpoint''s request model are supported; sending another one, or a ''From'' later than its ''To'', returns HTTP status 400. The request responses will come back as a JSON object. The common response properties for all endpoints are:


    embed::string - Lists the embed used in the request. This may sometimes be different from what you sent in, if in the future we add that some embeds get set automatically on certain endpoints

    links::object[] - Always empty, a leftover from the internal framework we use on our web API. Will be removed in the future if possible so do not rely on this

    page::int - Which page was fetched.'
servers:
- url: https://open-api.shepherd.vet
tags:
- name: PatientVaccine
paths:
  /pav2/open-api-patient-vaccines:
    post:
      tags:
      - PatientVaccine
      summary: Retrieves {OpenApiPatientVaccineController.PatientVaccine} resources that match…
      description: 'Example Request

        {

        "embed": "patient,patientVaccineStatus"

        }


        Example Response

        {

        "embed": "patient,patientVaccineStatus",

        "item": [

        {

        "administrationDate": "2025-06-11T00:00:00Z",

        "clinicId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",

        "dueDate": "2025-06-12T00:00:00Z",

        "invoiceItemId": "11112222-3333-4444-aaaa-bbbbbbbbbbbb",

        "isRabiesVaccine": false,

        "lotNumber": "",

        "manufacturer": "",

        "note": "",

        "patient": {

        "clinicId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",

        "dateDeleted": null,

        "deleted": false,

        "name": "Luka Horvat",

        "patientStatus": null,

        "statusId": "22223333-aaaa-bbbb-cccc-ddddeeeeffff",

        "dateCreated": "2025-04-17T07:43:19.678574Z",

        "dateUpdated": "2025-06-26T07:51:09.747133Z",

        "id": "abcd1234-5678-90ab-cdef-112233445566"

        },

        "patientId": "abcd1234-5678-90ab-cdef-112233445566",

        "patientVaccineStatus": {

        "abrv": "active",

        "description": null,

        "name": "Active",

        "dateCreated": "2025-04-02T13:14:13.180775Z",

        "dateUpdated": "2025-04-02T13:14:13.180775Z",

        "id": "99998888-aaaa-bbbb-cccc-ddddeeeeffff"

        },

        "patientVaccineStatusId": "99998888-aaaa-bbbb-cccc-ddddeeeeffff",

        "product": null,

        "productId": "55556666-7777-8888-9999-aaaabbbbcccc",

        "rabiesTag": "",

        "refillId": null,

        "reminderId": null,

        "serialNumber": "",

        "soap": null,

        "soapId": null,

        "vaccineLotExpirationDate": null,

        "vaccineName": "Canine DHPP Vaccine",

        "vaccineProductConfigurationId": "ccccdddd-eeee-ffff-1111-222233334444",

        "verifiedBy": "Vet Admin",

        "dateCreated": "2025-06-11T06:37:17.591289Z",

        "dateUpdated": "2025-06-11T06:37:21.320088Z",

        "id": "eeeeffff-aaaa-bbbb-cccc-1234567890ab"

        }

        ],

        "links": [],

        "page": 1,

        "recordsPerPage": 10,

        "searchQuery": null,

        "sort": null,

        "totalRecords": 1

        }'
      operationId: OpenApiPatientVaccineGet
      parameters:
      - name: x-integration-public-key
        in: header
        description: Your public API key
        required: true
        schema:
          type: string
      - name: x-integration-private-key
        in: header
        description: Your private API key
        required: true
        schema:
          type: string
      - name: x-clinic-id
        in: header
        description: The clinic uuid identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A paged collection of patient vaccines matching the supplied filter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiPatientVaccineController.PatientVaccine'
            text/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiPatientVaccineController.PatientVaccine'
            application/hal+json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiPatientVaccineController.PatientVaccine'
        '401':
          description: 'Authorization failed. One of: Missing X-Integration-Public-Key header, Missing X-Integration-Private-Key header, Missing X-Clinic-Id header, Incorrect API keys provided, or Integration not enabled for the provided clinic.'
        '429':
          description: Request rate limit exceeded. Please wait before making further requests. Returned once the integration passes its configured hourly or per-minute request allowance.
        '400':
          description: "A date filter range is reversed. The response body is one of:\n             \"DateCreated filter 'From' can't be later than 'To'.\" - dateCreatedFrom is after dateCreatedTo.\n             \"DateUpdated filter 'From' can't be later than 'To'.\" - dateUpdatedFrom is after dateUpdatedTo."
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenApiPatientVaccineController.PatientVaccineFilterModel'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApiPatientVaccineController.PatientVaccineFilterModel'
          application/hal+json:
            schema:
              $ref: '#/components/schemas/OpenApiPatientVaccineController.PatientVaccineFilterModel'
        description: The model.
        required: true
components:
  schemas:
    OpenApiPatientVaccineController.PatientStatus:
      description: PatientStatus REST model.
      type: object
      properties:
        abrv:
          description: Short unique identifier for the lookup.
          type: string
        description:
          description: The description of the lookup entry.
          type: string
        name:
          description: The name of the lookup entry.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiPatientVaccineController.SoapStatus:
      description: SoapStatus REST model.
      type: object
      properties:
        abrv:
          description: Short unique identifier for the lookup.
          type: string
        description:
          description: The description of the lookup entry.
          type: string
        name:
          description: The name of the lookup entry.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiPatientVaccineController.PatientVaccineStatus:
      description: PatientVaccineStatus REST model.
      type: object
      properties:
        abrv:
          description: Short unique identifier for the lookup.
          type: string
        description:
          description: The description of the lookup entry.
          type: string
        name:
          description: The name of the lookup entry.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiPatientVaccineController.PatientVaccine:
      description: PatientVaccine REST model.
      type: object
      properties:
        administrationDate:
          format: date-time
          description: Date when the Patient Vaccine was administered.
          type: string
        clinicId:
          description: Unique identifier representing the related Clinic entity.
          type: string
        dueDate:
          format: date-time
          description: The date on which the vaccine should be readministered.
          type: string
        invoiceItemId:
          format: uuid
          description: Unique identifier representing the related Invoice item entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        isRabiesVaccine:
          description: Flag indicating whether this patient vaccine is rabies vaccine.
          type: boolean
        lotNumber:
          description: The lot number of the vaccine used.
          type: string
        manufacturer:
          description: The name of the vaccine manufacturer.
          type: string
        note:
          description: Free-text field of note related to the vaccination.
          type: string
        patient:
          $ref: '#/components/schemas/OpenApiPatientVaccineController.Patient'
          description: Object representing the related Patient entity.
        patientId:
          format: uuid
          description: Unique identifier representing the related Patient entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        patientVaccineStatus:
          $ref: '#/components/schemas/OpenApiPatientVaccineController.PatientVaccineStatus'
          description: Object representing the related Patient vaccine entity.
        patientVaccineStatusId:
          format: uuid
          description: Unique identifier representing the related Patient vaccine status entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        product:
          $ref: '#/components/schemas/OpenApiPatientVaccineController.Product'
          description: Object representing the related Product entity.
        productId:
          format: uuid
          description: Unique identifier representing the related Product entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        rabiesTag:
          description: Rabies tag assigned to the Patient Vaccine
          type: string
        refillId:
          format: uuid
          description: Unique identifier representing the related Refill.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        reminderId:
          format: uuid
          description: Unique identifier representing the related Reminder.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        serialNumber:
          description: Serial number assigned to this Patient vaccine.
          type: string
        soap:
          $ref: '#/components/schemas/OpenApiPatientVaccineController.Soap'
          description: Object representing the related SOAP entity.
        soapId:
          format: uuid
          description: Unique identifier representing the related SOAP entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        vaccineLotExpirationDate:
          format: date-time
          description: Expiration date of the used vaccine lot.
          type: string
        vaccineName:
          description: Name of the vaccine as entered or configured.
          type: string
        vaccineProductConfigurationId:
          format: uuid
          description: Unique identifier representing the related vaccine product configuration.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        verifiedBy:
          description: Name of the user who verified the vaccine entry.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiPatientVaccineController.Patient:
      description: Patient REST model.
      type: object
      properties:
        clinicId:
          description: Unique identifier representing the related Clinic entity.
          type: string
        dateDeleted:
          format: date-time
          description: Date when Client was deleted.
          type: string
        deleted:
          description: Flag indicating whether this Patient is deleted.
          type: boolean
        name:
          description: Patient name.
          type: string
        patientStatus:
          $ref: '#/components/schemas/OpenApiPatientVaccineController.PatientStatus'
          description: Object representing the related Patient status entity.
        statusId:
          format: uuid
          description: Identifier representing the patient's current status.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiPatientVaccineController.Soap:
      description: Soap REST model.
      type: object
      properties:
        clinicId:
          description: Unique identifier representing the related Clinic entity.
          type: string
        soapStatus:
          $ref: '#/components/schemas/OpenApiPatientVaccineController.SoapStatus'
          description: Object representing the related SOAP status entity.
        soapStatusId:
          format: uuid
          description: Unique identifier representing the related SOAP status entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiPatientVaccineController.Product:
      description: Product REST model.
      type: object
      properties:
        clinicId:
          description: Unique identifier representing the related Clinic entity.
          type: string
        isRabiesVaccine:
          description: Flag indicating whether the product is used for a rabies vaccine.
          type: boolean
        name:
          description: Product name.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    RESTCollectionModelBase_OpenApiPatientVaccineController.PatientVaccine:
      type: object
      properties:
        embed:
          type: string
        item:
          type: array
          items:
            $ref: '#/components/schemas/OpenApiPatientVaccineController.PatientVaccine'
        page:
          format: int32
          type: integer
        recordsPerPage:
          format: int32
          type: integer
        searchQuery:
          type: string
        sort:
          type: string
        totalRecords:
          format: int32
          type: integer
    OpenApiPatientVaccineController.PatientVaccineFilterModel:
      description: PatientVaccine Filter REST model
      type: object
      properties:
        clientIds:
          description: 'Filters patient vaccines based on unique client identifiers.

            The input should be a comma-separated string of client Id values'
          type: string
        clinicIds:
          description: 'Comma-separated list of Clinic identifiers. Defaults to null. The filter is applicable only if the group to which the clinic belongs shares clients and patients.

            If provided only PatientVaccine data from filtered clinic will be returned (regardless of the x-clinic-id in header). If it remains null, data from group clinics will be returned.'
          type: string
        patientIds:
          description: Filters patient vaccines by specified Patient Ids. A comma-separated string of patient id values.
          type: string
        searchClient:
          description: Filters by the client's first, middle and last name.
          type: string
        searchQuery:
          description: Filters by the patient vaccine name, patient name, manufacturer, serial number and lot number.
          type: string
        dateCreatedFrom:
          format: date-time
          description: 'Sets the start of the date range filter on the entity creation date. Must not be later than DateCreatedTo, or

            the request returns 400. Defaults to null.'
          type: string
        dateCreatedTo:
          format: date-time
          description: The end of the date range filter on the entity creation date. Defaults to null.
          type: string
        dateUpdatedFrom:
          format: date-time
          description: 'The start of the date range filter on the entity last update date. Must not be later than DateUpdatedTo, or the

            request returns 400. Defaults to null.'
          type: string
        dateUpdatedTo:
          format: date-time
          description: The end of the date range filter on the entity last update date. Defaults to null.
          type: string
        embed:
          description: Comma-separated list of embedded properties to fetch. Nested fetches can be specified using dot notation (e.g., "client.clientPhones"). Defaults to null.
          type: string
        excludeIds:
          description: Comma-separated list of IDs representing entities that you wish to exclude from your search. Defaults to null.
          type: string
        ids:
          description: Comma-separated list of IDs representing entities that you wish to include in your search. Defaults to null.
          type: string
        page:
          format: int32
          description: The page number. Defaults to 1.
          type: integer
        rpp:
          format: int32
          description: The number of items to return per page. The max is 1000. Defaults to 10.
          type: integer
        sort:
          description: Which field to sort by. Needs to be in "field|order" format, where order is either "asc" or "desc". The default sort field depends on the endpoint, typically "id|asc"
          type: string