Play with FHIR ®

A lightweight REST-based access layer for standard HL7-defined data models. Read the spec

Get FHIR'd up! Epic's Sandbox now supports DSTU2 resources. All resources below are supported in Epic's 2015 release and forward.

New to FHIR? Check out our tutorial to get started!

FamilyMemberHistory

The FHIR FamilyMemberHistory resource defines a patient's family history. This resource returns the current status, age, and medical and surgical history of relatives related to a specific patient.

To play in an interactive sandbox, navigate to this page
using Chrome, Safari, or Firefox ("FHIRFox"??).
 Click the button. Go on.
See more

Endpoints

FamilyMemberHistory Search Interaction

Relative URL FHIR Interaction HTTP Method Action
/FamilyMemberHistory?[parameter=value] Search Get Search for FamilyMemberHistory resources using the specified search criteria.

The search interaction enables the client to query for family histories based on a specified set of parameters. The FamilyMemberHistory Search endpoint allows clients to retrieve family history information for a specific patient. Epic's sandbox currently supports the following query parameters for family history queries:

Parameter Name Parameter Type Description
patient Reference Search for FamilyMemberHistory resources for a specified patient ID.
Examples
Query Result
/FamilyMemberHistory?patient=Tbt3KuCY0B5PSrJvCu2j-PlK.aiHsu2xUjUM8bWpetXoB Returns Family History for Jason Argonaut.

Read Interaction

Heads up: Epic's implementation of the FamilyMemberHistory resource only supports query-based interactions and retrieval based on patient ID. Accessing a particular family member history resource via the Read request is not supported.

Errors

When things go wrong, the Epic EMR responds with an error code and a human-readable description to describe the incorrect submission. Currently, the error code is not included in the REST version of the specification, but it is provided here for your reference. These codes are meant for developer use only - they should not be presented to end users. Instead, your application should interpret the codes and provide user-friendly resolution steps when data cannot be filed.

FHIR Errors come in two flavors:

  • Fatal Errors cause the response to contain no results and are usually due to requests from the client processed as invalid - missing or invalid data in the request, unauthorized access, or expired content in the system.
  • Warning Errors accompany a successful response and are used to indicate that part of a request could not be fulfilled - for example, if a status is unknown, but the request can be fulfilled, the API will return the data and indicate that part of the request couldn't be understood.

FHIR Error Codes

Error Code Severity Description Example
4100 Fatal The resource request contained an invalid parameter Invalid parameter such as a non existent patient ID: AllergyIntolerance?patient=foo
4101 Warning Resource request returns no results A request for data that was otherwise valid but no information was documented or found (i.e. a patient with no pertinent implanted devices, or a demographic search where no patients met the search criteria).
4102 Fatal The read resource request contained an invalid ID Invalid Resource ID: AllergyIntolerance/foo
4107 Fatal The read resource request has been merged Requesting a Patient which has been merged - in this event, in addition to the error response, we will respond with an HTTP Redirect status. To browsers and many HTTP clients, the redirect will be transparent.
4110 Fatal No parameters are provided in the search request An invalid search request such as : AllergyIntolerance?
4111 Fatal Required search parameter missing from request A request missing a required parameter (such as the patient): Condition?category=diagnosis
4112 Fatal The resource request contained an invalid combination of parameters A search containing multiple different patient ID: AllergyIntolerance?patient=[ID 1]&patient=[ID 2]
4113 Fatal Session ID for cached search results has expired. Making a request for previously accessed paginated search results after the search has expired.
4115 Fatal Required search parameter has an invalid value An invalid parameter required for searching: Condition?Patient=[ID]&category=foo
4117 Warning No CVX code for Immunization resource Request for an Immunization resource without a documented CVX code.
4118 Fatal User not authorized for request Request data that the authenticated user is not allowed access to view (i.e. a patient asking for data about a stranger's allergies).
4119 Warning Additional data may be present for patient Request data while authenticated as an authorized patient or patient proxy. Inidicates that data available to the patient may not be the complete medical record within the system.