DocM.DocManagementWebService - RADplus web service

The DocM.DocManagementWebService web service. This service contains the following calls:

GetDocument Call

Parameter	Property	Value Accepted	Notes
SystemCode	N/A	Avatar System Code
UserName	N/A	Avatar User ID
Password	N/A	Avatar Password
DocumentID	N/A	Document ID number	From the DocM.document_image table

This method returns a DocM.Scan.WebServiceDocumentResponse object:

Parameter	Value Returned	Notes
Status	Boolean	true if the document was retrieved successfully, false if there was an error
Message	A message (String)	Description of the error (if Status is false) or the successfully retrieved document (if Status is true).
Files	DocM.Scan.ListOfWebServiceFileResponses	A list containing each file within the document (see details below)

Parameter	Value Returned	Notes
FileName	The name of the original file (String)	The file name can be used to save the file locally.
FileExtension	The file extension (String)	Describes the type of file uploaded (pdf, jpg, tiff, etc.)
FileData	The file data (BinaryStream)	The raw data of the file. This can be written to disk to get a new copy of the document files.

Note that this call is only applicable if Perceptive is configured and web-enabled (Perceptive version 7.1 and later).

Parameter

Property

Value Accepted

Notes

SystemCode	N/A	Avatar System Code
UserID	N/A	Avatar User ID
Password	N/A	Avatar Password
DocumentID	N/A	Document ID Number
ViewingUser	N/A	User ID of the viewing user	Used to check permission for a user to view the given document. If not provided, the login UserID above is used.

Parameter	Property	Value Accepted	Notes
SystemCode	N/A	Avatar System Code
UserID	N/A	Avatar User ID
Password	N/A	Avatar Password
EntityID	N/A	An entity type ID	Indicates which form types to return (PATIENT will return document types used for clients, STAFF for staff form types, etc.)

Parameter	Property	Value Accepted	Notes
SystemCode	N/A	Avatar System Code
UserID	N/A	Avatar User ID
Password	N/A	Avatar Password
Image	N/A	BinaryStream	The document file data to be imported.

Parameter	Property	Value Accepted	Notes
Document	DocumentDescription	Free text
	DocumentFileName	Free text
	DocumentExtension	Free text
	DocumentOriginationDate	Date
	EPISODENUMBER	Episode number (Integer)
	EntityID	Entity ID
	EntityTypeCode	Entity type
	FormID	Document form type
	NonEpisodic	Boolean
	OriginationCode
	SystemCode	Avatar System Code
	UserID	Avatar User ID
	AdditionalDocumentInformation	Free text
	VendorCode
	VendorFileID