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

If you haven't retrieved a remote capability statement, then by default the FHIR Sender will be populated with all known resources, interactions, operations, and parameters. Once you retrieve and cache a capability statement, only the interactions etc. supported by the server will be shown in the drop-down menus.

The first thing to decide is whether you want your FHIR Sender destination to invoke a Resource-specific interaction, or a System-wide interaction. Select either Resource or System next to Interaction Type:

The Interaction / Operation drop-down menu will change depending on which interaction type you choose. Once you select one, the Path and options underneath it will change.

Creating / Updating / Patching Interactions

These interactions (as well as transaction/batch and many operations) use one of the entity-enclosing HTTP methods: POST, PUT, or PATCH. When one of these is selected, you also need to specify a request payload/body. You can choose Use Template to enter a direct text template, or Use Builder to use the FHIR Resource Builder to create a payload for you.

When using the Builder mode, the resource being built is automatically selected for you, depending on the resource and/or interaction you've chosen.

Other Interactions

Any interaction that doesn't require a payload/body is usually going to use either a GET or DELETE request. Some of these requests have the resource ID or version ID baked directly into the URL. If that is the case, a Path Params table will become visible where you can enter values for those variables.

A Query Parameters table will also show up. You can use the drop-down menu to select a standard or supported query parameter, or you can edit it manually with your own custom parameters.


When using a search interaction, you'll typically want to include query parameters to narrow your search. Some standard global search parameters are shown in the Query Parameters drop-down menu by default. In addition to those, some resource-specific search parameters may appear, depending on what is present in the Capability Statement. For example, if the server presents a capability statement that says it supports the "family", "given", "identifier", and "name" parameters for the Patient resource, you should see those in the drop-down menu:

  • No labels