Create a New Healthcare Schema

You can create a new HL7 schema based on a standard out-of-the-box HL7 message definition and customize it to match your requirements.

You can create a schema in a project or a standalone environment (outside of a project).
  1. To create a schema in a project:
    1. In the navigation pane, click Projects.
    2. Click the project in which to create the schema.
    3. Click Healthcare Healthcare icon.
    4. In the Schemas section, click Add.
  2. To create a schema in a standalone environment:
    1. In the navigation pane, click Healthcare, then Schemas.
    2. On the Schemas page, click Create.
  3. Enter the following details.
    Element Description
    Name Enter a schema name.
    Identifier This field is automatically populated with a unique schema identifier based on your schema name. You can manually change this value, if needed.
    Description Enter an optional description of this schema.
    Message standard Select the message standard. The message standard identifies the business protocol to follow when exchanging messages between applications.
    Message version Select the message version. HL7 V2 versions 2.3.1, 2.4, 2.5.1, 2.5, 2.6, 2.7, 2.7.1, 2.8.1, 2.8, 2.8.2, and 2.9 are supported.
    Message type Select the message type. The types shown are based on the HL7 V2 version you selected.

    For this example, ADT_A08 (update patient information) is selected.


    The Create Healthcare schema dialog is shown. The Identifier, Description, Message standard, Message version, and Message type fields are shown.

  4. Click Create.
    The details page for your new HL7 message is displayed. The standard segments and elements that come with the message type you selected are shown. A segment is a higher level construct, consisting of a sequence of elements and composites. An element is the smallest unit that represents a single data field of a primitive type, such as alphanumeric text, integer, decimal, date, time, or binary. If you create a schema in a project, the project name is displayed in the banner. For this example, the schema was created in a standalone environment (outside of a project).


    The MyADT_A08_schema page is shown. The Identifier and Updated on fields are shown at the top. Below is a table with columns for Segment/Element, Name, Cardinality, and Element type.

    You can customize the standard HL7 message. For example, the application with which you are integrating may require another segment or loop. You can add new constructs (such as new segments and loops) to a standard healthcare schema or edit existing constructs within it.

  5. If you want to create a new segment, see Add a New Segment.
  6. If you want to create a new loop, see Add a New Loop.

Add a New Segment

According to your organization's requirements, you can add new segments to a standard healthcare schema to customize it.

  1. Hover over the row of a segment/element and click Actions Actions icon, then New segment.

    The Add new segment panel is displayed.

  2. If you want to use the contents of an existing segment definition to create a new segment, click Existing segment. This selection is useful when the contents of an existing segment are similar to the one you want to create.
    1. Expand Advance Search.
    2. Search by the version number or schema name to use.
    3. Begin typing the initial letters of the segment to show the available selections.
    4. Select the segment.
    5. Click Add.
    6. Enter a name, description, and cardinality value. For example, if you enter [0..1], a value of either zero or one is expected.
    7. Click Add.
  3. If you want to create a completely new segment without using existing information, click New segment.
    1. Enter a name, and click Add.

      The Properties panel is displayed.

    2. Enter a name, description, and cardinality value. For example, if you enter [0..1], a value of either zero or one is expected.
    3. Click Save.
  4. If you want to perform additional customizations, hover over the row of the segment/element and click Actions Actions icon, then select to perform more customizations:
    • New child element: The smallest unit that represents a single data field of a primitive type, such as alphanumeric text, integer, decimal, date, time, or binary.
    • New child composite: A complex data type consisting of one or more elements.
    • New segment: The next higher level construct, consisting of a sequence of elements and composites.
    • New loop: A container for a specific set of segments or child loops, which makes its structure nested and hierarchical.

Note:

If your inbound HL7 message request contains unexpected custom segments, you can select the Ignore non-modeled segments option when configuring the healthcare action in the integration canvas. With this option selected, unexpected custom segments not found in the schema are ignored completely, no errors are raised, and a response is successfully generated at runtime. See Convert HL7 Messages with a Healthcare Action in Using Oracle Integration for Healthcare in Oracle Integration 3.

Add a New Loop

According to your organization's requirements, you can add new loops to a standard healthcare schema to customize it. A loop is a container for a specific set of segments or child loops, which make its structure nested and hierarchical.

  1. Hover over the row of a segment/element and click Actions Actions icon, then New loop.

    The Add new loop panel is displayed.

  2. Enter a name for the segment, and click Add.
  3. Enter a cardinality value. For example, if you enter [0..1], a value of either zero or one is expected.
  4. Click Save.