| [613] | 1 | XTID ;OAKCIOFO/JLG - API set for VUID-Term/Concepts in VistA ;04/22/2005 15:12
|
|---|
| 2 | ;;7.3;TOOLKIT;**93**;Apr 25, 1995
|
|---|
| 3 | Q
|
|---|
| 4 | ; API set for VUID Term/Concepts in VistA
|
|---|
| 5 | ; supported by IA # 4631
|
|---|
| 6 | ; official definition of API set can be viewed online
|
|---|
| 7 | ; in the VistA Document Library website
|
|---|
| 8 | GETVUID(TFILE,TFIELD,TIREF) ;
|
|---|
| 9 | ;Function: Returns the VHA unique id (VUID) for a given term
|
|---|
| 10 | ; reference, TIREF. TIREF is represented differently based
|
|---|
| 11 | ; in its context--the combined value of TFILE and TFIELD
|
|---|
| 12 | ;
|
|---|
| 13 | ;Input:
|
|---|
| 14 | ; TFILE = VistA file # where term is defined.
|
|---|
| 15 | ; (req)
|
|---|
| 16 | ; TFIELD = field #, in TFILE where term is defined.
|
|---|
| 17 | ; (opt) When defined, it must be of type SET OF CODES.
|
|---|
| 18 | ; When not defined, TFILE represents a "table" of terms
|
|---|
| 19 | ; TIREF = term reference, as internal reference value.
|
|---|
| 20 | ; (req) When TFIELD is defined (SET OF CODES), TIREF is the
|
|---|
| 21 | ; internal value used in the set of codes.
|
|---|
| 22 | ; When TFIELD is not defined, TIREF is the IEN of the term
|
|---|
| 23 | ; in TFILE.
|
|---|
| 24 | ;
|
|---|
| 25 | ;Returns: Returns the VHA unique id (VUID) as a number for
|
|---|
| 26 | ; a given term reference. On error, it returns
|
|---|
| 27 | ; "0^<error message>"
|
|---|
| 28 | ;
|
|---|
| 29 | G GETVUID^XTID1
|
|---|
| 30 | ;
|
|---|
| 31 | SETVUID(TFILE,TFIELD,TIREF,TVUID) ;
|
|---|
| 32 | ;Function: Assigns (stores) a VHA unique id (VUID) to a given term
|
|---|
| 33 | ; reference, TIREF. TIREF is represented differently based in its
|
|---|
| 34 | ; context--the combined value of TFILE and TFIELD.
|
|---|
| 35 | ;
|
|---|
| 36 | ;Input:
|
|---|
| 37 | ; TFILE = VistA file # where term is defined.
|
|---|
| 38 | ; (req)
|
|---|
| 39 | ; TFIELD = field #, in TFILE where term is defined.
|
|---|
| 40 | ; (opt) When defined, it must be of type SET OF CODES.
|
|---|
| 41 | ; When not defined, TFILE represents a "table" of terms
|
|---|
| 42 | ; TIREF = term reference, as internal reference value.
|
|---|
| 43 | ; (req) When TFIELD is defined (SET OF CODES), TIREF is the
|
|---|
| 44 | ; internal value used in the set of codes.
|
|---|
| 45 | ; When TFIELD is not defined, TIREF is the IEN of the term
|
|---|
| 46 | ; in TFILE.
|
|---|
| 47 | ; TVUID = The VUID number to assign to term reference.
|
|---|
| 48 | ; (req)
|
|---|
| 49 | ;
|
|---|
| 50 | ;Returns: Returns indication of operation as
|
|---|
| 51 | ; 1 for successful; or
|
|---|
| 52 | ; "0^<error message>" for unsuccessful
|
|---|
| 53 | ;
|
|---|
| 54 | ;Modifies: updates or creates new entry in file 8985.1 or
|
|---|
| 55 | ; updates TFILE file
|
|---|
| 56 | ;
|
|---|
| 57 | G SETVUID^XTID1
|
|---|
| 58 | ;
|
|---|
| 59 | GETSTAT(TFILE,TFIELD,TIREF,TDATE) ;
|
|---|
| 60 | ;Function: Returns the status information for the given term (TIREF)
|
|---|
| 61 | ; and date (TDATE). TIREF is represented differently based in its
|
|---|
| 62 | ; context--the combined value of TFILE and TFIELD
|
|---|
| 63 | ;
|
|---|
| 64 | ;Input:
|
|---|
| 65 | ; TFILE = VistA file # where term is defined.
|
|---|
| 66 | ; (req)
|
|---|
| 67 | ; TFIELD = field #, in TFILE where term is defined.
|
|---|
| 68 | ; (opt) When defined, it must be of type SET OF CODES.
|
|---|
| 69 | ; When not defined, TFILE represents a "table" of terms
|
|---|
| 70 | ; TIREF = term reference, as internal reference value.
|
|---|
| 71 | ; (req) When TFIELD is defined (SET OF CODES), TIREF is the
|
|---|
| 72 | ; internal value used in the set of codes.
|
|---|
| 73 | ; When TFIELD is not defined, TIREF is the IEN of the term
|
|---|
| 74 | ; in TFILE.
|
|---|
| 75 | ; TDATE = FileMan date/time, defaults to NOW.
|
|---|
| 76 | ; (opt)
|
|---|
| 77 | ;
|
|---|
| 78 | ;Returns: Returns the status representation for a given
|
|---|
| 79 | ; term reference as
|
|---|
| 80 | ; "<internal value>^<FileMan effective date/time>^<external value>"
|
|---|
| 81 | ; where value is a set of codes (0:INACTIVE,1:ACTIVE).
|
|---|
| 82 | ; On error, it returns
|
|---|
| 83 | ; "^<error message>"
|
|---|
| 84 | ;
|
|---|
| 85 | G GETSTAT^XTID1
|
|---|
| 86 | ;
|
|---|
| 87 | SETSTAT(TFILE,TFIELD,TIREF,TSTAT,TDATE) ;
|
|---|
| 88 | ;Function: Assigns (stores) status information (TSTAT and TDATE)
|
|---|
| 89 | ; to the given term reference, TIREF. TIREF is represented
|
|---|
| 90 | ; differently based in its context--the combined value of
|
|---|
| 91 | ; TFILE and TFIELD.
|
|---|
| 92 | ;
|
|---|
| 93 | ;Input:
|
|---|
| 94 | ; TFILE = VistA file # where term is defined.
|
|---|
| 95 | ; (req)
|
|---|
| 96 | ; TFIELD = field #, in TFILE where term is defined.
|
|---|
| 97 | ; (opt) When defined, it must be of type SET OF CODES.
|
|---|
| 98 | ; When not defined, TFILE represents a "table" of terms
|
|---|
| 99 | ; TIREF = term reference, as internal reference value.
|
|---|
| 100 | ; (req) When TFIELD is defined (SET OF CODES), TIREF is the
|
|---|
| 101 | ; internal value used in the set of codes.
|
|---|
| 102 | ; When TFIELD is not defined, TIREF is the IEN of the term
|
|---|
| 103 | ; in TFILE.
|
|---|
| 104 | ; TSTAT = The status to assign (0 or 1).
|
|---|
| 105 | ; (req) TSTAT is a set of codes (0:INACTIVE, 1:ACTIVE)
|
|---|
| 106 | ;
|
|---|
| 107 | ; TDATE = FileMan date/time, defaults to NOW.
|
|---|
| 108 | ; (opt)
|
|---|
| 109 | ;
|
|---|
| 110 | ;Returns: Returns indication of operation
|
|---|
| 111 | ; 1:successful or or
|
|---|
| 112 | ; "0^<error message>" for unsuccessful
|
|---|
| 113 | ;
|
|---|
| 114 | ;Modifies: updates entry in file 8985.1 or TFILE file
|
|---|
| 115 | ;
|
|---|
| 116 | G SETSTAT^XTID1
|
|---|
| 117 | ;
|
|---|
| 118 | GETMASTR(TFILE,TFIELD,TIREF) ;
|
|---|
| 119 | ;Function: Returns the MASTER VUID flag for a given term
|
|---|
| 120 | ; reference, TIREF. TIREF is represented differently based
|
|---|
| 121 | ; in its context--the combined value of TFILE and TFIELD
|
|---|
| 122 | ;
|
|---|
| 123 | ;Input:
|
|---|
| 124 | ; TFILE = VistA file # where term is defined.
|
|---|
| 125 | ; (req)
|
|---|
| 126 | ; TFIELD = field #, in TFILE where term is defined.
|
|---|
| 127 | ; (opt) When defined, it must be of type SET OF CODES.
|
|---|
| 128 | ; When not defined, TFILE represents a "table" of terms
|
|---|
| 129 | ; TIREF = term reference, as internal reference value.
|
|---|
| 130 | ; (req) When TFIELD is defined (SET OF CODES), TIREF is the
|
|---|
| 131 | ; internal value used in the set of codes.
|
|---|
| 132 | ; When TFIELD is not defined, TIREF is the IEN of the term
|
|---|
| 133 | ; in TFILE.
|
|---|
| 134 | ;
|
|---|
| 135 | ;Returns: Returns the MASTER VUID value (set of codes: 0,1)
|
|---|
| 136 | ; On error, it returns
|
|---|
| 137 | ; "^<error message>"
|
|---|
| 138 | ;
|
|---|
| 139 | G GETMASTR^XTID1
|
|---|
| 140 | ;
|
|---|
| 141 | SETMASTR(TFILE,TFIELD,TIREF,TMASTER) ;
|
|---|
| 142 | ;Function: Assigns the MASTER VUID flag to a given term
|
|---|
| 143 | ; reference, TIREF. TIREF is represented differently based in its
|
|---|
| 144 | ; context--the combined value of TFILE and TFIELD.
|
|---|
| 145 | ;
|
|---|
| 146 | ;Input:
|
|---|
| 147 | ; TFILE = VistA file # where term is defined.
|
|---|
| 148 | ; (req)
|
|---|
| 149 | ; TFIELD = field #, in TFILE where term is defined.
|
|---|
| 150 | ; (opt) When defined, it must be of type SET OF CODES.
|
|---|
| 151 | ; When not defined, TFILE represents a "table" of terms
|
|---|
| 152 | ; TIREF = term reference, as internal reference value.
|
|---|
| 153 | ; (req) When TFIELD is defined (SET OF CODES), TIREF is the
|
|---|
| 154 | ; internal value used in the set of codes.
|
|---|
| 155 | ; When TFIELD is not defined, TIREF is the IEN of the term
|
|---|
| 156 | ; in TFILE.
|
|---|
| 157 | ; TMASTER = The MASTER VUID flag value to assign to term reference.
|
|---|
| 158 | ; (req)
|
|---|
| 159 | ;
|
|---|
| 160 | ;Returns: Returns indication of operation as
|
|---|
| 161 | ; 1 for successful; or
|
|---|
| 162 | ; "0^<error message>" for unsuccessful
|
|---|
| 163 | ;
|
|---|
| 164 | ;Modifies: updates entry in file 8985.1 or TFILE file
|
|---|
| 165 | ;
|
|---|
| 166 | G SETMASTR^XTID1
|
|---|
| 167 | ;
|
|---|
| 168 | GETIREF(TFILE,TFIELD,TVUID,TARRAY,TMASTER) ;
|
|---|
| 169 | ;Function: Returns a list of Terms' internal references (IREF) for
|
|---|
| 170 | ; a given VUID (TVUID). A term's file (TFILE) and field limit
|
|---|
| 171 | ; the size of the list to those terms found in a given file/field.
|
|---|
| 172 | ; TIREF is represented differently based in its context--the
|
|---|
| 173 | ; combined value of TFILE and TFIELD.
|
|---|
| 174 | ;
|
|---|
| 175 | ;Input:
|
|---|
| 176 | ; TFILE = VistA file # where term is defined.
|
|---|
| 177 | ; (opt)
|
|---|
| 178 | ; TFIELD = field #, in TFILE where term is defined.
|
|---|
| 179 | ; (opt) When defined, it must be of type SET OF CODES.
|
|---|
| 180 | ; When not defined, TFILE represents a "table" of terms
|
|---|
| 181 | ; TVUID = term's VHA unique id.
|
|---|
| 182 | ; (req)
|
|---|
| 183 | ;
|
|---|
| 184 | ;Output:
|
|---|
| 185 | ; TARRAY = name of local or global array that will contain the
|
|---|
| 186 | ; (opt) list of terms as
|
|---|
| 187 | ;
|
|---|
| 188 | ; ARRAY(TFILE,TFIELD,TIREF)= status
|
|---|
| 189 | ; on error it returns
|
|---|
| 190 | ; ARRAY("ERROR")="<error message>"
|
|---|
| 191 | ;
|
|---|
| 192 | G GETIREF^XTID1
|
|---|
| 193 | ;
|
|---|
| 194 | SCREEN(TFILE,TFIELD,TIREF,TDATE) ;
|
|---|
| 195 | ;Function: Returns the screening condition for the given term (TIREF)
|
|---|
| 196 | ; and date (TDATE). TIREF is represented differently based in its
|
|---|
| 197 | ; context--the combined value of TFILE and TFIELD.
|
|---|
| 198 | ;
|
|---|
| 199 | ;Input:
|
|---|
| 200 | ; TFILE = VistA file # where term is defined.
|
|---|
| 201 | ; (req)
|
|---|
| 202 | ; TFIELD = field #, in TFILE where term is defined.
|
|---|
| 203 | ; (opt) When defined, it must be of type SET OF CODES.
|
|---|
| 204 | ; When not defined, TFILE represents a "table" of terms
|
|---|
| 205 | ; TIREF = term reference, as internal reference value.
|
|---|
| 206 | ; (req) When TFIELD is defined (SET OF CODES), TIREF is the
|
|---|
| 207 | ; internal value used in the set of codes.
|
|---|
| 208 | ; When TFIELD is not defined, TIREF is the IEN of the term
|
|---|
| 209 | ; in TFILE.
|
|---|
| 210 | ; TDATE = FileMan date/time, defaults to NOW.
|
|---|
| 211 | ; (opt)
|
|---|
| 212 | ;
|
|---|
| 213 | ;Returns: 0 (i.e. don't screen) if the term is/was active or
|
|---|
| 214 | ; 1 if the term is/was inactive (i.e. screen).
|
|---|
| 215 | ;
|
|---|
| 216 | G SCREEN^XTID1
|
|---|
| 217 | ;
|
|---|
