Reference Type: Supported, Category: Toolkit—VHA Unique ID (VUID), Integration Agreement: 4631
As of Kernel Toolkit Patch XT*7.3*108, this extrinsic function retrieves the screening condition for a given term/concept reference and specified date/time. It returns whether or not a given entry should be screened out of selection lists. This API should not be used to determine if the given entry is active/inactive, since the API takes into consideration where in the standardization process the facility is. It returns the following values:
(required) VistA file/subfile number where term/concept is defined.
(optional) Field number in the "file" input parameter where term/concept is defined:
(required) Internal reference for term/concept:
(optional) VA FileMan date/time against which screening is checked. It defaults to NOW.
NOTE: If the value of the datetime parameter contains a date and no time, no entries are returned for the first day.
(optional) Flag to indicate caching. Used mainly when defining the "screen" parameter [e.g., DIC("S")] while searching large files. This will improve the speed of the search.
NOTE: It must be KILLed before initiating each search query (e.g., before calling the ^DIC).
Returns the screening condition as follows:
For terms defined in fields that are SET OF CODES:
>S file=2,field=.02,iref="M",datetime=$$NOW^XLFDT >W $$SCREEN^XTID(file,field,iref,datetime) 0
For terms defined in a single file:
>S file=16000009,field=.01,iref="3,",datetime="" >W $$SCREEN^XTID(file,field,iref,datetime) 0
When searching a large file:
>S file=120.52,field=.01,datetime="" >S SCREEN="I '$$SCREEN^XTID(file,field,Y_"","",datetime,.cached)" >. . . >K cached >D LIST^DIC(file,,".01;99.99",,"*",,,,SCREEN,,"LIST","MSG") >K cached
August 26, 2011