Shepherd Veterinary Software Client Patient API

openapi: 3.2.0
info:
  version: v1
  title: Shepherd Open API (v2.248.0.39) Client Patient 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: ClientPatient
paths:
  /pav2/open-api-client-patients:
    post:
      tags:
      - ClientPatient
      summary: Retrieves {OpenApiClientPatientController.ClientPatient} resources that match…
      description: 'Example Request

        {

        "embed": "client,patient",

        "clinicIds": "641d1862-762b-43ec-9abf-b2e300d32079",

        "ids": "e4aa9ac1-7e5d-44ae-b13c-b2e300d44ea6"

        }


        Example Response

        {

        "embed": "client,patient",

        "item": [

        {

        "client": {

        "firstName": "Jhon",

        "lastName": "Smith",

        "identifier": "XP92V3N",

        "homeClinicId": "641d1862-762b-43ec-9abf-b2e300d32079",

        "id": "52b89887-ce07-4d21-965a-b2e300d428c4"

        },

        "patient": {

        "name": "Pug",

        "identifier": "J8E6EO5",

        "homeClinicId": "641d1862-762b-43ec-9abf-b2e300d32079",

        "id": "2336319a-f1fd-4a09-86b5-b2e300d44e6a"

        },

        "id": "e4aa9ac1-7e5d-44ae-b13c-b2e300d44ea6"

        }

        ],

        "totalRecords": 1

        }'
      operationId: OpenApiClientPatientGet
      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 client-patient links matching the supplied filter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiClientPatientController.ClientPatient'
            text/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiClientPatientController.ClientPatient'
            application/hal+json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiClientPatientController.ClientPatient'
        '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.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenApiClientPatientController.ClientPatientFilterModel'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApiClientPatientController.ClientPatientFilterModel'
          application/hal+json:
            schema:
              $ref: '#/components/schemas/OpenApiClientPatientController.ClientPatientFilterModel'
        description: The model.
        required: true
components:
  schemas:
    OpenApiClientPatientController.Client:
      description: Client REST model.
      type: object
      properties:
        additionalText:
          description: Free-text field of additional info for the client.
          type: string
        alerts:
          description: Important info for the client, e.g. "Difficult to work with"
          type: string
        clientStatusId:
          description: Unique identifier of the related ClientStatus entity, e.g "Active" or "Inactive"
          type: string
        dateDeleted:
          format: date-time
          description: Date when Client was deleted.
          type: string
        deleted:
          description: Value indicating whether this client is deleted.
          type: boolean
        email:
          description: The client's email.
          type: string
        emailNotification:
          description: Flag indicating whether the client accepts Email notifications.
          type: boolean
        firstName:
          description: The client's first name.
          type: string
        homeClinicId:
          description: Unique identifier of the related Client's Home Clinic entity.
          type: string
        identifier:
          description: The client's short unique identifier inside the clinic. Clients from different clinics can have the same value.
          type: string
        isSubscribedToNotifications:
          description: 'Flag indicating whether the client is subscribed to notifications. If false, no email or SMS

            notifications should be sent to the client.'
          type: boolean
        isTaxExempt:
          description: Flag indicating whether the client is exempt from taxes.
          type: boolean
        lastName:
          description: The client's last name.
          type: string
        legacyId:
          description: The client's legacy identifier from a previous PIMS.
          type: string
        smsNotification:
          description: Flag indicating whether the client accepts SMS notifications.
          type: boolean
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiClientPatientController.Patient:
      description: Patient REST model.
      type: object
      properties:
        additionalText:
          description: Free-text field of additional info for the patient.
          type: string
        alerts:
          description: Important info for the patient, e.g. "Difficult to work with"
          type: string
        breedId:
          description: Identifier representing the patient's breed.
          type: string
        clients:
          description: Patient's owner(s).
          type: array
          items:
            $ref: '#/components/schemas/OpenApiClientPatientController.Client'
        color:
          description: Field representing patient color or marking (e.g., "Brown").
          type: string
        dateDeceased:
          format: date-time
          description: Date when the patient was marked as deceased.
          type: string
        dateOfBirth:
          format: date-time
          description: Birth date of the patient.
          type: string
        deleted:
          description: Value indicating whether patient is deleted.
          type: boolean
        homeClinicId:
          description: Identifier of the home clinic associated with the patient.
          type: string
        identifier:
          description: Identifier.
          type: string
        legacyId:
          description: Legacy identifier for the patient, used if patient was migrated from an other system.
          type: string
        microchipNumber:
          description: Microchip number assigned to the patient.
          type: string
        name:
          description: Patient's name.
          type: string
        patientCPRStatusNote:
          description: Free-text note describing the patient's CPR (Cardiopulmonary Resuscitation) status.
          type: string
        patientCprstatusId:
          description: Identifier representing the patient's CPR status.
          type: string
        rabiesTag:
          description: Rabies tag number assigned to the patient.
          type: string
        sexId:
          description: Identifier representing the patient's sex.
          type: string
        statusId:
          description: Identifier representing the patient's current status.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    RESTCollectionModelBase_OpenApiClientPatientController.ClientPatient:
      type: object
      properties:
        embed:
          type: string
        item:
          type: array
          items:
            $ref: '#/components/schemas/OpenApiClientPatientController.ClientPatient'
        page:
          format: int32
          type: integer
        recordsPerPage:
          format: int32
          type: integer
        searchQuery:
          type: string
        sort:
          type: string
        totalRecords:
          format: int32
          type: integer
    OpenApiClientPatientController.ClientPatient:
      description: ClientPatient REST model.
      type: object
      properties:
        client:
          $ref: '#/components/schemas/OpenApiClientPatientController.Client'
          description: Object representing related Client entity.
        clientId:
          format: uuid
          description: Unique identifier of the related Client entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        patient:
          $ref: '#/components/schemas/OpenApiClientPatientController.Patient'
          description: Object representing related Patient entity.
        patientId:
          format: uuid
          description: Unique identifier of the related Patient entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiClientPatientController.ClientPatientFilterModel:
      description: ClientPatient Filter REST model
      type: object
      properties:
        clientIds:
          description: Comma-separated list of Ids representing Client entities you wish to include in your search. Defaults to null.
          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.
          type: string
        isDeleted:
          description: 'Filters by client and patient deleted status. Defaults to null (fetches both deleted and non-deleted

            entities). In order to return a match, both patient and client entity should be in status Deleted = true.'
          type: boolean
        patientIds:
          description: 'Comma-separated list of Ids representing Patient entities you wish to include in your search. Defaults

            to null.'
          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