STANDARD DATA DICTIONARY #1.5 -- ENTITY FILE 6/27/25 PAGE 1
STORED IN ^DDE( (265 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 22.2)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
The ENTITY (#1.5) file maps VistA data to entities or resources, which can be exposed RESTfully to standard web methods and
formats. It can support various data models such as Fast Healthcare Interoperability Resources (FHIR) or Intersystems' Summary
Document Architecture (SDA).
DD ACCESS: @
RD ACCESS: @
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
IDENTIFIED BY:
"W.06": W " ",@("$P($P($C(59)_$S($D(^DD(1.5,.06,0)):$P(^(0),U,3),1:0)_$E("_DIC_"Y,0),0),$C(59)_$P(^(0),U,6)_"":"",2),$C(59
),1)")
POINTED TO BY: ENTITY field (#.08) of the ITEM sub-field (#1.51) of the ENTITY File (#1.5)
ENTITY field (#.03) of the VPR CONTAINER File (#560.1)
UPDATE ENTITY field (#.02) of the SOURCE FILE sub-field (#560.11) of the VPR CONTAINER File (#560.1)
DELETE ENTITY field (#.03) of the SOURCE FILE sub-field (#560.11) of the VPR CONTAINER File (#560.1)
CROSS
REFERENCED BY: ENTITY(AD), NAME(B), DEFAULT FILE NUMBER(F)
INDEXED BY: DATA MODEL & DISPLAY NAME & DEFAULT FILE NUMBER (FHIR), DATA MODEL & DISPLAY NAME & DEFAULT FILE NUMBER (SDA)
LAST MODIFIED: NOV 23,2022@17:17:35
1.5,.01 NAME 0;1 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>30!($L(X)<3)!'(X'?1P.E) X I $D(X) D CHKNAME^DDEX
MAXIMUM LENGTH: 30
LAST EDITED: NOV 08, 2021
HELP-PROMPT: A unique name, which is preceded by the package abbreviation. Answer must be 3-30 characters in
length.
DESCRIPTION: A unique name of the entity or resource this record will represent. The name must be preceded by
its package prefix (2 to 4 characters) specified in the PACKAGE file, or the letter "Z" or "A".
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 1.5^B
1)= S ^DDE("B",$E(X,1,30),DA)=""
2)= K ^DDE("B",$E(X,1,30),DA)
1.5,.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)
1.5,.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.
1.5,.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.
1.5,.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.
1.5,.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.5,.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.5,1 ITEM 1;0 Multiple #1.51
LAST EDITED: FEB 09, 2018
DESCRIPTION:
The Items multiple defines the data elements that make up the entity.
1.51,.01 ITEM 0;1 FREE TEXT (Multiply asked)
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)
1.51,.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
1.51,.03 ITEM TYPE 0;3 SET (Required)
'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
1.51,.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
1.51,.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
1.51,.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.
1.51,.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.
1.51,.08 ENTITY 0;8 POINTER TO ENTITY FILE (#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.
1.51,.09 WORD WRAP 0;9 SET (BOOLEAN Data Type)
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.51,.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)
1.51,.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.51,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.51,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.51,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.51,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.51,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.51,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.51,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: @
1.51,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.
1.51,3 COMPLEX TYPE 3;0 Multiple #1.513
DESCRIPTION:
This field allows an Item to return a group of fields or data elements.
IDENTIFIED BY: COMPLEX ITEM NAME(#.02)
1.513,.01 COMPLEX ITEM SEQUENCE 0;1 NUMBER (Multiply asked)
INPUT TRANSFORM: K:+X'=X!(X>999)!(X<1)!(X?.E1"."4N.N) X
LAST EDITED: FEB 08, 2018
HELP-PROMPT: Type a number between 1 and 999, 3 decimal digits.
DESCRIPTION:
This is the sequence in which to process these items within the group.
CROSS-REFERENCE: 1.513^B
1)= S ^DDE(DA(2),1,DA(1),3,"B",$E(X,1,30),DA)=""
2)= K ^DDE(DA(2),1,DA(1),3,"B",$E(X,1,30),DA)
1.513,.02 COMPLEX ITEM NAME 0;2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>80!($L(X)<1) X
MAXIMUM LENGTH: 80
LAST EDITED: FEB 28, 2018
HELP-PROMPT: Answer must be 1-80 characters in length.
DESCRIPTION:
Enter the name of an Item that will be processed as part of this complex group.
1.513,.03 SIMPLE TYPE FIELD NUMBER 0;3 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999999999999)!(X<.001)!(X?.E1"."10N.N) X
LAST EDITED: SEP 03, 2015
HELP-PROMPT: Type a number between .001 and 999999999999, 9 decimal digits.
DESCRIPTION:
The field number of the simple item that you want to map to a complex type.
1.51,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: @
1.51,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: @
1.51,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: @
1.51,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: @
1.51,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: @
1.5,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.5,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.5,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.5,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.
1.5,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: @
1.5,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: @
1.5,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: @
1.5,5 GET QUERY ROUTINE 5;E1,99 FREE TEXT (LABEL REFERENCE Data Type)
PROPERTY: PARAMETERS ALLOWED (Value = 1)
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
1.5,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: @
1.5,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: @
1.5,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: @
1.5,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: @
1.5,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: @
1.5,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: @
1.5,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: @
1.5,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: @
1.5,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: @
1.5,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: @
1.5,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: @
1.5,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: @
1.5,19 DESCRIPTION 19;0 WORD-PROCESSING #1.519 (IGNORE "|")
LAST EDITED: APR 12, 2018
HELP-PROMPT: Enter a description of this Entity, for documentation.
DESCRIPTION: This is a description of the Entity, to document its usage or data sources or any other
information that is helpful for maintenance.
1.5,19.1 GET POLICY DAC;1 POINTER ***** TO AN UNDEFINED FILE (#1.61), STORED IN ^DIAC(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.
1.5,19.2 PUT POLICY DAC;2 POINTER ***** TO AN UNDEFINED FILE (#1.61), STORED IN ^DIAC(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.
1.5,19.3 DELETE POLICY DAC;3 POINTER ***** TO AN UNDEFINED FILE (#1.61), STORED IN ^DIAC(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.
1.5,19.4 POST POLICY DAC;4 POINTER ***** TO AN UNDEFINED FILE (#1.61), STORED IN ^DIAC(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.
FILES POINTED TO FIELDS
ENTITY (#1.5) ITEM:ENTITY (#.08)
}UNDEFINED FILE (#1.61) GET POLICY (#19.1)
PUT POLICY (#19.2)
DELETE POLICY (#19.3)
POST POLICY (#19.4)
File #1.5
Record Indexes:
FHIR (#1536) RECORD REGULAR IR LOOKUP & SORTING
Short Descr: FHIR
Description: Retrieve FHIR Entities by Display Name, File#
Set Logic: S ^DDE("FHIR",$E(X(2),1,30),X(3),DA)=""
Set Cond: S X=(X="F")
Kill Logic: K ^DDE("FHIR",$E(X(2),1,30),X(3),DA)
Kill Cond: S X=(X="F")
Whole Kill: K ^DDE("FHIR")
X(1): DATA MODEL (1.5,.06)
X(2): DISPLAY NAME (1.5,.1) (Subscr 1) (Len 30) (forwards)
X(3): DEFAULT FILE NUMBER (1.5,.02) (Subscr 2) (forwards)
SDA (#1537) RECORD REGULAR IR LOOKUP & SORTING
Short Descr: SDA
Description: Retrieve SDA Entities by Display Name, File#
Set Logic: S ^DDE("SDA",$E(X(2),1,30),X(3),DA)=""
Set Cond: S X=(X="S")
Kill Logic: K ^DDE("SDA",$E(X(2),1,30),X(3),DA)
Kill Cond: S X=(X="S")
Whole Kill: K ^DDE("SDA")
X(1): DATA MODEL (1.5,.06)
X(2): DISPLAY NAME (1.5,.1) (Subscr 1) (Len 30) (forwards)
X(3): DEFAULT FILE NUMBER (1.5,.02) (Subscr 2) (forwards)
INPUT TEMPLATE(S):
DDE EDIT ENTITY FEB 28, 2018@21:10 USER #0
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):
DDE ENTITY ENTER/EDIT MAR 06, 2018@14:34 USER #0
DDE ENTITY HEADER DD #1.5
DDE ENTITY 1 DD #1.5
DDE ITEMS DD #1.51
DDE ENTITY 2 DD #1.5
DDE ENTITY 3 DD #1.5
DDE ITEM FIXED DD #1.51
DDE ITEM ID DD #1.51
DDE ITEM SIMPLE DD #1.51
DDE ITEM WORD PROC DD #1.51
DDE ITEM COMPLEX DD #1.51
DDE COMPLEX LIST DD #1.513
DDE ITEM ENTITY DD #1.51
DDE ITEM LIST DD #1.51
DDE LIST FILE DD #1.51
DDE LIST COMPLEX DD #1.51
DDE LIST COMPLEX ITEMS DD #1.513