8/10/2019 Export File Name Formats

1/3

\H^_^_^^^_\H^_^_^^^_\H^_^_^^^_\H^_^_^^^_\H [] __\H^_^_^^^_

Design Spec Rev 15, section 4.16.21:21 Support for formatting export filenames

21.1 The configuration file ExportFilenameFormats.txt can be used toformat the output filenames for most exported filenames. Each non-blank line ofthe file can contain a filename format string that controls the filename formatfor a specific export type:

21.1.1 Line 1: Audit Trail PDF and TXT beat log21.1.2 Line 2: Interface PDF and XML Statistics Export (includi

ng M-Gate Export)21.1.3 Line 3: Rx XML Statistics21.1.4 Line 4: Rx XML Strips21.1.5 Line 5: Web PDF Export21.1.6 Line 6: Unipro Export

21.2 Each non-blank line of the file must contain a filename format containing one or more of the following format specifiers.

21.2.1 Directory path specifiers can be at most one of the following specifiers. Use of each of the following is mutually exclusive of the others. You can also enter an explicit path instead of a format specifier.

21.2.1.1. = the default output pathfor the file as specified in Interface.dir, XML.dir, AuditTrailPath.txt or MGateConfig.ini (as appropriate).

21.2.1.2. = the current patient directory (can be DAY2 subdirectory).21.2.1.3. = the root directory fo

r the current patient.21.2.1.4. = the root directory fo

r the current Patient List (e.g. c:\usr for the Local Computer Patient List).21.2.2 = the default filename (no path) for t

his file type, including the file extension. See section 4.16.6 above.21.2.3 = the current patient ID21.2.4 = the current patient Second ID21.2.5 = the full name ("Last, First Middl

e") for the current patient. The middle and first names are omitted if blank.21.2.6 = the current patient last name.

21.2.7 = the current patient first name.21.2.8 = the current patient middle name.21.2.9 = the current patient sex, always one of th

e three single letters: "M" = Male, "F" = Female, "U" = Unknown.21.2.10 = start date/time of the recording (or of

the strip for XML Strips) in HL7 YYYYMMDDHHMMSS format. For 48 hour combinationreport files this is the start date/time of Day 1.

21.2.11 = start date of the recording (or of the strip for XML Strips) in HL7 YYYYMMDD format. For 48 hour combination report files this is the start date of Day 1. Note that is mutually exclusive with

8/10/2019 Export File Name Formats

2/3

.21.2.12 = the date the recording was last scanned, in

HL7 YYYYMMDD format (date only).21.2.13 = the current date/time when the export

file (i.e. the Report) is created, in HL7 YYYYMMDDHHMMSS format.21.2.14 = the current date when the export file (i.

e. the Report) is created, in HL7 YYYYMMDD format. Note that < ReportDate > is mutually exclusive with < ReportDateTime >.

21.2.15 = the date of birth of the current patient,in HL7 YYYYMMDD format (date only).

21.2.16 = the name of the current Patient List.

21.2.17 = the file type indicator for the file beingcreated, including the following (see section 4.16.6 above)

21.2.17.1. PAT-STATE for audit trail files21.2.17.2. STRIP^M^# for Mortara-format XML S

trips (where # is the truncated integer duration of the strip in seconds).21.2.17.3. STRIP^F^# for FDA-format XML Strip

s21.2.17.4. STAT for XML Statistics (Rx,

Interface and M-Gate)21.2.17.5. REPORT for Interface Export and M-Gate

Export PDF files21.2.17.6. WEB for Web PDF Export to At

hena 21.2.17.7. UNIPRO for Unipro Export to E-Scribe21.2.18 = the integer value of the slot number of t

he patient directory.21.3 Note that the filename format string on each line of ExportFilen

ameFormats.txt must NOT contain a file extension (e.g. .TXT, .PDF, .XML). The file extension will be appended as appropriate for the given file being exported.This cannot configured.

21.4 Each of the format specifiers will be replaced with its associated data value.

21.4.1 Remaining text (e.g. a fixed output directory path) willbe used as is.

21.4.2 All User-entered text that is used to replace format spe

cifiers (e.g. "OConnor" for ) will be filtered to remove characters which are illegal for filenames. Note this is also true of .

21.4.2.1. Patient First, Middle and Last Name fields

21.4.2.2. Patient ID and Second ID21.4.2.3. Patient List name (e.g. "Local Computer"

)21.4.3 Illegal characters removed include:

21.4.3.1. *, ?, , |, " (double-quote), /, \, :(colon)

21.4.3.2. # is removed because it interferes withWeb page bookmark navigation.

21.4.3.3. Periods ( . ) are removed because they interfere with some parsers looking for the filename extension.

21.4.3.4. ^ and underscore ( _ ) are removed because these are the reserved separators for .

21.4.3.5. % is removed because it can potentiallycause crashes in other programs.

21.4.4 All illegal characters are replaced with a hyphen ( - ).21.5 The format specifier names are case sensitive. For example you m

ust enter and not nor , which would be ignored.

8/10/2019 Export File Name Formats

3/3

21.6 ExportFilenameFormats.txt is supported by ConfigurationFileLocations.txt and can be configured to be in c:\usr (default), any network location or Per Patient List.

21.7 ExportFilenameFormats.txt overrides the output directory specified in AuditTrailPath.txt, MGateConfig.ini, Browse.dir, XML.dir and Interface.dir unless the format specifier is used.

21.8 If ExportFilenameFormats.txt does not exist or if the line corresponding to the specified export type is blank, the default path and filename for the given export file type will be used (e.g. see section 4.16.6 above). Thisis also the equivalent of the format:

\21.9 Filename uniqueness enforcement

21.9.1 For all file types EXCEPT Web PDF, the filename createdwill be tested to see if it already exists.

21.9.2 If it does, H-Scribe will wait up to 5 seconds to allowthe tag to change. If the filename is still not unique, an error will be declared. Existing files will NOT be overwritten.

21.9.3 This behavior is designed to support the tag which includes the tag.

21.9.4 For Web PDF, however, the tag does notinclude the tag, so overwriting of existing files is allowed.

Example: specifies a fixed output directory for all exports of that export type:

\\Server\ShareName\ExportDir\

Example: changes all export filenames of that export type to be the patient full name (Last, First Middle)

\

Example: changes all exports of that export type to go to the current patient directory, with the filenames containing first name, last name, ID and recording date/time

\^^^

Example: changes all exports of that export type to go to a network dire

ctory, with the filename containing a fixed protocol name, the Patient List name, the file type\\Server\ShareName\ExportDir\ProtocolXYZ__

Example: all exports of that export type to go to a common directory specific to each Patient List

\ExportDir\