Using the FHIR Interface

The FHIR Interface is a RESTful interface (Representational State Transfer), which provides a stateless, consistent way of accessing resources. This section introduces the basic concepts necessary to use the FHIR Interface.

Terms of Use

By using the HIEBus FHIR Interface, you agree to the following Terms of Use.

Endpoints

All FHIR requests are made over HTTP/HTTPS to a FHIR endpoint. A given site may implement any number of endpoints. For example:

https://YOUR_CAREEVOLUTION_URL/api/ENDPOINT_NAME/

Note
YOUR_CAREEVOLUTION_URL refers to the address you use to access the CareEvolution application, and ENDPOINT_NAME is a name assigned by your site administrator. Examples in this guide will use CareEvolution’s public FHIR test server, but in real applications you would use the endpoint for the system you wish to access.

Learn more about Endpoints.

Resources

FHIR resources (e.g., patient, procedure, claim) are implemented as REST resources. The resource becomes part of the request URL. For example:

https://fhir.careevolution.com/Master.Adapter1.WebClient/api/fhir/Patient

Learn more about Resources.

Requests

Query parameters in the URL allow you to specify parameters for the FHIR request. For example:

https://fhir.careevolution.com/Master.Adapter1.WebClient/api/fhir/Patient?family=Demoski&given=Helen

Learn more about Building Requests.

Posting Data

Data can be POSTed to the FHIR server.

Learn more about Posting Data.

Authentication

The FHIR Interface protects health data by requiring authentication on all operations. In order to access FHIR resources, you will need to obtain a valid access token and include it in the HTTP request header.

Learn more about Authentication.

Responses

The HTTP response will contain XML or JSON data for the request. Here is a small excerpt of a response showing a patient’s name:

    <name>
        <use value="official">
            <extension url="http://careevolution.com/fhirextensions#term">
                <valueCodeableConcept>
                    <coding>
                        <system value="http://fhir.carevolution.com/codes/CareEvolution/NameType" />
                        <code value="LegalName" />
                        <display value="Legal Name" />
                        <userSelected value="true" />
                    </coding>
                    <text value="Legal Name" />
                </valueCodeableConcept>
            </extension>
        </use>
        <family value="Demoski" />
        <given value="Helen" />
    </name>

Learn more about handling Responses and Errors.

Mapping and Codes

FHIR data must be translated between FHIR fields and their HIEBus equivalents. Coded values are commonly used to represent healthcare concepts.

Learn more about Field Mapping and Codes.