Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Info |  Details
Print Page as PDF
Sub-Field: 1.51

Package: VA FileMan

ENTITY(#1.5)-->1.51

Sub-Field: 1.51


Information

Parent File Name Number Package
ENTITY(#1.5) ITEM 1.51 VA FileMan

Details

Field # Name Loc Type Details
.01 ITEM 0;1 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>80!($L(X)<1) X
    MAXIMUM LENGTH: 80
  • LAST EDITED:  FEB 08, 2018
  • HELP-PROMPT:  Answer must be 1-80 characters in length.
  • DESCRIPTION:  
    This is the name of the Item, which will be used as the XML or JSON tag.
  • CROSS-REFERENCE:  1.51^B
    1)= S ^DDE(DA(1),1,"B",$E(X,1,60),DA)=""
    2)= K ^DDE(DA(1),1,"B",$E(X,1,60),DA)
.02 SEQUENCE 0;2 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>999)!(X<.001)!(X?.E1"."4N.N) X
  • LAST EDITED:  FEB 09, 2018
  • HELP-PROMPT:  Type a number between .001 and 999, 3 decimal digits.
  • DESCRIPTION:  
    This field defines the sequence in which to process top-level items; leave this blank for Items that will be processed via the Complex Fields group.
  • CROSS-REFERENCE:  1.51^SEQ
    1)= S ^DDE(DA(1),1,"SEQ",$E(X,1,30),DA)=""
    2)= K ^DDE(DA(1),1,"SEQ",$E(X,1,30),DA)
    Allows traversal of Items by Sequence
.03 ITEM TYPE 0;3 SET
************************REQUIRED FIELD************************
  • 'I' FOR ID;
  • 'F' FOR FIXED STRING;
  • 'S' FOR SIMPLE FIELD;
  • 'C' FOR COMPLEX GROUP;
  • 'E' FOR ENTITY;
  • 'L' FOR LIST;
  • 'W' FOR WORD PROCESSING;

  • LAST EDITED:  MAR 12, 2018
  • HELP-PROMPT:  Select the XML or JSON element type for this item.
  • DESCRIPTION:  This is the type of element for this Item. It describes how to find the source data in VistA, as well as its structure in the XML or JSON results:
    I = record ID
    F = fixed string
    S = simple VistA field
    C = complex field (group of items)
    E = embedded entity
    L = list of simple fields, items, or entities
    W = word processing VistA field
.04 FILE NUMBER 0;4 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>999999999999)!(X<.1)!(X?.E1"."9N.N)!'($D(^DD(+X,0))#2) X
  • LAST EDITED:  APR 12, 2018
  • HELP-PROMPT:  Enter the number of the VistA file containing the data for this Item, between .1 and 999999999999.
  • DESCRIPTION:  
    Enter the VistA file or sub-file number containing the data value(s) for this Item. Note that the IEN may need to be modified if this differs from the Entity's Default File Number.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
.05 FIELD NUMBER 0;5 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>999999999999)!(X<.001)!(X?.E1"."9N.N) X
  • LAST EDITED:  MAR 19, 2018
  • HELP-PROMPT:  Enter the field number that holds the data, between .001 and 999999999999.
  • DESCRIPTION:  
    This is the number of a field in the File that is the source of the data for this Item.
  • EXECUTABLE HELP:  D FLDLST^DDEX
.06 EXTENDED POINTER LKUP 0;6 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>999999999999)!(X<.001)!(X?.E1"."9N.N) X
  • LAST EDITED:  MAR 13, 2018
  • HELP-PROMPT:  Enter a field number in the pointed-to file, between .001 and 999999999999.
  • DESCRIPTION:  
    This is the number of a field in the pointed-to file to return as the resolved external value, instead of the .01 field.
.07 RETURN INTERNAL VALUE 0;7 SET
  • '1' FOR YES;

  • LAST EDITED:  FEB 28, 2018
  • HELP-PROMPT:  Enter YES to return the internal form of the value for this Item.
  • DESCRIPTION:  
    Set this to YES if the value of this item should remain in internal format; the default is to return the external format.
.08 ENTITY 0;8 POINTER TO ENTITY FILE (#1.5) ENTITY(#1.5)

  • INPUT TRANSFORM:  D TREE^DDEX
  • LAST EDITED:  MAR 15, 2018
  • HELP-PROMPT:  Select an Entity to evaluate as the value for this Item; an ancestor may not be selected as an item.
  • DESCRIPTION:  
    Enter the name of an Entity whose value should be constructed and returned as the value for this Item. A parent or ancestor of this Entity may not be used as a descendant item.
  • NOTES:  XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
  • CROSS-REFERENCE:  1.5^AD
    1)= S ^DDE("AD",$E(X,1,30),DA(1),DA)=""
    2)= K ^DDE("AD",$E(X,1,30),DA(1),DA)
    For Input Transform, to look back up the tree and ensure item is not an ancestor.
.09 WORD WRAP 0;9 SET (BOOLEAN Data Type)
  • If this value is YES, the text will be returned without carriage returns or line feeds so the client can allow the text to wrap; the default is No, which will insert CR-LF characters between lines.

  • LAST EDITED:  MAY 18, 2018
  • HELP-PROMPT:  Enter YES if this text should be returned in word-wrap mode, without carriage returns.
  • DESCRIPTION:  
    If this value is YES, the text will be returned without carriage returns or line feeds so the client can allow the text to wrap; the default is No, which will insert CR-LF characters between lines.
.1 MAXIMUM WORD SIZE 0;10 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>2999999)!(X<100)!(X?.E1"."1N.N) X
  • LAST EDITED:  APR 14, 2021
  • HELP-PROMPT:  Type a number between 100 and 2999999, 0 decimal digits.
  • DESCRIPTION:  This is the maximum limit on the number of characters that a Word Processing field will return. If a Word Processing field value exceeds this limit, an error message will be returned instead of the value. The error
    message is taken from WORD ERROR MESSAGE field (#.11)
.11 WORD ERROR MESSAGE 0;11 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>60!($L(X)<3) X
    MAXIMUM LENGTH: 60
  • LAST EDITED:  APR 14, 2021
  • HELP-PROMPT:  Answer must be 3-60 characters in length.
  • DESCRIPTION:  
    This is the error message that will be returned if a Word Processing field value exceeds the MAXIMUM WORD SIZE field (#.09) value.
1.01 LIST TYPE 1;1 SET
  • '1' FOR FILE;
  • '2' FOR SUBFILE;
  • '3' FOR COMPLEX;
  • '4' FOR ARRAY;

  • LAST EDITED:  FEB 06, 2018
  • HELP-PROMPT:  Select the source of the instances for this list.
  • DESCRIPTION:  
    Select the source of this Item's values, if the list instances will come from a file, sub-file, the Complex Fields group, or an array created by the GET ACTION (#6) field logic.
1.02 XML NAME 1;2 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>60!($L(X)<1) X
    MAXIMUM LENGTH: 60
  • LAST EDITED:  MAR 15, 2018
  • HELP-PROMPT:  Answer must be 1-60 characters in length.
  • DESCRIPTION:  
    Enter the name to be used for the tags around this Item when returning XML, for each entry in the list. If this Item is an entity, its Display Name will be the default but this name will override it if defined.
1.03 XREF 1;3 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>15!($L(X)<1) X
    MAXIMUM LENGTH: 15
  • LAST EDITED:  FEB 06, 2018
  • HELP-PROMPT:  Answer must be 1-15 characters in length.
  • DESCRIPTION:  
    If this list is coming from a file, enter the cross reference to be used to find the desired records.
1.04 FILTER BY 1;4 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>8!($L(X)<1) X
    MAXIMUM LENGTH: 8
  • LAST EDITED:  FEB 06, 2018
  • HELP-PROMPT:  Answer must be 1-8 characters in length.
  • DESCRIPTION:  If this list is coming from a file, you may 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 may be created in the GET ACTION (#6) code field; these should be killed in the Entity's GET EXIT ACTION (#3) field.
1.06 OVERWRITE SUBFILE 1;6 SET
  • '1' FOR YES;
  • '0' FOR NO;

  • LAST EDITED:  APR 13, 2017
  • HELP-PROMPT:  If the item represents the .01 of a multiple and you don't want to replace not append data then set this flag to yes.
  • DESCRIPTION:  
    If the Item represents the .01 of a multiple field, set this flag to YES if you want to replace the existing sub-file with the values in the incoming message rather than append the values on a PUT.
1.07 VUID PREFIX 1;7 SET
  • 'VUID' FOR VUID;

  • LAST EDITED:  APR 13, 2017
  • HELP-PROMPT:  Select 'VUID' if this item is referenced by VUID.
  • DESCRIPTION:  
    If this item is referenced by VUID then specify this prefix. A VUID is a unique key assigned by terminology service during data standardization, so this field flags items that should look up based on VUID.
1.1 SCREEN 1.1;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  FEB 06, 2018
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  
    This is standard MUMPS code that should set DIC('S') for a screen.
    WRITE AUTHORITY: @
2 FIXED RESPONSE 2;1 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>80!($L(X)<1) X
    MAXIMUM LENGTH: 80
  • LAST EDITED:  FEB 06, 2018
  • HELP-PROMPT:  Answer must be 1-80 characters in length.
  • DESCRIPTION:  
    Enter static text that should always be returned as the value of this Item.
3 COMPLEX TYPE 3;0 Multiple #1.513 1.513

  • DESCRIPTION:  
    This field allows an Item to return a group of fields or data elements.
  • IDENTIFIED BY:  COMPLEX ITEM NAME(#.02)
4 OUTPUT TRANSFORM 4;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  FEB 06, 2018
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  This is code that will be executed after extracting the data value, that may be used to re-format it for XML or JSON. It expects the variable VALUE to contain the current form of this property's value, and should leave
    VALUE set to the desired form (for example, S VALUE=+VALUE). If the value should be omitted, set VALUE to null.
    WRITE AUTHORITY: @
5 INPUT TRANSFORM 5;E1,245 MUMPS

  • INPUT TRANSFORM:  K:$L(X)>245 X D:$D(X) ^DIM
  • LAST EDITED:  FEB 06, 2018
  • HELP-PROMPT:  This is Standard MUMPS code.
  • DESCRIPTION:  
    This is code that will be executed after extracting the data value from an incoming resource, to re-format it for saving in VistA.
    WRITE AUTHORITY: @
6 GET 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 when extracting this item from VistA. It may do additional set up tasks for non-simple elements, or even create the return value itself for simple fields that cannot be pulled
    directly from VistA.
    At the time this code is executed within ^DDE, the following variables may be referenced:
    TAG = name of property (XML or JSON tag)
    IEN = internal entry number of record, or the string being processed
    FILE = VistA source sub/file number
    FIELD = VistA source field number
    The variable VALUE may be returned as the value of this property. If VALUE is not set here, then $$GET1^DIQ will be called using the Item's properties to determine a value.
    If a value for this Item cannot or should not be returned, set DDEOUT=1 to cause ^DDE to quit the item and go on to the next one.
    WRITE AUTHORITY: @
7 PUT 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:  
    For the PUT method, you may add logic for each item to set the value, transform, validate, or enforce business logic.
    WRITE AUTHORITY: @
8 POST 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:  
    For the POST method, you may add logic for each Item to set the value, transform, validate, or enforce business logic.
    WRITE AUTHORITY: @
Info |  Details