FHIR APIs

The section FHIR APIs displays the list of FHIR endpoints and the corresponding resources for each endpoint. On the tab FHIR APIs, as an administrator, you can:

  • Add endpoints fetched from your organization's FHIR server.
  • Add endpoints published in the Endpoint Directory and fetched from there if your organization account has the Endpoint Directory subscription.
  • Edit the endpoints' names.
  • Remove added endpoints.
  • Fetch the list of APIs of a certain endpoint from your organization's FHIR server using capability statements. Each list is automatically populated with resources based on the capability statement used.
  • Search for a certain API (resource).
  • View the object reference model/examples of the resources (APIs).
  • Download API directory information in a Swagger API format.

Note The option to add endpoints from the endpoint directory is only available to the users of an organization that is subscribed to Endpoint Directory service in Smart Trading Cloud.

To add an endpoint, first switch to Edit View on the top of the Developer Portal, and then click Add Endpoint that will be displayed after you switch to the edit mode.

To add an endpoint:

  1. On the tab FHIR APIs, click Add Endpoint.
  2. In the pane Add Endpoint, select From FHIR Server or From Endpoint Directory depending on from where you want to fetch the endpoints.
  3. If you have selected From FHIR Server, then, in Name, enter the name for the endpoint.
  4. In Endpoint URL, enter the link to the endpoint. In Capability Statement URL, the capability statement URL is generated automatically once you add the endpoint URL.
  5. Click Select Standard Version to select the business version of a certain capability statement (DSTU2, DSTU3, R4).
  6. Click Save.
  7. If you selected From Endpoint Directory, then, in Name, enter the name for the endpoint.

    Note To access the Endpoint Directory, you should publish your organization profile first.

  8. In Endpoints, from the drop-down list with published endpoints fetched from the Endpoint Directory, select the endpoint you need.
  9. Click Save.

    In both cases, the endpoints with APIs are added to separate tabs of the section FHIR APIs.

To edit or remove a certain endpoint, first switch to Edit View on the top of the section.

To edit an endpoint's name:

  1. On the tab FHIR APIs, select the tab of the endpoint you want to edit.
  2. Next to the name of the selected endpoint, click , and then, from the drop-down menu, click Edit.
  3. In Endpoint Name, edit the name of the endpoint.
  4. Click Save.

To remove an endpoint:

  1. On the tab FHIR APIs, select the tab of the endpoint you want to remove.
  2. Next to the name of the selected endpoint, click , and then, from the drop-down menu, click Delete.
  3. In the dialog Delete Confirmation, confirm the endpoint deletion.

All the users of the Developer Portal can download information for each API directory as OpenAPI Specification that is an API description format used for REST APIs in a JSON format that is OpenAPI 3.0 compliant. The OpenAPI specification (OpenAPI file in the JSON format) can include information on the following:

  • available endpoints (/users);
  • operations on each endpoint (GET /users, POST /users);
  • operation parameters, such as Input and output for each operation;
  • authentication methods,
  • contact information, and so on.

To download a swagger API:

  1. On the tab FHIR APIs, select the tab of the endpoint for which you want to download a swagger API.
  2. Under the FHIR version and capability statement of the endpoint, click Download swagger API.
  3. In the dialog Save As, select a location to where you want to download the file, and then click Save.

    The file in a JSON format is downloaded to the selected location.