GMPLSPECAUTH SPECAUTHDEF (5169)    REMOTE PROCEDURE (8994)

Name Value
NAME GMPLSPECAUTH SPECAUTHDEF
TAG SPECAUTHDEF
ROUTINE GMPLSPECAUTH
RETURN VALUE TYPE ARRAY
INPUT PARAMETER
  • JSONIN
    PARAMETER TYPE:   LITERAL
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    Called by CPRS for valid Special Authorities for a patient.
        "patientId": "100840"
    }
     
    Passes in a JSON String with elements below:
     
    "patientId" =: Patient unique internal number (DFN)
     
    Example JSON msg:
     
    {
    
RETURN PARAMETER DESCRIPTION
Returns an array with JSON string elements for Special Authorities (SA).
 "success"    = true/false - successfully found the patient DFN
 
Example:
{
    "facility": "21789",
    "specialAuthority": [
        {
            "code": "SC",
            "default": "unknown",
            "visible": true
 
        },
        {
            "code": "CV",
            "default": "unknown",
            "visible": true
        },
        {
            "code": "AO",
            "default": "unknown",
            "visible": true
Elements
        },
        {
            "code": "IR",
            "default": "unknown",
            "visible": true
        },
        {
            "code": "EC",
            "default": "unknown",
            "visible": false
 "facility" = Location of the Patient Hospital/Clinic.
        },
        {
            "code": "SHAD",
            "default": "unknown",
            "visible": false
        },
        {
            "code": "MST",
            "default": "unknown",
            "visible": true
 "specialAuthoritiy"
        },
        {
            "code": "HNC",
            "default": "unknown",
            "visible": false
        }
    ],
    "ssn4": "0902",
    "success": true
}
   "code"    = 2-4 characters - internal letter code, e.g. AO Agent Orange
   "defalut" = yes, no, unanswered - default prompt value
   "visible" = true/false - should this SA appear to user for an answer
 "patientId"  = nnnnn - patient DFN that data is for