Shepherd Veterinary Software Soap Imaging Notes API

openapi: 3.2.0
info:
  version: v1
  title: Shepherd Open API (v2.248.0.39) Soap Imaging Notes 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: SoapImagingNotes
paths:
  /pav2/open-api-soap-imaging-notes:
    post:
      tags:
      - SoapImagingNotes
      summary: Asynchronously inserts new {OpenApiSoapImagingNotesController.SoapAssessmentNote…
      description: ''
      operationId: SoapAssessmentNotePost
      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:
        '201':
          description: The created SOAP imaging note.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApiSoapImagingNotesController.SoapAssessmentNote'
            text/json:
              schema:
                $ref: '#/components/schemas/OpenApiSoapImagingNotesController.SoapAssessmentNote'
            application/hal+json:
              schema:
                $ref: '#/components/schemas/OpenApiSoapImagingNotesController.SoapAssessmentNote'
        '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 validation rule failed. The response body is one of:\n             \"Soap Assessment input is not valid\" - the request body is missing.\n             \"The request is invalid.\" with modelState - note is missing or blank. modelState names the offending field.\n             \"PatientId is required and cannot be empty.\" - patientId is the empty GUID.\n             \"The provided PatientId does not belong to the clinic.\" - patientId does not refer to a patient in the caller's clinic."
        '404':
          description: '"No active SOAP found" - the patient has no SOAP in Active, Boarding, Lab pending or In Review status in the caller''s clinic.'
        '409':
          description: '"Patient is deleted" - the patient has been deleted.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenApiSoapImagingNotesController.SoapAssessmentNoteEntry'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApiSoapImagingNotesController.SoapAssessmentNoteEntry'
          application/hal+json:
            schema:
              $ref: '#/components/schemas/OpenApiSoapImagingNotesController.SoapAssessmentNoteEntry'
        description: "An object containing the data required to create a new SOAP Imaging Note.\nMust include:\n- A non-empty note text.\n- A valid patient identifier referencing an existing, non-deleted patient.\n            \nThis object will be validated and, if valid, mapped to a new SOAP assessment note\nlinked to the patient’s most recent active SOAP record of type Imaging."
        required: true
components:
  schemas:
    OpenApiSoapImagingNotesController.UserProfile:
      description: Represents a user with additional title information such as prefix, suffix, role indicator, first and last name.
      type: object
      properties:
        firstName:
          description: User first name.
          type: string
        isDoctor:
          description: Value that indicate whether the user is a doctor.
          type: boolean
        lastName:
          description: User last name.
          type: string
        prefix:
          description: Title prefix of the user.
          type: string
        suffix:
          description: Title suffix of the user.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiSoapImagingNotesController.SoapAssessmentNoteEntry:
      description: Represents the input model used for creating a SOAP assessment note.
      required:
      - note
      - patientId
      type: object
      properties:
        note:
          description: The textual content of the soap assessment note for insert.
          type: string
        patientId:
          format: uuid
          description: The unique identifier of the Patient under which a soap assessment note will be added.
          type: string
          example: 00000000-0000-0000-0000-000000000000
    OpenApiSoapImagingNotesController.SoapAssessmentNote:
      description: Represents a SOAP assessment note, including metadata such as author, editor, associated assessment, and tagging information.
      required:
      - note
      - soapAssessmentType
      type: object
      properties:
        createdByUserId:
          format: uuid
          description: Unique identifier of the user who created the note.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        editedByUserId:
          description: Unique identifier of the user that edited the note.
          type: string
        note:
          description: Textual content of the assessment note.
          type: string
        soapAssessmentId:
          description: Unique identifier of the associated SOAP assessment.
          type: string
        soapAssessmentType:
          format: int32
          description: Type of the SOAP assessment.
          type: integer
        taggedTeamsIds:
          description: Identifiers of the tagged teams associated with the note.
          type: array
          items:
            type: string
        taggedUsersIds:
          description: Identifiers of the tagged users associated with the note.
          type: array
          items:
            type: string
        user:
          $ref: '#/components/schemas/OpenApiSoapImagingNotesController.UserProfile'
          description: Represents a user with additional title information such as prefix, suffix, role indicator, first and last name.
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string