URL - HL7 Module - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Premier - Standard - Essential

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

The URL option requires a base URL to be configured as described under Document Display URL Configuration.

The URL option uses DocPop, FolderPop, DeficiencyPop, or the OnBase Patient Window to provide a URL to either the document or its associated chart.

  1. Make sure the base URL is configured under Utils | Document Display URLs in OnBase Configuration.
  2. Open the configuration settings for the Send HL7 Message action in OnBase Studio.
  3. Select the message field you want to map.
    CAUTION:

    This field must not have a Keyword Type configured in Message Template configuration. If it does, the HL7 message will not append the document's Keyword value to the URL.

  4. Select the URL option.
  5. Select the name of the URL from the drop-down provided.
  6. Click Map.
  7. Click the Options tab to append a document handle or keyword to the URL's query string.
  8. Select one of the following options:

    Option

    Description

    Document Handle

    The option appends the docid parameter with the document's handle as the value. For DocPop URLs, this parameter would retrieve the document that triggered the message.

    Keyword Value

    The option appends the specified Parameter Name with the value of a Keyword Type from the document. For example, if you are using the OnBase Patient Window, the document's Medical Record Number value could be used to retrieve the associated record.
  9. If you selected Keyword Value in the previous step, complete the following fields:

    Option

    Description

    Parameter Name

    Enter the name of the parameter to append to the URL. For example, if you are using the OnBase Patient Window, you might use the mrn parameter.

    For available parameters, see the documentation for the respective Pop integration.

    Keyword Type

    Select the Keyword Type whose value should be used for the specified parameter.

    • If the document does not have an instance of the specified Keyword Type, the parameter appended without a value.

    • If the document contains multiple instances of the specified Keyword Type, then the first value is used.
  10. Click Save.