| DESCRIPTION |
This RPC performs the following events:
1. Creates a NEW APPOINTMENT REQUEST in File #409.85,
2. Creates an appointment entry in File 409.84, File 44, and File 2,
3. Dispositions/Closes the appointment request in File #409.85
|
| INPUT PARAMETER |
-
- REQUESTARRAY
- PARAMETER TYPE: LIST
- REQUIRED: YES
- SEQUENCE NUMBER: 1
- DESCRIPTION:
Below is the structure of the REQUEST ARRAY that contains all necessary
ISO FORMAT
REQUEST("CLINIC IEN") = (Required) CLINIC IEN
REQUEST("CREATE DATE") = (Required) DATE/TIME ENTERED
(#409.85,9.5) in ISO8601
date/time format to include
offset (e.g.
CCYY-MM-DDTHH:MM-NNNN)
REQUEST("PATIENT INDICATED DATE") = (Required) CID/PID DATE - ISO
FORMAT
REQUEST("DFN") = (Required) PATIENT IEN
data for the creation of the appointment request, scheduling the
REQUEST("APPOINTMENT REASON") = (Optional) FREE TEXT (1-150)
REQUEST("COLLATERAL VISIT") = (Optional) COLLATERAL - 1 FOR
YES
REQUEST("APPOINTMENT TYPE IEN") = (Optional) POINTER TO
APPOINTMENT TYPE FILE #409.1
REQUEST("APPOINTMENT TYPE NAME") = (Optional) NAME OF ENTRY IN
APPOINTMENT TYPE FILE #409.1
Either APPOINTMENT TYPE IEN
or APPOINTMENT TYPE NAME
is required
appointment, and then dispositioning the appointment.
REQUEST("EAS") = (Optional) Enterprise APPT
Scheduling Tracking Number
associated to an appt.
REQUEST("FOLLOWUP") = (Optional) FOLLOWUP VISIT - 1
FOR YES 0 FOR NO
REQUEST("INSTITUTION NAME") = (Optional) Institution name
from the INSTITUTION file
REQUEST("MODALITY") = (Optional) Valid Values:
FACE2FACE, TELEPHONE, VIDEO
REQUEST("NOTE") = (Optional) NOTE - FREE TEXT
1-150
REQUEST("OVERBOOK") = (Optional) OVERBOOK (0 for no,
1 for yes)
REQUEST("PATIENT COMMENT") = (Optional) Patient-entered
comments when using VAOS or
other web-service (stored at
409.85,60 a word processing
field)
REQUEST("PATIENT ELIGIBILITY IEN") = (Optional) ELIGIBILITY IEN
REQUEST("PATIENT PREFERRED END DATE",1) = (Optional) PATIENT PREFERRED
REQUEST("APPOINTMENT END TIME") = (Required) APPT END TIME - ISO
END DATE 1 - ISO FORMAT
REQUEST("PATIENT PREFERRED END DATE",2) = (Optional) PATIENT PREFERRED
END DATE 2 - ISO FORMAT
REQUEST("PATIENT PREFERRED END DATE",3) = (Optional) PATIENT PREFERRED
END DATE 3 - ISO FORMAT
REQUEST("PATIENT PREFERRED START DATE",1)= (Optional) PATIENT PREFERRED
START DATE 1 - ISO FORMAT
REQUEST("PATIENT PREFERRED START DATE",2)= (Optional) PATIENT PREFERRED
START DATE 2 - ISO FORMAT
REQUEST("PATIENT PREFERRED START DATE",3)= (Optional) PATIENT PREFERRED
FORMAT
START DATE 3 - ISO FORMAT
REQUEST("PATIENT STATUS") = (Optional) PATIENT STATUS -
"NEW" OR "ESTABLISHED
REQUEST("PRIORITY") = (Optional) PRIORITY - "ASAP"
or FUTURE
REQUEST("PRIORITY GROUP") = (Optional) ENROLLMENT PRIORITY
- GROUP 1 - GROUP 7
REQUEST("REQUEST COMMENT") = (Optional) REQUEST COMMENT
REQUEST("SECONDARY STOP CODE") = (Optional) Secondary Stop Code
Number pointer to CLINIC STOP
REQUEST("APPOINTMENT LENGTH") = (Required) APPT LENGTH IN
file #40.7 used to populate
the REQ SECONDARY STOP CODE
field in 409.85
REQUEST("SERVICE CONNECTED") = (Optional) Valid Values: YES,
NO
REQUEST("SERVICE CONNECTED PERCENTAGE") = (Optional) SC % = 0-100
REQUEST("STATION NUMBER") = (Optional) STATION NUMBER
(#99),INSTITUTION (#4)
REQUEST("STATION NAME") = (Optional) STATION NAME
(#.01),INSTITUTION (#4)
MINUTES (5-120)
Either STATION NUMBER or
STATION NAME is required
REQUEST("STOP CODE") = (Optional) CLINIC STOP pointer
to CLINIC STOP file 40.7 used
to populate the REQ
SERVICE/SPECIALTY field
in 409.85
REQUEST("VAOS GUID") = (Optional) VAOS GUID
REQUEST("APPOINTMENT START TIME") = (Required) APPT START TIME -
|
| RETURN PARAMETER DESCRIPTION |
Successful Return:
"IEN": 255931
}
}
Otherwise, JSON Errors will be returned for any invalid/missing
parameters. The Request and Appointment IEN is set to NULL values.
{
"Appointment": {
"IEN": ""
},
RETURNJSON = Returns the Request and Appointment IEN in JSON formatted
"Error": [
"Missing Patient ID.",
"Missing Origination date/time.",
"Missing Appointment Request Type.",
"Either Institution Name or Station Number must be
defined.",
"Clinic Name or Clinic Stop is required.",
"Missing Requested By.",
"Missing Provider ID.",
"Missing Origination date/time."
string.
],
"Request": {
"IEN": ""
}
}
}
{
"Appointment": {
"IEN": 292007
},
"Request": {
|
