Difference between revisions of "TIU Package API"

Revision as of 22:35, 17 March 2005

TIU API

The TIU package deals with medical records, i.e. progress notes, discharge summaries etc. etc.

No documentation of an API was created with the TIU package. The purpose of this page will be to document some entry points, for those needing an API. This page will be used as a workspace, as the interdependencies etc. are explored.

Entire TIU Source Code

Print a Document

<mentry>PRINT^TIUEPRNT</mentry>(RecNum)

Purpose: prompts user, "Do you want to print note?" Then asks if chart or work copy, and destination device.

    RecNum: is record number of note to print, aka DA, in the VA FileMan TIU DOCUMENT File.

Print Documents(s)

<mentry>PRINT^TIUPRPN1</mentry>(WorkType,Paging)

Purpose: Print document array

    Input:
      ^TMP("TIUPR",$J) is array of records to be printed
         Format:^TMP("TIUPR",$J,s1,TIUDATE,TIUDA)=TIUPFNBR (e.g. "Vice SF 509")
                ^TMP("TIUPR",$J,s2,TIUDATE,TIUDA)
                ^TMP("TIUPR",$J,s3,TIUDATE,TIUDA)
                   s_ format:  "SSN;DNF"   or "TIUGRP$HeaderText;DFN
                   TIUDATE is date
                   TIUDA=record number in file 8925
               e.g. SET ^TMP("TIUPR",$J,SSN_";"_DFN,DATE,IFN)="Vice SF 509"
      WorkType:   1=Chart Copy;  0=Work Copy 
      Paging:     1=Contiguous; 0=Fresh Page for each note

Called by:

 <mentry>ENTRY^TIUPRPN</mentry>(TIUFLAG,TIUSPG)-- Print SF 509 Progress Notes
 <mentry>PRINT^TIUPRPN5</mentry>(1,TIUSPG)     -- Sort PNs for printing by Location
 <mentry>PRINT^TIUPRPN7</mentry>(1,1)          -- Progress Notes Output Batch Print

Sign a Document

<mentry>EDSIG^TIURS</mentry>(TIUDA,TIUADD,TIUPASK)

Purpose: Asks user for electronic signature code. If correct, it signs note

Input:

      TIUDA -- the is the IEN, or record number, from file 8925, of the document to sign.
      TIUADD -- This appears to be an OUT parameter, and is set to 1
      TIUPASK -- I believe if value is not 0, then user is asked if they want to print note.

Silently Sign a Document

<mentry>ES^TIURS</mentry>(TIUDA,TIUES,TIUI)

Purpose: Asks user for electronic signature code. If correct, it signs note

Input:

    TIUDA -- the is the IEN, or record number, from file 8925, of the document to sign.
    TIUES -- a string like this: "1^Author Name^Signature Title"
    TIUI -- Not used, optional (??)

Example of use: (Thanks to author Kirk Fox)

    ;This will autosign a note.
    ;DUZ=THE SIGNER
    ;R=IEN OF NOTE IN FILE 8925
    S TIUES=1_U_$P($G(^VA(200,+DUZ,20)),U,2,3)
    D ES^TIURS(R,TIUES) W "ES "_R
    K TIUES
    Q

Create a New Document

<mentry>MAIN^TIUEDIT</mentry>(TIUCLASS,SUCCESS,DFN,TIUTITLE,EVNTFLAG,NOSAVE,TIUNDA,TIUSNGL,TIUCHNG)

    Create new document(s)
     May branch off to edit existing docmt instead of creating new one.
     Call with: [TIUCLASS] --> pointer to file (8925) corresponding to
                               the class (e.g., Progress Notes=3)
                               from which to select a title
        [by ref] [SUCCESS] --> Boolean flag returned as IFN when a
                               record is created, or 0 when record
                               creation fails
                     [DFN] --> IEN in patient file (#2)
                [TIUTITLE] --> Pointer or NAME or PTR^NAME of the
                               TITLE from file 8925.1 to be used as
                               the default.
                [EVNTFLAG] --> Boolean flag for visit prompt (0 to
                               prompt, 1 to force event type visit)
                  [NOSAVE] --> Boolean flag to suppress saving the data
                               (e.g., when testing new Boilerplates
                               using DDEF action TRY, etc.).
         [by ref] [TIUNDA] --> array of form: TIUNDA(IFN)="".
                               Used in SHOW NOTES ACROSS PATIENTS.
                               See TIURC, which sets TIUONCE.
                               Also used in TIUEDIM, for mult pts.
                 [TIUSNGL] --> Boolean flag to create only ONE note
                               regardless of multiple pt preference.
        [by ref] [TIUCHNG] --> If received, passes back TIUCHNG array,
                               which collects info across records about
                               actions taken. Used in feedback
                               msgs to user.
     Other variables:
     sets [TIUTYP] --> array with form similar to that of XQORNOD:
                               TIUTYP = title IFN
                               TIUTYP(1) = 1^title IFN^title name,
                               where 1 for us is just a positive #
     sets  [TIUBY] --> used in some input templates to BYpass fields.
     Called by:
       Outpt Pharmacy, Consults, ...