SDES2 SEARCH CLIN BY STOP CODE

TITLEVALUE
NAMESDES2 SEARCH CLIN BY STOP CODE
DESCRIPTIONReturns detailed clinic information based on a search on Medical Center
Division (Station Number) and/or Stop Code and/or Stop Code range.
TAGSEARCHCLIN
ROUTINESDES2SRCHCLNBYSC
INPUT PARAMETERSSEQUENCE NUMBER1
INPUT PARAMETERSDCONTEXT
DESCRIPTION SDCONTEXT("ACHERON AUDIT ID") = Up to 40 Character unique ID number.
Ex: 11d9dcc6-c6a2-4785-8031-8261576fca37
SDCONTEXT("USER DUZ") = The DUZ of the user taking action on the
calling application.
SDCONTEXT("USER SECID") = The SECID of the user taking action in the
calling application.
SDCONTEXT("PATIENT DFN")= The name of the patient taking action on the
calling application.
SDCONTEXT("PATIENT ICN")= The ICN of the patient taking action on the
calling application.
PARAMETER TYPELIST
REQUIREDYES
MAXIMUM DATA LENGTH
INPUT PARAMETERSSEQUENCE NUMBER2
INPUT PARAMETERSDSEARCH
DESCRIPTIONThe SDSEARCH array contains the following array elements:

SDSEARCH("STATION") (Opt) = Station Number: If present, the search
would be limited to matching clinics at the given institution.
- If absent, the search would take place across all
divisions/institutions. Example values: 534, 534GB.
- If "STARTING STOP CODE" is not populated, "STATION" will be
REQUIRED.

SDSEARCH("STARTING STOP CODE") (Opt) = The beginning range of Stop
Codes to be included in the search.
- If "ENDING STOP CODE" is not populated, this will be the only Stop
Code not populated, this will be the only Stop Code to be included
in the search.
- If "STATION" is not populated, "STARTING STOP
"CODE" is REQUIRED.

SDSEARCH("ENDING STOP CODE") (Opt) = Boolean to return Active or
Inactive clinics.
- If populated, the "STARTING STOP CODE" value is REQUIRED.

* Either "STATION" or "STARTING STOP CODE" must be populated.
PARAMETER TYPELIST
REQUIREDYES
MAXIMUM DATA LENGTH
RETURN VALUE TYPEGLOBAL ARRAY
RETURN PARAMETER DESCRIPTION {
"ClinicAudit": [
{
"ApptCancelLetter": "TEST APPT CANCEL LETTER",
"ApptLength": 30,
"ClinicCancelLetter": "TEST CLINIC CANCEL LETTER",
"ClinicIEN": 5392,
"ClinicName": "TEST CLINIC 1",
"ClinicStatus": "Active",
"CreditStopCodeAMIS": 179,
"CreditStopCodeIEN": 391,
"CreditStopCodeName": "RT CLIN VID CARE HOME",
"DefaultProviderActive": 1,
"DefaultProviderIEN": 520849258,
"DefaultProviderName": "VSETEST,PROVIDERONE",
"DefaultProviderSecID": 1233213858,
"DirectScheduling": "YES",
"DisplayApptToVets": "YES",
"DivisionName": "TEST MEDICAL CENTER",
"ECheckIn": "NO",
"MaxDaysForFuture": 15,
"NoShowLetter": "TEST NO SHOW LETTER",
"NonCountClinic": "NO",
"OverbooksPerDay": 3,
"PatientFriendlyName": "Testing",
"PhysicalLocation": "Over There",
"PreApptLetter": "TEST PRE-APPT LETTER",
"PreCheckIn": "YES",
"Providers": [
{
"Active": 1,
"ID": 520637558,
"Name": "PROVIDER,TEST",
"SecID": 1023705699
},
{
"Active": 0,
"ID": 520641089,
"Name": "PROVIDER,TEST 2",
"SecID": ""
},
{
"Active": 1,
"ID": 520680480,
"Name": "PROVIDER,TEST THREE",
"SecID": ""
}
],
"SpecialInstructions": [
{
"InstructionText": "This is the first instruction"
},
{
"InstructionText": "This is the second instruction"
},
{
"InstructionText": "This is your final instruction"
}
],
"StopCodeAMIS": 529,
"StopCodeIEN": 329,
"StopCodeName": "HCHV/HCMI INDIV",
"Telephone": "555-555-1212",
"TelephoneExt": "ext 17"
},
{
...
}
]
}
AVAILABILITY
INACTIVEACTIVE
CLIENT MANAGERYES
WORD WRAP ON
VERSION
SUPPRESS RDV USER SETUP
APP PROXY ALLOWEDYes