| ['MAKE(SUCCESS,DFN,TITLE,VDT,VLOC,VSIT,TIUX,VSTR,SUPPRESS,N', 'OASF)'] |
This entry point allows the creation of TIU DOCUMENT
records.
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
DFN |
Input |
This REQUIRED PARAMETER is the pointer to the patient
file.
|
TITLE |
Input |
This is the pointer to the TIU DOCUMENT DEFINITION
FILE which identifies the TITLE of the document to be filed.
|
VDT |
Used |
This optional parameter is the Date/time of visit.
If the parameter VSIT is present, this will be ignored. Otherwise, the RPC
will attempt to generate a match with a visit based on DFN, VDT, and VLOC
(visit location). In the event that the RPC cannot generate such a match, a
new EVENT-type Visit will be created with the current date/time.
|
VLOC |
Used |
This optional parameter is the Location of Visit
(e.g., Cardiology Clinic). It is a pointer to Hospital location (File #44).
|
VSIT |
Used |
This is a pointer to the Visit File (#9000010) entry
for the visit to which the document is to be linked.
|
TIUX |
Input |
This is the input array in which the identifiers of
the document, as well as its text, are to be stored in the following format:
TIUX(.02)=45678
TIUX(1301)=2960703.104556
TIUX(1302)=293764
TIUX("TEXT",1,0)="The patient is a 70 year old WHITE MALE, who presented
to the ONCOLOGY CLINIC"
TIUX("TEXT",2,0)="On JULY 3, 1996@10:00 AM, with the chief complaint of
NECK PAIN..."
|
VSTR |
Used |
This parameter identifies the visit location,
date/time, and Service Category (Hospitalization, Ambulatory,
Telecommunications, or Event (HISTORICAL)) in the form of a semi-colon
delimited string (e.g., "469;2970616.1415;A").
|
SUPPRESS |
Input |
BOOLEAN flag indicating whether or not to suppress
execution of the COMMIT ACTION for the document in question. This gives the
calling application control over the circumstances in which the COMMIT CODE
should be executed.
|
NOASF |
Used |
This parameter can optionally be set to 1 to indicate
the ASAVE cross-reference in the TIU Document file (#8925) should not be set
when call is made. The intent of this cross-reference is for telnet type
sessions where a user could be dropped. The cross-reference is used to
provide the user with an easy way to resume editing the TIU Document they were
working on when they were dropped. In the Clinical Procedures realm, for
example, where the stub is created in the 'background' this cross-reference
should not be set since the user is not interactively involved in the creation
of the record.
|
SUCCESS |
Both |
If the call is successful, this will be the record
number (IEN) of the resulting entry in the TIU DOCUMENT FILE (#8925). In the
event of a filing error, the first "^"-piece will be zero, and the second
"^"-piece of this scalar return variable will be a textual message describing
the nature of the error (e.g., 0^Invalid TITLE Selected.").
|
|
UPDATE(SUCCESS,TIUDA,TIUX,SUPPRESS) |
This API updates the record named in the TIUDA
parameter, with the information contained in the TIUX(Field #) array. The
body of the modified TIU document should be passed in the TIUX("TEXT",i,0)
subscript, where i is the line number (i.e., the "TEXT" node should be ready
to MERGE with a word processing field). Any filing errors which may occur
will be returned in the single valued ERR parameter (which is passed by
reference).
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
SUCCESS |
Both |
This is the return parameter, which is passed by
reference. If an error occurs, it will be a pointer to the FM dialog file
followed by the integer 1 in the second "^"-piece (e.g., 8925001^1).
|
TIUDA |
Input |
This is the record # (IEN) of the TIU Document in
file #8925.
|
TIUX |
Input |
This is the input array which contains the data to be
filed in the modified document. It should look something like this:
TIUX(.02)=45678
TIUX(1301)=2960703.104556
TIUX(1302)=293764
TIUX("TEXT",1,0)="The patient is a 70 year old WHITE MALE, who presented
to the ONCOLOGY CLINIC"
TIUX("TEXT",2,0)="On JULY 3, 1996@10:00 AM, with the chief complaint of
NECK PAIN..."
|
SUPPRESS |
Used |
This BOOLEAN Flag is passed in to suppress the call
to the COMMIT CODE for the TIU DOCUMENT in question (i.e., SUPPRESS=1 ==>
don't execute commit code; SUPPRESS=0 or UNDEFINED ==> DO execute commit
code).
|
|
DELETE(ERR,TIUDA,TIURSN,OVRRIDE) |
Deletes TIU Document records...Evaluates
authorization.
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
TIUDA |
Input |
Record number of TIU Document to be deleted.
|
TIURSN |
Used |
This optional parameter specifies the reason for
deletion (i.e., Privacy Act, or Administrative Action). It only needs to be
passed if the document has already been signed, and the user is still
authorized to delete the record.
|
ERR |
Output |
Returns error message with ERR=1^Explanation text if
the user is NOT authorized to delete the named record (e.g., it's his, but
signed; or it's not his, and he better keep his paws off it).
|
OVRRIDE |
Input |
This optional BOOLEAN parameter indicates to the API
whether the business rules defined by the site for the DELETE action should be
overridden for the document in question. Allowable values are 1 (TRUE), or 0
(FALSE). DEFAULT is 0 (FALSE).
|
|
MAKEADD(TIUDADD,TIUDA,TIUX,SUPPRESS) |
This call allows the creation of addenda to TIU
Documents. Beginning when TIU*1*184 is released, please call MAKEADD^TIUSRVP2
instead. Although MAKEADD^TIUSRVP will still work, the version in TIUSRVP2
will be more efficient.
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
TIUDA |
Input |
This is the record number of the parent document in
file 8925.
|
TIUX |
Input |
This is a local input array containing the data to be
filed for the addendum record, formatted as follows:
TIUX(.02)=45678
TIUX(1301)=2960703.104556
TIUX(1302)=293764
TIUX("TEXT",1,0)="The patient is a 70 year old WHITE MALE, who presented
to the ONCOLOGY CLINIC"
TIUX("TEXT",2,0)="On JULY 3, 1996@10:00 AM, with the chief complaint of
NECK PAIN..."
|
SUPPRESS |
Input |
BOOLEAN flag indicating whether or not to suppress
execution of the COMMIT ACTION for the document in question. This gives the
calling application control over the circumstances in which the COMMIT CODE
should be executed.
|
TIUDADD |
Both |
This is the record number of the resulting addendum.
NOTE: If no addendum record may be created, then the return variable will
look as follows: "-1^Could not create addendum."
|
|
SIGN(.ERR,TIUDA,TIUX) |
Validates and applies an electronic signature to a
document. Beginning when TIU*1*184 is released, please call SIGN^TIUSRVP2
instead. Although SIGN^TIUSRVP will still work, the version in TIUSRVP2 will
be more efficient.
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
ERR |
Both |
Passed by reference to return #^text of error message
from Dialog file if the user is NOT authorized to sign the document or if the
ES code is invalid; if successful, ERR=0.
|
TIUDA |
Input |
IEN of TIU DOCUMENT file (#8925)
|
TIUX |
Input |
User's electronic signature code, assumed to be
encrypted by the Broker's ENCRYP^XUSRB1.
|
|
