Shepherd Veterinary Software Soap Assessment Diagnosis Description API
The SoapAssessmentDiagnosisDescription API from Shepherd Veterinary Software — 1 operation(s) for soapassessmentdiagnosisdescription.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/shepherd-vet:shepherd-vet-soapassessmentdiagnosisdescription-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: v1
title: Shepherd Open API (v2.248.0.39) Soap Assessment Diagnosis…
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: SoapAssessmentDiagnosisDescription
paths:
/pav2/open-api-soap-assessment-diagnosis-description:
post:
tags:
- SoapAssessmentDiagnosisDescription
summary: Retrieves {OpenApiSoapAssessmentDiagnosisDescriptionController.SoapAssessmentDia…
description: 'Example Request
{
"rpp": 1,
"page": 2,
"embed": "snomedDiagnosisDescription"
}
Example Response
{
"embed": "snomedDiagnosisDescription",
"item": [
{
"name": "Dermatitis",
"snomedDiagnosisDescription": {
"description": "Contact dermatitis due to poison ivy",
"designationTypeId": "eead12b4-88ef-4f16-a9d7-c1355f7b4cc3",
"diagnosisDischargeInstruction": null,
"diagnosisDischargeInstructions": [],
"diagnosisId": "34762fa9-5591-4f90-bb94-87093e8789c4",
"snomedDescriptionId": "116154003",
"dateCreated": "2025-08-05T13:30:12.411Z",
"dateUpdated": "2025-08-05T13:30:12.411Z",
"id": "54bc3e1f-50fd-40d1-bdc6-882dd872d9cd"
},
"snomedDiagnosisDescriptionId": "54bc3e1f-50fd-40d1-bdc6-882dd872d9cd",
"soap": null,
"soapAssessment": null,
"soapAssessmentDiagnosisType": 1,
"soapAssessmentId": "19c1f5da-4207-4ed2-b0de-95f775ec3ad6",
"soapDischargeInstructions": [],
"dateCreated": "2025-08-05T13:31:10.000Z",
"dateUpdated": "2025-08-06T08:15:44.000Z",
"id": "adf1b25b-3be9-4a26-bc84-c0f35e912a56"
}
],
"links": [],
"page": 2,
"recordsPerPage": 1,
"searchQuery": null,
"sort": null,
"totalRecords": 3
}'
operationId: OpenApiSoapAssessmentDiagnosisDescriptionGet
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 SOAP assessment diagnosis descriptions matching the supplied filter.
content:
application/json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiSoapAssessmentDiagnosisDescriptionController.SoapAssessmentDiagnosisDescription'
text/json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiSoapAssessmentDiagnosisDescriptionController.SoapAssessmentDiagnosisDescription'
application/hal+json:
schema:
$ref: '#/components/schemas/RESTCollectionModelBase_OpenApiSoapAssessmentDiagnosisDescriptionController.SoapAssessmentDiagnosisDescription'
'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/OpenApiSoapAssessmentDiagnosisDescriptionController.SoapAssessmentDiagnosisDescriptionFilterModel'
text/json:
schema:
$ref: '#/components/schemas/OpenApiSoapAssessmentDiagnosisDescriptionController.SoapAssessmentDiagnosisDescriptionFilterModel'
application/hal+json:
schema:
$ref: '#/components/schemas/OpenApiSoapAssessmentDiagnosisDescriptionController.SoapAssessmentDiagnosisDescriptionFilterModel'
required: true
components:
schemas:
OpenApiSoapAssessmentDiagnosisDescriptionController.SnomedDiagnosisDescription:
description: SnomedDescription REST model.
type: object
properties:
description:
description: Free-text description of the SNOMED diagnosis.
type: string
designationTypeId:
format: uuid
description: Unique identifier representing the related SNOMED Designation Type entity.
type: string
example: 00000000-0000-0000-0000-000000000000
diagnosisDischargeInstruction:
$ref: '#/components/schemas/OpenApiSoapAssessmentDiagnosisDescriptionController.DischargeInstruction'
description: Object representing the related single discharge instruction.
readOnly: true
diagnosisDischargeInstructions:
description: List of discharge instruction objects related to this diagnosis.
type: array
items:
$ref: '#/components/schemas/OpenApiSoapAssessmentDiagnosisDescriptionController.DischargeInstruction'
diagnosisId:
description: Unique identifier representing the related Diagnosis entity.
type: string
snomedDescriptionId:
description: Unique identifier representing the related SNOMED description entity.
type: string
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
OpenApiSoapAssessmentDiagnosisDescriptionController.SoapAssessmentDiagnosisDescriptionFilterModel:
description: Soap Assessment Diagnosis Description Filter 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
diagnosisIds:
description: Comma-separated list of Diagnosis identifiers.
type: string
includePatientHomeClinic:
description: "Used to support multi-site practices that share patients and clients.\nDetermines whether to include Soap assessment diagnosis descriptions from a patient's home clinic\nwhen filtering by clinic.\n \nBehavior:\n- If true:\n - Includes Soap assessment diagnosis descriptions from the specified clinic (default)\n - Also includes assessment diagnosis descriptions from other clinics where the patient's home clinic\n matches the specified clinic\n- If false (default):\n \n - Only includes Soap assessment diagnosis descriptions directly from the specified clinic\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
snomedDiagnosisDescriptionIds:
description: Comma-separated list of SNOMED diagnosis description identifiers.
type: string
soapAssessmentDiagnosisType:
format: int32
description: 'Filters by SoapAssessmentDiagnosisType. 0 for Problem, 1 for Diagnosis and 2 for
Chronic Condition. Defaults to null (fetches all soap assessment diagnosis descriptions)'
type: integer
soapAssessmentIds:
description: Comma-separated list of Soap Assessment identifiers
type: string
soapIds:
description: Comma-separated list of SOAP ids.
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
OpenApiSoapAssessmentDiagnosisDescriptionController.Soap:
description: Soap REST model.
type: object
properties:
clinicId:
description: Unique identifier representing the related Clinic entity.
type: string
createdByUserId:
description: Unique identifier representing the user who created this SOAP.
type: string
dateCheckedIn:
format: date-time
description: Date when this SOAP was checked in.
type: string
dateDeleted:
format: date-time
description: Date when this SOAP was deleted.
type: string
deleted:
description: Flag indicating whether this SOAP is deleted.
type: boolean
invoiceId:
description: Unique identifier representing the related Invoice entity.
type: string
locationId:
description: Unique identifier representing the related Location entity.
type: string
patientId:
description: Unique identifier representing the related Patient entity.
type: string
soapStatusId:
description: Unique identifier representing the related SOAP status entity.
type: string
supervisingDoctorId:
description: Unique identifier representing the Supervising doctor.
type: string
title:
description: Short descriptive title of the SOAP record.
type: string
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
OpenApiSoapAssessmentDiagnosisDescriptionController.SoapAssessment:
description: SoapAssessment REST model.
type: object
properties:
clinicId:
description: Unique identifier representing the related Clinic entity.
type: string
description:
description: Description of the assessment.
type: string
prognosisHigh:
$ref: '#/components/schemas/OpenApiSoapAssessmentDiagnosisDescriptionController.Prognosis'
description: 'Initial prognosis of the patient during this assessment. Possible values (in decreasing order): Excellent, Good, Fair, Guarded, Poor, Grave.'
prognosisHighId:
description: Unique identifier representing the related Initial prognosis entity.
type: string
prognosisLow:
$ref: '#/components/schemas/OpenApiSoapAssessmentDiagnosisDescriptionController.Prognosis'
description: 'Updated prognosis of the patient at this assessment. Cannot be set higher than the initial prognosis (prognosisHigh). Possible values: Excellent, Good, Fair, Guarded, Poor, Grave.'
prognosisLowId:
description: Unique identifier representing the New prognosis identifier.
type: string
soapId:
description: Unique identifier representing the related SOAP entity. Serves as the primary key of SOAP Assessment.
type: string
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
RESTCollectionModelBase_OpenApiSoapAssessmentDiagnosisDescriptionController.SoapAssessmentDiagnosisDescription:
type: object
properties:
embed:
type: string
item:
type: array
items:
$ref: '#/components/schemas/OpenApiSoapAssessmentDiagnosisDescriptionController.SoapAssessmentDiagnosisDescription'
page:
format: int32
type: integer
recordsPerPage:
format: int32
type: integer
searchQuery:
type: string
sort:
type: string
totalRecords:
format: int32
type: integer
OpenApiSoapAssessmentDiagnosisDescriptionController.DischargeInstruction:
description: DischargeInstruction REST model.
type: object
properties:
clinicId:
description: Unique identifier representing the related clinic entity.
type: string
description:
description: Free-text field for discharge instruction description.
type: string
isActive:
description: Flag indicating whether this Discharge Instruction is active.
type: boolean
snomedDiagnosisDescriptionId:
description: Unique identifier representing the related SNOMED diagnosis description entity.
type: string
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
OpenApiSoapAssessmentDiagnosisDescriptionController.SoapDischargeInstruction:
description: SoapDischargeInstruction REST model.
type: object
properties:
assessmentDiagnosisDescId:
format: uuid
description: Unique identifier representing the related Assessment diagnosis desc entity.
type: string
example: 00000000-0000-0000-0000-000000000000
clinicId:
description: Unique identifier representing the related Clinic entity.
type: string
deleted:
description: Flag indicating weather this SOAP treatment note is deleted.
type: boolean
description:
description: HTML representation of description.
type: string
name:
description: Name of the SOAP discharge instruction.
type: string
productId:
format: uuid
description: Unique identifier representing the related Product entity. If the discharge instruction originates from a product added to the SOAP, this will hold the productId.
type: string
example: 00000000-0000-0000-0000-000000000000
soapId:
format: uuid
description: Unique identifier representing the related SOAP entity.
type: string
example: 00000000-0000-0000-0000-000000000000
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
OpenApiSoapAssessmentDiagnosisDescriptionController.SoapAssessmentDiagnosisDescription:
description: Soap Assessment Diagnosis Description REST Model
type: object
properties:
name:
description: Name of the SOAP assessment diagnosis description.
type: string
snomedDiagnosisDescription:
$ref: '#/components/schemas/OpenApiSoapAssessmentDiagnosisDescriptionController.SnomedDiagnosisDescription'
description: Object representing the related SNOMED diagnosis description entity.
snomedDiagnosisDescriptionId:
format: uuid
description: Unique identifier representing the related snomed diagnosis description entity.
type: string
example: 00000000-0000-0000-0000-000000000000
soap:
$ref: '#/components/schemas/OpenApiSoapAssessmentDiagnosisDescriptionController.Soap'
description: Object representing the related SOAP entity.
soapAssessment:
$ref: '#/components/schemas/OpenApiSoapAssessmentDiagnosisDescriptionController.SoapAssessment'
description: Object representing the related SOAP assessment entity.
soapAssessmentDiagnosisType:
format: int32
description: 'Type of the SOAP assessment diagnosis; 0 for Problem, 1 for Diagnosis and 2 for
Chronic Condition.'
type: integer
soapAssessmentId:
format: uuid
description: Unique identifier representing the related SOAP assessment entity.
type: string
example: 00000000-0000-0000-0000-000000000000
soapDischargeInstructions:
description: List of SOAP discharge instruction objects related to this diagnosis description.
type: array
items:
$ref: '#/components/schemas/OpenApiSoapAssessmentDiagnosisDescriptionController.SoapDischargeInstruction'
dateCreated:
format: date-time
type: string
dateUpdated:
format: date-time
type: string
id:
type: string
OpenApiSoapAssessmentDiagnosisDescriptionController.Prognosis:
description: Prognosis 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