web stats
Skip to end of metadata
Go to start of metadata

This feature is used on the FHIR Sender, FHIR Transformer Step Type, and FHIR Code Template Type. It provides an easy, graphically driven way to create or learn about the structure of FHIR resources or data types.

Overview

At the top of the builder is the top-level object being created. For example if you are creating a Patient with the FHIR Sender, the top-level object will be a Patient:

Each object in the tree may have properties underneath it. These are indented and have check boxes next to them. Select or deselect the check boxes to include or exclude properties:

Populating Values

To the right of each property name are the options you have available to populate the property. The options will vary depending on the type of property. For example the following JSON value types typically only have a single text field:

  • String
  • Boolean
  • Number
  • Integer
  • Null

You can enter in hard-coded values as shown in the screenshot above. Or, depending on the context you can provide dynamic variable replacement.

FHIR Sender

When using the resource builder on a FHIR Sender, you can use Velocity variable replacements such as ${varName}. You can also drag-and-drop variables over from the right-hand-side Destination Mappings list.

FHIR Transformer Step / Code Template

When using the resource builder on a FHIR Transformer Step or FHIR Code Template, any JavaScript expression is valid. For String values, you can also choose to enter a hard-coded literal value. Next to each String value field, there is a button you can use to toggle between these two modes:

Enumerated Values

Some properties have a pre-set list of possible values. For these properties you will be able to choose between Enum and Variable.

Choose Enum to select a specific value from the list.

Choose Variable if you want to use a separate hard-coded value, or a dynamically replaced variable instead.

Object Builder

When a property value is the type Object, you will be able to choose from Object Builder or Variable. If you want to use a hard-coded value or dynamically replaced variable, choose Variable.

When Object Builder is selected, the property will be expanded into a sub-tree that shows all of the sub-properties. From there you can select or deselect sub-properties as you see fit.

Array Builder

When a property value is the type Array, you will be able to choose from Array Builder or Variable. If you want to use a hard-coded value or dynamically replaced variable, choose Variable.

When Array Builder is selected, a plus icon will be enabled, allowing you to add new elements to the array. Each element will have a minus icon that you can use to remove that specific element.

Description Tool-tips and JSON Schema

If a property has a description, it will show up in the tool-tip for the variable text field:

You can also click on the colored icon next to the text field to view the underlying JSON schema for that specific node:

  • No labels