Web Access API for EV Release 6.1.1

Overview

This API provides access to EV clinical data using a web API that follows the HL7 Fast Healthcare Interoperability Resources (FHIR) standard. This version of the API is based on FHIR Release 3 (STU3), specifically version 3.0.1. The API also implements the US Core Profiles (STU1), specifically version 1.0.0.

Basic Usage

The API is a RESTful based API and as such relies on the HTTP protocol. Below is the general URL syntax for the HTTP requests.

General URL Syntax:

[ Base URL ]/[ FHIR Resource ]

The results of the request are returned in an HTTP Response. The HTTP Response body will be in the JSON format.

Base URL

The base URL is made up of the domain name for the server, the TCP port (default=8100), and the assigned EV site number (e.g., 123).

Base URL Construct:

https://<server domain>:<port>/sites/<EV site number>

Example Base URL:

https://greathospital.com:8100/sites/123/

Sample Request and Response

Below is a sample request for getting the demographic information for a patient with the last name Bishop. Followed by the corresponding response.

Sample Request:

Patient?family=Bishop

Sample Response:

{
    "resourceType": "Bundle",
    "type": "searchset",
    "total": 1,
    "link": [
        {
            "relation": "self",
            "url": "https://greathospital.com:8100/sites/123/Patient?family=BISHOP"
        }
    ],
    "entry": [
        {
            "fullUrl": "https://greathospital.com:8100/sites/123/Patient/1",
            "resource": {
                "resourceType": "Patient",
                "id": "1",
                "text": {
                    "status": "generated",
                    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Patient</b></p><p><b>Name</b>: BISHOP, Jay</p><p><b>Gender</b>: Male</p> <p><b>BirthDate</b>:1956-02-21</p><p><b>Identifiers</b>:</p><p><b>Medical record number</b>: MRN-6WP64S3</p> <p><b>Communication:</b></p><p><b>Primary Language</b>: Burmese</p> <p><b>General Practitioners:</b></p></div>"
                },
                "extension": [
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/us-core-race",
                        "extension": [
                            {
                                "url": "ombCategory",
                                "valueCoding": {
                                    "system": "http://hl7.org/fhir/v3/Race",
                                    "code": "1516-4",
                                    "display": "Zuni"
                                }
                            },
                            {
                                "url": "ombCategory",
                                "valueCoding": {
                                    "system": "http://hl7.org/fhir/v3/Race",
                                    "code": "2106-3",
                                    "display": "White"
                                }
                            }
                        ]
                    },
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/us-core-ethnicity",
                        "extension": [
                            {
                                "url": "ombCategory",
                                "valueCoding": {
                                    "system": "urn:oid:2.16.840.1.113883.6.238",
                                    "code": "2186-5",
                                    "display": "Not Hispanic or Latino"
                                }
                            }
                        ]
                    }
                ],
                "identifier": [
                    {
                        "use": "usual",
                        "type": {
                            "coding": [
                                {
                                    "system": "http://hl7.org/fhir/v2/0203",
                                    "code": "MR"
                                }
                            ],
                            "text": "Medical record number"
                        },
                        "system": "http://hl7.org/fhir/v2/0203",
                        "value": "MRN-6WP64S3"
                    }
                ],
                "name": [
                    {
                        "text": "BISHOP, Jay",
                        "family": "BISHOP",
                        "given": [
                            "Jay"
                        ]
                    }
                ],
                "gender": "male",
                "birthDate": "1956-02-21",
                "communication": [
                    {
                        "language": {
                            "text": "Burmese"
                        },
                        "preferred": true
                    }
                ]
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}

Response Codes

When the HTTP response is received it will contain a status code indicating whether the request was successful or not. The table below shows the possible result codes with their meaning.

Code	Reason Phrase	Description
200	OK	Success
201	Created	Resource was successfully created.
204	No Content	Resource was successfully deleted.
400	Bad Request	Request failed due to an invalid request content.
401	Unauthorized	Request failed due to either an invalid access token or the user not being authorized to access the resource or perform that operation on the resource.
404	Not Found	Request failed because a resource exist for that id.
409	Conflict	Request failed because of a conflicting condition. For example, a resource could not be deleted because it is being referenced by another resource.
422	Unprocessable Entity	Request failed because of a server business rule. For example, failed to add an AllergyIntolerance because it already exists for the encounter.

References:

FHIR Resources

The API supports the following FHIR resources.