Print Page as PDF
DBIA3780 ICR (3780)

DBIA3780    ICR (3780)

Name Value
NUMBER 3780
IA # 3780
DATE CREATED 2002/10/08
CUSTODIAL PACKAGE CLINICAL PROCEDURES
CUSTODIAL ISC Chicago
USAGE Private
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE MCARAPI
NAME DBIA3780
GENERAL DESCRIPTION
This IA documents the API interface between Medicine
version 2.3 and Immunology Case Registry version 2.1.  Prior to calling the
API GET^MCARAPI(RESULTS,MCARDFN,MCSDT,MCEDT,MCFLDS), ICR should check the
existence of patch MC*2.3*34.
STATUS Active
DURATION Till Otherwise Agreed
ID MCARAPI
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
GET(RESULTS,MCARDFN,MCSDT,MCEDT,MCFLDS)
This API returns a list of data from the
Electrocardiogram file (#691.5) for a patient for a specified start and end
date.  Only the Electrocardiogram records in the following statuses will be
returned in the list:

RELEASED ON-LINE VERIFIED                                    RELEASED OFF-LINE
VERIFIED                                      RELEASED NOT VERIFIED
RELEASED ON-LINE VERIFIED OF SUPERSEDED
RELEASED OFF-LINE VERIFIED OF SUPERSEDED
VARIABLES TYPE VARIABLES DESCRIPTION
RESULTS Both
Input: The global ^TMP array in which to return
results. (Required)

Output: Passed by Reference
Global array returned in the FM DIQ call
format.
MCARDFN Input
The Patient DFN (Required).
MCSDT Input
The start date of the date range to return the data
in.  This must be in FM internal format.  (Required)
MCEDT Input
The end date of the date range to return the data in.
This must be in FM internal format. (Required)
MCFLDS Input
A list of fields from file #691.5 to be returned in
RESULTS.  MCFLDS should contain a list of fields delimited by ";"  (Required)

example: MCFLDS=".01;11;20..."

Example API call:

S RESULTS="^TMP(""NAMESPACE"",$J)"                 D
GET^MCARAPI(.RESULTS,162,2900101,3021001,
".01;11")

return:

^TMP("NAMESPACE",$J,file #,record ien_",",field #,"E")=Data
^TMP("NAMESPACE",$J,subfile #,entry #_","_record ien
field of the multiple,"E")=data

RESULTS(0) will equal one of the following,
if the call failed:
-1^No Patient DFN.
-1^No Start Date Range
-1^No End Date Range.
-1^Start Date greater than End Date.
-1^No fields defined.
-1^Global TMP array only.

If no return array defined,^TMP("MCAPI",$J,0)
equals
-1^No return array global.

If no data, RESULTS(0) equals
-1^No data for patient.
SUBSCRIBING PACKAGE CLINICAL CASE REGISTRIES