Print Page as PDF
TIUSCFI API CALLS ICR (5495)

TIUSCFI API CALLS    ICR (5495)

Name Value
NUMBER 5495
IA # 5495
DATE CREATED 2009/08/06
CUSTODIAL PACKAGE TEXT INTEGRATION UTILITIES
USAGE Private
TYPE Routine
ROUTINE TIUSCFI
NAME TIUSCFI API CALLS
GENERAL DESCRIPTION
This ICR documents the API calls in the routine
TIUSCFI.
STATUS Pending
DURATION Till Otherwise Agreed
ID TIUSCFI
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
SET(SRDA,TIUDA)
This API will create the link between a TIU document
and a surgical case.

SET^TIUSCFI(<surgical case#^patient DFN>,<document IEN>)
Example: D SET^TIUSCFI("10108^33654",4479)
VARIABLES TYPE VARIABLES DESCRIPTION
SRDA (required) Input
Input value of the surgery case number and patient
DFN delimited by "^".
TIUDA (required) Input
Input value of the TIU document internal entry
number.
LIST(TIUY,TIUDFN,TIUDATE)
This API returns a list of all the TIU documents for
a patient within 30 days of a given date. The documents must fall within 30
days of the given date and have a local title mapped to the desired standard
titles. The current standard titles that will be included are CONSENT,
PROCEDURE CONSENT and RESEARCH CONSENT.

Example: D LIST^TIUSCFI(.RETURN,100832,3090709)

Also returns the STANDARD TITLE as:
<return value>("STDTITL",TIUDA,SEQ)=STANDARD TITLE NAME
Example: ^TMP("TIULIST",5455333,4479,1)="CONSENT"
VARIABLES TYPE VARIABLES DESCRIPTION
TIUY (optional) Output
Return array. This may be a global or local value. If
TIUY is not provided, the default value is ^TMP("TIULIST",$J).

Node            Piece
-----------     ----------------------
@TIUY@(NUM)     1. IEN of TIU Document
2. Document Title (local)
3. Entry Date
4. Patient Data (Name and L1234)
5. Author Data (IEN, Name,
Signature Name)
6. Location
7. Document Status
8. Admission Date
9. Discharge Date
10. Requesting Package Reference
11. # of Images Attached @TIUY@("INDX",<Document IEN>,NUM)=""
@TIUY@("STDTITL",<Document IEN>,NUM)=Standard Title Name
TIUDFN (required) Input
Internal entry number of the patient.
TIUDATE (optional) Input
Date in FM format. If TIUDATE is not provided, the
default value of NOW will be used.
GETDOCS(TIUY,SRDA,SEQ)
This API returns a list of all the TIU documents
associated with a given surgical case. Documents with a STATUS of RETRACTED
are not included.

Example: D GETDOCS^TIUSCFI(.RETURN,"10108;SRF(")

Also returns the STANDARD TITLE as:
<return value>("STDTITL",TIUDA,SEQ)=STANDARD TITLE NAME
Example: ^TMP("TIULIST",5455333,4479,1)="CONSENT"
VARIABLES TYPE VARIABLES DESCRIPTION
TIUY (optional) Output
Return array. This may be a global or local value. If
TIUY is not provided, the default value is ^TMP("TIULIST",$J).

Node            Piece
-----------     ----------------------
@TIUY@(NUM)     1. IEN of TIU Document
2. Document Title (local)
3. Entry Date
4. Patient Data (Name and L1234)
5. Author Data (IEN, Name,
Signature Name)
6. Location
7. Document Status
8. Admission Date
9. Discharge Date
10. Requesting Package Reference
11. # of Images Attached @TIUY@("INDX",<Document IEN>,NUM)=""
@TIUY@("STDTITL",<Document IEN>,NUM)=Standard Title Name
SRDA (required) Input
Input value of the surgery case number and global
root delimited by ";". Example:  "12567;^SRF("
SEQ (optional) Input
Input variable that determines the order of the
return data. Null or 1 (default) value returns documents newest to oldest. -1
returns documents in reverse sort order, oldest to newest.
$$SIGNDT(TIUDA)
This extrinsic function returns the SIGNATURE DATE
for a given TIU document in FM format.

Example: W $$SIGNDT^TIUSCFI(4486)
Returns: 3090626.120144
VARIABLES TYPE VARIABLES DESCRIPTION
TIUDA (required) Input
Input value of the TIU document internal entry
number.
DEL(TIUDA,SRDA)
This API will delete the link between a TIU document
and a surgical case. The optional parameter (SRDA) will also allow automatic
linking to a new surgical case if desired so that one surgical case may be
changed to another with one call.

Example: D DEL^TIUSCFI(4486)
VARIABLES TYPE VARIABLES DESCRIPTION
TIUDA (required) Input
Input value of the TIU document internal entry
number.
SRDA (optional) Input
Input value of the surgery case number and the DFN of
the Patient delimited by "^".
IMAGES(TIUY,TIUDFN,TIUSDT,TIUEDT)
This API returns a list of all the TIU documents for
a patient that have a linked IMAGE associated with them. The documents must
fall within the desired date range and have a local title mapped to the
desired standard titles. The current standard titles that will be included are
CONSENT, PROCEDURE CONSENT and RESEARCH CONSENT.

Also returns the STANDARD TITLE as:
<return value>("STDTITL",TIUDA,SEQ)=STANDARD TITLE NAME
Example: ^TMP("TIULIST",5455333,4479,1)="CONSENT"
VARIABLES TYPE VARIABLES DESCRIPTION
TIUY (optional) Output
Return array. This may be a global or local value. If
TIUY is not provided, the default value is ^TMP("TIULIST",$J).

Node            Piece
-----------     ----------------------
@TIUY@(NUM)     1  IEN of TIU Document
2  Document Title (local)
3. Entry Date
4. Patient Data (Name and L1234)
5. Author Data (IEN, Name,
Signature Name)
6. Location
7. Document Status
8. Admission Date
9. Discharge Date
10. Requesting Package Reference
11. # of Images Attached @TIUY@("INDX",<Document IEN>,NUM)=""
@TIUY@("STDTITL",<Document IEN>,NUM)=Standard Title Name
TIUDFN (required) Input
Internal entry number of the patient.
TIUSDT (required) Input
Starting date of the desired date range in FM format.

TIUEDT (required) Input
Ending date of the desired date range in FM format.
SUBSCRIBING PACKAGE SURGERY