| RETURN PARAMETER DESCRIPTION |
This is the fully expanded return JSON. Not all components will
"ApptType": "",
"CreditStopCodeAMIS": 117,
"CreditStopCodeIEN": 123,
"CreditStopCodeName": "NURSING (2ND ONLY)",
"DateLinkedApptMade": "",
"DateTimeEntered": "",
"DisplayClinicAppt": "YES",
"DispositionIEN": "",
"DispositionReason": "",
"DispositionedBy": "",
"DispositionedDate": "",
"ByPatientOrProvider": "",
"EASTrackingNumber": "",
"EnrollmentPriorityGroup": "GROUP 3",
"EnteredByIEN": 123456,
"EnteredByName": "USER ,TEST G",
"InstitutionIEN": "",
"InstitutionName": "",
"InstitutionNumber": "",
"LinkedApptClinic": "",
"LinkedApptCreditStopCode": "",
"LinkedApptEnteredBy": "",
"CPRSOrderID": "",
"LinkedApptInstitutionName": "",
"LinkedApptInstitutionNumber": "",
"LinkedApptStationNumber": "",
"LinkedApptStatus": "",
"LinkedApptStopCode": "",
"MRTC": [
{
"ChildRequestIEN": 264525,
"ChildRequestSequenceNumber": 1,
"LinkedAppointmentIEN": 298941,
"CPRSPreRequisites": [
"PatientIndicatedDate": "2024-03-06"
},
{
"ChildRequestIEN": 264526,
"ChildRequestSequenceNumber": 2,
"LinkedAppointmentIEN": "",
"PatientIndicatedDate": "2024-03-13"
},
{
"ChildRequestIEN": 264527,
{
"ChildRequestSequenceNumber": 3,
"LinkedAppointmentIEN": "",
"PatientIndicatedDate": "2024-03-20"
}
],
"MRTCDaysBetweenAppts": "",
"MRTCHowManyNeeded": "",
"MRTCNeeded": "",
"MRTCTotal": "",
"ModalityCode": "",
"PreRequisite": "PRE-REQ 434"
"ModalityName": "",
"PIDChangeAllowed": "",
"ParentRequestIEN": "",
"PatientComment": [
{
"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",
"PatientStatus": "",
"Priority": "",
"ProviderIEN": "",
"ProviderName": "",
"ProviderSecID": "",
"PreRequisite": "PRE-REQ 534"
"RecallAccessionNumber": "",
"RecallAppointmentLength": 30,
"RecallAppointmentType": "YEARLY EXAM",
"RecallClinicSecondaryStopCodeAMIS": 117,
"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",
"RecallProviderIEN": 27,
"RecallProviderIndicatedDate": "2018-03-29",
"RecallProviderName": "TEST,PROVIDER A",
"RecallProviderNewPersonIEN":123123,
"RecallProviderSecID": "",
"RecallSecondPrint": "",
contain data. For example, if the record is not an MRTC, the
{
"RecallSimilarPatientData": "",
"RequestComments": "",
"RequestIEN": 206674,
"RequestSubType": "",
"ScheduledDateOfAppt": "",
"SdecContactDateOfLastLetterSent": "",
"SdecContactNumberOfCalls": "",
"SdecContactNumberOfContacts": 0,
"SdecContactNumberOfEmailContact": "",
"SdecContactNumberOfLetters": "",
"PreRequisite": "PRE-REQ 634"
"SdecContactNumberOfSecureMessage": "",
"SdecContactNumberOfTextContact": "",
"SensitiveRecord": 0,
"ServiceConnectedPercentage": "",
"ServiceConnectedPriority": "",
"Status": "",
"Type": ""
}
]
}
}
"MRTCHowManyNeeded": "",
"MRTCNeeded": "",
"PIDChangeAllowed": "",
"ParentRequestIEN": "",
"PatientComment": [
""
],
"PatientContact": [
""
],
],
"PatientICN": "",
"PatientIEN": 7220539,
"PatientIndicatedDate": "",
"PatientName": "TEST, PATIENT",
"PatientStatus": "",
"Priority": "",
"ProviderIEN": "",
"ProviderName": "",
"RecallAccessionNumber": "",
"RecallAppointmentLength": 30,
"CPRSStatus": "",
"RecallAppointmentType": "OTHER",
"RecallClinicSecondaryStopCodeAMIS": 179,
"RecallClinicSecondaryStopCodeIEN": 391,
"RecallClinicSecondaryStopCodeName": "RT CLIN VID CARE HOME",
"RecallClinicStopCodeAMIS": 303,
"RecallClinicStopCodeIEN": 147,
"RecallClinicStopCodeName": "CARDIOLOGY",
"RecallComment": "RECALL COMMENTS",
"RecallDateReminderSent": "",
"RecallEnteredBySecID": 1234565,
"CPRSTimeSensitive": "",
"RecallFastingNonFasting": "",
"RecallGAFScore": "New GAF Required",
"RecallProviderIEN": 230,
"RecallProviderIndicatedDate": "2024-02-19",
"RecallProviderName": "VSETEST,PROVIDERONE",
"RecallProviderNewPersonIEN": 123456,
"RecallProviderSecID": 1234567,
"RecallSecondPrint": "",
"RecallSimilarPatientData": "|",
"RequestComments": "",
"ChildRequestSequenceNumber": "",
"RequestIEN": 28050,
"RequestType": "",
"ScheduledDateOfAppt": "",
"SdecContactDateOfLastLetterSent": "",
"SdecContactNumberOfCalls": 1,
"SdecContactNumberOfContacts": 1,
"SdecContactNumberOfEmailContact": "",
"SdecContactNumberOfLetters": "",
"SdecContactNumberOfSecureMessage": "",
"SdecContactNumberOfTextContact": "",
"ClinicIEN": "" ,
"SensitiveRecord": 0,
"ServiceConnectedPercentage": "",
"ServiceConnectedPriority": "",
"Status": "",
"Type": "Recall"
},
{
"ApptType": "",
"ByPatientOrProvider": "",
"CPRSOrderID": "",
"ClinicName": "",
"CPRSPreRequisites": [
""
],
"CPRSStatus": "PENDING",
"CPRSTimeSensitive": "",
"ClinicIEN": 2147,
"ClinicName": "CHY CARDIOLOGY",
"ClinicSecondaryStopCodeAMIS": "",
"ClinicStopCodeAMIS": "",
"ClinicStopCodeIEN": "",
"ClinicSecondaryStopCodeAMIS": "",
"ClinicStopCodeName": "",
"CommentMultiple": [
""
],
"ConsultAssociatedStopCodes": [
{
"AmisStopCode": 116,
"RestrictionType": "E",
"StopCode": 379,
"StopCodeName": "RESPIRATORY THERAPY"
MRTC component will exist, but will not have any data. This
"ClinicSecondaryStopCodeIEN": "",
},
{
"AmisStopCode": 303,
"RestrictionType": "E",
"StopCode": 147,
"StopCodeName": "CARDIOLOGY"
},
{
"AmisStopCode": 107,
"RestrictionType": "P",
"ClinicSecondaryStopCodeName": "",
"StopCode": 114,
"StopCodeName": "EKG"
},
{
"AmisStopCode": 115,
"RestrictionType": "E",
"StopCode": 122,
"StopCodeName": "ULTRASOUND (US)"
}
],
"ClinicStopCodeAMIS": "",
"ConsultCanEditPid": 0,
"ConsultClinicIndicatedDate": "2024-02-14",
"ConsultCovidPriority": "",
"ConsultDateReleasedFromCPRS": "2024-02-09T15:48:12-0500",
"ConsultProhibitedClinicFlag": 0,
"ConsultRequestType": "Consult",
"ConsultServiceRenderedAs": "outpatient",
"ConsultToService": "ECHO - OUTPATIENT",
"ConsultUrgencyOrEarliestDate": "2024-02-14",
"Contact": {
"ClinicStopCodeIEN": "",
"Clinic": 2147,
"ClinicStopCodeAMIS": 303,
"ID": 2524,
"MainSequence": 1,
"Patient": 7220539,
"PreferredDate": "2024-02-14",
"RequestPointer": "1158862;GMR(123,",
"RequestType": "C",
"Service": ""
},
"ClinicStopCodeName": "",
"ContactAttempts": [
{
"Comments": "CONSULT CONTACT ATTEMPT",
"DateTimeEntered": "2024-02-14T11:51:38-0500",
"DateTimeOfContact": "2024-02-14T11:51:31-0500",
"EnteredByIEN": 523257,
"EnteredByName": "TEST,BRADLEY W",
"EnteredBySecID": 123123,
"LeftMessage": "NO",
"Sequence": 1,
"CommentMultiple": [
"Type": "CALL"
}
],
"CreateDate": "2024-02-09T15:48-0500",
"DateLinkedApptMade": "",
"DateTimeEntered": "",
"DispositionReason": "",
"DispositionedBy": "",
"DispositionedDate": "",
"EASTrackingNumber": "",
{
"EnrollmentPriorityGroup": "",
"EnteredByIEN": 123123,
"EnteredByName": "TEST,BRADLEY W",
"InstitutionIEN": "",
"InstitutionName": "",
"LinkedAppointmentType": "",
"LinkedApptClinic": "",
"LinkedApptCreditStopCode": "",
"LinkedApptEnteredBy": "",
"LinkedApptStationNumber": "",
"Comment": "This is an appt request comment 333333777"
"LinkedApptStatus": "",
"LinkedApptStopCode": "",
"LinkedInstitution": "",
"MRTC": [
""
],
"MRTCDaysBetweenAppts": "",
"MRTCHowManyNeeded": "",
"MRTCNeeded": "",
"PIDChangeAllowed": "",
}
"ParentRequestIEN": "",
"PatientComment": [
""
],
"PatientContact": [
""
],
"PatientICN": "",
"PatientIEN": 7220539,
"PatientName": "TEST, PATIENT",
],
"PatientStatus": "",
"Priority": "",
"ProviderIEN": 1231237,
"ProviderName": "TEST,BRADLEY W",
"ProviderSecID": 123123,
"RecallAccessionNumber": "",
"RecallAppointmentLength": "",
"RecallAppointmentType": "",
"RecallClinicSecondaryStopCodeAMIS": "",
"RecallClinicSecondaryStopCodeIEN": "",
also applies to other components such as CPRSPreRequisites,
"ConsultAssociatedStopCodes": [
"RecallClinicSecondaryStopCodeName": "",
"RecallClinicStopCodeAMIS": "",
"RecallClinicStopCodeIEN": "",
"RecallClinicStopCodeName": "",
"RecallComment": "",
"RecallDateReminderSent": "",
"RecallEnteredBySecID": "",
"RecallFastingNonFasting": "",
"RecallGAFScore": "",
"RecallPatientSensitiveRecordAccessChecks": "",
{
"RecallProviderIEN": "",
"RecallProviderIndicatedDate": "",
"RecallProviderName": "",
"RecallProviderNewPersonIEN": "",
"RecallProviderSecID": "",
"RecallSecondPrint": "",
"RecallSimilarPatientData": "",
"RequestComments": "",
"RequestIEN": 1158862,
"RequestType": "",
"AmisStopCode": 116,
"ScheduledDateOfAppt": "",
"SdecContactDateOfLastLetterSent": "",
"SdecContactNumberOfCalls": 1,
"SdecContactNumberOfContacts": 1,
"SdecContactNumberOfEmailContact": "",
"SdecContactNumberOfLetters": "",
"SdecContactNumberOfSecureMessage": "",
"SdecContactNumberOfTextContact": "",
"SensitiveRecord": 0,
"ServiceConnectedPercentage": "",
"RestrictionType": "E",
"ServiceConnectedPriority": "",
"Status": "",
"Type": "Consult"
}
]
}
"StopCode": 379,
"StopCodeName": "RESPIRATORY THERAPY"
},
{
"AmisStopCode": 303,
"RestrictionType": "E",
ConsultAssociatedStopCodes, ContactAttempts, etc.
"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": {
"Clinic": 5260,
"ClinicStopCodeAMIS": 323,
"ID": 2529,
"MainSequence": 1,
"Request": [
"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,
"Type": "TEXT"
}
],
"CreateDate": "",
|
