VA FileMan V. 22.2 Programmer Manual Banner


 

Main Section User Manual Advanced User Manual

Data Mapping Utility (DMU)


$$GET1^DDE(): Retrieve Single Entity File Record as JSON or XML String

Reference Type Category ICR #
Supported Data Mapping 7008
Description

The $$GET1^DDE API accepts many of the same input parameters as the GET^DDE API; however, it expects to receive a value for the id parameter to return a single record and returns a string as the results to the function.

Format
$$GET1^DDE(ENTITY[,ID][,.QUERY][,FORMAT][,ERROR_ROOT])
Input Parameters
entity(Required) The name or IEN of an ENTITY (#1.5) file.
id(Required) The identifier of the record, or input string, to be processed by the Entity.
query(name)(Optional) An array of name-value pairs passed by reference to support the Entity or refine the results (but not search), such as:
  • QUERY(“patient”) = PATIENT (#2) file IEN
  • QUERY(“notag”) = 1, to omit the leading item tag for JSON results
format(Optional) Desired format for the results:
  • 0=JSON (default).
  • 1=XML.
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
ResultsThe XML or JSON results are returned in a string as the results of the function. Any errors encountered during processing are returned in the error_root array.
Examples

To return problem IEN=940 as XML:

>W $$GET1^DDE("VPR PROBLEM",940,,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>
	

To parse and return a VistA standard name as JSON:

>W $$GET1^DDE("VPR NAME","LNAME,FNAME MI")

"NAME":{"FAMILYNAME":"LNAME", "GIVENNAME":"FNAME", "MIDDLENAME":"MI"}
	

Reviewed/Updated: May 2026