FHIR API HIEBus™ FHIR API
Interface Guide

Handling Responses

When you issue a FHIR request, the server will issue a standard HTTP response. The status code tells you whether the request was successful.

Status Meaning
200 OK
201 Resource Created
Other An Error Occurred

For more information about error responses, see Handling Errors.

For a successful request, the response body will contain the requested information.

Response Format

The response body uses XML format by default. You can request JSON format instead by specifying a data format in the request.

Resource Fields

Below is part of a response to a sample search request. For more information about what FHIR fields are supported and where that data comes from in the HIEBus system, see Mapping.

Request: [base]/Patient/f4968df0-3121-e611-8128-0a69c1b3225b

Response:

<Patient xmlns="http://hl7.org/fhir">
    <id value="f4968df0-3121-e611-8128-0a69c1b3225b" />
    <meta>
        <lastUpdated value="2016-05-23T22:01:49.23+00:00" />
    </meta>
    <identifier>
        <use value="usual" />
        <system value="http://fhir.carevolution.com/identifiers/CareEvolution/MRN/PACode" />
        <value value="123456780" />
    </identifier>
    <identifier>
        <system value="http://fhir.carevolution.com/identifiers/CareEvolution/MCID" />
        <value value="ABC 123" />
    </identifier>
    <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>
    ...
</Patient>