VA FileMan Developer's Guide: GET^DDE

Contents:

Data Mapping Utility (DMU)

GET^DDE(): Retrieve Multiple or Single Entity File Records as JSON or XML Array

Reference Type	Category	ICR #
Supported	Data Mapping	7008

Description

The GET^DDE API is the main API for processing an Entity to retrieve VistA data. It can retrieve multiple records using the query input array, or a single record using the id input parameter. It returns an array containing the data in msg_root formatted in either XML or JSON.

Format

GET^DDE(ENTITY[,ID][,.QUERY][,FORMAT][,MAX][,MSG_ROOT][,ERROR_ROOT])

Input Parameters

entity	(Required) The name or IEN of an ENTITY (#1.5) file.
id	(Optional) The identifier of the record, or input string, to be processed by the Entity. If an id is defined, no query is performed.
query(name)	(Optional) An array of name-value pairs passed by reference to refine the query or results. Standard names supported by DDE include: QUERY(“patient”) = PATIENT (#2) file IEN QUERY(“start”) = start date.time of search (default = all), FM format QUERY(“stop”) = stop date.time of search (default = all), FM format QUERY(“notag”) = 1, to omit the leading item tag for JSON results QUERY(#) = filters to be used by FIND^DIC, with index defined in Entity Other name-value pairs can be passed in as well if supported by the Query Routine, such as QUERY(“status”) = “active”.
format	(Optional) Desired format for the results: 0=JSON (default). 1=XML.
max	(Optional) Maximum number of records to return in the results (default = 9999).
msg_root	(Optional) Closed-root array name where the results are returned. If this parameter is not passed, the results are returned in nodes descendant from ^TMP(“DDE GET”,$J).
error_root	(Optional) Closed-root array name where the errors are returned. If this parameter is not passed, the results are returned in nodes descendant from ^TMP(“DDERR”,$J).

Output

Results

The XML or JSON results are returned in the msg_root array, where each entry corresponds to one record. Any errors encountered during processing are returned in the error_root array.

Example

To return the problems for patient DFN 229 as XML:

>S QUERY("PATIENT")=229 D GET^DDE("VPR PROBLEM",,.QUERY,1,,"ZZRES") ZW ZZRES

ZZRES(0)=3
ZZRES(1)="<PROBLEM><UPDATEDON>2019-05-02T00:00:00</UPDATEDON><EXTENSION><ISEXPOSUREAO>FALSE</ISEXPOSUREAO><ISEXPOSUREIR>FALSE</ISEXPOSUREIR><ISEXPOSUREPG>FALSE</ISEXPOSUREPG><LOCATION><SDACODINGSTANDARD>VA44</SDACODINGSTANDARD><EXTENSION><STOPCODE><SDACODINGSTANDARD>AMIS</SDACODINGSTANDARD><CODE>301</CODE><DESCRIPTION>GENERAL INTERNAL MEDICINE</DESCRIPTION></STOPCODE><SERVICE>MEDICINE</SERVICE><SPECIALTY><SDACODINGSTANDARD>VA45.7</SDACODINGSTANDARD><CODE>9</CODE><DESCRIPTION>GENERAL MEDICINE</DESCRIPTION></SPECIALTY></EXTENSION><CODE>23</CODE><DESCRIPTION>GENERAL MEDICINE</DESCRIPTION></ORGANIZATION><SDACODINGSTANDARD>VA4</SDACODINGSTANDARD><CODE>500</CODE><DESCRIPTION>CAMP MASTER</DESCRIPTION></ORGANIZATION><LOCATIONTYPE>CLINIC</LOCATIONTYPE></LOCATION><REMOVED>FALSE</REMOVED><ISSC>FALSE</ISSC><LEXICONID>7026741</LEXICONID><COMMENTS><COMMENT><ID>1,1,940</ID><ENTEREDAT><SDACODINGSTANDARD>VA4</SDACODINGSTANDARD></ENTEREDAT><ENTEREDBY><SDACODINGSTANDARD>VA200</SDACODINGSTANDARD><CODE>10000000407</CODE><DESCRIPTION>DDEUSER,ONE</DESCRIPTION></ENTEREDBY><ENTEREDON>2019-05-02</ENTEREDON><COMMENTTEXT>TESTING UPDATES</COMMENTTEXT></COMMENT><COMMENT><ID>2,1,940</ID><ENTEREDAT><SDACODINGSTANDARD>VA4</SDACODINGSTANDARD></ENTEREDAT><ENTEREDBY><SDACODINGSTANDARD>VA200</SDACODINGSTANDARD><CODE>10000000407</CODE><DESCRIPTION>DDEUSER,ONE</DESCRIPTION></ENTEREDBY><ENTEREDON>2019-05-02</ENTEREDON><COMMENTTEXT>SECOND COMMENT</COMMENTTEXT></COMMENT></COMMENTS></EXTENSION><PROBLEMDETAILS>ALCOHOL ABUSE (SCT 15167005)</PROBLEMDETAILS><PROBLEM><SDACODINGSTANDARD>SNOMED CT</SDACODINGSTANDARD><CODE>15167005</CODE><DESCRIPTION>ALCOHOL ABUSE</DESCRIPTION></PROBLEM><CLINICIAN><SDACODINGSTANDARD>VA200</SDACODINGSTANDARD><CODE>10000000407</CODE><DESCRIPTION>DDEUSER,ONE</DESCRIPTION></CLINICIAN><STATUS><SDACODINGSTANDARD>SNOMED CT</SDACODINGSTANDARD><CODE>55561003</CODE><DESCRIPTION>ACTIVE</DESCRIPTION></STATUS><ENTEREDBY><SDACODINGSTANDARD>VA200</SDACODINGSTANDARD><CODE>10000000407</CODE><DESCRIPTION>DDEUSER,ONE</DESCRIPTION></ENTEREDBY><ENTEREDAT><SDACODINGSTANDARD>VA4</SDACODINGSTANDARD></ENTEREDAT><ENTEREDON>2019-05-02T00:00:00</ENTEREDON><EXTERNALID>940;PL</EXTERNALID></PROBLEM>"
ZZRES(2)="<PROBLEM><UPDATEDON>2007-04-10T00:00:00</UPDATEDON><EXTENSION><ISEXPOSUREAO>FALSE</ISEXPOSUREAO><ISEXPOSUREIR>FALSE</ISEXPOSUREIR><ISEXPOSUREPG>FALSE</ISEXPOSUREPG><LOCATION><SDACODINGSTANDARD>VA44</SDACODINGSTANDARD></LOCATION><SERVICE>MEDICAL</SERVICE><ISSC>FALSE</ISSC><ONSETDATE>2005-04-07</ONSETDATE><LEXICONID>60339</LEXICONID></EXTENSION><PROBLEMDETAILS>HYPERTENSION</PROBLEMDETAILS><PROBLEM><SDACODINGSTANDARD>ICD-9-CM</SDACODINGSTANDARD><CODE>401.9</CODE><DESCRIPTION>HYPERTENSION NOS</DESCRIPTION></PROBLEM><CLINICIAN><SDACODINGSTANDARD>VA200</SDACODINGSTANDARD><EXTENSION><TITLE>SCHOLAR EXTRAORDINAIRE</TITLE></EXTENSION><CODE>10000000031</CODE><DESCRIPTION>VEHU,ONEHUNDRED</DESCRIPTION><NAME><FAMILYNAME>VEHU</FAMILYNAME><GIVENNAME>ONEHUNDRED</GIVENNAME></NAME></CLINICIAN><STATUS><SDACODINGSTANDARD>SNOMED CT</SDACODINGSTANDARD><CODE>55561003</CODE><DESCRIPTION>ACTIVE</DESCRIPTION></STATUS><ENTEREDBY><SDACODINGSTANDARD>VA200</SDACODINGSTANDARD><CODE>10000000031</CODE><DESCRIPTION>VEHU,ONEHUNDRED</DESCRIPTION></ENTEREDBY><ENTEREDAT><SDACODINGSTANDARD>VA4</SDACODINGSTANDARD><CODE>500</CODE><DESCRIPTION>CAMP MASTER</DESCRIPTION></ENTEREDAT><ENTEREDON>2007-04-10T00:00:00</ENTEREDON><FROMTIME>2005-04-07T00:00:00</FROMTIME><EXTERNALID>644;PL</EXTERNALID></PROBLEM>"
ZZRES(3)="<PROBLEM><UPDATEDON>2005-03-17T00:00:00</UPDATEDON><EXTENSION><ISEXPOSUREAO>FALSE</ISEXPOSUREAO><ISEXPOSUREIR>FALSE</ISEXPOSUREIR><ISEXPOSUREPG>FALSE</ISEXPOSUREPG><LOCATION><SDACODINGSTANDARD>VA44</SDACODINGSTANDARD><EXTENSION><STOPCODE><SDACODINGSTANDARD>AMIS</SDACODINGSTANDARD><CODE>301</CODE><DESCRIPTION>GENERAL INTERNAL MEDICINE</DESCRIPTION></STOPCODE><SERVICE>MEDICINE</SERVICE><SPECIALTY><SDACODINGSTANDARD>VA45.7</SDACODINGSTANDARD><CODE>9</CODE><DESCRIPTION>GENERAL MEDICINE</DESCRIPTION></SPECIALTY></EXTENSION><CODE>23</CODE><DESCRIPTION>GENERAL MEDICINE</DESCRIPTION></ORGANIZATION><SDACODINGSTANDARD>VA4</SDACODINGSTANDARD><CODE>500</CODE><DESCRIPTION>CAMP MASTER</DESCRIPTION></ORGANIZATION><LOCATIONTYPE></LOCATIONTYPE></LOCATION><REMOVED>FALSE</REMOVED><ISSC>FALSE</ISSC><ONSETDATE>2005-03-17</ONSETDATE><LEXICONID>269673</LEXICONID></EXTENSION><PROBLEMDETAILS>ACUTE MYOCARDIAL INFARCTION, UNSPECIFIED SITE, EPISODE OF CARE UNSPECIFIED</PROBLEMDETAILS><PROBLEM><SDACODINGSTANDARD>ICD-9-CM</SDACODINGSTANDARD><CODE>410.90</CODE><DESCRIPTION>AMI NOS, UNSPECIFIED</DESCRIPTION></PROBLEM><CLINICIAN><SDACODINGSTANDARD>VA200</SDACODINGSTANDARD><EXTENSION><TITLE>SCHOLAR EXTRAORDINAIRE</TITLE></EXTENSION><CODE>20005</CODE><DESCRIPTION>VEHU,FOUR</DESCRIPTION><NAME><FAMILYNAME>VEHU</FAMILYNAME><GIVENNAME>FOUR</GIVENNAME></NAME><CAREPROVIDERTYPE><SDACODINGSTANDARD>X12</SDACODINGSTANDARD><EXTENSION><CLASSIFICATION>PHYSICIAN/OSTEOPATH</CLASSIFICATION></EXTENSION><CODE>203B00000N</CODE><DESCRIPTION>PHYSICIANS (M.D. AND D.O.)</DESCRIPTION></CAREPROVIDERTYPE></CLINICIAN><STATUS><SDACODINGSTANDARD>SNOMED CT</SDACODINGSTANDARD><CODE>55561003</CODE><DESCRIPTION>ACTIVE</DESCRIPTION></STATUS><ENTEREDBY><SDACODINGSTANDARD>VA200</SDACODINGSTANDARD><CODE>20005</CODE><DESCRIPTION>VEHU,FOUR</DESCRIPTION></ENTEREDBY><ENTEREDAT><SDACODINGSTANDARD>VA4</SDACODINGSTANDARD><CODE>500</CODE><DESCRIPTION>CAMP MASTER</DESCRIPTION></ENTEREDAT><ENTEREDON>2005-03-17T00:00:00</ENTEREDON><FROMTIME>2005-03-17T00:00:00</FROMTIME><EXTERNALID>495;PL</EXTERNALID></PROBLEM>"

Reviewed/Updated: May 2026