API RefAttaches

See API Specification

RefAttaches GET

Version Added: 22.4.27

Gets a list of refattaches.


PatNum: Optional. Filter responses by PatNum.

Example Requests:
GET /refattaches
GET /refattaches?PatNum=25

Example Response:
"RefAttachNum": 1,
"ReferralNum": 3,
"referralName": "Steve N Stevens, DDS",
"PatNum": 25,
"RefDate": "2022-01-05",
"ReferralType": "RefFrom",
"RefToStatus": "None",
"Note": "",
"ProcNum": 0,
"DateProcComplete": "0001-01-01",
"ProvNum": 0,
"DateTStamp": "2022-01-05 10:13:12"

200 OK
400 BadRequest "Patient has been deleted".
404 NotFound "Patient not found".

RefAttaches POST

Version Added: 21.2

Attaches a patient to a referral source. The referral source must be specified by either ReferralNum or referralName. Before calling this method, use Referrals GET to find the ReferralNum of an existing referral source. Alternatively, specify a referralName to search the LName of existing referrals for an exact match. If a match is not found, a new referral with that name is created and used. ProcNum, DateProcComplete, and ProvNum cannot be changed.

PatNum: Required.
ReferralNum: This or referralName is required.
referralName: This or ReferralNum is required.
RefDate: Optional.
ReferralType: Optional. Either "RefTo", "RefFrom", or "RefCustom". Default "RefFrom".
RefToStatus: Optional. Typically only used with outgoing referrals. Either "None", "Declined", "Scheduled", "Consulted", "InTreatment", or "Complete". Default "None".
Note: Optional.

Example Requests:
POST /refattaches

"PatNum": 50,
"ReferralNum": 2

"PatNum": 50,
"ReferralNum": 2,
"ReferralType": "RefTo",
"RefToStatus": "InTreatment",
"Note": "08/12 - Dr. Bokish called to confirm this is still in progress.",
"RefDate": "2021-07-28"

"PatNum": 50,
"referralName": "Google"

Example Response:
201 Created
400 BadRequest "Referral is already attached to this patient" or Invalid Fields
404 NotFound "Patient not found" or "Referral not found".