DG OTH ELIGIBILITY CLOCK STATUS    ICR (6873)

Name Value
NUMBER 6873
IA # 6873
DATE CREATED 2018/02/13
CUSTODIAL PACKAGE REGISTRATION
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DGOTHD
NAME DG OTH ELIGIBILITY CLOCK STATUS
GENERAL DESCRIPTION
The purpose of this API is to facilitate the retrieval
of status of the OTH (Other Than Honorable discharge) eligibility for urgent
mental health for the patient by CPRS application in order to display it in
CPRS header. The OTH status is calculated based on the data stored in the
Registration file (#33) OTH ELIGIBILITY CLOCK. The API returns 0 if the
patient doesn't have OTH entry in the file(#33) or if the patient is not
eligible for OTH.
STATUS Active
KEYWORDS OTH
DURATION Till Otherwise Agreed
ID DGOTHD
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$OTHDCLCK(DGDFN,DGDATE)
This function entry point is used to search for and
retrieve the OTH (Other Than Honorable) eligibility data for a specific
patient. The patient for the function call is specified by IEN in the PATIENT
file (#2) in the first parameter. The date for which the status needs to be
retrieved is specified in the 2nd parameter in FileMan format. MUMPS code
examples of use:

>S DFN=7209366

>W !,$$OTHDCLCK^DGOTHD(DFN)

1^2^3171119^3180217^0^3180227^3180528^83^3180227



>S DFN=7209366,DATE=3180404

>W !,$$OTHDCLCK^DGOTHD(DFN,DATE)

1^2^3171119^3180217^0^3180227^3180528^54^3180227
VARIABLES TYPE VARIABLES DESCRIPTION
DGDFN Input
IEN of patient in the PATIENT File (#2).
DGDATE Input
(Optional) The date to calculate status in FileMan
format.
$$OTHDCLCK Output
Returns the information to display information about
the OTH clock.

The return string is of the following format:

"0" = if the patient is not eligible for OTH or if the patient does not have
an entry in the OTH ELIGIBILITY CLOCK file (#33).

"-1^Error Message" = Failure  (2 piece string (^)-delimited).

"p1^p2^p3^p4^p5^p6^p7^p8" = Successful, where:
p1 = 1 .. n
1..n - the latest sequence number of the 365 period;
p2 = 1,2,or 3
1 if the patient is in the first 90 day period,
2 if the patient is in the second 90 day period,
3 if the patient has used all 180 days in this 365 day period;
p3 = FM date for the start of the clock for the first 90 day period,
p4 = FM date for the end of the clock for the first 90 day period,
p5 = the number of days left in the first 90 day period,
p6 = FM date for the start of the clock for the second 90 day period,
p7 = FM date for the end of the clock for the second 90 day period,
p8 = the number of days left in the second 90 day period,
p9 = FM date of the authorization for the 2nd period (null if no
authorization).
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE SUBSCRIBING DETAILS
ORDER ENTRY/RESULTS REPORTING
This function is called from GET^OROTHCL to support the
"OROTHCL GET" RPC.
CREATOR SHAMUKHAMEDOV,SHAVKAT
DBA Comments
5/29/18-DT: The SHPRE project team is implementing the DG
(Custodial package) and OR (Subscribing package) portion related to ICR 6873.
OR M-code will be included in an OR patch for the appropriate version of CPRS
(the exact version will be determined soon).  The DG portion is included in
SHRPE patch DG*5.3*952.
DATE ACTIVATED 2018/05/29
DATE/TIME EDITED
DATE/TIME EDITED ACTION AT THE REQUEST OF WITH CONCURRENCE OF
2018/05/29 14:47 APPROVED SHAMUKHAMEDOV,SHAVKAT HAWSEY,JASON
Generated from SEP 05, 2018@ IA Listing Descriptions