SDES2 CREATE APPT REQ2 (5138)    REMOTE PROCEDURE (8994)

Name Value
NAME SDES2 CREATE APPT REQ2
TAG CREATEREQUEST
ROUTINE SDES2CRTAPREQ2
RETURN VALUE TYPE ARRAY
AVAILABILITY RESTRICTED
WORD WRAP ON FALSE
APP PROXY ALLOWED Yes
DESCRIPTION
Creates new appointment request in the SDEC APPT REQUEST file (#409.85).
This will return all the details of the appointment request.
Can only be invoked by Acheron.
INPUT PARAMETER
  • SDCONTEXT
    PARAMETER TYPE:   LIST
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    SDCONTEXT("ACHERON AUDIT ID")
    SDCONTEXT("PATIENT ICN")
     - The ICN of the target patient from the calling application.
     - Up to 40 Character unique ID number. 
     - Ex: 11d9dcc6-c6a2-4785-8031-8261576fca37
    SDCONTEXT("USER DUZ")
     - The DUZ of the user taking action in the calling application.
    SDCONTEXT("USER SECID")
     - The SECID of the user taking action in the calling application.
    SDCONTEXT("PATIENT DFN")
     - The DFN/IEN of the target patient from the calling application.
    
  • REQUEST
    PARAMETER TYPE:   LIST
    REQUIRED:   YES
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    Appointment request data.
    REQUEST("REQUEST SUB TYPE")=""                          REQ
    REQUEST("REQUESTED BY")=""                              REQ
    REQUEST("CLINIC IEN")=""                                OPT/REQ  \
    REQUEST("PRIMARY AMIS")=""                              OPT/REQ---> 
      Either CLINIC IEN or PRIMARY AMIS/CREDIT PRIMARY AMIS must be defined
    REQUEST("CREDIT AMIS")=""                               OPT/REQ  /
    REQUEST("STATION NUMBER")=""                            OPT/REQ -- > 
      Either STATION NUMBER or INSTITUTION NAME is REQUIRED
    REQUEST("INSTITUTION NAME")=""                          OPT/REQ --/
    REQUEST("CREATE DATE")=""                               OPT
      
      Defaults to today if not sent
    REQUEST("PROVIDER IEN")=""                              OPT
      (Required if 'REQUESTED BY' is 'PROVIDER')
    REQUEST("PRIORITY GROUP")=""                            OPT
    REQUEST("SERVICE CONNECTED")=""                         OPT
      (This is for PRIORITY; 1 OR 0, if passed)
    REQUEST("SERVICE CONNECTED PERCENTAGE")=""              OPT
    REQUEST("MODALITY")=""                                  OPT
    REQUEST("PATIENT STATUS")=""                            OPT
    REQUEST("VAOS GUID")=""                                 OPT
    REQUEST("DFN")=""                                       REQ
    REQUEST("TIME SENSITIVE")=""                            OPT
    REQUEST("REQUEST COMMENT")=""                           OPT
    REQUEST("PATIENT COMMENT")=""                           OPT
    REQUEST("PATIENT PREFERRED START DATE",1)=""            OPT
    REQUEST("PATIENT PREFERRED END DATE",1)=""              OPT
    REQUEST("PATIENT PREFERRED START DATE",2)=""            OPT
    REQUEST("PATIENT PREFERRED END DATE",2)=""              OPT
    REQUEST("PATIENT PREFERRED START DATE",3)=""            OPT
    REQUEST("PATIENT PREFERRED END DATE",3)=""              OPT
    REQUEST("MRTC","NEEDED")=""                             OPT
      (PATIENT IEN)
    REQUEST("MRTC","PARENT REQUEST")=""                     OPT
    REQUEST("MRTC","DAYS BETWEEN APPTS")=""                 OPT
    REQUEST("MRTC","HOW MANY NEEDED")=""                    OPT
    REQUEST("DUPLICATE REASON")=""                          OPT
    REQUEST("APPOINTMENT TYPE")=""                          OPT
      APPOINTMENT TYPE - can be the Name or IEN
    REQUEST("PATIENT INDICATED DATE")=""                    REQ
      (PID DATE IN ISO FORMAT)
    REQUEST("PRIORITY")=""                                  REQ
    
RETURN PARAMETER DESCRIPTION
This is the fully expanded return JSON. Not all components will
   "AppointmentRequestIEN": "",
     "Type": "TEXT"
    }
   ],
   "CreateDate": "",
   "CreditStopCodeAMIS": 117,
   "CreditStopCodeIEN": 123,
   "CreditStopCodeName": "NURSING (2ND ONLY)",
   "DateLinkedApptMade": "",
   "DateTimeEntered": "",
   "DisplayClinicAppt": "YES",
   "ApptType": "",
   "DispositionIEN": "",
   "DispositionReason": "",
   "DispositionedBy": "",
   "DispositionedDate": "",
   "DuplicateReason": "DUPLICATE REASON TEXT",
   "EASTrackingNumber": "",
   "EnrollmentPriorityGroup": "GROUP 3",
   "EnteredByIEN": 123456,
   "EnteredByName": "USER ,TEST G",
   "InstitutionIEN": "",
   "ByPatientOrProvider": "",
   "InstitutionName": "",
   "InstitutionNumber": "",
   "LinkedApptClinic": "",
   "LinkedApptCreditStopCode": "",
   "LinkedApptEnteredBy": "",
   "LinkedApptInstitutionName": "",
   "LinkedApptInstitutionNumber": "",
   "LinkedApptStationNumber": "",
   "LinkedApptStatus": "",
   "LinkedApptStopCode": "",
   "CPRSOrderID": "",
   "MRTC": [
    {
     "ChildRequestIEN": 264525,
     "ChildRequestSequenceNumber": 1,
     "LinkedAppointmentIEN": 298941,
     "PatientIndicatedDate": "2024-03-06"
    },
    {
     "ChildRequestIEN": 264526,
     "ChildRequestSequenceNumber": 2,
   "CPRSPreRequisites": [
     "LinkedAppointmentIEN": "",
     "PatientIndicatedDate": "2024-03-13"
    },
    {
     "ChildRequestIEN": 264527,
     "ChildRequestSequenceNumber": 3,
     "LinkedAppointmentIEN": "",
     "PatientIndicatedDate": "2024-03-20"
    }
   ],
    {
   "MRTCDaysBetweenAppts": "",
   "MRTCHowManyNeeded": "",
   "MRTCNeeded": "",
   "MRTCTotal": "",
   "ModalityCode": "",
   "ModalityName": "",
   "PIDChangeAllowed": "",
   "ParentRequestIEN": "",
   "PatientComment": [
    {
     "PreRequisite": "PRE-REQ 434"
     "Comment": "TESTING TESTING TESTING 123 "
    },
    {
     "Comment": "Patient preferred date range #1: Jul 25, 2022@10:00 to 
Jul 31, 2022@10:00 "
    },
    {
     "Comment": "Patient preferred date range #2: Aug 17, 2022@10:00 to 
Aug 31, 2022@10:00 "
    },
    },
    {
     "Comment": "Patient preferred date range #3: Sep 30, 2022@10:00 to 
Oct 01, 2022@10:00"
    }
   ],
   "PatientICN": "",
   "PatientIEN": 11221122,
   "PatientIndicatedDate": "",
   "PatientLast4": 4607,
   "PatientName": "PATIENT, TEST",
    {
   "PatientPhone": 999-999-9999,
   "PatientStatus": "",
   "Priority": "",
   "ProviderIEN": "",
   "ProviderName": "",
   "ProviderSecID": "",
   "RecallAccessionNumber": "",
   "RecallAppointmentLength": 30,
   "RecallAppointmentType": "YEARLY EXAM",
   "RecallClinicSecondaryStopCodeAMIS": 117,
     "PreRequisite": "PRE-REQ 534"
   "RecallClinicSecondaryStopCodeIEN": 123,
   "RecallClinicSecondaryStopCodeName": "NURSING (2ND ONLY)",
   "RecallClinicStopCodeAMIS": 323,
   "RecallClinicStopCodeIEN": 296,
   "RecallClinicStopCodeName": "PRIMARY CARE\/MEDICINE",
   "RecallComment": "RTC IN 1 YEAR W LABS PER RTC ORDER\/\/CID=032918",
   "RecallDateReminderSent": "2018-01-28",
   "RecallEnteredBySecID": 1234,
   "RecallFastingNonFasting": "FASTING",
   "RecallGAFScore": "New GAF Required",
contain data. For example, if the record is not an MRTC, the 
    },
   "RecallProviderIEN": 27,
   "RecallProviderIndicatedDate": "2018-03-29",
   "RecallProviderName": "TEST,PROVIDER A",
   "RecallProviderNewPersonIEN":123123,
   "RecallProviderSecID": "",
   "RecallSecondPrint": "",
   "RecallSimilarPatientData": "",
   "RequestComments": "",
   "RequestIEN": 206674,
   "RequestSubType": "",
    {
   "ScheduledDateOfAppt": "",
   "SdecContactDateOfLastLetterSent": "",
   "SdecContactNumberOfCalls": "",
   "SdecContactNumberOfContacts": 0,
   "SdecContactNumberOfEmailContact": "",
   "SdecContactNumberOfLetters": "",
   "SdecContactNumberOfSecureMessage": "",
   "SdecContactNumberOfTextContact": "",
   "SensitiveRecord": 0,
   "ServiceConnectedPercentage": "",
     "PreRequisite": "PRE-REQ 634"
   "ServiceConnectedPriority": "",
   "Status": "",
   "Type": ""
  }
 ]
}
}
    }
   ],
   "CPRSStatus": "",
   "CPRSTimeSensitive": "",
   "ChildRequestSequenceNumber": "",
   "ClinicIEN": "" ,
   "ClinicName": "",
MRTC component will exist, but will not have any data. This 
   "ClinicSecondaryStopCodeAMIS": "",
   "ClinicSecondaryStopCodeIEN": "",
   "ClinicSecondaryStopCodeName": "",
   "ClinicStopCodeAMIS": "",
   "ClinicStopCodeIEN": "",
   "ClinicStopCodeName": "",
   "CommentMultiple": [
    {
     "CommAddedByDUZ": 123456789,
     "CommAddedByName": "TEST,USER ONE", 
also applies to other components such as CPRSPreRequisites,
     "Comment": "This is an appt request comment 333333777",
     "DateCommAdded": "2024-10-16T09:30:00"
    },
   ],
   "ConsultAssociatedStopCodes": [
    {
     "AmisStopCode": 116,
     "RestrictionType": "E",
     "StopCode": 379,
     "StopCodeName": "RESPIRATORY THERAPY"
ConsultAssociatedStopCodes, ContactAttempts, etc.
    },
    {
     "AmisStopCode": 303,
     "RestrictionType": "E",
     "StopCode": 147,
     "StopCodeName": "CARDIOLOGY"
    },
    {
     "AmisStopCode": 107,
     "RestrictionType": "P",
  
     "StopCode": 114,
     "StopCodeName": "EKG"
    },
    {
     "AmisStopCode": 115,
     "RestrictionType": "E",
     "StopCode": 122,
     "StopCodeName": "ULTRASOUND (US)"
    }
   ],
{
   "ConsultCanEditPid": "",
   "ConsultClinicIndicatedDate": "",
   "ConsultCovidPriority": "",
   "ConsultDateReleasedFromCPRS": "",
   "ConsultProhibitedClinicFlag": "",
   "ConsultRequestType": "",
   "ConsultServiceRenderedAs": "",
   "ConsultToService": "",
   "ConsultUrgencyOrEarliestDate": "",
   "Contact": {
 "Request": [
    "Clinic": 5260,
    "ClinicStopCodeAMIS": 323,
    "ID": 2529,
    "MainSequence": 1,
    "Patient": 7201233,
    "PreferredDate": "2024-02-24",
    "RequestPointer": "12345;SDEC(409.85,",
    "RequestType": "A",
    "Service": ""
   },
  {
   "ContactAttempts": [
    {
     "Comments": "ONE CONTACT ATTEMPT FOR VSE 7306",
     "DateTimeEntered": "2024-02-23T11:43:23-0500",
     "DateTimeOfContact": "2024-02-23T11:42:58-0500",
     "EnteredByIEN": 12345,
     "EnteredByName": "USER, VSETEST",
     "EnteredBySecID": 456789,
     "LeftMessage": "NO",
     "Sequence": 1,