FHIR API HIEBus™ FHIR API
Interface Guide

Using Postman

You can use Postman or a similar tool to exercise the REST API of the FHIR test site with custom queries.

Installing Postman

Install the app for your operating system from the Postman website.

Postman Quickstart

You can view full help for Postman through their help documentation, but the following steps will give you a quick overview of how to use it to access the FHIR Interface to query data.

  1. Launch Postman.
  2. Create a new Request.
Create a Request
Create a Request
  1. Enter a name and either select a collection or create a new one to save the request.
  2. Select GET for a query.
  3. Enter the endpoint of the resource you want to access. For example: https://fhir.careevolution.com/Master.Adapter1.WebClient/api/fhir/Patient.
  4. Select ‘Params’ and enter any search parameters.
Create a Request
Create a Request
  1. Under ‘Authorization’, select Bearer Token and enter an OAuth access token you generated.
Create a Request
Create a Request
  1. Select ‘Send’.

The result of the query will appear at the bottom of the screen. For example:

<Bundle xmlns="http://hl7.org/fhir">
    <type value="searchset" />
    <total value="9" />
    <link>
        <relation value="self" />
        <url value="https://fhir.careevolution.com/Master.Adapter1.WebClient/api/fhir/Patient?family=Demoski&amp;_count=20" />
    </link>
    <entry>
        <fullUrl value="https://fhir.careevolution.com/Master.Adapter1.WebClient/api/fhir/Patient/1deda6e4-3121-e611-8128-0a69c1b3225b" />
        <resource>
            <Patient>
                <id value="1deda6e4-3121-e611-8128-0a69c1b3225b" />
                ...
            </Patient>
        </resource>
    <entry>
</Bundle>

If there is a problem with your request, the response will look something like this:

{
    "Message": "You are not authorized to access this resource."
}

See Error Handling for help troubleshooting errors.