End Points

Common

Base Url: https://api.enablemyhealth.com

Retrieval By ID: https://api.enablemyhealth.com/DSTU2/[Type]/[ID]

Errors: See Error codes Here!

No Results: Returned as a Bundle of 4101 Error

Headers: We look at the Accept Header to determine response type.
To get JSON response please only pass application/json.
For XML response please only pass application/xml.
The default is XML.

Specific Interface Specifications

Patient 

Patient Interface

Patient Search

To perform a Patient Search you will need the patient’s FirstName, LastName and Date of Birth.

Requests without all these values will return no results.

The endpoint will be: [BaseURL]/Patient?family=[LastName]&given=[FirstName]&birthdate=[DOB(yyyyMMdd)]

A successful search will return a bundle of Patient with direct links to the patient based off the ID value.

To retrieve a specific patient by ID you will use the end point [BaseURL]/Patient/[ID] or alternately, you can use [BaseURL]/Patient?_id=[ID]

This ID Value will be used to retrieve all other Patient specific data.


Parameter Name

Parameter Type

Description

_id

Reference

Search for Patient resources using one or more server ids (equivalent to one or more Get /Patient/{ID} requests). If _id is included in your search, all other parameters are ignored.

identifier

Token

Search for Patient resources using a business identifier, such as an MRN.  Queries must be in the format [OID]|[ID], where [OID] is the HL7 Root of the identifier type, and is found in the Identifier.System field of a resource. You can use this parameter as the only parameter in a search or with other parameters.

family

String

name parameter, but do not need any other additional parameters. 

given

String

Search for Patient resources using a first name or given name. This parameter is used to find patients with matching given names, and supports both exact and "sounds like" matches. Query responses return matching patients in order of closest match, with the strongest match first. You must use this parameter with the family parameter, but do not need any additional parameters.

birthdate

Date

Search for Patient resources using a date of birth in XML format (YYYY-MM-DD). You must use this parameter with one of the following sets of parameters: identifier, telecom, or family and given

gender

Token

Search for Patient resources using  the following gender codes: female, male, other, or unknown. You must use this parameter with one of the following sets of parameters: identifier , telecom, or family and given.

address

String

Search for Patient resources using an address string.Queries must be formatted as a string and only contain the first line of the patient's street address. You must use this parameter with one of the following parameters: identifier, telecom, or family and given.

telecom

String

Search for Patient resources using a patient’s home or cell phone number.  Queries can be formatted with or without dashes. You can use this parameter as the only parameter in a search or with other parameters.

Patient XML Example Response

<Patient xmlns="http://hl7.org/fhir">

<id value="24E2B196-55A9-4041-BD89-2D025B9E5F32"/>

<extension url="http://hl7.org/fhir/StructureDefinition/us-core-race">

<valueCodeableConcept>

<coding>

<system value="2.16.840.1.113883.5.104"/>

<code value="2106-3"/>

<display value="White"/>

</coding>

<text value="White"/>

</valueCodeableConcept>

</extension>

<extension url="http://hl7.org/fhir/StructureDefinition/us-core-ethnicity">

<valueCodeableConcept>

<coding>

<system value="2.16.840.1.113883.5.50"/>

<code value="2186-5"/>

<display value="Not Hispanic or Latino"/>

</coding>

<text value="Not Hispanic or Latino"/>

</valueCodeableConcept>

</extension>

<active value="true"/>

<name>

<family value="Newman"/>

<given value="Alice"/>

</name>

<telecom>

<system value="phone"/>

<value value="5557231544"/>

<use value="home"/>

</telecom>

<telecom>

<system value="phone"/>

<value value="5557771234"/>

<use value="mobile"/>

</telecom>

<gender value="female"/>

<birthDate value="1970-05-01"/>

<address>

<line value="1357 Amber Dr"/>

<city value="BEAVERTON"/>

<state value="OK"/>

<postalCode value="97006"/>

<country value="USA"/>

</address>

<maritalStatus>

<coding>

<system value="http://hl7.org/fhir/ValueSet/marital-status"/>

<code value="UNK"/>

<display value="Unknown"/>

</coding>

<text value="Unknown"/>

</maritalStatus>

<communication>

<language>

<coding>

<system value="urn:oid:2.16.840.1.113883.6.99"/>

<code value="en"/>

<display value="English"/>

</coding>

<text value="English"/>

</language>

</communication>

</Patient>


 

Provider

Provider (Practitioner) search allows provider names, address and phone number to be retrieved. 

Relative URL

FHIR Interaction

HTTP Method

Action

/Practitioner/{ID}

Read

Get

Retrieve practitioner by ID


Medications

This will allow you to retrieve both the prescriptions (MedicationOrder) and current medications (MedicationStatement) for a patient. The FHIR MedicationOrder includes prescriptions or OTC drugs ordered by the provider.with the medication script.

The FHIR MedicationStatement function defines detailed information about medications being taken by the patient. This includes medication prescriptions, OTC drugs ordered, and current medications reported taken by a patient. 

MedicationOrder Search Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/MedicationOrder?[parameter=value]

Search

Get

Retrieves prescriptions



Parameter Name

Parameter Type

Description

patient

Reference

Retrieve MedicationOrder by patient ID.

status

Token

Filter prescriptions by active, completed, stopped, and non-active status. 

dateWritten

Date

Filter prescriptions list by the date prescription was written.

Examples

Query

Result

/MedicationOrder?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32

Returns all active MedicationOrder resources for Alice Newman

/MedicationOrder?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32&status=active,completed

Returns active and completed MedicationOrder resources for Alice Newman

MedicationOrder Read Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/MedicationOrder/{ID}

Read

Get

Retrieve MedicationOrde by ID

MedicationStatement Search Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/MedicationStatement?[parameter=value]

Search

Get

Retrieves current medications

 

Parameter Name

Parameter Type

Description

patient

Reference

Retrieve data by patient ID.

status

Token

Status of active, completed, intended, and non activated to filter the list of current medications. 

effectiveDate

Date

Retrieves current medications list by the effective date.

Examples

Query

Result

/MedicationStatement?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32

Returns all active current meds for Alice Neman

/MedicationStatement?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32&status=active,completed

Returns active and completed MedicationStatement resources for Jason Argonaut.


 

Allergies

This will allow you to retrieve known allergies for a patient.  The FHIR AllergyIntolerance resource defines clinical information about a patient's allergic response to a substance. The AllergyIntolerance resource displays the substance reacted to, level of severity, type of reaction, and onset date. 

AllergyIntolerance Search Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/AllergyIntolerance?[parameter=value]

Search

Get

Retrieve AllergyIntolerance using the specified search criteria.


Parameter Name

Parameter Type

Description

patient

Reference

Search for AllergyIntolerance resources by patient ID.

onset

Date

Further refine a search for AllergyIntolerances by onset date


AllergyIntolerance Read Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/AllergyIntolerance/{ID}

Read

Get

Retrieve details about AllergyIntolerance ID



 

Condition

The Condition function is retrieves a patient’s problems, diagnoses, or other health concerns during the encounter or visit. Conditions are typically associated with other resources, such as the reason for a prescription, procedure, diagnostic test, etc... A Condition might be acute or chronic, but it is not used to represent an adverse reaction or an allergy intolerance.

Search Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/Condition?[param=value]

Search

Get

Retrieve Condition function using the specified search criteria.



Parameter Name

Parameter Type

Description

patient

Reference

Search for Condition function by a patient ID.

category

Token

Indicates the type of Condition resource associated with the patient. The standard FHIR category code of diagnosis, along with the Extension Codes defined by the Argonaut project of problem and health-concern are supported as options.

clinicalStatus

Token

Further refine a search for Conditions by providing a status of the condition. By default, confirmed Condition resources are returned. Statuses of confirmed and resolved are supported.

onset

Date

Further refine a search for Conditions by providing by specifying a date or range of dates for when the condition first affected the patient. Note: all active conditions will be returned in the response in addition to other data returned in the search.

Examples

Query

Result

/Condition?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32

Returns all Conditions for Alice Newman

/Condition?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32&category=diagnosis&clinicalStatus=resolved

Returns all resolved Conditions for Alice Newma

/Condition?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32&category=health-concern

Returns all Conditions for Alice Newman of category healthConcern



 

Observations

The FHIR Observation function defines information about a measurement, observation, or test results about a patient. The below documentation describes how the Observation resource is used to:

  • Provide measurements gathered as a vital sign or flowsheet data point.

  • Describe analyte level result information or sensitivities and isolates from a microbiology analysis.

  • Retrieve the patient's current smoking status.

Examples of common observations are: Laboratory results (blood sugar, hemoglobin), Vital signs (temperature, blood pressure), Personal characteristics (height, weight), and Social history (tobacco/alcohol use, employment status).

Observation Search Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/Observation?[parameter=value]

Search

Get

Retrieves Observation function that meet the specified search criteria


Parameter Name

Parameter Type

Description

patient

Reference

Search for Observation function for a specified patient ID. Both patient and code or category are required for a valid patient-based search.

code

Token

Search for Observation function for a valid LOINC code. Both patient and code (or category) are required for a valid patient-based search.

category

Token

Search for Observation function for a valid category (vital-signs, social-history, laboratory). Both patient and category (or code) are required for a valid patient-based search.

date

Date

Further refine a search for a given set of result- or vital sign-based Observations by specifying a date or date range in XML format (YYYY-MM-DD) for when the observation was resulted or recorded.

issued

Date

Further refine a search for a smoking history Observations by specifying a date or date range in XML format (YYYY-MM-DD) for when the observation was recorded.

Examples

Query

Result

/Observation?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32&code=8310-5

Returns all temperature (8310-5) Observations for Alcie Newman.

/Observation?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32&code=3141-9&date=20150622

Returns all weight (3141-9) Observations for Alice Newman documented on June 22, 2015.

/Observation?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32&code=1975-2

Returns all bilirubin (1975-2) Observations for Jason Argonaut.

/Observation?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32&code=718-7&date=lt20190101

Returns all hemoglobin (718-7) Observations for Alice Newman resulted prior to 2019.

/Observation?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32&code=72166-2

Returns the current Smoking History status (72166-2) Observation for Alice Newman

Observation Read Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/Observation/{ID}

Read

Get

Retrieve details about Observation ID


 

Diagnostic Report

Retrieves radiology diagnostic reports.The FHIR DiagnosticReport function contains information about a single diagnostic service performed for a patient. Individual components and text-based content, such as narratives or impressions, are represented within the DiagnosticReport with a FHIR Observation resource

DiagnosticReport Search Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/DiagnosticReport?[parameter=value]

Search

Get

Retrieves DiagnosticReport function that meet the specified search criteria



Parameter Name

Parameter Type

Description

patient

Reference

Search for DiagnosticReport function by patient ID.

date

Date

Filter DiagnosticReports for a patient by specifying a date or date range in XML format (YYYY-MM-DD) for when the DiagnosticReport was resulted.


Examples

Query

Result

/DiagnosticReport?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32

Retrieve all Diagnostic Reports for Alice Newman

DiagnosticReport?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32&date=gt2016-02-01&date=lt2015-05-22

Retrieve all Diagnostic Reports for Jason Argonaut resulted in June, 22 2015

DiagnosticReport Read Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/DiagnosticReport/{ID}

Read

Get

Retrieve details about DiagnosticReport ID



 

Immunization Records

This will allow you to retrieve immunizations administered and Immunization history for a patient.

Immunization Search Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/Immunization?[parameter=value]

Search

Get

Retrieves Immunization function that meet the specified search criteria


Parameter Name

Parameter Type

Description

patient

Reference

Search for Immunization resources for a specified patient ID.

date

Date

Further refine a search for a given set of Immunizations on a patient by specifying a date or date range in XML format (YYYY-MM-DD) for when the Immunization was administered or last documented.

Examples

Query

Result

/Immunization?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32

Retrieve Immunization resources for Alice Newman.

/Immunization?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32&date=gt2015-06-01

Retrieve Immunization resources for Alice Newman administered after June 1, 2015

Immunization Read Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/Immunization/{ID}

Read

Get

Retrieve details about Immunization ID



 

Procedures

The FHIR Procedure function retrieves surgeries and procedures performed, including endoscopies and biopsies, as well as less invasive actions like counseling and physiotherapy. 

Procedure Search Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/Procedure?[parameter=value]

Search

Get

Retrieves Procedure function that meet the specified search criteria


Parameter Name

Parameter Type

Description

patient

Reference

Search for Procedure function by patient ID.

date

Date

Further refine a search for a given set of Procedures on a patient by specifying a date or date range in XML format (YYYY-MM-DD) for when the Procedure was resulted.

Examples

Query

Result

/Procedure?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32

Retrieve all Procedures for Alice Newman.

/Procedure?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32&date=gt2015-12-31

Retrieve all Procedures for Alice Newman in 2015.

Procedure Read Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/Procedure/{ID}

Read

Get

Retrieve details about Procedure ID



 

Implanted Devices

This will allow you to retrieve a list of implanted devices installed in patient.

The FHIR Device resource describes information about a specific patient's durable, manufactured medical items. The below documentation describes only medical devices implanted in a patient.

Device Search Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/Device?[parameter=value]

Search

Get

Retrieves Device function that meet the specified search criteria



Parameter Name

Parameter Type

Description

patient

Reference

Search for Device resources for a specified patient ID.

type

Token

further filter devices for a given patient by restricting the results of a search to one or more device types.

udi

String

Further refine a search for a Devices by restricting the results of a search to one or more device udis as described by the device's FDA-mandated Universal Device Identifier.

_lastUpdated

Date

Further refine a search for a Devices by specifying a date or range of dates. Note: all currently implanted devices for the patient will be included in the response in addition to other results returned in the search.

Examples

Query

Result

/Device?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32

Retrieve all implanted devices documented for Alice Newman

/Device?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32&type=Pacemaker

Retrieve all implanted devices documented for Alice Newman which are of type "Pacemaker".

Device Read Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/Device/{ID}

Read

Get

Retrieve details about Device ID



 

CDA Document Retrieval

This will allow you to retrieve a CDA clinical summary document (CCDA 2.1) for a patient. The FHIR DocumentReference resource describes information about a document. The DocumentReference resource includes information about a document, the associated patient and author, and information about its creation. The DocumentReference function only contains metadata about the document. The actual document content is accessed via the Binary resource that is referenced in DocumentReference.content.attachment.url.

The FHIR Binary resource is the rendering of any FHIR resource with different native file types in XML or JSON. The below documentation describes the use of the Binary resource to retrieve CDA documents via FHIR API.

DocumentReference Search Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/DocumentReference?[parameter=value]

Search

Get

Retrieves DocumentReference function that meet the specified search criteria



Parameter Name

Parameter Type

Description

patient

Reference

Search for DocumentReference function by patient ID.

created

Date

Filter by a date or date range in XML format (YYYY-MM-DD) for when the DocumentReference was created.

class

Token

Further refine a search for a given set of DocumentReferences on a patient by specifying a document class to return only documents of that type.

Examples

Query

Result

/DocumentReference?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32

Retrieve all DocumentReference resources for Alice Newman

/DocumentReference?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32&created=2015-05-22

Retrieve all DocumentReference resources for Alice Newman created on June 22, 2015.

DocumentReference Read Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/DocumentReference/{ID}

Read

Get

Retrieve details about DocumentReference ID


 

Care Plan

Retrieve a patient’s longitudinal Care Plan health concerns and goals. The FHIR CarePlan function is a comprehensive Plan of Care that spans providers and specialties to display a complete summary of health concerns, goals, instructions, interactions, and outcomes. 

CarePlan Search Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/CarePlan?[parameter=value]

Search

Get

Retrieves CarePlan function that meet the specified search criteria

/Goals?[parameter=value]

Search

Get

Retrieves Goal function that meet the specified search criteria

CarePlan?patient=24e2b196-55a9-4041-bd89-2d025b9e5f32&category=team

/conditions?[parameter=value]&category=health-concern

Search

Get

Retrieves health concerns function that meet the specified search criteria

/CarePlan?[parameter=value]&category=team

Search

Get

Retrieves care team function that meet the specified search criteria



Parameter Name

Parameter Type

Description

patient

Reference

Search for CarePlan resources for a specified patient ID.

date

Date

Further refine the content within the CarePlan by providing by specifying a date or range of dates for what historical data should be included in the care plan. Note: all active historical data and all future data will be returned in the response in addition to other data returned in the search.

category

Token

Further refine which CarePlan resources are returned by category. There are two supported categories: 38717003 will return only the longitudinal care plan. 734163000 will return encounter-level care plans. If no category is specified, only the longitudinal care plan is returned.

Examples

Query

Result

/CarePlan?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32

Retrieve the CarePlan for Alice Newmant.

/CarePlan?patient=24E2B196-55A9-4041-BD89-2D025B9E5F32&category=38717003&category=734163000

Return both longitudinal and encounter-level CarePlans for Alice Newmant

CarePlan Read Interaction

Relative URL

FHIR Interaction

HTTP Method

Action

/CarePlan/{ID}

Read

Get

Retrieve details about CarePlan ID