| DESCRIPTION |
Returns immunization records from the V Immunization and V Immunization
FILTER will be ignored).
If an invalid IEN was passed in, the following error will be
returned: "Record with IEN #xxx does not exist."
If the record could not be returned for some other reason, the
following error will be returned: "Unable to return record with IEN
#xxx."
2. A time range (and other filter criteria) can be passed in FILTER, and
Deleted file. There are two methods for defining the criteria to determine
a list of records that meet that criteria will be returned. Any
record last modified or deleted (if FILTER("INC DELETE")=1) within
that time range will be returned.
To limit the number of records returned, FILTER("MAX") can be set to
the maximum number of records to be returned. The RPC will return a
value called "BOOKMARK". That value can be used to call the RPC
again, this time passing in the "BOOKMARK" value in
FILTER("BOOKMARK") (all other parameters should be defined exactly as
when previously called), and the RPC will return the next n number of
which records to return.
records that meet the search criteria, and starting where the
previous call left off. So for example, if there are 1,000 records
that meet the search criteria, and FILTER("MAX") is set to return a
maximum of 100 records, the RPC will need to be called 10 times in
order to return all 1,000 records. Each subsequent time the RPC is
called, the caller would set FILTER("BOOKMARK") to the bookmark value
returned in the previous call. The caller would know when they reach
the end and that there are no more records to be returned, when the
RPC returns TOTAL ITEMS=0.
Note: All date/time references are to be in FileMan format.
1. A specific list of record IDs can be passed in, and only those
records will be returned (if they exist on the system). When called
in this way, the list of records should be passed in LIST, and FILTER
should not be defined (if both LIST and FILTER are defined, only the
records listed in LIST will be returned, and the search criteria in
|
| INPUT PARAMETER |
-
- FILTER
- PARAMETER TYPE: LIST
- REQUIRED: NO
- SEQUENCE NUMBER: 1
- DESCRIPTION:
Search criteria (Optional).
("MAX") - The maximum number of records to return (defaults to
99)
("BOOKMARK") - If wanting to get the next n number of records, the
bookmark value returned in the previous call should be
passed here. (Optional)
("INC DELETE") - Flag to control if records should also be returned
from the V IMMUNIZATION DELETED file. (defaults to
"1").
1 - Include records from both the V IMMUNIZATION and V
IMMUNIZATION DELETED files
("START") - Start date/time to begin search from (Defaults to T-1)
0 - Only include records from the V IMMUNIZATION file.
("STOP") - Stop date/time to end search (if time is not
specified, midnight is assumed). (Defaults to T-1)
("DATA SRC EXC") - A semi-colon delimited list of Data Source names (in
external format) (e.g., SRC1;SRC2;SRCn). (Optional)
Any immunization record whose DATA SOURCE matches one
of the data names in this list will be filtered out,
and will not be returned.
-
- LIST
- PARAMETER TYPE: LIST
- REQUIRED: NO
- SEQUENCE NUMBER: 2
- DESCRIPTION:
A list of record numbers (IENs) to return. (Optional)
To specify an IEN from the V IMMUNIZATION file, set LIST(IEN)="".
To specify an IEN from the V IMMUNIZATION DELETED file, set
LIST(IEN_"D")="" (e.g., PXLIST("123D")="").
-
- DATE
- PARAMETER TYPE: LITERAL
- REQUIRED: NO
- SEQUENCE NUMBER: 3
- DESCRIPTION:
A date in FileMan format. (Optional)
TYPE="UPDATE-BEFORE"). Two, will be the current state of the record
(i.e., TYPE="UPDATE-AFTER"). b) if no significant changes have been
made to this record since that date (i.e., the record was edited
after that date, but none of the fields that are returned in this
call were modified with that edit), then we will not return this
record, as nothing significant changed since that date.
3. Deletes: a) If a record was added after that date and later deleted,
we won't return the record, as on that date the record did not exist,
and the current record is deleted, so nothing really changed since
that date. b) If a record was edited after that date and then
It is used when the caller wants to see how the records being returned
deleted, the deleted record will be returned the way it existed on
that date, as from that date's perspective that is what the deleted
record looked like.
changed since that date. When populated, it is used in a number of ways:
1. Additions: If a record was added after that date, and later edited,
we will return the record as if it's a new record (i.e., TYPE="ADD")
(even though it's truly an edited record), as from that date's
perspective this is a new record.
2. Edits: a) We will return two versions of an edited record. One, will
be the way the record existed on that date (i.e.,
-
- DEMOGRAPHICS
- PARAMETER TYPE: LITERAL
- REQUIRED: NO
- SEQUENCE NUMBER: 4
- DESCRIPTION:
Return patient demographics? (1=Yes/0=No). (Defaults to "1").
|
| RETURN PARAMETER DESCRIPTION |
A list of records that meet the search criteria.
o IMM-UPDATE - Used wehn the immunizatin record was edited (and the
caller did not pass in DATE).
o IMM-UPDATE-BEFORE/IMM-UPDATE-AFTER - Used when the immunizatin record
was edited and the called passed in DATE. Two objects will be
returned. The IMM-UPDATE-BEFORE object will be the way the record
existed before that date, and the IMM-UPDATE-AFTER will be the current
state of the record.
For more details on the fields and attributes of the immunization and
patient objects, please see the documentation.
Each item returned will contain an immunization object, and if
demographics are requested, a patient object.
The immunization object can be called: IMM-ADD, IMM-DELETE, IMM-UPDATE,
IMM-UPDATE-BEFORE, or IMM-UPDATE-AFTER.
o IMM-ADD - Used when the immunization record is a "new" record.
o IMM-DELETE - Used when the immunizatin record is a deleted record.
|
