Shepherd Veterinary Software Soap Physical Exam API

openapi: 3.2.0
info:
  version: v1
  title: Shepherd Open API (v2.248.0.39) Soap Physical Exam 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: SoapPhysicalExam
paths:
  /pav2/open-api-physical-exams:
    post:
      tags:
      - SoapPhysicalExam
      summary: Retrieves {OpenApiSoapPhysicalExamController.PhysicalExam} resources that match…
      description: 'Example Request

        {

        "embed": "physicalExamTemplate",

        "rpp": 1

        }


        Example Response

        {

        "embed": null,

        "item": [

        {

        "clinicId": "a18cf204-d2b1-45ac-b18f-4cd86e1c77db",

        "coreUser": null,

        "creationDate": "2025-08-06T10:12:00Z",

        "note": "",

        "pav2User": null,

        "physicalExamClinicBodyMaps": [],

        "physicalExamTemplate": {

        "clinicId": "a18cf204-d2b1-45ac-b18f-4cd86e1c77db",

        "isDeleted": false,

        "name": "General Canine Exam",

        "schema": "{\"fields\": [{\"name\": \"Heart\", \"order\": 0, \"inputs\": [{\"type\": \"textarea\", \"order\": 0, \"value\": \"Normal rhythm.\", \"inputs\": []}], \"rowOrder\": 0}]}",

        "dateCreated": "2025-08-06T10:11:55.905019Z",

        "dateUpdated": "2025-08-06T10:11:55.906019Z",

        "id": "91cf17f0-cb1f-4298-aab8-e1e6dc9a4f5d"

        },

        "physicalExamTemplateId": "91cf17f0-cb1f-4298-aab8-e1e6dc9a4f5d",

        "schema": "{\"fields\": [{\"name\": \"Heart\", \"order\": 0, \"value\": \"\", \"inputs\": [{\"type\": \"textarea\", \"order\": 0, \"value\": \"No murmur detected.\", \"inputs\": []}], \"rowOrder\": 0}]}",

        "soap": null,

        "soapId": "66af9f13-0fbe-4aa2-95dc-b435723b3a81",

        "soapObjectiveId": "66af9f13-0fbe-4aa2-95dc-b435723b3a81",

        "supervisingDoctorId": "7b5dcfe0-f55a-4193-a344-8871bc2ef60c",

        "title": "Canine Annual Checkup",

        "dateCreated": "2025-08-06T10:12:12.671475Z",

        "dateUpdated": "2025-08-06T10:12:56.678994Z",

        "id": "f502fd18-14e1-4e56-9e96-88b8607c8c8f"

        }

        ],

        "links": [],

        "page": 1,

        "recordsPerPage": 1,

        "searchQuery": null,

        "sort": null,

        "totalRecords": 3

        }'
      operationId: OpenApiPhysicalExamGet
      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 physical exams matching the supplied filter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiSoapPhysicalExamController.PhysicalExam'
            text/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiSoapPhysicalExamController.PhysicalExam'
            application/hal+json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiSoapPhysicalExamController.PhysicalExam'
        '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/OpenApiSoapPhysicalExamController.SoapPhysicalExamFilter'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApiSoapPhysicalExamController.SoapPhysicalExamFilter'
          application/hal+json:
            schema:
              $ref: '#/components/schemas/OpenApiSoapPhysicalExamController.SoapPhysicalExamFilter'
        description: The model.
        required: true
components:
  schemas:
    OpenApiSoapPhysicalExamController.PhysicalExam:
      description: PHysicalExam REST model.
      type: object
      properties:
        clinicId:
          description: Unique identifier representing the related Clinic entity.
          type: string
        coreUser:
          $ref: '#/components/schemas/OpenApiSoapPhysicalExamController.CoreUser'
          description: Object representing the related Core user entity.
        creationDate:
          format: date-time
          description: Date and time of the physical exam creation.
          type: string
        note:
          description: Free-text note for additional physical exam info.
          type: string
        pav2User:
          $ref: '#/components/schemas/OpenApiSoapPhysicalExamController.Pav2User'
          description: Object representing the additional data of related user.
        physicalExamClinicBodyMaps:
          description: List of objects representing the Physical exam clinic body maps entities.
          type: array
          items:
            $ref: '#/components/schemas/OpenApiSoapPhysicalExamController.PhysicalExamClinicBodyMap'
        physicalExamTemplate:
          $ref: '#/components/schemas/OpenApiSoapPhysicalExamController.PhysicalExamTemplate'
          description: Object representing the related Physical exam template entity.
        physicalExamTemplateId:
          description: Unique identifier representing the related Physical exam template entity.
          type: string
        schema:
          description: Schema of the physical exam.
          type: string
        soap:
          $ref: '#/components/schemas/OpenApiSoapPhysicalExamController.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
        soapObjectiveId:
          description: Unique identifier representing the related SOAP objective entity. SoapObjectiveId is the same as the SoapId.
          type: string
        supervisingDoctorId:
          description: Unique identifier representing the Supervising doctor.
          type: string
        title:
          description: Title of the physical exam.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiSoapPhysicalExamController.SoapPhysicalExamFilter:
      description: SoapPhysicalExamFilter REST model.
      type: object
      properties:
        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
        creationDateFrom:
          format: date-time
          description: Creation date from.
          type: string
        creationDateTo:
          format: date-time
          description: Creation date to.
          type: string
        includePatientHomeClinic:
          description: "Used to support multi-site practices that share patients and clients.\nDetermines whether to include Soap physical exams from a patient's home clinic\nwhen filtering by clinic.\n            \nBehavior:\n- If true:\n  - Includes Soap physical exams from the specified clinic (default)\n  - Also includes physical exams from other clinics where the patient's home clinic\n    matches the specified clinic\n- If false (default):\n  - Only includes Soap physical exams directly from the specified clinic\n            \nNote: The patient's home clinic is only considered if ClinicIds are provided\nin the filter; otherwise, all data from the group is returned."
          type: boolean
        patientIds:
          description: Comma-separated list of Patient identifiers.
          type: string
        physicalExamTemplateIds:
          description: Comma-separated list of Physical exam template identifiers.
          type: string
        searchQuery:
          description: Search query used to search by content of physical exam's note, schema and title.
          type: string
        soapIds:
          description: Filters by SOAP identifier.
          type: string
        soapIsDeleted:
          description: Filtering by deleted SOAPs. When this value is true it will show only physical exams from deleted SOAPs. Defaults to null (fetches entities from both deleted and non-deleted SOAPs).
          type: boolean
        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
    OpenApiSoapPhysicalExamController.CoreUser:
      description: Core User REST model.
      type: object
      properties:
        firstName:
          description: User's first name.
          type: string
        lastName:
          description: User's last name.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiSoapPhysicalExamController.BodyMapDrawing:
      description: BodyMapDrawing REST model.
      type: object
      properties:
        mediaVaultEntryId:
          format: uuid
          description: Media vault entry unique identifier.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiSoapPhysicalExamController.Soap:
      description: Soap REST model.
      type: object
      properties:
        dateCheckedIn:
          format: date-time
          description: Date of patient check in for this soap.
          type: string
        id:
          description: Unique SOAP identifier.
          type: string
    OpenApiSoapPhysicalExamController.PhysicalExamClinicBodyMap:
      description: PhysicalExamClinicBodyMap REST model.
      type: object
      properties:
        bodyMapDrawing:
          $ref: '#/components/schemas/OpenApiSoapPhysicalExamController.BodyMapDrawing'
          description: Object representing the related Body map drawing entity.
        bodyMapDrawingId:
          format: uuid
          description: Unique identifier representing the related Body map drawing entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        clinicBodyMap:
          $ref: '#/components/schemas/OpenApiSoapPhysicalExamController.ClinicBodyMap'
          description: Object representing the related Clinic body map entity.
        clinicBodyMapId:
          format: uuid
          description: Unique identifier representing the Clinic body map entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        clinicId:
          description: Unique identifier representing the related clinic entity.
          type: string
        isFromTemplate:
          description: Flag indicating whether this physical exam clinic body map is from template.
          type: boolean
        physicalExamId:
          format: uuid
          description: Unique identifier representing the related Physical exam entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiSoapPhysicalExamController.PhysicalExamTemplate:
      description: PhsicalExamTemplate REST model.
      required:
      - name
      type: object
      properties:
        clinicId:
          description: Unique identifier representing the related clinic entity.
          type: string
        isDeleted:
          description: Flag indicating whether this physical exam template is deleted.
          type: boolean
        name:
          description: Name of the physical exam template.
          type: string
        schema:
          description: Schema of the physical exam template.
          type: object
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiSoapPhysicalExamController.Pav2User:
      description: Pav2User REST model.
      type: object
      properties:
        isDoctor:
          description: Flag indicating whether this user is doctor.
          type: boolean
        prefix:
          description: User's assigned prefix (e.g., "Dr.", "Mr.", "Mrs.").
          type: string
        suffix:
          description: User's assigned suffix (e.g., "MD", "PhD", "Jr.").
          type: string
        userLicenseType:
          $ref: '#/components/schemas/OpenApiSoapPhysicalExamController.UserLicenseType'
          description: Object representing the type of the user license.
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiSoapPhysicalExamController.UserLicenseType:
      description: UserLicenseType 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
    OpenApiSoapPhysicalExamController.BodyMap:
      description: BodyMap REST model.
      type: object
      properties:
        name:
          description: Name of body map.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    RESTCollectionModelBase_OpenApiSoapPhysicalExamController.PhysicalExam:
      type: object
      properties:
        embed:
          type: string
        item:
          type: array
          items:
            $ref: '#/components/schemas/OpenApiSoapPhysicalExamController.PhysicalExam'
        page:
          format: int32
          type: integer
        recordsPerPage:
          format: int32
          type: integer
        searchQuery:
          type: string
        sort:
          type: string
        totalRecords:
          format: int32
          type: integer
    OpenApiSoapPhysicalExamController.ClinicBodyMap:
      description: ClinicBodyMap REST model.
      type: object
      properties:
        bodyMap:
          $ref: '#/components/schemas/OpenApiSoapPhysicalExamController.BodyMap'
          description: Object representing the related Body map entity.
        bodyMapId:
          format: uuid
          description: Unique identifier representing the related Body map entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string