Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Documents that a client needs to receive as a result of an order should be send in POST request to endpoint.

This is an example URL: https://sa.yourlawyer.com:4430/sasvcdev/SAWebService.svc/Retrieval/Documents
Note that it will be generally different for different clients (SaaS clients can share the same URL).

If you are using Push API, documents that a client needs to receive as a result of an order should be send to the URL which been in the field CallbackURL.

JSON structure:

Code Block
languagejson
{  
   "RecordID":"473",
   "SACaseNumber":"Y6009938",
   "Comments":"",
   "Documents":[  
      {  
         "ICDCodes":[  
            {  
               "PageNumber":"3",
               "Confidence":"97.94",
               "ICDCode":"V7643",
               "ICDCodeFormatted":"V76.43",
               "Format":"ICD9",
               "Description":"Screening for malignant neoplasms of skin",
               "Type":"diagnosis"
            },
            {  
               "PageNumber":"3",
               "Confidence":"99.58",
               "ICDCode":"70219",
               "ICDCodeFormatted":"702.19",
               "Format":"ICD9",
               "Description":"Other seborrheic keratosis",
               "Type":"diagnosis"
            }
         ],
         "DocumentType":"Medical Document",
         "DocumentName":"Dermatology Associates of Virginia - Reynolds Crossing MED Davis,D.pdf",
	     "SADocumentSubcategoryTypeID":20,
  	     "Document":"JVBERi0xLjYNJeLjz9MNCjk..."
      }
   ]
}


Fields description:

RecordID (integer) – SA record ID– Record retrieval order id
SACaseNumber (string) – SmartAdvocate case number
Comments (string) – Comments added to an order
Documents (list of documents):

ICDCodes

...

– if you do not support ICD codes recognition then you don't need to include this part into Json request.

PageNumber

...

– page where ICD code identified
Confidence

...

– Confidence percentage
ICDCode

...

– ICD code
ICDCodeFormatted

...

– formatted ICD code
Format

...

– format of ICD code
Description

...

– description of ICD Code
Type – type of ICD code

DocumentType

...

– Document type
SADocumentSubcategoryTypeID

...

– Smart advocate Document subcategory ID
DocumentName

...

– Document name
Document - The base64 encoded binary data for the file.

Large binary documents could can be send sent to URL: https://sa.yourlawyer.com:4430/sasvcdev/SAWebService.svc/Retrieval/UploadDocument?filename={filename}&RecordID={RecordID}&SACaseNumber={SACaseNumber}

...