Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Info |  Desc |  Directly Accessed By Routines |  Accessed By FileMan Db Calls |  Pointed To By FileMan Files |  Pointer To FileMan Files |  Fields |  ICR |  Found Entries  | All
Print Page as PDF
Global: ^DDE

Package: VA FileMan

Global: ^DDE


Information

FileMan FileNo FileMan Filename Package
1.5 ENTITY VA FileMan

Description

Directly Accessed By Routines, Total: 9

Package Total Routines
VA FileMan 5 DDEG    DDEGET    DDEMAP    DDEPRT    DDEX    
Kernel 1 XPDIA0    
Virtual Patient Record 1 VPRHSX    

Accessed By FileMan Db Calls, Total: 1

Package Total Routines
Virtual Patient Record 1 VPRP8I    

Pointed To By FileMan Files, Total: 1

Package Total FileMan Files
VA FileMan 1 ENTITY(#1.5)[#1.51(.08)]    

Pointer To FileMan Files, Total: 2

Package Total FileMan Files
VA FileMan 2 ENTITY(#1.5)[#1.51(.08)]    APPLICATION ACTION(#1.61)[19.119.219.319.4]    

Fields, Total: 33

Field # Name Loc Type Details
.01 NAME 0;1 FREE TEXT
************************REQUIRED FIELD************************

  • INPUT TRANSFORM:  K:$L(X)>30!($L(X)<3)!'(X'?1P.E) X
    MAXIMUM LENGTH: 30
  • LAST EDITED:  APR 12, 2018
  • HELP-PROMPT:  Answer must be 3-30 characters in length.
  • DESCRIPTION:  
    The name of the entity or resource this record will represent.
  • CROSS-REFERENCE:  1.5^B
    1)= S ^DDE("B",$E(X,1,30),DA)=""
    2)= K ^DDE("B",$E(X,1,30),DA)
.02 DEFAULT FILE NUMBER 0;2 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>999999999999)!(X<.1)!(X?.E1"."9N.N)!'($D(^DD(+X,0))#2) X
  • LAST EDITED:  APR 18, 2018
  • HELP-PROMPT:  Enter the file number associated with this entity, between .1 and 999999999999.
  • DESCRIPTION:  
    This is the primary file or sub-file number associated with this entity, and the default source file for data. It is optional if no data associated with this entity is stored in any FileMan file.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
  • CROSS-REFERENCE:  1.5^F
    1)= S ^DDE("F",$E(X,1,30),DA)=""
    2)= K ^DDE("F",$E(X,1,30),DA)
    Allows finding Entities by primary file number
  • RECORD INDEXES:  FHIR (#1536), SDA (#1537)
.03 SORT BY 0;3 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>15!($L(X)<1) X
    MAXIMUM LENGTH: 15
  • LAST EDITED:  MAR 05, 2018
  • HELP-PROMPT:  Answer must be 1-15 characters in length.
  • DESCRIPTION:  This is the default cross reference to use when GETting instances of this entity or resource; it may be overridden by the XREF field in the Item multiple when this entity is embedded inside another, or by other query
    parameters.
.04 FILTER BY 0;4 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>8!($L(X)<1) X
    MAXIMUM LENGTH: 8
  • LAST EDITED:  MAR 05, 2018
  • HELP-PROMPT:  Answer must be 1-8 characters in length.
  • DESCRIPTION:  Enter the name of a local variable that contains the value to filter entries by using the specified cross reference. See the FileMan Developer's Guide for a list of variables that will be available to use (read only).
    Other variables can be set and killed by the Entity's GET Pre and Post Processing code fields.
.05 READ ONLY 0;5 SET
  • '1' FOR READONLY;

  • LAST EDITED:  JUL 20, 2018
  • HELP-PROMPT:  Enter 1 to set the read only flag for ENTITY.
  • DESCRIPTION:  
    Set this flag if this entity is read only. It will then not support the create, post, or put http verbs.
.06 DATA MODEL 0;6 SET
  • 'S' FOR SDA;
  • 'F' FOR FHIR;

  • LAST EDITED:  APR 18, 2018
  • HELP-PROMPT:  Enter the data model that this entity represents.
  • DESCRIPTION:  
    If this entity is intended to return data according to the constraints of a specific model, such as SDA or FHIR, then enter that here.
  • RECORD INDEXES:  FHIR (#1536), SDA (#1537)
.1 DISPLAY NAME .1;1 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>80!($L(X)<1) X
    MAXIMUM LENGTH: 80
  • LAST EDITED:  APR 18, 2018
  • HELP-PROMPT:  Answer must be 1-80 characters in length.
  • DESCRIPTION:  
    This is the name that will be used for the XML or JSON tags. If no value is entered here, the Name (.01) field will be used.
  • RECORD INDEXES:  FHIR (#1536), SDA (#1537)
1 ITEM 1;0 Multiple #1.51 1.51

  • LAST EDITED:  FEB 09, 2018
  • DESCRIPTION:  
    The Items multiple defines the data elements that make up the entity.
1.1 KEY ITEM ID;1 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>100!($L(X)<2) X
  • LAST EDITED:  SEP 03, 2015
  • HELP-PROMPT:  Answer must be 2-100 characters in length.
  • DESCRIPTION:  
    The item that is the key value of this entity.
1.2 KEY FIELD NUMBER ID;2 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>999999999999)!(X<.01)!(X?.E1"."10N.N) X
  • LAST EDITED:  SEP 03, 2015
  • HELP-PROMPT:  Type a number between .01 and 999999999999, 9 decimal digits.
  • DESCRIPTION:  
    The field number associated with the item that is the key to the entity.
1.3 KEY CODSYS ID;3 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>20!($L(X)<2) X
  • LAST EDITED:  SEP 03, 2015
  • HELP-PROMPT:  Answer must be 2-20 characters in length.
  • DESCRIPTION:  
    The coding system associated with the key.
1.4 KEY XREF ID;4 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>20!($L(X)<1) X
  • LAST EDITED:  SEP 03, 2015
  • HELP-PROMPT:  Answer must be 1-20 characters in length.
  • DESCRIPTION:  
    The name of the item that is the alternate key to the entity type.
2 GET ENTRY ACTION 2;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  MAY 22, 2019
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  This is code that will be executed prior to any other processing for the GET method. If you set any additional variables here for use inside the Entity, remember to kill them in the GET POST PROCESSING.
    If this Entity is being processed inside another one, the local variable ID holds the string that the parent entity will be passing into this one (i.e., a pointer from a field value that is being expanded into a full coded
    element by this entity).
    WRITE AUTHORITY: @
3 GET EXIT ACTION 3;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  MAY 22, 2019
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  
    This is code that will be executed after all other processing for the GET method. Be sure to kill any variables set in the GET PRE PROCESSING field.
    WRITE AUTHORITY: @
4 GET ID ACTION 4;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  MAY 22, 2019
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  This is code that will be executed for each record, to identify or validate it. Local variable DIEN contains the id value or string passed into this Entity to operate on.
    Set DDEOUT=1 to skip or omit this entire record from the results.
    WRITE AUTHORITY: @
5 GET QUERY ROUTINE 5;E1,99 FREE TEXT (LABEL REFERENCE Data Type)

  • LAST EDITED:  MAR 07, 2018
  • HELP-PROMPT:  Enter the tag^routine to be used in place of FIND^DIC for this Entity.
  • DESCRIPTION:  Enter the tag^routine to be used for finding the appropriate records in the VistA primary source file, instead of FIND^DIC. This routine should create the array DLIST(#)=ID, where # is a sequential number and ID is a
    string that identifies a record in the Default File. ID may also be a string that is processed by this entity.
    Local variables that may be referenced and used (not changed or killed) include: DFN = Patient file #2 ien
    DSTRT = Start date.time of search (FileMan format)
    DSTOP = Stop date.time of search (FileMan format)
    DMAX = Maximum number of results to return
5.1 SCREEN 5.1;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  MAR 03, 2018
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  
    This is Standard MUMPS code that will set DIC('S') for a screen, to be used in a FIND^DIC query.
    WRITE AUTHORITY: @
6 PUT ENTRY ACTION 6;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  MAY 22, 2019
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  
    This is code that will be executed prior to any other processing for the PUT method.
    WRITE AUTHORITY: @
7 PUT EXIT ACTION 7;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  MAY 22, 2019
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  
    This is code that will be executed after all other processing for the PUT method.
    WRITE AUTHORITY: @
8 PUT ID ACTION 8;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  MAY 22, 2019
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  
    This is code that will be executed for each record, to identify or validate it.
    WRITE AUTHORITY: @
10 PUT CREATE ACTION 10;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  MAY 22, 2019
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  
    This is code that will be executed whenever a new record is created via the PUT method.
    WRITE AUTHORITY: @
11 DELETE ENTRY ACTION 11;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  MAY 22, 2019
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  
    This is code that will be executed prior to any other processing for the DELETE method.
    WRITE AUTHORITY: @
12 DELETE EXIT ACTION 12;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  MAY 22, 2019
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  
    This is code that will be executed after all other processing for the DELETE method.
    WRITE AUTHORITY: @
13 DELETE ID ACTION 13;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  MAY 22, 2019
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  
    This is code that will be executed for each record, to identify or validate it.
    WRITE AUTHORITY: @
14 POST ENTRY ACTION 14;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  MAY 22, 2019
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  
    This is code that will be executed prior to any other processing for the POST method.
    WRITE AUTHORITY: @
15 POST EXIT ACTION 15;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  MAY 22, 2019
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  
    This is code that will be executed after all other processing for the POST method.
    WRITE AUTHORITY: @
16 POST ID ACTION 16;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  MAY 22, 2019
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  
    This is code that will be executed for each record, to identify or validate it.
    WRITE AUTHORITY: @
18 POST CREATE ACTION 18;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  MAY 22, 2019
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  
    This is code that will be executed whenever a new record is created via the POST method.
    WRITE AUTHORITY: @
19 DESCRIPTION 19;0 WORD-PROCESSING #1.519
19.1 GET POLICY DAC;1 POINTER TO APPLICATION ACTION FILE (#1.61) APPLICATION ACTION(#1.61)

  • LAST EDITED:  MAR 20, 2017
  • HELP-PROMPT:  Select the equivalent Application Action to GET instances of this Entity.
  • DESCRIPTION:  This field points to the Application Action #1.61 entry which is the VistA equivalent of the GET method for the Entity. The Application Action is linked to a Data Access Control Policy in file #1.6. This policy will be
    evaluated when a GET request is made for this Entity, to determine if the user or client is authorized to access the data.
19.2 PUT POLICY DAC;2 POINTER TO APPLICATION ACTION FILE (#1.61) APPLICATION ACTION(#1.61)

  • LAST EDITED:  MAR 20, 2017
  • HELP-PROMPT:  Select the equivalent Application Action to PUT an instance of this Entity.
  • DESCRIPTION:  This field points to the Application Action #1.61 entry which is the VistA equivalent of the PUT method for the Entity. The Application Action is linked to a Data Access Control Policy in file #1.6. This policy will be
    evaluated when a PUT request is made for this Entity, to determine if the user or client is authorized to access the data.
19.3 DELETE POLICY DAC;3 POINTER TO APPLICATION ACTION FILE (#1.61) APPLICATION ACTION(#1.61)

  • LAST EDITED:  MAR 20, 2017
  • HELP-PROMPT:  Select the equivalent Application Action to DELETE an instance of this Entity.
  • DESCRIPTION:  This field points to the Application Action #1.61 entry which is the VistA equivalent of the DELETE method for the Entity. The Application Action is linked to a Data Access Control Policy in file #1.6. This policy will be
    evaluated when a DELETE request is made for this Entity, to determine if the user or client is authorized to access the data.
19.4 POST POLICY DAC;4 POINTER TO APPLICATION ACTION FILE (#1.61) APPLICATION ACTION(#1.61)

  • LAST EDITED:  MAR 20, 2017
  • HELP-PROMPT:  Select the equivalent Application Action to POST an instance of this Entity.
  • DESCRIPTION:  This field points to the Application Action #1.61 entry which is the VistA equivalent of the POST method for the Entity. The Application Action is linked to a Data Access Control Policy in file #1.6. This policy will be
    evaluated when a POST request is made for this Entity, to determine if the user or client is authorized to access the data.

Found Entries, Total: 151

NAME: VPR PATIENT ID    NAME: VPR INSURANCE    NAME: VPR INSURANCE PLAN    NAME: VPR INSURANCE COMPANY    NAME: VPR INS GROUP NAME    NAME: VPR NAME    NAME: VPR FACILITY    NAME: VPR USER    
NAME: VPR PROVIDER    NAME: VPR ICD    NAME: VPR PROBLEM    NAME: VPR LOINC    NAME: VPR LAB ORDER    NAME: VPR DISPLAY GROUP    NAME: VPR ORDERABLE ITEM    NAME: VPR LAB URGENCY    
NAME: VPR LRCH RESULT    NAME: VPR LRCH RESULT ITEM    NAME: VPR LAB TEST    NAME: VPR PATIENT    NAME: VPR PATIENT ALIAS    NAME: VPR LANGUAGE    NAME: VPR RACE    NAME: VPR PATIENT ADDRESS    
NAME: VPR STATE    NAME: VPR ETHNICITY    NAME: VPR RELIGION    NAME: VPR MARITAL STATUS    NAME: VPR VISIT    NAME: VPR LOCATION    NAME: VPR ALLERGY    NAME: VPR DOCUMENT    
NAME: VPR ALLERGY SIGN/SYMPTOM    NAME: VPR RAD ORDER    NAME: VPR OTHER ORDER    NAME: VPR ORDER URGENCY    NAME: VPR RAD RESULT    NAME: VPR ADVANCE DIRECTIVE    NAME: VPR DOCUMENT TITLE    NAME: VPR APPOINTMENT    
NAME: VPR VITAL MEASUREMENT    NAME: VPR VITAL TYPE    NAME: VPR V EXAM    NAME: VPR EXAM    NAME: VPR FAMILY HISTORY    NAME: VPR HEALTH FACTOR    NAME: VPR SOCIAL HISTORY    NAME: VPR REFERRAL    
NAME: VPR CONSULT SERVICE    NAME: VPR SURGERY    NAME: VPR PROCEDURE    NAME: VPR V PROVIDER    NAME: VPR VITAL QUALIFIER    NAME: VPR PATIENT RECORD FLAG    NAME: VPR PTF    NAME: VPR MEDICATION    
NAME: VPR DOSAGE STEP    NAME: VPR DRUG PRODUCT    NAME: VPR VACCINATION    NAME: VPR MED ROUTE    NAME: VPR IMMUNIZATION    NAME: VPR IMM ROUTE    NAME: VPR IMM ADMINISTRATION    NAME: VPR IMM SITE    
NAME: VPR INSURED ADDRESS    NAME: VPR COUNTRY    NAME: VPR INS COMPANY ADDRESS    NAME: VPR PERSON CLASS    NAME: VPR CODE TABLE    NAME: VPR PATIENT NUMBER    NAME: VPR PATIENT BIRTHPLACE    NAME: VPR PATIENT NOK    
NAME: VPR PATIENT NOK ADDRESS    NAME: VPR PATIENT ECON    NAME: VPR PATIENT ECON ADDRESS    NAME: VPR PATIENT EMPLOYER    NAME: VPR PATIENT EMPLOYER ADDRESS    NAME: VPR SPECIALTY    NAME: VPR ADMISSION    NAME: VPR DOCUMENT STATUS    
NAME: VPR CODE ONLY    NAME: VPR CW NOTES    NAME: VPR MED ADMINISTRATION    NAME: VPR LRAP REPORT    NAME: VPR PREGNANCY    NAME: VPR CPT    NAME: VPR V CPT    NAME: VPR V POV    
NAME: VPR RAD REPORT    NAME: VPR LRMI REPORT    NAME: VPR SCHEDULED ADMISSION    NAME: VPR DRUG CLASS    NAME: VPR DRUG GENERIC    NAME: VPR IV PRODUCT    NAME: VPR PATIENT EXTENSION    NAME: VPR PATIENT ELIGIBILITY    
NAME: VPR PATIENT DISABILITY    NAME: VPR PERSON CLASS EXTENSION    NAME: VPR LOCATION EXTENSION    NAME: VPR COMMENT    NAME: VPR ALLERGY EXTENSION    NAME: VPR DRUG INGREDIENT    NAME: VPR VISIT EXTENSION    NAME: VPR ADMISSION EXTENSION    
NAME: VPR APPOINTMENT EXTENSION    NAME: VPR PRF EXTENSION    NAME: VPR PROBLEM EXTENSION    NAME: VPR PTF EXTENSION    NAME: VPR DOCUMENT EXTENSION    NAME: VPR DOCUMENT ROLE    NAME: VPR DOCUMENT SERVICE    NAME: VPR DOCUMENT SETTING    
NAME: VPR DOCUMENT SUBJECT    NAME: VPR DOCUMENT TYPE    NAME: VPR ORDER EXTENSION    NAME: VPR LRCH RESULT EXTENSION    NAME: VPR RAD RESULT EXTENSION    NAME: VPR PROCEDURE EXTENSION    NAME: VPR SURGERY EXTENSION    NAME: VPR REFERRAL EXTENSION    
NAME: VPR HF EXTENSION    NAME: VPR MED EXTENSION    NAME: VPR MED FILL    NAME: VPR IMM EXTENSION    NAME: VPR IMM VIS    NAME: VPR VITAL EXTENSION    NAME: VPR CPT MODIFIER    NAME: VPR ALLERGY ASSESSMENT    
NAME: VPR RAD RPT EXTENSION    NAME: VPR LRAP EXTENSION    NAME: VPR LRMI EXTENSION    NAME: VPR SIGNER    NAME: VPR FIM    NAME: VPR CUSTOM PAIR    NAME: VPR HEALTH CONCERN    NAME: VPR FIM EXTENSION    
NAME: VPR ORDER STATUS    NAME: VPR AMIS    NAME: VPR TEAM MEMBER    NAME: VPR FACILITY ADDRESS    NAME: VPR FAMILY DOCTOR    NAME: VPR PROVIDER EXTENSION    NAME: VPR PATIENT LANGUAGE    NAME: VPR SOURCE FACILITY    
NAME: VPR LRSP RESULT    NAME: VPR LRCY RESULT    NAME: VPR LREM RESULT    NAME: VPR LRMI RESULT    NAME: VPR LR RESULT EXTENSION    NAME: VPR P24 MED EXTENSION    NAME: VPR P24 MEDICATION    

ICR, Total: 1

ICR LINK Subscribing Package(s) Fields Referenced Description
ICR #7008
Info |  Desc |  Directly Accessed By Routines |  Accessed By FileMan Db Calls |  Pointed To By FileMan Files |  Pointer To FileMan Files |  Fields |  ICR |  Found Entries  | All