Export and Import a Healthcare Message

You can export and import an individual HL7 message between projects in an instance or from one instance to another (for example, from a development instance to a production instance).

Note:

Export and import of HL7 messages is only supported in projects.

This capability provides a more granular approach to the export and import of messages than offered by exporting and importing an entire project. Only the specific message you selected in exported. With entire projects, all existing messages are included in the export file.

Export an HL7 Message

If the message includes a custom schema, that is also automatically exported.

  1. In the navigation pane, click Projects.
  2. Click the project from which to export the message.
  3. Click Healthcare Healthcare icon.
  4. Go to the HL7 messages section.
  5. For the message to export, click Actions Actions icon, then select Export.

    A ZIP file of the message is downloaded to your local drive.

Import an HL7 Message

If the message to import is associated with a custom schema, you must first export and import the custom schema in the Schemas section before importing the message. Otherwise, an error message is displayed. See Export and Import a Healthcare Schema.

Do not edit the downloaded message export file. The message file to import must satisfy all of following requirements. Otherwise, the import process fails.
  • The file must contain a top-level folder named healthcareartifacts/.
  • The file must contain exactly one message file matching healthcareartifacts/hcdocument_*.xml.
  • The message XML root element must be <healthcaredocument>.
  • If a schema file is present, it must match healthcareartifacts/hcschema_*.xml.
  • If a schema file is present, the schema XML root element must be <healthcareSchema>.
  • No files are allowed outside healthcareartifacts/.
  1. In the navigation pane, click Projects.
  2. Click the project in which to import the HL7 message.
  3. Click Healthcare Healthcare icon.
  4. In the HL7 messages section, click the Add icon.
  5. Click Import.
  6. Drag and drop the exported message ZIP file into the field.
  7. If you want to replace an existing message in this project, select Overwrite the message definition, if it exists. You cannot overwrite a message that is part of an active integration.