| SETARRAY |
DESCRIPTION Special Authorities definitions and
optionally full business rules and help text wp field.
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
AR |
Output |
Array to return Special Authority business rules and
optionally including the full instructions and Help text.
|
FULLSTRUCT |
Input |
Boolean field. One of 2 valid statuses below:
0 for no
1 for yes
Example call base rules: D
SETARRAY^PXSPECAUTH(.AR,0) base rules
Example output: Below showing a sampling of the output. Only the first
3 indicators. Whereas, you would receive all.
AR("specialAuthorityTypes",10,"abbreviation")="SC"
AR("specialAuthorityTypes",10,"code")="SC"
AR("specialAuthorityTypes",10,"default")="Unanswered"
AR("specialAuthorityTypes",10,"disabled")="false"
AR("specialAuthorityTypes",10,"displayName")="Service &Connected Condition"
AR("specialAuthorityTypes",10,"id")=1
AR("specialAuthorityTypes",10,"sequence")=10
AR("specialAuthorityTypes",20,"abbreviation")="CV"
AR("specialAuthorityTypes",20,"code")="CV"
AR("specialAuthorityTypes",20,"default")="Unanswered"
AR("specialAuthorityTypes",20,"disabled")="false"
AR("specialAuthorityTypes",20,"displayName")="Combat&Vet (Combat Related)"
AR("specialAuthorityTypes",20,"id")=8
AR("specialAuthorityTypes",20,"sequence")=20
Example call all rules: D
SETARRAY^PXSPECAUTH(.AR,1) all rules
AR("specialAuthorityTypes",10,"abbreviation")="SC"
AR("specialAuthorityTypes",10,"code")="SC"
AR("specialAuthorityTypes",10,"default")="Unanswered"
AR("specialAuthorityTypes",10,"description","\",1)="Service-Connected(SC)
:"_$c( 13,10)
AR("specialAuthorityTypes",10,"description","\",2)="Veterans are eligible for
medical care for treatment of service-connected"_$c(13,10)
AR("specialAuthorityTypes",10,"description","\",3)="(SC) conditions without
incurring copayment charges or claims against"_$c(13,10)
AR("specialAuthorityTypes",10,"description","\",4)="their insurance. See
'Help' for additional information."_$c(13,10)
AR("specialAuthorityTypes",10,"disabled")="false"
AR("specialAuthorityTypes",10,"displayName")="Service &Connected Condition"
AR("specialAuthorityTypes",10,"id")=1
AR("specialAuthorityTypes",10,"package",1,"excluded")="false"
AR("specialAuthorityTypes",10,"package",1,"name")="ORDER ENTRY/RESULTS
REPORTING"
AR("specialAuthorityTypes",10,"sequence")=10
AR("specialAuthorityTypes",10,"valueChangeActions",1,"actions",1)="SetUna
nswered "
AR("specialAuthorityTypes",10,"valueChangeActions",1,"actions",2)="Disabl e "
AR("specialAuthorityTypes",10,"valueChangeActions",1,"linkedSpecialAuthor i
ties", 1)="AO"
AR("specialAuthorityTypes",10,"valueChangeActions",1,"linkedSpecialAuthor i
ties", 2)="EC"
AR("specialAuthorityTypes",10,"valueChangeActions",1,"linkedSpecialAuthor i
ties", 3)="IR"
AR("specialAuthorityTypes",10,"valueChangeActions",1,"whenValueIs")="Yes"
AR("specialAuthorityTypes",10,"valueChangeActions",2,"actions",1)="Enable
"
AR("specialAuthorityTypes",10,"valueChangeActions",2,"linkedSpecialAuthor i
ties", 1)="AO"
AR("specialAuthorityTypes",10,"valueChangeActions",2,"linkedSpecialAuthor i
ties", 2)="EC"
AR("specialAuthorityTypes",10,"valueChangeActions",2,"linkedSpecialAuthor i
ties", 3)="IR"
AR("specialAuthorityTypes",10,"valueChangeActions",2,"whenValueIs")="No"
AR("specialAuthorityTypes",10,"valueChangeActions",3,"actions",1)="Enable
"
AR("specialAuthorityTypes",10,"valueChangeActions",3,"linkedSpecialAuthor
ities", 1)="AO"
AR("specialAuthorityTypes",10,"valueChangeActions",3,"linkedSpecialAuthor
ities", 2)="EC"
AR("specialAuthorityTypes",10,"valueChangeActions",3,"linkedSpecialAuthor
ities", 3)="IR"
AR("specialAuthorityTypes",10,"valueChangeActions",3,"whenValueIs")="Unan
swered"
AR("specialAuthorityTypes",20,"abbreviation")="CV"
AR("specialAuthorityTypes",20,"code")="CV"
AR("specialAuthorityTypes",20,"default")="Unanswered"
AR("specialAuthorityTypes",20,"description","\",1)="Combat Veteran
(CV):"_$c(13, 10)
AR("specialAuthorityTypes",20,"description","\",2)="To receive CV exemption
the veteran must have served in combat operations"_$c(13,10)
AR("specialAuthorityTypes",20,"description","\",3)="after the Gulf War or in
com bat against a hostile force after November 11,"_$c(13,10)
AR("specialAuthorityTypes",20,"description","\",4)="1998. In addition, the
condition for which the veteran is treated must be"_$c(13,10)
AR("specialAuthorityTypes",20,"description","\",5)="related to that combat,
the veteran must have registered as a combat"_$c(13,10)
AR("specialAuthorityTypes",20,"description","\",6)="veteran, and be within
two y ears of separation from active military"_$c(13,10)
AR("specialAuthorityTypes",20,"description","\",7)="service. Finally, the
condition must not be already considered to be"_$c(13,10)
AR("specialAuthorityTypes",20,"description","\",8)="service related or that
exemption should apply. See 'Help' for additional"_$c(13,10)
AR("specialAuthorityTypes",20,"description","\",9)="information."_$c(13,1 0)
AR("specialAuthorityTypes",20,"disabled")="false"
AR("specialAuthorityTypes",20,"displayName")="Combat &Vet (Combat Related)"
AR("specialAuthorityTypes",20,"id")=8
AR("specialAuthorityTypes",20,"package",1,"excluded")="true"
AR("specialAuthorityTypes",20,"package",1,"name")="PROBLEM LIST"
AR("specialAuthorityTypes",20,"sequence")=20
|
|
$$FINDBYCODE(SACODE) |
This extrinsic function returns the file #820
internal entry number (IEN) for this indicator from the SA file (#820) for the
SA CODE value passed in.
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
SACODE |
Input |
The SA code
|
IEN |
Output |
Example: $$FINDBYCODE^PXSPECAUTH("AO") returns 2.
|
|
$$FINDBYNAME(NAME) |
This extrinsic function returns the file #820
internal entry number (IEN) for this indicator.
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
NAME |
Input |
The Name of the SA.
|
|
Output |
Example: $$FINDBYNAME^PXSPECAUTH("IONIZING RADIATION
EXPOSURE") returns 3.
|
|
$$GETDISPLAYNAME(IEN) |
This extrinsic function returns the display name of
the Special Authority.
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
IEN |
Input |
The IEN of the indicator from file #820.
|
|
Output |
The Special Authority name to be displayed to the
user.
Example: $$GETDISPLAYNAME^PXSPECAUTH(8) returns: "Combat &Vet(Combat Related)"
Note: "&" is the Delphi GUI hot key indication, translate that character to
NULL for printable or VistA screen media.
|
|
$$GETVALUE(VALUE) |
This extrinsic function returns the default value for
the SA file as JSON.
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
VALUE |
Input |
The internal value for the SA.
|
RETURN |
Output |
The external value for the passed in internal value.
Example: VALUE="1" then returns "Yes",
VALUE="0" then returns "No",
all other passed in values returns "Unanswered"
|
|
$$GETZERO(IEN) |
This extrinsic function returns the 0 node from file
#820, which, contains these pieces: NAME ^ CODE ^ DISPLAY NAME ^ SEQ ^
ABBREVIATION ^ SCHEDULING SEQUENCE DEFAULT SPECIAL AUTHORITY ^DISABLED
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
IEN |
Input |
The IEN of the indicator from the SA file.
|
|
Output |
The 0 node as described above.
Example: $$GETZERO^PXSPECAUTH(8) returns "COMBAT VETERAN^CV^Combat &Vet
(Combat Related)^10^CV^^1^^"
|
|
$$PKGEXCL(SACODE,PKGNAME) |
This extrinsic function returns 1 if 1 if it is
excluded 0 if it is not.
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
SACODE |
Input |
The code of the SA in file #820.
Example: "AO" is Agent Orange
|
PKGNAME |
Input |
The Name of the package found in the PACKAGE file
(#9.4).
Example: "PROBLEM LIST"
|
|
Output |
Boolean value: 1 if the package is excluded for the
SA, 0 if SA is not.
Example: W $$PKGEXCL^PXSPECAUTH("CV","PROBLEM LIST") will return 1.
|
|
GETSADEF |
This API determines which Special Authorities must be
answered by the end user.
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
INPUTS |
Input |
The inputs are in a subscripted array containing the
following:
INPUTS("patientId")=100840
INPUTS("dateTime")=3250423.1458
INPUTS("location")=240
INPUTS("visitIen")=7456
INPUTS("loadStructure")="true"
The subscripts patientId and dateTime are required, the others are optional.
patientId: the patient's DFN
dateTime: the date and time to evaluate the patient for which the
Special Authority should be answered.
The subscripts location, visitIen, and loadStructure are optional:
location is the IEN of the Hospital Location from file #44.
visitIen is the IEN from file #9000010.
|
RESULTS |
Output |
The output is a subscripted array defining the order
in which the special authorities should appear in the application and the
properties for each item. The code subscript is the code. The default
subscript indicates if the special authority should have a default value. The
visible subscript, if set to true, indicates that the special authority must
be answered; if set to false, the special authority should not be prompted
for.
Example output:
RESULTS("specialAuthority",1,"code")="SC"
RESULTS("specialAuthority",1,"default")="Unanswered"
RESULTS("specialAuthority",1,"visible")="true"
RESULTS("specialAuthority",2,"code")="CV"
RESULTS("specialAuthority",2,"default")="Yes"
RESULTS("specialAuthority",2,"visible")="true
|
|
GETPATSA |
This API returns whether the Special Authorities
questions should/can be asked for a patient at a specific date/time. It also
returns whether the Special Authorities question should have a default value.
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
DFN |
Input |
The pointer value of the location entry[PR2] from
file #2, required.
|
ATM |
Input |
The Encounter Date/Time, required
|
LOC |
Input |
The pointer value of the location entry from file
#44, optional.
|
PXARRAY |
Output |
This is the result of the call in the following
format: PXARRAY(CODE)=ASK^DEFAULT
CODE: The text value from field #2 for the entry from file #820.
ASK: Boolean value (1 or 0), a value of 1 means to ask the Special
Authority, a value of 0 means do not ask.
DEFAULT: Boolean value (1 or 0), a value of 1 means default to Yes,
a value of 0 means default to No. No value means do not
set a default.
|
|
$$ISACTIVECODE |
This extrinsic function returns 0 if the code cannot
be found or if the code is inactive. Returns 1 is the code is active.
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
CODE |
Input |
The internal text of the CODE value
|
RETURN |
Output |
Boolean value, returns 1 or 0
|
|
GETCODE |
Returns the value in Code field #2
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
IEN |
Input |
The internal IEN for the SA from file 820.
|
Return |
Output |
Return the Code value stored in field #2
|
|
