| $$SDAPI(.ARRAY) |
Name: SDAPI ;Retrieve Filtered Appointment
Data
Declaration: $$SDAPI^SDAMA301(.ARRAY)
Description: This API returns filtered appointment information and should
be called using an EXTRINSIC call. This will be a SUPPORTED IA.
Argument ARRAY - An array, passed by value, that is defined and
name-spaced by the calling application, containing the
following parameters:
Field List Required, ARRAY("FLDS"). List of appointment field IDs
requested, each ID separated by a semicolon. See Appendix
A for a complete list of available appointment fields and
their associated IDs.
Filters Optional. See Appendix B for a complete list of
available appointment filters and their input array
format.
Max Appts Optional, ARRAY("MAX"). Maximum appointments requested.
See Appendix B for a description and valid values of this
array entry.
Sort Optional, ARRAY("SORT"). Allows the output to be sorted by
patient DFN, instead of by Patient and Clinic IENs. See
Appendix B for a description and valid values of this
array entry.
Return Values
From the extrinsic call, this API will return "-1" if an error occurred, "0"
if no appointment is found that matches the filter criteria, or a count of the
returned appointments.
If no appointment is found that matches the filter criteria, the
^TMP($J,"SDAMA301") global will not be generated.
If appointments are found that match the filter criteria, the appointments
will be returned in ^TMP($J,"SDAMA301",SORT1,SORT2,APPT DATE/TIME) =
field1^field2^field3^ where SORT1 and SORT2 are driven by the patient filter
and defined in the table below, and field1 is appointment data ID 1 (appt
date/time) if requested, field2 is appointment data ID 2 (clinic IEN and name)
if requested, etc. Note: Field 6 will always be null, because if field 6
(Appointment comments) is requested, the comments will appear on the next
subscript ("C") of the global reference. IE. ^TMP($J,"SDAMA301",SORT1,
SORT2,APPT DATE/TIME,"C")=field 6.
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
ARRAY(FLDS) |
Input |
Required, ARRAY("FLDS"). This is a list of the
appointment field ID's requested, each ID separated by a semicolon.
|
ARRAY(MAX) |
Input |
Optional, ARRAY("MAX"). mAXIMUM APPOINTMENTS
REQUESTED.
|
ARRAY(SORT) |
Input |
Optional, ARRAY("SORT"). Allows the output to be
sorted by patient DFN, instead of by Patient and Clinic IENs.
|
$$SDAPI |
Output |
From the extrinsic call, this API will return "-1" if
an error occurred, "0" if no appointment is found that matches the filter
criteria, or a count of the returned appointments.
|
|
