SPECIAL AUTHORITIES ICR (7506)

Name

Value

NUMBER

7506

IA #

7506

DATE CREATED

2024/11/07

CUSTODIAL PACKAGE

PCE PATIENT CARE ENCOUNTER

USAGE

Controlled Subscription

TYPE

Routine

ROUTINE

PXSPECAUTH

NAME

SPECIAL AUTHORITIES

GENERAL DESCRIPTION

Patch PX*1.0*244 will release a new SPECIAL AUTHORITIES
FILE #(820) and a routine of API calls to retrieve information about all the
special authorities. This Controlled ICR allows subscribers to call these APIs
to retrieve information from the new file.

Special Authorities file will define all the previously known as Environmental
Indicators in a file to allow future growth and to help minimize elaborate
software enhancements when needing to add a new authority.  This file contains
the business rules behind each authority, e.g. Name, code, disabled,
abbreviation, sequence, default, disabled, visible, Package - disabled?,
Linked authority behavior rules, Linked Authority, When value is, Actions to
take.

See individual Component Entry for description and examples of call and
returned results.

STATUS

Pending

KEYWORDS

SPECIAL AUTHORITY
ENVIRONMENTAL
INDICATORS
SPECIAL AUTHORITIES

PXSPECAUTH

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

SETARRAY

DESCRIPTION Special Authorities definitions and
optionally full business rules and help text wp field.

VARIABLES

TYPE

VARIABLES DESCRIPTION

multiple

Both

Array to return Special Authority results business
rules and optionally including the full instructions and Help text wp field
information.

Input

Array to return Special Authority results business
rules and optionally including the full instructions and Help text wp field
information.

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",5,"abbreviation")="ASC"
AR("specialAuthorityTypes",5,"code")="ASC"
AR("specialAuthorityTypes",5,"default")="Unanswered"
AR("specialAuthorityTypes",5,"disabled")="false"
AR("specialAuthorityTypes",5,"displayName")="Acute Suicidal Crisis"
AR("specialAuthorityTypes",5,"id")=9
AR("specialAuthorityTypes",5,"sequence")=5
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",5,"abbreviation")="ASC"
AR("specialAuthorityTypes",5,"code")="CA"
AR("specialAuthorityTypes",5,"default")="Unanswered"
AR("specialAuthorityTypes",5,"disabled")="false"
AR("specialAuthorityTypes",5,"displayName")="Acute Suicidal Crisis"
AR("specialAuthorityTypes",5,"id")=9
AR("specialAuthorityTypes",5,"package",1,"excluded")="true"
AR("specialAuthorityTypes",5,"package",1,"name")="PROBLEM LIST"
AR("specialAuthorityTypes",5,"sequence")=5
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 me dical care for treatment of service-connected"_$c(13,10)
AR("specialAuthorityTypes",10,"description","\",3)="(SC) conditions without
incu rring 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)="SetUnan
swered
"
AR("specialAuthorityTypes",10,"valueChangeActions",1,"actions",2)="Disable
"
AR("specialAuthorityTypes",10,"valueChangeActions",1,"linkedSpecialAuthori
ties", 1)="AO"
AR("specialAuthorityTypes",10,"valueChangeActions",1,"linkedSpecialAuthori
ties", 2)="EC"
AR("specialAuthorityTypes",10,"valueChangeActions",1,"linkedSpecialAuthori
ties", 3)="IR"
AR("specialAuthorityTypes",10,"valueChangeActions",1,"whenValueIs")="Yes"
AR("specialAuthorityTypes",10,"valueChangeActions",2,"actions",1)="Enable"
AR("specialAuthorityTypes",10,"valueChangeActions",2,"linkedSpecialAuthori
ties", 1)="AO"
AR("specialAuthorityTypes",10,"valueChangeActions",2,"linkedSpecialAuthori
ties", 2)="EC"
AR("specialAuthorityTypes",10,"valueChangeActions",2,"linkedSpecialAuthori
ties", 3)="IR"
AR("specialAuthorityTypes",10,"valueChangeActions",2,"whenValueIs")="No"
AR("specialAuthorityTypes",10,"valueChangeActions",3,"actions",1)="Enable"
AR("specialAuthorityTypes",10,"valueChangeActions",3,"linkedSpecialAuthori
ties", 1)="AO"
AR("specialAuthorityTypes",10,"valueChangeActions",3,"linkedSpecialAuthori
ties", 2)="EC"
AR("specialAuthorityTypes",10,"valueChangeActions",3,"linkedSpecialAuthori
ties", 3)="IR"
AR("specialAuthorityTypes",10,"valueChangeActions",3,"whenValueIs")="Unans
wered" 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
cond ition 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
condi tion must not be already considered to be"_$c(13,10)
AR("specialAuthorityTypes",20,"description","\",8)="service related or that
exem ption should apply.  See 'Help' for additional"_$c(13,10)
AR("specialAuthorityTypes",20,"description","\",9)="information."_$c(13,10
)
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(CODE)

Function call returns the internal entry number (ien)
for this indicator from the SA file (#820) for the SA CODE value passed in.

VARIABLES	TYPE	VARIABLES DESCRIPTION
NAME	Input	The Name of the SA to find the ien.
Output of function call	Output	IEN field Example: CODE="AO" returns 2.

$$FINDBYNAME(NAME)

Function call that returns the internal entry number
(ien) for this indicator from the SPECIAL AUTHORITY (SA) file (#820) for the
name passed in.

VARIABLES	TYPE	VARIABLES DESCRIPTION
NAME	Input	The Name of the SA to find the ien.
Output of function call	Output	IEN field value. Example: NAME="IONIZING RADIATION EXPOSURE" returns 3.

$$GETDISPLAYNAME(IEN)

Function call returns the display name of the
indicator from the SA file for the SA CODE value passed in.

VARIABLES

TYPE

VARIABLES DESCRIPTION

IEN

Input

The IEN of the indicator from the SA file.

Output of function call

Output

The name to be displayed to the user from the SA
file.

Example: For CODE="CV" name returned:"Combat &Vet (Combat Related)"

note: "&" is delphi gui hot key indication, translate that character to null
for printable or VistA screen media.

$$GETVALUE(DEF)

Function call returns the default answer value found
in the SA file to its JSON equivalent.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	The IEN of the indicator from the SA file.
Output of function call	Output	The JSON text equivalent value to a 1, 0, or null. Example: DEF="1" then returns "Yes", DEF="0" then returns "No", Null then returns "Unanswered"

$$GETZERO(IEN)

Function call that returns the 0 node from the SA
file, 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 of function call	Output	The JSON text equivalent value to a 1, 0, or null. Example: DEF="1" then "Yes", DEF="0" then "No", Else "Unanswered")

$$PKGEXCL(SACODE,PKGNAME)

Function returns the 0 node from the SA file, which
contains these pieces: NAME ^ CODE ^ DISPLAY NAME ^ SEQ ^ ABBREVIATION ^
SCHEDULING SEQUENCE DEFAULT SPECIAL AUTHORITY ^DISABLED

VARIABLES

TYPE

VARIABLES DESCRIPTION

1. SACODE

Input

The code of the SA in the SA file.

Example: "AO" is Agent Orange

2. PKGNAME

Input

The Name of the package found in the PACKAGE file
(*9.4).

Example: "PROBLEM LIST"

Output of function call

Output

Boolean value for if code is excluded from the
package passed in.

Example: W $$PKGEXCL^PXSPECAUTH("CV","PROBLEM LIST") will return 1.

SUBSCRIBING PACKAGE

SUBSCRIBING PACKAGE	SUBSCRIBING DETAILS
ORDER ENTRY/RESULTS REPORTING	Added 11/05/24, effective with patches PX1.0244 and OR3.0508 The OERR package will be subsribing to this routine to return all the valid authorities and their characteristics.