Introduction

Welcome to the ezyVet Standard Diagnostic Integration Beta Reference Page!

The ezyVet Standard Diagnostic Integration is designed around a RESTful interface and utilizes OAuth 2.0 Client Credentials grant. The webhooks accepts and returns messages in JSON-format.

Standard Diagnostic Integration will be aliased to SDI throughout this doc.

Partner Endpoints

Access Token

An endpoint which must be implemented by an API Partner. This endpoint will allow ezyVet to authenticate and use the Partner's web services (if authentication is required).

Fetch an Access Token

Note that this endpoint must be implemented by a Partner. This is NOT ezyVet's endpoint.

Sample Request: Get an Access Token.

var settings = {
  "url": "(Access Token Endpoint)",
  "method": "POST",
  "headers": {
    "content-type": "application/json"
  },
  "data": {
    "client_id": "abc",
    "client_secret": "def",
    "grant_type": "client_credentials"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

Response (JSON)

{
  "access_token": "CnKAVqSqp6UBq3Ei17e1UIj2U39UuOQI1i9Db3QT",
  "token_type": "Bearer"
}

HTTP Request

POST (Access Token Endpoint)

Query Parameters

Parameter	Type	Default	Description
client_id	string	-	The client ID.
client_secret	string	-	The client secret.
grant_type	string	-	The grant type.

Response Parameters

Parameter	Type	Default	Description
access_token	string	-	The access token.
token_type	string	Bearer	The type of the access token. (Default of Bearer)

Diagnostic Codes

An endpoint which must be implemented by an API Partner. This endpoint will allow ezyVet to fetch a list of Diagnostic Codes.

Fetch Diagnostic Codes

Note that this endpoint must be implemented by a Partner. This is NOT ezyVet's endpoint.

Sample Request: Get a list of Diagnostic Codes.

var settings = {
  "url": "(Fetch Diagnostic List Endpoint)",
  "method": "GET",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer token12345 (only if access token required)"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

Response (JSON)

{
  "directoryofservice": {
    "Test": [
      {
        "Name": "Complete Blood Count",
        "Code": "CBC",
        "Replicate": "0",
        "validFrom": "2012-12-13",
        "ExcVAT": "50",
        "Currency": "USD",
        "NonDiscountable": "true"
      }
    ]
  }
}

HTTP Request

GET (Fetch Diagnostic List Endpoint)

Response Parameters

Parameter	Type	Default	Parent	Description
directoryofservice	json	-	-	A `JSON` object containing information related to the directory of service.
Test	list	-	directoryofservice	A `List` containing details for each `Diagnostic Code`.
Name*	string	-	Test	The name of the test.
Code*	string	-	Test	The code of the test. (The `Diagnostic Code`)
Replicate	num, string	-	Test	Flag for replication.
validFrom*	date	-	Test	The date from which the test is valid.
ExcVAT	num, string	-	Test	Excluding VAT amount.
Currency*	string	-	Test	The currency of the amount.
NonDiscountable	boolean, string	-	Test	True if non discountable, False otherwise.

Animal Breeds & Species

An endpoint which must be implemented by an API Partner. This endpoint will allow ezyVet to fetch a list of Animal Species.

Fetch Animal Breeds & Species

Note that this endpoint must be implemented by a Partner. This is NOT ezyVet's endpoint.

Sample Request: Get a list of Animal Species.

var settings = {
  "url": "(Fetch Breeds & Species List Endpoint)",
  "method": "GET",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer token12345 (only if access token required)"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

Response (JSON)

{
  "species": [
    {
      "code": "CANINE",
      "name": "Canine",
      "breeds": [
        {
          "code": "LABRADOR_RETRIEVER",
          "name": "Labrador Retriever"
        },
        {
          "code": "PUG",
          "name": "Pug"
        }
      ]
    },
    {
      "code": "EQUINE",
      "name": "Equine",
      "breeds": [
        {
          "code": "BELGIAN_HORSE",
          "name": "Belgian Horse"
        },
        {
          "code": "THOROUGHBRED",
          "name": "Thoroughbred"
        }
      ]
    }
  ]
}

HTTP Request

GET (Fetch Breeds & Species List Endpoint)

Response Parameters

Parameter	Type	Default	Parent	Description
species	list	-	-	A `List` of species.
code	string	-	species	The code of the species.
name	string	-	species	The name of the species.
breeds	list	-	species	A `List` of breeds related to the species.
code	string	-	breeds	The code of the breed.
name	string	-	breeds	The name of the breed.

Diagnostic Request

An endpoint which must be implemented by an API Partner (wishing to receive Diagnostic Requests). This endpoint will allow ezyVet to push a list of Diagnostic Requests.

Push Diagnostic Request

ezyVet will push Diagnostic Requests as they are made/updated/disabled to the (Diagnostic Request Endpoint). The partner must acknowledge the POST request with a HTTP 200 OK once they have received the Diagnostic Requests successfully AND have been able to parse the information correctly.

Partner's should take note of the value of RequestStatus. It will either be request (active) or cancel (disabled).

Note that this endpoint must be implemented by a Partner. This is NOT ezyVet's endpoint.

Sample Request : Push a list of Diagnostic Requests (JSON) to partner's endpoint.

var settings = {
  "url": "(Diagnostic Request Endpoint)",
  "method": "POST",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer token12345 (only if access token required)"
  },
  "data": {
    "labreport": {
      "Identification": {
        "ReportType": "request",
        "PracticeRef": "NZ0-DR158",
        "PIMSName": "ezyVet",
        "PIMSVersion": "21.80",
        "OwnerName": "Sales, Cash",
        "OwnerId": "2",
        "VetName": "Team Star",
        "VetID": "10",
        "OwnershipId": "1",
      },
      "AnimalDetails": {
        "AnimalID": "1",
        "AnimalName": "Mini",
        "Breed": "Border Collie",
        "Gender": "MN",
        "Species": "Canine",
        "Age": "6Y 5M 15D",
        "DateOfBirth": "2011-03-07",
        "AbbreviatedHistory": "Some history.",
        "AdditionalFields": {
          "AnimalCode": "100001",
          "BreedCode": "BORDCOL",
          "SpeciesCode": "C",
          "ConsultCode": "300003"
        }
      },
      "LabRequests": {
        "LabRequest": [
          {
            "TestCode": "AR1PE",
            "RequestStatus": "request"
          }
        ]
      }
    }
  } 
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

Response (JSON)

200 OK

Unsuccessful Response (text/html)

Error message. e.g. ("Cannot process this lab request.")

HTTP 4xx e.g. 400

Optional Response (JSON)

{
  "external_link": "(valid URL)",
  "status": "(The status given by the Partner)"
} 

200 OK

HTTP Request

POST (Diagnostic Request Endpoint)

Query Parameters

Parameter	Type	Default	Parent	Description
labreport	json	-	-	A `JSON` object containing the lab report details.
Identification	json	-	labreport	A `JSON` object containing identity information.
ReportType	string	-	Identification	The lab report type.
PracticeRef	string	-	Identification	The practice reference ID. This field is derived from the `DiagnosticRequest`.
PIMSName	string	-	Identification	The PIMS name.
PIMSVersion	float, string	-	Identification	The PIMS version number.
OwnerName	string	-	Identification	The name of the `Owner`.
OwnerId	num, string	-	Identification	The ID of the `Owner` of the `Animal`.
VetName	string	-	Identification	The name of the `Vet` who initiated the `DiagnosticRequest`.
VetID	num, string	-	Identification	The ID of the `Vet` who initiated the `DiagnosticRequest`.
OwnershipId	num, string	-	Identification	The originating ownership separation the diagnostic request came from.
AnimalDetails	json	-	labreport	A `JSON` object containing `Animal` details.
AnimalID	num, string	-	AnimalDetails	The ID of the `Animal`.
AnimalName	string	-	AnimalDetails	The name of the `Animal`.
Breed	string	-	AnimalDetails	The breed of the `Animal`.
Gender	string	-	AnimalDetails	The `Animal's` gender.
Species	string	-	AnimalDetails	The `Animal's` species.
Age	string	-	AnimalDetails	The `Animal's` age. Denoted with `Y = year`, `M = month` and `D = day`.
DateOfBirth	date, string	-	AnimalDetails	The date of birth of the `Animal`.
AdditionalFields	json	-	AnimalDetails	A `JSON` object containing additional fields related to the `Animal`.
AbbreviatedHistory	string	-	AnimalDetails	Notes for history/specifics of the `DiagnosticRequest`.
AnimalCode	num, string	-	AdditionalFields	The `Animal` code.
BreedCode	string	-	AdditionalFields	The `Breed` code.
SpeciesCode	string	-	AdditionalFields	The `Species` code.
ConsultCode	string	-	AdditionalFields	The `Consult` code.
LabRequests	json	-	labreport	A `JSON` object containing LabRequest.
LabRequest	array	-	LabRequests	A `List` containing lab request objects.
TestCode	string	-	LabRequest	The test code.
RequestStatus	string	-	LabRequest	The request status.

Response Parameters

Parameter	Type	Default	Description
external_link (optional)	string, URL	-	An optional field. Can be provided if the partner wishes the ezyVet user to be redirected to their site in order to fill out any additional information that may be required by them. Must be a valid URL if provided. NOTE: If the partner does not include this in the response, then the user will not be redirected anywhere. If an external_link has been provided in the past, then the user can still access that link at anytime if the setting Company Logo has been populated in the Integration Setting in ezyVet.
status (optional)	string	-	An optional field. Partner may return this field if they wish to provide the current status of the `DiagnosticRequest` in their system to ezyVet.

Endpoints

Authentication

DiagnosticResult

The result of a Standard Diagnostic. It is sometimes also referred to as a lab result. Each DiagnosticResult must be linked to an Animal.

VetXML support has now been deprecated. Please use the JSON format to send results.

Create a DiagnosticResult

Creates a single DiagnosticResult.

The diagnostic result must either be in JSON or VetXML enclosed in a JSON string. Ensure the Vet and Animal are both provided in the lab report.

You can also upload Attachment's together with the creation of a DiagnosticResult. This can be done by encoding the file using base64 and including it in the request. The file types supported are JPG, PNG and PDF. The maximum file size is 5MB (before encoding).

Please ensure DiagnosticResult's are sent as JSON as VetXML support will be deprecated soon.

Note that Attachment's are only supported for the JSON format.

You can provide a list of values for both the diagnostic_result_item_list and attachment_list parameters per request.

Ensure VetXML is correctly escaped in the JSON string.

Sample Request: Create a DiagnosticResult for a given diagnostic request (JSON).

var settings = {
  "url": "https://integrations.ezyvet.com/call/standarddiagnostic/labReport",
  "method": "POST",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer token12345",
  },
  "data": {
    "labreport": {
      "LabReport": {
        "Identification": {
          "ReportType": "Request",
          "PracticeID": "0",
          "PracticeRef": "AU50-DR400",
          "LaboratoryID": "200314",
          "LaboratoryRef": "Panny Farm",
          "OwnerName": "Joe",
          "OwnerID": "8",
          "VetName": "Collin Tupin",
          "VetID": "10",
          "BillingType": "Practice",
          "PIMSName": "ezyVet",
          "PIMSVersion": "21.1"
        },
        "AnimalDetails": {
          "AnimalID": "21",
          "AnimalName": "Abbey",
          "Gender": "Female Spayed",
          "Species": "Dog",
          "Breed": "Spanish Mastiff",
          "DateOfBirth": "2011-02-07T11:00:00:0800"
        },
        "LabResults": [
          {
            "LabResult": {
              "LabResultHeader": {
                "TestCode": "CBC",
                "TestName": "New SDI result",
                "TestType": "BloodTest",
                "ResultDate": "2012-12-15T12:12:12",
                "ResultNotes": "
                This is heading 1
                ========

                This is heading 2
                --------

                [LINK](https://ezyvet.com)

                Below is an external image:
                ![Image](https://cdn4.iconfinder.com/data/icons/animals-57/500/cat_animal_-512.png)

                This is: *Italic text* OR _Italic text_
                This is: **Bold text** OR __Bold text__

                * Unordered list item 1
                * Unordered list item 2

                1. Ordered List 1
                2. Ordered List 2

                | Tables        |     With      | Markdown |
                | ------------- | :-----------: | -------: |
                | col 3 is      | right-aligned |    $1600 |
                | col 2 is      |   centered    |      $12 |
                | zebra stripes |   are neat    |       $1 |

                Here is the link to the documentation - https://commonmark.org/help/
                "
              },
              "LabResultItems": [
                {
                  "LabResultItem": {
                    "AnalyteName": "Blood Level",
                    "Result": "50",
                    "Units": "p",
                    "LowRange": "1",
                    "HighRange": "100",
                    "PathologistName": "Sally",
                    "PathologistTitle": "Ms"
                    "Qualifier": "qualifier",
                    "Notes": "notes"
                  }
                }
              ],
              "attachment_list": [
                {
                  "content_upload_method": "base64",
                  "content_type": "jpg",
                  "content_name": "four_pixels.jpg",
                  "content_binary":
                    "/9j/4AAQSkZJRgABAQEAYABgAAD/4QBmRXhpZgAATU0AKgAAAAgABgESAAMAAAABAAEAAAMBAAUAAAABAAAAVgMDAAEAAAABAA
            AAEQAAEAAAABAQAAAFERAAQAAAABAAAOw1ESAAQAAAABAAAOwwAAAAAAAYagAACxj//bAEMAAgEBAgEBAgICAgICAgIDBQMDA
            wMgQEAwUHBgcHBwYHBwgJCwkICAoIBwcKDQoKCwwMDAwHCQ4PDQwOCwwMDP/bAEMBAgICAwMDBgMDBgwIBwgMDAwMDA
            wMwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDP/AABEIAAIAAgMBIgACEQEDEQH/
            xAAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgv/xAC1EAACAQMDAgQDBQUEBAAAAX0BAgMABBEFEiExQQYTUWEHInEUMo
            GRgjQrHBFVLR8CQzYnKCCQoWFxgZGiUmJygpKjQ1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoOEhYaHiImKkpO
            UlXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4eLj5OXm5+jp6vHy8/T19vf4+fr/xAAfAQADAQEBAQEBAQEBA
            AAAAAAQIDBAUGBwgJCgv/xAC1EQACAQIEBAMEBwUEBAABAncAAQIDEQQFITEGEkFRB2FxEyIygQgUQpGhscEJIzNS8BVictEKFiQ04SX
            xFZGiYnKCkqNTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqCg4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4
            ubw8TFxsfIycrS09TV1tfY2dri4+Tl5ufo6ery8/T19vf4+fr/2gAMAwEAAhEDEQA/AOT8XfBPwZJ4r1Rm8I+GGZruUknS4Mk7z/s0UUV+NR2P
            0/96qf4n+bP//Z"        
                },
                {
                  "content_upload_method": "base64",
                  "content_type": "pdf",
                  "content_name": "brokenPDF.pdf",
                  "content_binary":
            "JVBERi0xLjUKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nCWL
            vQqEMBAG+32KrxYu7q6aRAgphLvCTliwEDt/ugNtfH0FmWKaGXaCiw4w2LFGeBHXBkFoX58rjQX+b/Fw7tQZNd5FBK2f2RaUP4EobJsSS/
            YxsWZJXOWPJq7zbD19jQYacAP9iBdmCmVuZHN0cmVhbQplbmRvYmoKCjMgMCBvYmoKMTA2CmVuZG9iagoKNSAwIG9iago8PC9MZW5ndGggNiAwIFIvRmlsdGVyL0Zs
            YXRlRGVjb2RlL0xlbmd0aDEgODE4OD4+CnN0cmVhbQp4nOU4fVAbV36/tyuB+DASBGRs2ejJG7AxIGEwjvEXMiABBhvx5UjYMVqkBckGSZUEjp3LmLs2OY8c1z7nmtS
            JZ5I/rpnkmo6XOL2Sm/RM0qbt9XqXpHfpTXrxxTN3N+1M7bGbS/JHUpv+3tsVxsRJpp3+14W3+/v+fo9d0skpBQphBkRwhyblRKnRIADAPwGQktB0mu7sLduO8FUA4Z
            /HEuOTz/zVwY8BDK8C5L46PnFsbHX/S2mAwgiA+E5EkcOfrmquAbBsRRtbIkjovn0sF/EE4vdHJtMPXyELJYh/F/HSiXhIpuIoQfxFxAsn5YcTDsM29G9B+0Bj8qSyr
            iWnE/FfABRMJ+KpdBhOLgCs6WH8RFJJ9Dwz+hbiE+j/LNII/rCrEMEchguiAf4/X8bTUAadxp1ghgS/33WJL8MqOA+wcI1hd+63exY++7+MwqQ9/hRegFfhNLwPD+kML
            /ggClNIWXq9Ae8ilV0+GIbvQ+ZLzL4Mc8jX5IJwhmVyz8sHT8Ml+Pu7vPhgEh7BWP4S3ieb4Mc4KnH4iJjgm/AWWv0IaXvvZUoowtsYB8eWUH8FzwqnYI/wW0TOM47gEi
            zwt3CBHELLaczz9GLGO75g9NvwKN4HIALTCPPLuPO//hXyFn6PWT0Ke+BbsBsmlmi8Tp4T87F/g/Ac1vQNTnNlmbmd4mHhB4Jw60lEvgPjuGSCuQunxd1fUqH/8SUOwQ
            pSLVZC3r24wmYw3/5MaFj4WLwf8mFo4WaWttC98HtRvh0zjBjWGHcafvJVPnK+Y5hEbVj43e1HboeN+4wvYLfwpHB3HBgO+IcGB/r7fL379vZ07+nq7PB62ttad7tbdu3c
            sX1b89YHtjRtqnc562o3rK+qvF9a57CXlxZbzEUrCvLzTLk5RoMoEKilKgl6VLGSFntlySPJnXW11FMeaa+r9UjeoEplquLDUCV1dnKSJKs0SNUqfMhLyEHVjZJjyyTdmq
            R7UZJY6A7YwVxIVP1pu0TnyHCfH+HT7VKAqtc5vJfDhiqOrEDE4UANHhWLlnpU73Qk4wlijGS2IL9NalPy62phNr8AwQKE1A1SYpZs2EU4IGzwbJsVwLSCucVMPXJY9fX5P
            e02hyNQV9ulFkntnAVt3KSa06bmcpM0ykKHU3S2dj7zxJwFRoM1hWEpLB/0q6KMuhnRk8l8Wy2uUauldrX6+G/LMXNFrZXaPWoNs9rdv+in+45LohorLRLNfAKYjnT92t0UWa
            fkVFo+AQaqQptK+v0Odtm8WOtMxitRbyaYkecWZkYlapEys4WFmYQHyw0+P5qYW/jhKZvqfSKgWoIRsi2gp+7t71bv6zvgV4VKL43ISMHfFsmx1eYoXpTxfRkbsCxYHKyww8HK
            cGrODaOIqDN9fg2nMGp7BdyumoAqBBlnPsspG2KcmSxnUT0oYW+7B/wZ1VDZFZY8WPFTsjozitN1mDVGsqhFn9ocUqakmDa7AlyWYlRd4ShVjVVYJNRaqoBzw1QyFo4Ufao9rt"
                }
              ] 
            }
          } 
        ]
      }
    }
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

Response (JSON)

{
    "message": [
        {"level": "info", "text": "Inserted AU0-DR5. Specifics: ..."}
    ]
}

HTTP Request

POST https://integrations.ezyvet.com/call/standarddiagnostic/labReport

Lab Report

Parameter	Type	Default	Parent	Description
labreport*	string, json	-	-	A string containing the `VetXML` representation of the lab report or a `JSON` representation of the lab report.
LabReport*	json	-	labreport	A `JSON` object containing the lab report.
Identification*	json	-	LabReport	A `JSON` object containing identity information.
ReportType	string	-	Identification	The lab report type.
PracticeID	num, string	-	Identification	The practice ID.
PracticeRef*	string	-	Identification	The practice reference ID. This field is used to match `DiagnosticResults` with existing `DiagnosticRequests`.
LaboratoryID	num, string	-	Identification	The laboratory's ID.
LaboratoryRef	string	-	Identification	The laboratory's reference ID.
OwnerName	string	-	Identification	The name of the `Owner`.
OwnerID	num, string	-	Identification	The ID of the `Owner` of the `Animal`.
VetName	string	-	Identification	The name of the `Vet` who initiated the `DiagnosticRequest`.
VetID	num, string	-	Identification	The ID of the `Vet` who initiated the `DiagnosticRequest`.
BillingType	string	-	Identification	The billing type.
PIMSName	string	-	Identification	The PIMS name.
PIMSVersion	float, string	-	Identification	The PIMS version number.
AnimalDetails*	json	-	LabReport	A `JSON` object containing `Animal` details.
AnimalID*	num, string	-	AnimalDetails	The ID of the `Animal`.
AnimalName	string	-	AnimalDetails	The name of the `Animal`.
Gender	string	-	AnimalDetails	The `Animal's` gender.
Species	string	-	AnimalDetails	The `Animal's` species.
Breed	string	-	AnimalDetails	The breed of the `Animal`.
DateOfBirth	datetime, string	-	AnimalDetails	The date of birth of the `Animal`.
LabResults	list	-	LabReport	A `List` of LabResults.
LabResult	json	-	LabResults	A `JSON` object containing information regarding a lab result.
LabResultHeader*	json	-	LabResult	A `JSON` object containing header information for a lab result.
TestCode*	string	-	LabResultHeader	The test code.
TestName	string	-	LabResultHeader	The test name.
TestType	string	-	LabResultHeader	The test type.
ResultDate*	datetime	-	LabResultHeader	The date and time of the result.
ResultNotes	string	-	LabResultHeader	Any notes related to the result.
LabResultItems	json	-	LabResult	A `JSON` object containing a list of LabResultItems.
LabResultItem	json	-	LabResultItems	A `JSON` object containing the lab result item's details.
AnalyteName*	string	-	LabResultItem	The analyte name.
Result*	num, string	-	LabResultItem	The lab result's value.
Units*	string	-	LabResultItem	The units of the lab result. E.g. mL (millilitres).
LowRange	num , string	-	LabResultItem	The lowest value of the range of results.
HighRange	num, string	-	LabResultItem	The highest value of the range of results.
PathologistName	string	-	LabResultItem	The name of the pathologist.
PathologistTitle	string	-	LabResultItem	The title of the pathologist.
Qualifier	string	-	LabResultItem	The qualifier of the result item.
Notes	string	-	LabResultItem	Any notes related to the result item.
attachment_list	list	[]	LabResult	A list of `Attachments`.

Attachment List

Parameter	Type	Default	Parent	Description
content_upload_method*	string	-	attachment_list	String containing method used to upload information.
content_type*	string	-	attachment_list	String containing type of attachment. `JPG`, `PNG` or `PDF`.
content_name*	string	-	attachment_list	String containing the name of the attachment file.
content_binary*	string	-	attachment_list	String containing the binary representation of the file.

Response Fields

Parameter	Type	Default	Description
message	list	-	The message upon response. Gives information regarding the outcome of the request.

Update a DiagnosticResult

Update a DiagnosticResult.

Please ensure DiagnosticResult's are sent as JSON as VetXML support will be deprecated soon.

In order to update a DiagnosticResult, there must already be an existing DiagnosticResult with the same PracticeRef.

Note that Attachment's are only supported for the JSON format.

You can provide a list of values for both the diagnostic_result_item_list and attachment_list parameters per request. Providing empty lists for either of the parameters will not update the respective parameter in ezyVet to be empty as well (instead will leave it unchanged).

Ensure VetXML is correctly escaped in the JSON string.

Sample Request: Update a DiagnosticResult for a given diagnostic request (JSON).

var settings = {
  "url": "https://integrations.ezyvet.com/call/standarddiagnostic/updateResult",
  "method": "PATCH",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer token12345",
  },
  "data": {
    "labreport": {
      "LabReport": {
        "Identification": {
          "ReportType": "Request",
          "PracticeID": "0",
          "PracticeRef": "AU50-DR400",
          "LaboratoryID": "200314",
          "LaboratoryRef": "Panny Farm",
          "OwnerName": "Joe",
          "OwnerID": "8",
          "VetName": "Collin Tupin",
          "VetID": "10",
          "BillingType": "Practice",
          "PIMSName": "ezyVet",
          "PIMSVersion": "21.1"
        },
        "AnimalDetails": {
          "AnimalID": "21",
          "AnimalName": "Abbey",
          "Gender": "Female Spayed",
          "Species": "Dog",
          "Breed": "Spanish Mastiff",
          "DateOfBirth": "2011-02-07T11:00:00:0800"
        },
        "LabResults": [
          {
            "LabResult": {
              "LabResultHeader": {
                "TestCode": "CBC",
                "TestName": "New SDI result",
                "TestType": "BloodTest",
                "ResultDate": "2012-12-15T12:12:12",
                "ResultNotes": "
                This is heading 1
                ========

                This is heading 2
                --------

                [LINK](https://ezyvet.com)

                Below is an external image:
                ![Image](https://cdn4.iconfinder.com/data/icons/animals-57/500/cat_animal_-512.png)

                This is: *Italic text* OR _Italic text_
                This is: **Bold text** OR __Bold text__

                * Unordered list item 1
                * Unordered list item 2

                1. Ordered List 1
                2. Ordered List 2

                | Tables        |     With      | Markdown |
                | ------------- | :-----------: | -------: |
                | col 3 is      | right-aligned |    $1600 |
                | col 2 is      |   centered    |      $12 |
                | zebra stripes |   are neat    |       $1 |

                Here is the link to the documentation - https://commonmark.org/help/
                "
              },
              "LabResultItems": [
                {
                  "LabResultItem": {
                    "AnalyteName": "Blood Level",
                    "Result": "50",
                    "Units": "p",
                    "LowRange": "1",
                    "HighRange": "100",
                    "PathologistName": "Sally",
                    "PathologistTitle": "Ms"
                    "Qualifier": "qualifier",
                    "Notes": "notes"
                  }
                },
                {
                  "LabResultItem": {
                      "AnalyteName": "Monos ",
                      "Result": "235",
                      "Units": "/uL",
                      "LowRange": "0.000",
                      "HighRange": "850.000",
                      "PathologistName": null,
                      "PathologistTitle": null,
                      "Qualifier": null,
                      "Notes": ""
                  }
                }
              ],
              "attachment_list": [
                {
                  "content_upload_method": "base64",
                  "content_type": "jpg",
                  "content_name": "four_pixels.jpg",
                  "content_binary":
                    "/9j/4AAQSkZJRgABAQEAYABgAAD/4QBmRXhpZgAATU0AKgAAAAgABgESAAMAAAABAAEAAAMBAAUAAAABAAAAVgMDAAEAAAABAA
            AAEQAAEAAAABAQAAAFERAAQAAAABAAAOw1ESAAQAAAABAAAOwwAAAAAAAYagAACxj//bAEMAAgEBAgEBAgICAgICAgIDBQMDA
            wMgQEAwUHBgcHBwYHBwgJCwkICAoIBwcKDQoKCwwMDAwHCQ4PDQwOCwwMDP/bAEMBAgICAwMDBgMDBgwIBwgMDAwMDA
            wMwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDP/AABEIAAIAAgMBIgACEQEDEQH/
            xAAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgv/xAC1EAACAQMDAgQDBQUEBAAAAX0BAgMABBEFEiExQQYTUWEHInEUMo
            GRgjQrHBFVLR8CQzYnKCCQoWFxgZGiUmJygpKjQ1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoOEhYaHiImKkpO
            UlXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4eLj5OXm5+jp6vHy8/T19vf4+fr/xAAfAQADAQEBAQEBAQEBA
            AAAAAAQIDBAUGBwgJCgv/xAC1EQACAQIEBAMEBwUEBAABAncAAQIDEQQFITEGEkFRB2FxEyIygQgUQpGhscEJIzNS8BVictEKFiQ04SX
            xFZGiYnKCkqNTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqCg4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4
            ubw8TFxsfIycrS09TV1tfY2dri4+Tl5ufo6ery8/T19vf4+fr/2gAMAwEAAhEDEQA/AOT8XfBPwZJ4r1Rm8I+GGZruUknS4Mk7z/s0UUV+NR2P
            0/96qf4n+bP//Z"
                },
                 {
                  "content_upload_method": "base64",
                  "content_type": "pdf",
                  "content_name": "brokenPDF.pdf",
                  "content_binary":
            "JVBERi0xLjUKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nCWL
            vQqEMBAG+32KrxYu7q6aRAgphLvCTliwEDt/ugNtfH0FmWKaGXaCiw4w2LFGeBHXBkFoX58rjQX+b/Fw7tQZNd5FBK2f2RaUP4EobJsSS/
            YxsWZJXOWPJq7zbD19jQYacAP9iBdmCmVuZHN0cmVhbQplbmRvYmoKCjMgMCBvYmoKMTA2CmVuZG9iagoKNSAwIG9iago8PC9MZW5ndGggNiAwIFIvRmlsdGVyL0Zs
            YXRlRGVjb2RlL0xlbmd0aDEgODE4OD4+CnN0cmVhbQp4nOU4fVAbV36/tyuB+DASBGRs2ejJG7AxIGEwjvEXMiABBhvx5UjYMVqkBckGSZUEjp3LmLs2OY8c1z7nmtS
            JZ5I/rpnkmo6XOL2Sm/RM0qbt9XqXpHfpTXrxxTN3N+1M7bGbS/JHUpv+3tsVxsRJpp3+14W3+/v+fo9d0skpBQphBkRwhyblRKnRIADAPwGQktB0mu7sLduO8FUA4Z
            /HEuOTz/zVwY8BDK8C5L46PnFsbHX/S2mAwgiA+E5EkcOfrmquAbBsRRtbIkjovn0sF/EE4vdHJtMPXyELJYh/F/HSiXhIpuIoQfxFxAsn5YcTDsM29G9B+0Bj8qSyr
            iWnE/FfABRMJ+KpdBhOLgCs6WH8RFJJ9Dwz+hbiE+j/LNII/rCrEMEchguiAf4/X8bTUAadxp1ghgS/33WJL8MqOA+wcI1hd+63exY++7+MwqQ9/hRegFfhNLwPD+kML
            /ggClNIWXq9Ae8ilV0+GIbvQ+ZLzL4Mc8jX5IJwhmVyz8sHT8Ml+Pu7vPhgEh7BWP4S3ieb4Mc4KnH4iJjgm/AWWv0IaXvvZUoowtsYB8eWUH8FzwqnYI/wW0TOM47gEi
            zwt3CBHELLaczz9GLGO75g9NvwKN4HIALTCPPLuPO//hXyFn6PWT0Ke+BbsBsmlmi8Tp4T87F/g/Ac1vQNTnNlmbmd4mHhB4Jw60lEvgPjuGSCuQunxd1fUqH/8SUOwQ
            pSLVZC3r24wmYw3/5MaFj4WLwf8mFo4WaWttC98HtRvh0zjBjWGHcafvJVPnK+Y5hEbVj43e1HboeN+4wvYLfwpHB3HBgO+IcGB/r7fL379vZ07+nq7PB62ttad7tbdu3c
            sX1b89YHtjRtqnc562o3rK+qvF9a57CXlxZbzEUrCvLzTLk5RoMoEKilKgl6VLGSFntlySPJnXW11FMeaa+r9UjeoEplquLDUCV1dnKSJKs0SNUqfMhLyEHVjZJjyyTdmq
            R7UZJY6A7YwVxIVP1pu0TnyHCfH+HT7VKAqtc5vJfDhiqOrEDE4UANHhWLlnpU73Qk4wlijGS2IL9NalPy62phNr8AwQKE1A1SYpZs2EU4IGzwbJsVwLSCucVMPXJY9fX5P
            e02hyNQV9ulFkntnAVt3KSa06bmcpM0ykKHU3S2dj7zxJwFRoM1hWEpLB/0q6KMuhnRk8l8Wy2uUauldrX6+G/LMXNFrZXaPWoNs9rdv+in+45LohorLRLNfAKYjnT92t0UWa
            fkVFo+AQaqQptK+v0Odtm8WOtMxitRbyaYkecWZkYlapEys4WFmYQHyw0+P5qYW/jhKZvqfSKgWoIRsi2gp+7t71bv6zvgV4VKL43ISMHfFsmx1eYoXpTxfRkbsCxYHKyww8HK
            cGrODaOIqDN9fg2nMGp7BdyumoAqBBlnPsspG2KcmSxnUT0oYW+7B/wZ1VDZFZY8WPFTsjozitN1mDVGsqhFn9ocUqakmDa7AlyWYlRd4ShVjVVYJNRaqoBzw1QyFo4Ufao9rt"
                }
              ] 
            }
          } 
        ]
      }
    }
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

Response (JSON)

{
    "message": [
        {"level": "info", "text": "Updated AU0-DR5. Specifics: ..."}
    ]
}

HTTP Request

PATCH https://integrations.ezyvet.com/call/standarddiagnostic/updateResult

Lab Report

Parameter	Type	Default	Parent	Description
labreport*	string, json	-	-	A string containing the `VetXML` representation of the lab report or a `JSON` representation of the lab report.
LabReport*	json	-	labreport	A `JSON` object containing the lab report.
Identification*	json	-	LabReport	A `JSON` object containing identity information.
ReportType	string	-	Identification	The lab report type.
PracticeID	num, string	-	Identification	The practice ID.
PracticeRef*	string	-	Identification	The practice reference ID. This field is used to match `DiagnosticResults` with existing `DiagnosticRequests`.
LaboratoryID	num, string	-	Identification	The laboratory's ID.
LaboratoryRef	string	-	Identification	The laboratory's reference ID.
OwnerName	string	-	Identification	The name of the `Owner`.
OwnerID	num, string	-	Identification	The ID of the `Owner` of the `Animal`.
VetName	string	-	Identification	The name of the `Vet` who initiated the `DiagnosticRequest`.
VetID	num, string	-	Identification	The ID of the `Vet` who initiated the `DiagnosticRequest`.
BillingType	string	-	Identification	The billing type.
PIMSName	string	-	Identification	The PIMS name.
PIMSVersion	float, string	-	Identification	The PIMS version number.
AnimalDetails*	json	-	LabReport	A `JSON` object containing `Animal` details.
AnimalID*	num, string	-	AnimalDetails	The ID of the `Animal`.
AnimalName	string	-	AnimalDetails	The name of the `Animal`.
Gender	string	-	AnimalDetails	The `Animal's` gender.
Species	string	-	AnimalDetails	The `Animal's` species.
Breed	string	-	AnimalDetails	The breed of the `Animal`.
DateOfBirth	datetime, string	-	AnimalDetails	The date of birth of the `Animal`.
LabResults	list	-	LabReport	A `List` of LabResults.
LabResult	json	-	LabResults	A `JSON` object containing information regarding a lab result.
LabResultHeader*	json	-	LabResult	A `JSON` object containing header information for a lab result.
TestCode*	string	-	LabResultHeader	The test code.
TestName*	string	-	LabResultHeader	The test name.
TestType	string	-	LabResultHeader	The test type.
ResultDate	datetime	-	LabResultHeader	The date and time of the result.
ResultNotes	string	-	LabResultHeader	Any notes related to the result.
LabResultItems	json	-	LabResult	A `JSON` object containing a list of LabResultItems.
LabResultItem	json	-	LabResultItems	A `JSON` object containing the lab result item's details.
AnalyteName*	string	-	LabResultItem	The analyte name.
Result*	num, string	-	LabResultItem	The lab result's value.
Units*	string	-	LabResultItem	The units of the lab result. E.g. mL (millilitres).
LowRange	num , string	-	LabResultItem	The lowest value of the range of results.
HighRange	num, string	-	LabResultItem	The highest value of the range of results.
PathologistName	string	-	LabResultItem	The name of the pathologist.
PathologistTitle	string	-	LabResultItem	The title of the pathologist.
Qualifier	string	-	LabResultItem	The qualifier of the result item.
Notes	string	-	LabResultItem	Any notes related to the result item.
attachment_list	list	[]	LabResult	A list of `Attachments`.

Attachment List

Parameter	Type	Default	Parent	Description
content_upload_method*	string	-	attachment_list	String containing method used to upload information.
content_type*	string	-	attachment_list	String containing type of attachment. `JPG`, `PNG` or `PDF`.
content_name*	string	-	attachment_list	String containing the name of the attachment file.
content_binary*	string	-	attachment_list	String containing the binary representation of the file.

Response Fields

Parameter	Type	Default	Description
message	string	-	The message upon response. Gives information regarding the outcome of the request.

Introduction

Partner Endpoints

Access Token

Fetch an Access Token

HTTP Request

Query Parameters

Response Parameters

Diagnostic Codes

Fetch Diagnostic Codes

HTTP Request

Response Parameters

Animal Breeds & Species

Fetch Animal Breeds & Species

HTTP Request

Response Parameters

Diagnostic Request

Push Diagnostic Request

HTTP Request

Query Parameters

Response Parameters

Endpoints

Authentication

DiagnosticResult

Create a DiagnosticResult

HTTP Request

Lab Report

Attachment List

Response Fields

Update a DiagnosticResult

HTTP Request

Lab Report

Attachment List

Response Fields

Features

Errors