TITLE | VALUE | |
---|---|---|
NAME | SDES SEARCH CLINIC ATTRIBUTES | |
DESCRIPTION | Given a whole or partial Clinic Name, Station Number (Opt) and Date (Opt) return the matching clinics and their key attributes. Can only be invoked by Acheron | |
TAG | SEARCHCLIN | |
ROUTINE | SDESCLNSEARCH | |
INPUT PARAMETERS | SEQUENCE NUMBER | 1 |
INPUT PARAMETER | SEARCHSTRING | |
DESCRIPTION | Full or partial clinic name to search for. Min Length = 2 chars Max Length = 30 chars | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | 30 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 2 |
INPUT PARAMETER | STATION | |
DESCRIPTION | The Station Number to screen against. This is optional. 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. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 7 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 3 |
INPUT PARAMETER | DATE | |
DESCRIPTION | An ISO 8601 formatted date to use when determining the Status of the clinic. If not passed in the date will default to the current date. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 21 | |
RETURN VALUE TYPE | ARRAY | |
RETURN PARAMETER DESCRIPTION | A listing of matching clinics and their key attributes. { "Clinic": [ { "Abbreviation": "TEST1", "ClinicIEN": 5392, "ClinicName": "TEST CLINIC 1", "ClinicStatus": "Active", "CreditStopCodeAMIS": 179, "CreditStopCodeIEN": 391, "CreditStopCodeName": "RT CLIN VID CARE HOME", "DefaultProviderIEN": 1234567, "DefaultProviderName": "VSETEST,PROVIDERONE", "DefaultProviderSecID": 1233213858, "NonCountClinic": "NO", "PatientFriendlyName": "", "Providers": [ { "ID": 01234567, "Name": "TEST,PROVIDER1", "SecID": 1023705699 }, { "ID": 85555222, "Name": "TEST,PROVIDER2", "SecID": "" } ], "StopCodeAMIS": 529, "StopCodeIEN": 329, "StopCodeName": "HCHV/HCMI INDIV", "Subspecialty": [ { "ID": 1, "Name": "SUBSPECIALTY TEST 1", "Tier": "SECONDARY", "Parent": "" }, { "ID": 2, "Name": "SUBSPECIALTY TEST 2", "Tier": "TERTIARY", "Parent": 1 } ], } ] } | |
AVAILABILITY | RESTRICTED | |
INACTIVE | ||
CLIENT MANAGER | ||
WORD WRAP ON | ||
VERSION | ||
SUPPRESS RDV USER SETUP | ||
APP PROXY ALLOWED | Yes |