| YTAPI LISTALL |
LISTALL |
YTAPI |
AGREEMENT |
This API returns all psychological test administrations for a specified to end search [optional] CODE: YS("CODE")="GAF" set to optionally return GAF administrations Output: YSDATA(1)=[DATA] YSDATA(x)= internal administration date^external administration date^test code Data is sorted in order of most recent administration to the oldest patient during a specified time period. No scoring is returned. ASI s and administration. If no administrations are found YSDATA(2) will not be returned. optionally GAF s are also returned. Input: DFN : patient internal identifier BEGIN: inclusive date in %DT acceptable format (11/11/2011) to begin search [optional] END: inclusive date in %DT acceptable format (11/11/2011) |
| YTAPI LISTONE |
LISTONE |
YTAPI |
AGREEMENT |
This API returns all psychological test administrations for a specified CODE: Test code from file 601 including "ASI" and "GAF" e.g. "CAGE", "BDI" BEGIN: inclusive date in %DT acceptable format (11/11/2011) to begin search [optional] END: inclusive date in %DT acceptable format (11/11/2011) to end search [optional] LIMIT: constrains to the last N administrations [optional] Scale: scale number from file 601 or 1-7 on ASI [optional] Output: YSDATA(1)=[DATA] patient during a specified time period for a specified test or YSDATA(x)= internal administration date ^ external administration date^test code [^scale name^raw score^transformed score] Data is sorted in order of most recent administration to the oldest administration. If no administrations are found Array(2) will not be returned. If patient has no psych testing at all ,an error will be returned. instrument. If a scale is also specified, scoring for that scale is returned. User must have adequate privileges to receive this information (i.e. often the YSP KEY). Input: DFN : patient internal identifier |
| YTAPI SCOREIT |
SCOREIT |
YTAPI2 |
AGREEMENT |
This API returns all scoring information for a specified patient given a Output: Array(2)= Patient Name^Test Code^Test Title^Internal Admin date^External Admin Date ^Ordered by Array(3)=R1^Responses 1-200 undelimited Array(4)=R2^ Responses 201-400 undelimited (even if less than 200) Array(5)=R3^ Responses 401-600 undelimited Array(6)=S1^Scale Name^Raw Score^Transformed Score Array(7)=S2^ Scale Name^Raw Score^Transformed Score And onward as needed specified administration date for a specified test or instrument. User must have adequate privileges to receive this information (i.e. often the YSP KEY) Input: DFN : patient internal identifier CODE: Test code from file 601 or "ASI" e.g. "CAGE", "BDI" ADATE: inclusive administration date in %DT acceptable format (11/11/2011) |
| YTAPI SAVEIT |
SAVEIT |
YTAPI1 |
AGREEMENT |
This API allows saving of patient responses to a test or interview in the ADATE: inclusive administration date in %DT acceptable format (11/11/2011) Staff: DUZ of professional ordering the test R1: string of patient responses 1-200 R2: string of patient responses 201-400 [as needed] R3: string of patient responses 401-600 [as needed] Output: Array(1)=[DATA] indicates successful call M database. The patient ien, the test code, and administration date is required along with the responses. All responses are checked for validity. No scoring is returned but successful addition to the M database is indicated. Input: DFN : patient internal identifier CODE: Test code from file 601 or "ASI" e.g. "CAGE", "BDI" |
| YTAPI SHOWIT |
SHOWIT |
YTAPI3 |
AGREEMENT |
This API returns the text, bottom, introduction and possible correct Output: Array(1)=[DATA] ;indicates successful call Array(2)=MMPI2^1 ;SECOND LINE IS TEST Code^ item number Array(item number,"I",line number)=introductory text Array(item number,"T", line number)=text of question Array(item number,"R",0)=allowed responses Array(item number,"R",line number)= response cues responses for a specified test item in file 601. It will work only for tests as opposed to interviews or batteries. The ASI is not supported. Input: CODE: Test code from file 601 e.g. "CAGE", "BDI" ITEM: a positive whole number between 1 and the highest item number for the specified test. |
| YTAPI SHOWALL |
SHOWALL |
YTAPI3 |
AGREEMENT |
This API returns the text, bottom, introduction and possible correct Array(2)=MMPI2 ;SECOND LINE IS TEST Code Array(item number,"I",line number)=introductory text Array(item number,"T", line number)=text of question Array(item number,"R",0)=allowed responses Array(item number,"R",line number)= response cues responses for all items in a test in file 601. It will work only for tests as opposed to interviews or batteries. The ASI is not supported. Input: CODE: Test code from file 601 e.g. "CAGE", "BDI" Output: Array(1)=[DATA] ;indicates successful call |
| YS GAF API |
GAFHX |
YSGAFAPI |
AGREEMENT |
|
| YTAPI PREVIEW |
PREVIEW |
YTAPI4 |
AGREEMENT |
This API allows scoring of patient responses to a test or interview ADATE: inclusive administration date in %DT acceptable format (11/11/2011) Staff: DUZ of professional ordering the test R1: string of patient responses 1-200 R2: string of patient responses 201-400 [as needed] R3: string of patient responses 401-600 [as needed] Output: Array(2)= Patient Name^Test Code^Test Title^Internal Admin date^External Admin Date ^Ordered by Array(3)=R1^Responses 1-200 undelimited without making changes in the M database. The patient ien, the test Array(4)=R2^ Responses 201-400 undelimited (even if less than 200) Array(5)=R3^ Responses 401-600 undelimited Array(6)=S1^Scale Name^Raw Score^Transformed Score Array(7)=S2^ Scale Name^Raw Score^Transformed Score And onward as needed code, and administration date is required along with the responses. All responses are checked for validity. Scoring is returned in the output documented in the SCOREIT API. Input: DFN : patient internal identifier CODE: Test code from file 601 or "ASI" e.g. "CAGE", "BDI" |
| YTAPI OUTNOTE |
OUTNOTE |
YTAPI5 |
AGREEMENT |
This API returns text to be entered in a progress note based on the Array(5)=R3^ Responses 401-600 undelimited Array(6)=S1^Scale Name^Raw Score^Transformed Score Array(7)=S2^ Scale Name^Raw Score^Transformed Score And onward as needed Output: Array(2)= Patient Name^Test Code^Test Title^Internal Admin date^External Admin Date ^Ordered by Array(3)=R1^Responses 1-200 undelimited outcome of a test administration. Input is the output of SCOREIT or Array(4)=R2^ Responses 201-400 undelimited (even if less than 200) Array(5)=R3^ Responses 401-600 undelimited Array(6)=S1^Scale Name^Raw Score^Transformed Score Array(7)=S2^ Scale Name^Raw Score^Transformed Score And onward as needed Array("ON")= output text PREVIEW API. Output adds this text to the output YSDATA Input: Array(2)= Patient Name^Test Code^Test Title^Internal Admin date^External Admin Date ^Ordered by Array(3)=R1^Responses 1-200 undelimited Array(4)=R2^ Responses 201-400 undelimited (even if less than 200) |
| YTAPI NEW ASI |
ADDER |
YTAPI8 |
SUBSCRIPTION |
This remote procedure allows new entries to be added to the ADDICTION SEVERITY INDEX file (#604). Input required: none Output: YSDATA(1)=[DATA] YSDATA(2)= IEN created in file 604 |
| YTRP INSTRUMENT REPORT |
INTRMNT |
YTRPWRP |
PUBLIC |
This remote procedure allows staff to print out psychological tests and interview reports. |
| YTAPI QUEST |
QUEST |
YTAPI6 |
RESTRICTED |
Returns flat array with data about a psychological test. Array(1)=[DATA] ;indicates successful call Array(2)=MMPI2 ;SECOND LINE IS TEST Code Array(x)=first item number^I^introductory text Array(x)=first item number^T^text of question Array(x)=first item number^A^allowed responses Array(x)= first item number^R^response cues . . Array(x)=last item number^I^introductory text Array(x)=last item number^T^text of question This API returns the text, bottom, introduction and possible correct Array(x)=last item number^A^allowed responses Array(x)=last item number^R^response cues responses for all items in a test in file 601. It will work only for tests as opposed to interviews or batteries. The ASI is not supported. Input: CODE: Test code from file 601 e.g. "CAGE", "BDI" Output: |
| YTAPI PRIVLEGE |
PRIVL |
YTAPI5 |
SUBSCRIPTION |
Returns user privlege to see psych test results. YSDATA(2)=1^interview or YSDATA(2)=1^exempt test or YSDATA(2)=0^no access Input: YSCODE ;code of test or interview to check privelges for Output: YSDATA(1)=[DATA] YSDATA(2)=1^user privileged for all tests or YSDATA(2)=1^exempt test" or |
| YTAPI SAVE INCOMPLETES |
SAVEINC |
YTAPI7 |
SUBSCRIPTION |
API to save responses of partially completed psychological tests. R3: array of answers 401-600 Output: YSDATA(1)=[DATA] YSDATA(2)=saved ok Input: DFN ;ien of file 2 Patient YSCODE: code of test in file 604 YSNEXT: next item number to be answered YSORDER: DUZ of staff ordering test R1: array of answers 1-200 R2: array of answers 201-400 |
| YTAPI GET INCOMPLETE |
GETINC |
YTAPI7 |
SUBSCRIPTION |
API to retrive partially completed psychological tests. YSDATA(3)=responses 1-200 YSDATA(4)=responses 201-400 YSDATA(5)=responses 401-600 Input Required: DFN ;ien of file 2 Patient YSCODE ; code for entry in file 601 Psycholgical Testing Output: YSDATA(1)=[DATA] YSDATA(2)=INSTRUMENT^DATE ENTERED^DATE ADMINISTERED CLERICALLY^NEXT ITEM^VALID RESPONSE STRING^CLERK TEST^ORDERED BY^DATE BEGUN |
| YTAPI LIST INCOMPLETES |
LISTINC |
YTAPI7 |
SUBSCRIPTION |
API to returm a list of incomplete psychological tests. Input Required: DFN ; ien of file 2 Patient Output: YSDATA(1)=[DATA] YSDATA(X)=CODE^DATE OF ADMIN^(not) restartable |
| YTAPI NEW GAF |
ENT |
YSGAFAP1 |
SUBSCRIPTION |
Allows entry of a new GAF rating. Input Required: DFN - Patient IEN GAF - GAF Score (Axis 5) DATE - Date/Time of Diagnosis STAFF - Diagnosis By DUZ Output: only reports success vs. error YSDATA(1)=[DATA] VS. YSDATA(1)=[ERROR] |
| YTAPI ASI LISTER |
LISTASI |
YTAPI8 |
SUBSCRIPTION |
This API lists all ASI administrations for a specified patient. 0 RETURNED IF NO ADMINS Input required: DFN (ien of file 2) Output is in the following format: YSDATA(1)=[DATA] YSDATA(2)= IEN^DATE OF INTERVIEW^CLASS^SPECIAL^ESIGNED . . YSDATA(X)= IEN^DATE OF INTERVIEW^CLASS^SPECIAL^ESIGNED |
| YTAPI GET ASI RESPONSES |
GETASI |
YTAPI8 |
SUBSCRIPTION |
This API returns the ASI responses for a specified ASI administration. Input required: DFN ; ien of file 2 Patient IEN ; ien of file 604 Addiction Severity Index Output: YSDATA(1)=[DATA] YSDATA(x)= Field #^Question name^is it Required^Answer |
| YSRP ASI NARRATIVE |
ASINAR |
YSASRPWP |
PUBLIC |
This procedure prints the selected ASI in narrative form. |
| YSRP ASI ITEM |
ASIITM |
YSASRPWP |
|
This procedure prints the selected Addiction Severity Index in a captioned format. |
| YTAPI ASI SIGNER |
SIGN |
YTAPI8 |
SUBSCRIPTION |
Allows interviewer to sign ASI, transcriber to "sign off" and send a YSDATA(2)=1^ASI SIGNED bulletin. Input Required: CODE: electronic signature code IEN: ien of ASI in file 604 Output: reports on status of the operation only YSDATA(1)=[DATA] |
| YTAPI TEST BULLETIN |
SNDBUL |
YTAPI9 |
SUBSCRIPTION |
When a clerk gives a psychological test by order of a clinician, a VISTA YSDATA(1)=[DATA] email bulletin is sent to that clinician, informing him/her of the administration of the test, the date, the clerk and the patient. Input: DFN ;ien of file 2 Patient YSORD ;DUZ of ordering clinician Output: only success vs. error is reported. |
| YTAPI CLERK RESPONSES |
CLERK |
YTAPI9 |
SUBSCRIPTION |
This API returns the possible answer alternatives for each question in a test or interview from file 601, Psychological Testing Input Required: Code , the test/interview code ie MMPI2 Output: YSDATA(1)=[DATA] YSDATA(x)=Question number^A^string with approriate answers (ie TFX) |
| YTAPI ASI SAVE DATA |
SAVASI |
YTAPI9 |
SUBSCRIPTION |
This API saves data to the file 604, Addiction Severity Index. YSDATA(1)=[DATA] YSDATA(2)=OK ASI SAVE YSIEN Required input: YSIEN ,ien of the file 604 entry YS(1)=file 604 field number^value to save . . YS(x)=file 604 field number^value to save Output: only to indicate success vs error |
| YTAPI ASI PNOTE |
ASIPN |
YTAPI9 |
SUBSCRIPTION |
This API creates a Pnote in TIU based on the ASI report. Input required: IEN of file 604, Addiction Severity Index. Output is only to show success or failure of the operation. YSDATA(1)=[DATA]/[ERROR] YSDATA(2)=OK Progress Note created/No Pnote entered |
| YTAPI TEST BATTERY |
BATT |
YTAPI9 |
SUBSCRIPTION |
Returns a list of all available test batteries and the tests within them. Input: none Output: YSDATA(1)=[DATA] YSADAT(x)=battery name^test1^test2^test3^test4 |
| YTAPI SAVE TEST COMMENT |
ADDCOMM |
YTRPEXT |
|
This API is used to add comments to completed tests and interviews. |
| YTAPI ASI FACTORS |
EN |
YSASFS |
SUBSCRIPTION |
Input IEN of file 604, Addiction Severity Index Returns the 5 factor scores for an ASI in the following format: YSDATA(1)=[DATA] YSDATA(2)=ALCOHOL^FACTOR SCORE^T SCORE . . YSDATA(6)=LEGAL^FACTOR SCORE^T SCORE |
| YTQ TSLIST |
TSLIST |
YTQAPI |
SUBSCRIPTION |
Returns a list of tests and surveys from 601.71. |
| YTQ TSLIST1 |
TSLIST1 |
YTQAPI |
SUBSCRIPTION |
Returns a delimited list, one field per line of all fields in 601.71 for a specified entry. FIELD LABEL ^ FIELD VALUE |
| YTQ QUESTALL |
QUESTALL |
YTQAPI3 |
SUBSCRIPTION |
Retuns Item text, Intro, Choicetypes and Display information for all YSDATA(4)=QUESTION TEXT1=fIRST line of text YSDATA(5)=additional text lines as needed YSDATA(6)=INTRO TEXT1=IEN FOR MH INTRO^First intro line YSDATA(7)=additional intro lines as needed YSDATA(8)=DESC1=Respone Type^CHOICETYPE^MIN^MAX^IS REQUIRED ^HINT^CHOICEIDENTIFIER YSDATA(9)=QDISPLAY1=DisplayId^FontName^FontBold^FontItalic ^FontUnderlined ^ Fontsize^FontColor ^Alignment ^left^Mask^Colums^Component (for question text) YSDATA(10)=IDISPLAY1=DisplayId^FontName^FontBold^FontItalic Questions in a Specified Instrument. ^FontUnderlined ^Fontsize^FontColor^Alignment ^left^Mask^Colums^Component (for intro text) YSDATA(11)=CDISPLAY1=DisplayId^FontName^FontBold^FontItalic ^FontUnderlined ^Fontsize^FontColor^Alignment ^left^Mask^Colums^Component (for choice) : Repeat for each item in test Input: YS("CODE"):As test name Output: YSDATA(1)=[DATA] or [ERROR] YSDATA(2)="NUMBER OF QUESTIONS="_N3 YSDATA(3)=QUESTION NUMBER1=ien for MH Question^QUESTION SEQUENCE^DESIGNATOR |
| YTQ CHOICES |
CHOICES |
YTQAPI |
SUBSCRIPTION |
Returns Choice all for an instrument. ;input: CODE as test name ;output: 601.75(1) CHOICETYPE ID^SEQUENCE^CHOICE IFN^CHOICE TEXT |
| YTQ BATTC |
BATTC |
YTQAPI3 |
SUBSCRIPTION |
Return: Battery Name^ Instrument ordered Battery Name and then by sequence. |
| YTQ SKIP |
SKIPPED |
YTQAPI |
SUBSCRIPTION |
INPUT: CODE as MH TEST SURVEY name OUTPUT: QuestionID^SkippedQuestionID ordered by QuestionID,SkippedQuestionID |
| YTQ SECTION |
SECTION |
YTQAPI |
SUBSCRIPTION |
INPUT: CODE as instrument NAME OUTPUT: FirstQuestionId^TabCaption^SectionCaption |
| YTQ SAVE |
EDAD |
YTQAPI1 |
SUBSCRIPTION |
Generic proceedure to add or edit a MH file entry validation (use only if approved by developer) : : YS(x)=YS(1)=FIELD #^Value^[3rd piece] Output: YSDATA(1)=[DATA] or [ERROR] Input: YS("FILEN")=File Number (i.e. the file# for administrations would be 601.84) YS("IEN")= : the internal number of the record you want to edit. Leave blank if creating a new record. If creating a new record you must send .01^NEW for those MH files using the New input transform. YS(1)=FIELD #^Value^[3rd piece is 1 if you need to bypass |
| YTQ RULES |
RULES |
YTQAPI1 |
SUBSCRIPTION |
Returns all the Rules for a specified Instrument YSDATA(X+2):MessageText^IsConsistencyCheck Input: YS("CODE")= test name Output: YSDATA(1)=[DATA] YSDATA(x): RULE ID= IndexQuestion^IndexValue^ IndexValueDataType ^IndexOperator^BoolOperator^TargetQuestion YSDATA(x+1):TargetValue^TargetValueDataType^ TargeOperator |
| YTQ GETANS |
GETANS |
YTQAPI1 |
SUBSCRIPTION |
Returns answers to an MH TESTS AND SURVEYS Input: AD= Administration number QN=Question Number |
| YTQ CAPIE |
CAPIE |
YTQAPI1 |
SUBSCRIPTION |
Returns array of data from specified file and IENS INPUT: FILEN as number FIELDS "**" or a field Number IENS as internal record number (no comma) OUTPUT: Field #(;subfield)^ Field label ^ internal data ^ [external data] if different |
| YTQ WP FILER |
WPED |
YTQAPI1 |
SUBSCRIPTION |
Files single Word Processing Field. YS(X)=TEXT line X Output: [DATA] if no errors VS [ERROR] It REPLACES previous text if any with current text. Input: FILEN= fileman file Number IEN= internal record number (cannot create a new record) FIELD= field to be modified (must be a WP field) YS(1)= TEXT line 1 ... |
| YTQ GENERIC LISTER |
LISTER |
YTQAPI2 |
SUBSCRIPTION |
Returns a lists of all entries in a file for a specified field. FROM: last ien already retrieved default= start INDEX: index to sort on default= regular cross-ref on IEN Output: [DATA] # of entries returned^#requested (often 500)^any more (0 or 1) IEN^Data requested . . IEN^Data requested Input: FIELN: file or subfile Number FIELD: filed number optionals FLAG: 'I' returns internal format, 'B' backwards sort defaul= external, forward NUMBER: number of entries requested default=500 |
| YTQ ALL ANSWERS |
ALLANS |
YTQAPI2 |
SUBSCRIPTION |
Returns all the answers given to a particular MH administration . . QUESTION #^seq^ANSWER input: AD = ADMINISTRATION # output: [DATA] ADMINISTRATION ID^DFN^INSTRUMENT^DATE GIVEN^IS COMPLETE QUESTION #^seq^ANSWER . |
| YTQ SET ANSWER |
SETANS |
YTQAPI2 |
SUBSCRIPTION |
Save an answer to a specified MH Question of a specified MH YS(N) as Answer N Administration. Input: AD as MH adminisration ID QN as MH Question ID YS(1) as Answer 1 . . . |
| YTQ GET ADMINISTRATIONS |
ADMINS |
YTQAPI2 |
SUBSCRIPTION |
Returns all MH Administrations for a specified patient. input : DFN output:AdministrationID=InstrumentName^DateGiven^DateSaved^OrderedBy^Admin isteredBy^Signed^IsComplete^NumberOfQuestionsAnswered |
| YTQ ALL CHOICES |
CCALL |
YTQAPI2 |
SUBSCRIPTION |
No input needed returns all choice id^sequnce^chice ifn^choice text. |
| YTQ GET SCALES |
SCALEG |
YTQAPI3 |
SUBSCRIPTION |
Returns a list of scale for a given test in order of their scale groups. Output is sorted by Scale Group Sequence and Scale Sequence Input: CODE: alphabetic 601.71 entry Output: [DATA] vs [Error] GroupX= SCALEGROUP ID^INSTRUMENT NAME^SCALEGROUP NAME^ GROUP SEQUENCE^ORDINATE TITLE^MIN^INCREMENT^MAX^GRID1^GRID2^GRID3 Scalex= SCALE ID^SCALEGROUP ID^SCALE SEQUENCE^SCALE NAME^XLABEL |
| YTQ FIRST WP |
FIRSTWP |
YTQAPI3 |
SUBSCRIPTION |
Returns the first line only of a WP field ;Input: FILEN(file number), FIELD (WP filed #) ;Ouput IEN^WP Text line 1 |
| YTQ PURGE |
PURGE |
YTQAPI3 |
SUBSCRIPTION |
Deletes a specific record from a specific file. Works only at top level Output: conformation only and does not check pointers or del node. Take care using this API Input: FILEN (file #) IEN (internal record #) |
| YTQ CHOICE ADD |
ADDCH |
YTQAPI4 |
SUBSCRIPTION |
This API is to be used to enter a new MH CHOICE 601.75. It searches for Output: error and message or 601.75 ien added Question Force returned when Force not equal Y and non case sensitive match found. already present choices and if available returns that 601.75 ien. Also checked are non-case sensitive matches. Input: TEXT as text of the choice FORCE: set as Y to force an add when there is a non case sensitive match |
| YTQ CHOICETYPE ADD |
CTADD |
YTQAPI4 |
SUBSCRIPTION |
Use this API to enter a new choicetype (MH CHOICETYPE 601.751). A choicetype is a collection of choices (MH CHOICE 601.75) and their sequence. input: list of choice iens in numbered sequence ex YS(1)=3,YS(2)=22 output NEW choice type number |
| YTQ CHOICETYPE DELETE |
CTDEL |
YTQAPI4 |
SUBSCRIPTION |
This API will safely delete all 601.751 enteries of the choicetype presented. This API will not allow deletions of Choicetypes referrefd to in the MH Question file (601.72) Input: CHOICETYPE Output: DELETED if sucessful LIST OF question iens if in use |
| YTQ CHOICETYPE DESCRIBE |
CTDESC |
YTQAPI4 |
SUBSCRIPTION |
This API lists the properites of a specified CHOICETYPE. input; CHOICETYPE output: CHOICETYPE^choicetype ien^sequence^choice ien^choice text |
| YTQ CHOICETYPE ORPHAN DELETE |
ORPHCT |
YTQAPI4 |
SUBSCRIPTION |
This API will safely remove all CHOICETYPES (601.751) that have no question (601.72) referncing them. INPUT: none OUTPUT: list of choicetypes deleted |
| YTQ CHOICE ORPHAN DELETE |
ORPHCH |
YTQAPI4 |
SUBSCRIPTION |
This API will remove all choices (601.75) that are not part of a CHOICETYPE (601.751) It is suggested that API YTQ CHOICETYPE ORPHAN DELETE will be run before the API. INPUT none OUTPUT list of choices deleted |
| YTQ DISPLAY |
DISPLAY |
YTQAPI5 |
SUBSCRIPTION |
Returns all display data in internal format YSDATA(2)=DisplayId^FontName^FontBold^FontItalic^FontUnderlined^Fontsize^F ontColor^Alignment^left^Mask^Colums^Component : : YSDATA(x)=DisplayId^FontName^FontBold^FontItalic^FontUnderlined^Fontsize^F ontColor^Alignment^left^Mask^Colums^Component Input: list of DisplayIDs YS(1)=DisplayId1 YS(2)=DisplayId2 : : YS(x)=DisplayId(x) Output: YSDATA(1)=[DATA] |
| YTQ GAF HX |
GAFRET |
YTQAPI6 |
SUBSCRIPTION |
Returns all GAF diagnosis for a specified Patient YSDATA(X): 627.8 IEN = external date of dx^GAF^rater DUZ^Rater name^error msg Input: YS("DFN")= Pt DFN YS("END")- Date of last GAF requested [optional] YS("BEGIN") : Date of first GAF requested [optional] YS("LIMIT"): To limit output to the last x diagnosis Output: YSDATA(1): [DATA] or [ERROR] |
| YTQ ADMINS BOTH |
ADMINS |
YTQAPI5 |
SUBSCRIPTION |
output: Administration ID D^Instrument Name^Date Given^Date Saved ^Orderer^Admin.By^Signed^# Answers^R_Privl ^Is Legacy^INSTRUMENT id 601.71^Test IENS 601^Is copyright ^Location IENS This does NOT return ASI or GAF data. Returns all testing administrations for a specified patient.Returns data from 601.84, 601.2 and 601.4. This is new and legacy data. input : DFN COMPLETE: Y for all completed admins, N for all incompletes (Reqiured) |
| YTQ TEST ADD |
TESTADD |
YTQAPI4 |
SUBSCRIPTION |
Use this API to add a new instrument to the MH TESTS and SURVEYS file Input: CODE as name of test OUTPUT: new ien^added |
| YTQ CHOICEIDENT |
IDENTAE |
YTQAPI4 |
SUBSCRIPTION |
Add enter choiceIdentifiers IN |
| YTQ SCALEGROUP |
SCALEGRP |
YTQAPI8 |
SUBSCRIPTION |
Returns all information from file MH SCALEGROUPS (601.86) for a specified instrument input: CODE as instrument name output: SCALEGROUP ID^INSTRUMENT ID^SCALEGROUP NAME^GROUP SEQUENCE^ ORDINATE TITLE^ORDINATEMIN^ORDINATEINCREMENT^ORDINATEMAX^GRID1^GRID2^ GRID3 |
| YTQ SCORE ADMIN |
GETSCORE |
YTQAPI8 |
SUBSCRIPTION |
Returns scoring for all scales for a specified Administration in output: Scale name=Raw Score Scalegroup and Scale Sequence order. Input: AD as ien for MH Administrations (required for full legacy only): CODE as Instrument Name DFN as pt IEN ADATE as SAVE DATE in FM format |
| YTQ LEGACY REPORT |
LEGACY |
YTQAPI8 |
SUBSCRIPTION |
|
| YTQ DELETE SCALES AND GROUP |
DELSG |
YTQAPI8 |
SUBSCRIPTION |
****Use with Care*** Deletes a ScaleGroup and ALL its scales! Input : ID as ien of MH Scalegroups (601.86) Output: Data vs Error |
| YTQ KEYS |
KEY |
YTQAPI7 |
|
Get all keys for a specified test input: CODE as TEST name output:SCALE=ScaleName^scale Id KEY=Question ID^Target^Value^Key Ien |
| YTQ VERSRV |
VERSRV |
YTQAPI7 |
SUBSCRIPTION |
This procedure allows version checking by using the Option (19) menu text. Input: YSB as option name to be checked. Output: [DATA] vs [ERROR] 2= mha3 version 3= CR dll version 4= mh dll version |
| YTQ RULEDEL |
RULEDEL |
YTQAPI7 |
SUBSCRIPTION |
Deletes a rule and all associated skips and instrument rules Input: IEN as ien of file 601.82 Output Data vs Error |
| YTQ TEST ORDER |
SNDBUL |
YTQAPI7 |
SUBSCRIPTION |
Send message to psych test ordering clinician Input: DFN as patient ien : ORD as ordered for (in duz form) : TEST1 as name of test ordered (required;string) :TEST2-TEST10 as name of other tests ordered (optional but in order;string) Output: [DATA] VS [ERROR] |
| YTQ BATTDEL |
BATDEL |
YTQAPI7 |
SUBSCRIPTION |
Deletes a battery and all associated MH Battery COntents and MH Battery Users Input: IEN as ien of file 601.77 Output Data vs Error |
| YTQ PATIENT INFO |
PATSEL |
YTQAPI9 |
SUBSCRIPTION |
Patient demographic and eligibility information ; YSDATA(7)=date of death ; YSDATA(8)=0 NCS/ 1 SC^%^service connected Input DFN as ien of file 2 Output ; YSDATA(2)= name ; YSDATA(3)=ssn ; YSDATA(4)=dob ; YSDATA(5)=age ; YSDATA(6)=sex |
| YTQ USERQ |
USERQ |
YTQAPI9 |
SUBSCRIPTION |
Returns name of current user and optionally checks a security Key YSDATA(4)= Institution file pointer^Institution name^station number with suffix^new name of medical centers that have integrated Input DUZ as internal ien file 200 for user to check [optional default is current user] KEY as name of security key to check [optional] Output YSDATA(2)= name of user^DUZ YSDATA(3) if key sent 1^holds VS 0^lacks KEY |
| YTQ SET NATIONAL |
NATSET |
YTQAPI9 |
RESTRICTED |
Allows Psychological test editor to save test data in IENS under 100000 for national distribution. input: NATIONAL as Yes or No output: YSPROG=1 |
| YTQ WP ALL |
FULLWP |
YTQAPI11 |
|
Returns any Word processing field data for any file. Used to return intoductions as an example. Input: FILEN as the nimber of the file FIELD; as the field number Ouput: IEN of the entry^line of text |
| YTQ DELETE TEST |
DELETEME |
YTQAPI6 |
|
Deletes a test, quiz or survey. Only removes the top level entry (601.71) and entires in MH Instrument Content (601.76). Will not remove a test that HAS BEEN OPERATIONAL (ie has answers entered while OPERATIONAL is set). input: CODE as test name output: DATA vs ERROR |
| YTQ COPY TEST |
COPY |
YTQAPI10 |
|
Copies a test to a new name. Used when design for one test is based on Output: DATA vs Error another. Questions, Intros, Content, Sections, Scales, Rule and Keys are all duplicated. Input: ORIGINAL: As name of test to be copied. ie 'MH Survey' New: Name of new test ie 'MH Survey Copy' NATIIONAL : optional if test is to be distributed nationally. Available only to MH developers. |
| YTQ SCORE SAVE |
SCORSAVE |
YTQAPI11 |
SUBSCRIPTION |
Save results to MH Results (601.92). Use only for completed tests. Input: AD as administration ID Output : DATA vs ERROR |
| YTQ EXPORT |
EXPORT |
YTQAPI13 |
SUBSCRIPTION |
Exports a test to a Mailman message for sharing over the network. Input: Code as name of test to be exported Output: DATA vs ERROR |
| YTQ IMPORT |
IMPORT |
YTQAPI12 |
SUBSCRIPTION |
Used to import a test description into the VISTA database from a mailman message created by the export function. Input: Message as message number from file 3.9 Output: DATA vs ERROR |
| YTQ EXPORTED MAIL |
MLIST |
YTQAPI12 |
SUBSCRIPTION |
Returns a list of mail created by the export utility in reverse date order. Input: NONE Output: DATA vs EROR 1)Message #^Subject line^date . . x)Message #^Subject line^date |
| YTQ PATIENT LOOKUP |
FINDP |
YTQAPI11 |
SUBSCRIPTION |
Patient lookup utility. ; input: ; VALUE = value to lookup ; NUMBER= maximum number to find [optional] ; Lookup uses multiple index lookup of File #2 ; output: ; [DATA]^number of records returned ; DFN^patient name^DOB^PID (ssn)^Gender |
| YTQ ASI LISTER |
LISTASI |
YTQAPI12 |
|
API returns a list of ASI administrations for a single patient. (#.51) ELECTRONICALLY SIGNED [1S]^ (#.09) INTERVIEWER (external)^ (#.09) INTERVIEWER (internal) Input: DFN as ien of Pateint file Output: [DATA]^# of admins returned vs [ERROR] IEN= (#.05) DATE OF INTERVIEW^ (#.04) CLASS^ (#.11) SPECIAL^ |
| YTQ PN CREATE |
PCREATE |
YTQTIU |
SUBSCRIPTION |
API creates a progress note representation of the narrative report for an administration. Input AD AS ien of 601.84 mh administration HOSP: as ien of hospital location YS(1...X) as text of note Output: DATA vs ERROR |
| YTQ GET REPORT |
MHREPORT |
YTQAPI9 |
SUBSCRIPTION |
Gets a report format from MH REPORTS file (#601.93) Input: CODE as instrument name Output:[DATA]^IENS of 601.93 vs [ERROR] LINE# ^ line text |
| YTQ ASI SIGNOK |
SIGNOK |
YTQAPI14 |
SUBSCRIPTION |
This API evaluates wheher one of 3 conditions is meet for the stored ASI Missing fields are listed in YSDATA(3...x) in file Addiction Severity Index (#604). Input: IENS as iens for 604 Output: 1^OK TO SIGN 0^MISSING REQUIRED FIELDS 2^A G12 RECORD |
| YTQ HL7 |
HL7 |
YTQHL7 |
SUBSCRIPTION |
Sends HL7 Message to national database. |
| YTQ LEGCR |
LEGCR |
YTQAPI9 |
SUBSCRIPTION |
|
| YTQ ALLKEYS |
ALLKEYS |
YTQPXRM5 |
|
Returns all security keys for a specified user. input IEN as internal of file 200 [optional/DUZ] |
| YTQ SET SCRATCH |
SETSCR |
YTQPXRM8 |
SUBSCRIPTION |
api to set data to a scratch file for the MHA3 DLL. |
| YTQ GET SCRATCH |
GETSCR |
YTQPXRM8 |
|
Returns data from the scratch file for thr MHA3 Clinical reminders DLL. |
| YTQ KILL SCRATCH |
KILLSCR |
YTQPXRM8 |
SUBSCRIPTION |
Delete entires from the scratch file when a clinical reminder is saved. |
| YTQ ADMIN DELETE |
DELADMIN |
YTQAPI5 |
SUBSCRIPTION |
Users who have the MHS Manager menu can delete a specified MH Output: Data vs ERROR Administration and its MH Answers and MH Results. Please use caution as deletions cannot be restored. Only ADPACs should use this feature and in consultation with medical records policy. Input: YS("AD") as internal entry number of MH ADMINISTRATIONS (#601.84) file. |
| YTQ SET ANSWER ALL |
SAVEALL |
YTQAPI17 |
SUBSCRIPTION |
Saves all answers for an administration. Input: YS("AD") as internal entry number of MH ADMINISTRATIONS (#601.84) file. Output: Data vs ERROR |
| YTQ CONSULT CREATE |
CCREATE |
YTQCONS |
SUBSCRIPTION |
Links consult requests and MHA3 results. Input : YS("AD") as ien of MH ADMINISTRATIONS file (#601.84) YS("CON") as ien of REQUEST/CONSULTATION file (#123) YS("COSIGNER") as ien of NEW PERSON file(#200) |
| YTQ DELETE ENTRY |
DELENTRY |
YTQAPI6 |
SUBSCRIPTION |
Deletes an entry from a file. YSDATA(2)="error message" Example: > S YSDATA="TEST",YS("FILE")=627.8,YS("IEN")=100123 > D DELENTRY^YTQAPI6(.YSDATA,.YS) Input: YSDATA=Array name to return success/error response YS("FILE")=File number (e.g., 627.8) YS("IEN")=record internal entry number (e.g., 100123) Output: YSDATA(1)="[DATA]" or YSDATA(1)="[ERROR]" |
| YTQ GET RESULTS |
LDSCORES |
YTSCORE |
SUBSCRIPTION |
Returns saved results in the MH RESULTS File (#601.92) by Scale for a specific Administration. Input: AD as ien for MH ADMINISTRATIONS Output: Scale name=Scale score |
| YTQ GET SCRATCH SCORES |
GETTSC |
YTQPXRM8 |
|
Returns Scales score built from the Scratch global for CPRS (601.94) |
| YTQREST QENTRY |
QENTRY |
YTQREST0 |
RESTRICTED |
Front controller for patient entered mental health instruments. Limited REST calls, as this is intended for use with an application proxy. |
| YTQRRPC SELECT |
SELECT |
YTQRRPC |
RESTRICTED |
Calls for Instrument Selection (Delphi Version) |
| YTQREST QSTAFF |
QSTAFF |
YTQREST0 |
RESTRICTED |
Front controller for creating instrument assignments. This RPC is used by Delphi-based MHA and is a predecessor to full web-based MHA. |
| YTQ SAVE ADMIN |
SAVEADM |
YTQAPI5A |
SUBSCRIPTION |
Create a new or update existing administration. |
| YTQ ADMIN SAVE |
ADMSAVE |
YTQAPI1 |
SUBSCRIPTION |
Save or update mental health administration is (601.84). Output: YSDATA(1)=[DATA] or [ERROR] Input: YS("IEN") : internal number for record you want to update. "NEW" if creating a new record. YS(1) : FIELD#^value^{1 to bypass validation} : : YS(n) : FIELD#^value^{1 to bypass validation} |
| YTQREST QADMIN |
QADMIN |
YTQREST |
RESTRICTED |
Front controller for questionnaire administrator. |
| YTQRCRD DLL |
DLL |
YTQRCRD |
RESTRICTED |
Calls for MHA DLL used by CPRS when hosting web version of MHA. |
