NextGen Knowledge Center

Setting FHIR Listener Properties

After installing, you should now have "FHIR Listener" as one of your source connector options. You can see that it's quite similar to the HTTP Listener:

The first option in the FHIR Listener Settings allows you to select the FHIR version to use in the source connector. The default selected version is R4. Each version of FHIR has a different set of resources, so selecting a different version in the drop-down will change the list of resources in the Resources table. You can find documentation about FHIR resources at http://hl7.org/fhir/R4/resourcelist.html.

A FHIR server provides a capability statement that gives clients an overview of the application. This includes what resources and interactions the application supports, and any other requirements it has. The FHIR Listener connector settings affect what values show up in the capability statement. They are as follows (see also — Resource CapabilityStatement - Detailed Descriptions):

  • Capability Statement Template: If set, this will provide a base capability statement that the server will use. The settings below this will still override the matching items in the template. This allows you to configure advanced settings that aren't satisfied by the rest of the options in the UI.

  • Identifier URL: An absolute URL that is used to identify this capability statement when it is referenced in a specification, model, design or an instance.

  • Name: A free text natural language name identifying the capability statement.

  • Supported Formats: Indicates in the capability statement whether XML and/or JSON are formally supported by the server.

  • System Interactions: These are system-level interactions that don't necessarily operate on a single resource.

Finally, the Resource Interactions table determines which interactions are supported for each resource type. An "interaction" is a pre-defined method of communicating with the server to send or retrieve a resource or some other metadata. For example, the "read" interaction accesses the current contents of a resource with a GET request. For more information, go here: http://hl7.org/fhir/R4/http.html.

The selections you make in the Resources table will be reflected in the generated capability statement, telling clients what is supported and what isn't. You can multi-select resources in the table, then use the checkboxes to the right to toggle interactions on or off.