Uploading Supplemental Custom Guidelines, Maps, and other Files for HL7 and FHIR

HL7 users specify validation profiles, guidelines, maps, and other files when validating or translating data. FHIR users specify Mapping rule and structure map files for FHIR Mapping Language of FHIR Transformation activity.

In order for these files to be accessible when building TIBCO Cloud™ Integration processes involving the ActiveMatrix BusinessWorks Plug-in for HL7 with FHIR for HL7, the files must be uploaded to TIBCO Cloud Integration as supplemental files and must be contained in a zip file called supplement_hl7.zip. For FHIR, the files must be uploaded to TIBCO Cloud Integration as supplemental files and must be contained in a zip file called supplement_fhir.zip.

To upload the supplement zip file, all users can use either the TIBCO Cloud™ - Command Line Interface or the TIBCO Cloud Integration UI.

For HL7, all customers must push the supplement_hl7.zip file and for FHIR, all customers must push the supplement_fhir.zip file to TIBCO Cloud Integration by using the TIBCO Cloud - Command Line Interface. Without it, ActiveMatrix BusinessWorks Plug-in for HL7 with FHIR processes cannot run on TIBCO Cloud Integration.

If you have no supplemental custom files to upload, create and upload the supplement_hl7.zip file or the supplement_fhir.zip file that contains dummy files.

Note: Note: These procedures must be repeated to delete, add new, or change existing supplemental files.

Preparing Supplemental Files for HL7

Perform the following procedure to prepare supplemental files for uploading to TIBCO Cloud Integration:

Before you begin

  • Supplemental files must be created with UNIX line termination format, not the Windows line termination format.
  • If there is an Instream base path set in the supplemental files, it must be edited to point to the following baseroot: /opt/tibco/fs.

  1. Create a folder (in this example, the folder is called Supplement). Within that folder, create a bin folder and a Database folder.

  2. In the /bin folder, add supplemental files of type .apf or .ini.

  3. In the /Database folder, add supplemental files of type .xsd,.std, or .map.

  4. Create a .zip file named supplement_hl7.zip that contains the contents of both the /bin and /Database folders.

Note: Note: The parent folder should not contain any other folders. All the supplement files and folders must be compressed directly to the supplement_hl7.zip file.

Uploading Supplemental Files for HL7

Perform any one of the following procedures to upload supplemental files to TIBCO Cloud Integration:

By using the TIBCO Cloud - CLI

  1. Create an empty folder (in this example, the folder is called _Uploaded_Supplemental Files).

  2. Copy the supplement_hl7.zip file to the empty folder.

  3. Ensure that TIBCO Cloud - Command Line Interface is installed in this folder. If not, install the TIBCO Cloud - CLI. For more information, see Installing the TIBCO Cloud™ - Command Line Interface.
  4. From the new folder, run the following command:

    ./tibcli bwplugin supplement hl7

  5. Enter your TIBCO Cloud Integration login and password.
    Note: Note: Only Admin users are allowed to upload supplemental files within an organization.

    A message window indicating a successful login is displayed.

  6. The files are uploaded to TIBCO Cloud Integration and unzipped. A success message is displayed.

    Note: Note: Supplemental files are extracted to /opt/tibco/fs.

By using TIBCO Cloud Integration UI

  1. Go to the Environment and Tools page.
  2. In the Connector Management & Extensions section, upload the supplement_hl7.zip file as a supplement. Select hl7 under the BusinessWorks section.

Using Supplemental Files for HL7

Before attempting to access new supplemental files on TIBCO Cloud Integration, re-deploy the application. For more information, see the "Pushing an Application to the Cloud" topic in the TIBCO Business Studio™ - Cloud Edition documentation.

Note: Note: Existing processes (workflows) are not impacted. To access new supplemental files, the existing processes (workflows) must be re-deployed to TIBCO Cloud - CLI.

Preparing Supplemental Files for FHIR

Perform the following procedure to prepare supplemental files for uploading to TIBCO Cloud Integration:

Before you begin

  • Supplemental files must be created with UNIX line termination format, not Windows line termination format.
  • If there is a base path set in the supplemental files, it must be edited to point to the following baseroot: /opt/tibco/fs.

  1. Create a folder (in this example, the folder is called Supplement).

  2. Depending on the mapping option that you select, add files to the Supplement folder.

  3. Create a .zip file named supplement_fhir.zip that contains the content of the Supplement folder.

Uploading Supplemental Files for FHIR

Perform any one of the following procedures to upload supplemental files to TIBCO Cloud Integration:

By using the TIBCO Cloud - CLI

  1. Create an empty folder (in this example, the folder is called Supplement).
  2. Copy the supplement_fhir.zip file to the empty folder.

  3. Ensure that TIBCO Cloud - CLI is installed in this folder. If not, install the TIBCO Cloud - CLI. For more information, see Installing the TIBCO Cloud™ - Command Line Interface.
  4. From the new folder, run the following command:

    ./tibcli bwplugin supplement FHIR.client.

  5. Enter your TIBCO Cloud Integration login and password.
    Note: Note: Only Admin users are allowed to upload supplemental files within an organization.

    A login success message is displayed.

  6. The files are uploaded to TIBCO Cloud Integration and unzipped. A success message is displayed.

By using TIBCO Cloud Integration UI

  1. Go to the Environment and Tools page.
  2. In the Connector Management & Extensions section, upload the supplement_fhir.zip as a supplement. Select fhir.client under the BusinessWorks section.

Note: Note: Supplemental files are extracted to /opt/tibco/fs.

Using Supplemental Files for FHIR

Before attempting to access the new supplemental files on TIBCO Cloud Integration, re-deploy the application. See the "Pushing an Application to the Cloud" topic in the TIBCO Business Studio™ - Cloud Edition documentation.

Note: Note: Existing processes (workflows) are not impacted. To access new supplemental files, the existing processes (workflows) must be re-deployed to TIBCO Cloud - CLI.