TITLE | VALUE | |
---|---|---|
NAME | SDES GET TIU DOC BY CONTEXT | |
DESCRIPTION | This RPC returns lists of TIU Documents that satisfy various criteria (e.g. All signed, unsigned by author, uncosigned notes, signed by author, signed by date range) to the calling application. | |
TAG | TIUDOCBYCONTEXT | |
ROUTINE | SDESGETTIUDOC | |
INPUT PARAMETERS | SEQUENCE NUMBER | 1 |
INPUT PARAMETER | CLASS | |
DESCRIPTION | This is the IEN or pointer to TIU DOCUMENT DEFINITION File #8925.1 | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | ||
INPUT PARAMETERS | SEQUENCE NUMBER | 2 |
INPUT PARAMETER | CONTEXT | |
DESCRIPTION | The integer code indicating the context of the query, as: 1 = All Signed (by PT) 2 = Unsigned (by PT&(AUTHOR!TRANSRIBER) 3 = Uncosigned (by PT&EXPECTED COSIGNER) 4 = Signed notes (by PT&selected author) 5 = Signed notes (by PT&date range) | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | ||
INPUT PARAMETERS | SEQUENCE NUMBER | 3 |
INPUT PARAMETER | DFN | |
DESCRIPTION | The IEN or pointer to Patient File #2 | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | 32000 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 4 |
INPUT PARAMETER | BEGINDATE | |
DESCRIPTION | The beginning date/time in ISO 8601 Time Format to start for the search. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 25 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 5 |
INPUT PARAMETER | ENDDATE | |
DESCRIPTION | The ending date/time in ISO 8601 Time Format to start for the search. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 25 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 6 |
INPUT PARAMETER | PERSON | |
DESCRIPTION | The IEN or pointer to the New Person File #200 for searches by author (DUZ will be assumed if this parameter is not passed). | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | ||
INPUT PARAMETERS | SEQUENCE NUMBER | 7 |
INPUT PARAMETER | OCCURENCELIMIT | |
DESCRIPTION | The number of documents to return for the search. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | ||
INPUT PARAMETERS | SEQUENCE NUMBER | 8 |
INPUT PARAMETER | SEQUENCE | |
DESCRIPTION | This is the sequence in which the data will be sorted in the return array. Acceptable input: A = Ascending D = Descending | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | ||
INPUT PARAMETERS | SEQUENCE NUMBER | 9 |
INPUT PARAMETER | SHOWADD | |
DESCRIPTION | Boolean: Include addenda in the return array, when their parent documents are identified by the search. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | ||
INPUT PARAMETERS | SEQUENCE NUMBER | 10 |
INPUT PARAMETER | INCLUDEUND | |
DESCRIPTION | Boolean: Include Undictated and Untranscribed documents along with Unsigned documents, when the CONTEXT is 2. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | ||
INPUT PARAMETERS | SEQUENCE NUMBER | 11 |
INPUT PARAMETER | SHOWMORE | |
DESCRIPTION | Boolean: Return "0^SHOW MORE" in return array when additional notes available for context of 1 or 5 when occurrence limit prevents all notes from displaying. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | ||
INPUT PARAMETERS | SEQUENCE NUMBER | 12 |
INPUT PARAMETER | TIUIEN | |
DESCRIPTION | Starting TIU IEN for additional return when "SHOW MORE" was received in previous return array (LATE date/time will be set to Reference date of this TIU document). | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | ||
INPUT PARAMETERS | SEQUENCE NUMBER | 13 |
INPUT PARAMETER | EASTRCKNGNMBR | |
DESCRIPTION | Enterprise Appointment Scheduling (EAS) Tracking Number associated to an appointment. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 40 | |
RETURN VALUE TYPE | ARRAY | |
RETURN PARAMETER DESCRIPTION | Returns a JSON array. Otherwise, it will return the appropriate error. If successful: { "TIUDocument": [ { "Author": "AUTHOR,AUTHOR H", "AuthorDUZ": 01010101010, "DocumentIEN": 10819537, "DocumentPrintName": "Discharge Summary", "EpisodeBeginDateTime": "2018-01-18", "EpisodeEndDateTime": "", "HasChildren": "", "HospitalLocation": "C MEDICINE", "HospitalLocationIEN": 77, "IENOfParentDocument": 1, "ImageCount": 0, "Last4SSN": "0000", "NoteDateTime": "2018-01-29T17:56-0500", "PatientDFN": 7220027, "PatienName": "LAST,FIRST", "RequestingPackageVariablePointer": "", "SignatureBlockName": "AUTHOR H AUTHOR", "Status": "completed", "Subject": "", "TypeOfLocation": "Adm", "VisitLocationIEN": 2174, "VisitLocationName": "STPDN-M" } ] } | |
AVAILABILITY | RESTRICTED | |
INACTIVE | ||
CLIENT MANAGER | ||
WORD WRAP ON | ||
VERSION | ||
SUPPRESS RDV USER SETUP | ||
APP PROXY ALLOWED | Yes |