Electronic Health Information Export
The export of Electronic Health Information (EHI) is core functionality of the iCare system and this document satisfies the CMS requirements for the 21st Century Cures Act: Interoperability, Information Blocking, and the ONC Health IT Certification Program §170.315 (b)(10) Electronic Health Information export-
The iCare system offers several methods to export electronic health information.
- Single patient electronic health information You can use either of the following two methods to export individual patient data:
- A user with proper privileges can create export files via the iCare system’s CCDA and HIM features:
- Generate a CCD from within a patient chart by navigating to Reports > Clinical Summary > Continuity of Care and Referral Notes.
- Export Clinical Assessments and Notes by navigating to Patient Info > HIM Request.
- Patient data can be exported via FHIR by using the Patient REST API. See instructions below for Single Patient Search.
- A user with proper privileges can create export files via the iCare system’s CCDA and HIM features:
- Patient population electronic health information export. Patient data for populations or groups of patient can be exported by the following two methods.
- You may make a CSC request for export of the entirety of your organization’s clinical data. The files will be provided via SFTP or other requested means and will include a description of the data file formats and data dictionary.
- Population or group patient data can be exported via FHIR by using the Patient REST API. See instructions below for Population and Group Patient Search.
- Documentation. These export methods are described here and in the iCare Knowledge Base under Electronic Health Information Export.
Instructions – Exporting Patient Data via REST APIs
Introduction
- iCare provides a set of REST APIs that allows third-party entities to receive the data from the EHR
- API responses are formatted in accordance with Fast Healthcare Interoperability Resources (FHIR) standard. FHIR is a HL7 specification for seamless transfer of healthcare information electronically. The standardized resource types make application development simpler.
- The APIs supported by the iCare are as per the US Core,USCIS.Every resource is exposed as a URL, which can be obtained by accessing the API Root Endpoint.
- The response format for the patient search and individual criteria data requests are based on FHIR.
- The API is accessible in test and production environments.
User authorization:
- Users must have the Admin role or another role with PHI Export permission to access this feature. Enter the username and password to authorize
- Click on Authorize button
- You can receive any data by category. Please see below detailed descriptions of available data.
Generate authorization token using patient’s account
- You can also access data by using the patient’s account credentials. To reset the patient’s username and password, use the User Management feature in the Admin control panel. Once a token is generated it can be used to get the patient’s other information. Enter the patient’s username and password and click on the Authorize button.
- You will then receive the token to be used.
- For a single Patient to create a request, select the API for which you need to request the data and generate Access Token.
- For patient populations search, see the section below.
Single Patient Search
- URI: Patient?_id=<id> in your browser URI please add this value.
- Or can use
- URI: https://sandbox-r4.interopengine.com/fhir/r4/icare/Patient/id/$export , id = MRN.XXXXXX
- Request Parameters: id must be set to id of the patient MRN.
- Method: GET
- Example: https://sandbox-r4.interopengine.com/fhir/r4/icare/Patient?_id=MRN.XXXXXX
Population Patient Search:
To perform a population (bulk) patient search, first generate the token
Bulk patient – Token Generate
Post: https://sandbox-r4.interopengine.com/oauth/icare/token
Use the generated token as the bearer token
GET: https://sandbox-r4.interopengine.com/fhir/r4/icare/Patient/$export
Group Patient search:
To perform a group patient search, first generate the token
Group patient – Token Generate
Post: https://sandbox-r4.interopengine.com/oauth/icare/token
Use the generated token as the bearer token
GET: https://sandbox-r4.interopengine.com/fhir/r4/icare/Group/GroupID/$export
Data Elements:
CarePlan
- URI:CarePlan?category=assess-plan&patient=<id> in your browser URI please add this value.
- Or can use
- URI: https://sandbox-r4.interopengine.com/fhir/r4/icare/Patient/id/$export , id = MRN.XXXXXX
- Request Parameters: id must be set to id of the patient MRN.
- Method: GET
- Example:https://sandbox-r4.interopengine.com/fhir/r4/icare/CarePlan?category=assess-plan&patient=MRN.XXXXXX
AllergyIntolerance
- URI: AllergyIntolerance?patient=<id> – in your browser URI please add this value.
- Or can use
- URI: https://sandbox-r4.interopengine.com/fhir/r4/icare/Patient/id/$export , id = MRN.XXXXXX
- Request Parameters: id must be set to id of the patient MRN.
- Method: GET
- Example: https://sandbox-r4.interopengine.com/fhir/r4/icare/AllergyIntolerance?patient=MRN.XXXXXX
CareTeam
- URI: CareTeam?patient=<id>&status=active in your browser URI please add this value.
- Or can use
- URI: https://sandbox-r4.interopengine.com/fhir/r4/icare/Patient/id/$export , id = MRN.XXXXXX
- Request Parameters: id must be set to id of the patient MRN.
- Method: GET
- Example: https://sandbox-r4.interopengine.com/fhir/r4/icare/CareTeam?patient=MRN.XXXXXX&status=active
Condition
- URI:Condition?patient=<id> in your browser URI please add this value.
- Or can use
- URI: https://sandbox-r4.interopengine.com/fhir/r4/icare/Patient/id/$export , id = MRN.XXXXXX
- Request Parameters: id must be set to id of the patient MRN.
- Method: GET
- Example:https://sandbox-r4.interopengine.com/fhir/r4/icare/Condition?patient=MRN.XXXXXX
Device
- URI: Device?patient=<id> in your browser URI please add this value.
- Or can use
- URI: https://sandbox-r4.interopengine.com/fhir/r4/icare/Patient/id/$export , id = MRN.XXXXXX
- Request Parameters: id must be set to id of the patient MRN.
- Method: GET
- Example: https://sandbox-r4.interopengine.com/fhir/r4/icare/Device?patient=MRN.XXXXXX
DiagnosticReport
- URI: DiagnosticReport?category=LAB&patient=<id> in your browser URI please add this value.
- Or can use
- URI: https://sandbox-r4.interopengine.com/fhir/r4/icare/Patient/id/$export , id = MRN.XXXXXX
- Request Parameters: id must be set to id of the patient MRN.
- Method: GET
- Example: https://sandbox-r4.interopengine.com/fhir/r4/icare/DiagnosticReport?category=LAB&patient=MRN.XXXXXX
DocumentReference
- URI:DocumentReference?patient=<id>- in your browser URI please add this value.
- Or can use
- URI: https://sandbox-r4.interopengine.com/fhir/r4/icare/Patient/id/$export , id = MRN.XXXXXX
- Request Parameters: id must be set to id of the patient MRN.
- Method: GET
- Example:https://sandbox-r4.interopengine.com/fhir/r4/icare/DocumentReference?patient=MRN.XXXXXX
Note: Document Reference is generating one URL,which is containing all the information about Assessment,Notes and Documents tabs.
Goal
- URI: Goal?patient=<id> in your browser URI please add this value.
- Or can use
- URI: https://sandbox-r4.interopengine.com/fhir/r4/icare/Patient/id/$export , id = MRN.XXXXXX
- Request Parameters: id must be set to id of the patient MRN.XXXXXX
- Method: GET
- Example: https://sandbox-r4.interopengine.com/fhir/r4/icare/Goal?patient=MRN.XXXXXX
Immunization
- URI: Immunization?patient=<id> in your browser URI please add this value.
- Or can use
- URI: https://sandbox-r4.interopengine.com/fhir/r4/icare/Patient/id/$export , id = MRN.XXXXXX
- Request Parameters: id must be set to id of the patient MRN.
- Method: GET
- Example:https://sandbox-r4.interopengine.com/fhir/r4/icare/Immunization?patient=MRN.XXXXXX
MedicationRequest
- URI: MedicationRequest?intent=proposal&patient=<id>- in your browser URI please add this value.
- Or can use
- URI: https://sandbox-r4.interopengine.com/fhir/r4/icare/Patient/id/$export , id = MRN.XXXXXX
- Request Parameters: id must be set to id of the patient MRN.
- Method: GET
- Example: https://sandbox-r4.interopengine.com/fhir/r4/icare/MedicationRequest?patient=MRN.XXXXXX
Observation
- URI: Observation?code=2708-6&patient=<id> in your browser URI please add this value.
- Or can use
- URI: https://sandbox-r4.interopengine.com/fhir/r4/icare/Patient/id/$export , id = MRN.A006054
- Request Parameters: id must be set to id of the patient MRN.
- Method: GET
- Example: https://sandbox-r4.interopengine.com/fhir/r4/icare/Observation?code=2708-6&patient=MRN.A006077
Procedure
- URI: Procedure?patient=<id> in your browser URI please add this value.
- Or can use
- URI: https://sandbox-r4.interopengine.com/fhir/r4/icare/Patient/id/$export , id = MRN.XXXXXX
- Request Parameters: id must be set to id of the patient MRN.
- Method: GET
- Example: https://sandbox-r4.interopengine.com/fhir/r4/icare/Patient?_id=MRN.XXXXXX
Encounter
- URI: Patient?_id=<id> in your browser URI please add this value.
- Or can use
- URI: https://sandbox-r4.interopengine.com/fhir/r4/icare/Patient/id/$export , id = MRN.XXXXXX
- Request Parameters: id must be set to id of the patient MRN.
- Method: GET
- Example: https://sandbox-r4.interopengine.com/fhir/r4/icare/Procedure?patient=MRN.XXXXXX
Note that items related to psychotherapy will not be included in any data export.