Mapping Document Types for Advanced Document Import - HL7 Module - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Essential - Standard - Premier

HL7 Module
Platform
OnBase
Product
HL7 Module
Release
Foundation 23.1
License
Essential
Standard
Premier

Advanced Document Import can assign Document Types to documents based on values in the corresponding HL7 messages. When $$DOCTYPE or $$FILEEXT is mapped as a default value in the HL7 message template, Advanced Document Import can use values provided in that field to identify the appropriate Document Types.

When creating an advanced document import process, the following must be taken into consideration when $$DOCTYPE or $$FILEEXT is mapped:

  • The literal value found in $$FILEEXT is used to determine an appropriate file extension for the file being stored.

    • This is true even if a value of $$DOCTYPE is found.

    • $$DOCTYPE values will never be used to set the file extension.

  • $$DOCTYPE will be used to determine an appropriate Document Type and File Format via user-defined mappings. If $$DOCTYPE is not configured or populated, OnBase attempts to use $$FILETYPE values to find a mapping.

  • If $$FILEEXT is not configured or populated, and the OnBase File Format is not associated with a default file extension, the HL7 product will store new files with an ".hl7" file extension. To avoid this default value, configure $$FILEEXT or default file extension for the OnBase File Format.

If the $$DOCTYPE or $$FILEEXT value in an HL7 message is mapped to a Document Type, then Advanced Document Import stores the document using that Document Type. If the value is not mapped, then the default Document Type is used. For more information, see Document Type and File Type Resolution for Advanced Document Import.

Note:

If a message has values for both $$DOCTYPE and $$FILEEXT, the $$DOCTYPE mapping is used. To prevent conflict, only one of these variables should be mapped per system.

To map Document Types to HL7 codes:

  1. Click Map Document Types. The HL7 Document Type Mapping dialog box is displayed.
  2. Do one of the following:

    • To map a new HL7 code, type the value in the field provided, and then click Create. The HL7 code is case sensitive. It must match the case of the HL7 message value. Otherwise, the document is archived to the default Document Type.

    • To change the mapping for an existing HL7 code, select the code and click Map.

    The mapping dialog box is displayed.

  3. Select the Document Type to assign the document.
  4. If the file format of the document differs from the Document Type's default file format, then select the File Type to assign to the document.

    For example, if a Document Type's default file format is Image File Format, but the document's file format is text, then you should select Text Report Format for the File Type. Otherwise, the document is not displayed correctly in the Client.

    Note:

    Only File Types supported by the Message Action are listed in the File Type drop-down list. If a Document Type's default file format is not supported, it cannot be mapped unless an alternative File Type is selected.

  5. Click OK.
  6. Repeat for each HL7 code you want to map to a Document Type.
  7. Click OK to save and close HL7 Document Type Mapping.