Configuring FHIR for Search and Create Patient in EMRs
To allow registrars to use the PatientSecure client workflows to search for and create a patient in the Cerner and Epic EMR, you must configure an integration with the FHIR APIs.
Before You Begin
Before you begin, you must obtain the following information from Cerner or Epic for use with the FHIR APIs.
-
Account identifier for the FHIR service
-
Password for the FHIR service
-
Client identifier for the FHIR service
-
Web service URL to connect to the FHIR web service.
Overview of the FHIR APIs
PatientSecure's Search and Create feature integrates with your EMR's FHIR APIs to improve user experience and streamline registrar workflow.
Below are details about the APIs that PatientSecure consumes, based on EMR type.
Cerner
FHIR Type | Version | Resource | APIs | API documentation resources |
---|---|---|---|---|
FHIR API | R4 | Patient |
Patient.Read Patient.Search Patient.Create Patient.Patch |
https://fhir.cerner.com/millennium/r4/base/individuals/patient/ |
Epic
Access to these APIs requires a subscription to Epic's App Orchard Developer Program.
FHIR Type | Version | Resource | APIs | API documentation resources |
---|---|---|---|---|
FHIR API | STU3 | Patient |
Patient.Search |
https://apporchard.epic.com/Sandbox?api=883 |
Epic Private Write | n/a | n/a | PatientCreate(2019) |
https://apporchard.epic.com/Sandbox?api=933 |
Configuration Tasks
Install the PatientSecure FHIR Service on the application servers.
The integration requires that you install an additional service component on the PatientSecure application servers. Use the PatientSecure Server Console to install and configure the FHIR service.
For more information, see Adding a Server.
Configure External Systems in the PatientSecure Admin Console
Create an external system for FHIR and define its patient identifiers.
To configure an external FHIR system:
-
In the Admin Console, go to Settings > External Systems and Patient Identifiers.
The External Systems and Patient Identifiers page opens.
-
Click Add System. The Add/Edit Systems dialog opens.
-
Type a display name (case-insensitive, up to 30 characters) in the System Name box.
-
Select FHIR from the System type drop-down list.
-
Select Epic or Cerner from the EMR drop-down list.
-
From the FHIR version drop-down list, select the FHIR release number that applies to your EMR system:
-
For Epic, select STU3.
-
For Cerner, the default of R4 is selected.
-
-
In the Account ID box, enter the account identifier with the FHIR service.
-
In the Password box, enter the password for the FHIR service.
-
In the Client ID box, enter the client identifier with the FHIR service.
-
In the Web service URL box, enter the URL of the FHIR web service.
-
For Epic, configure the following settings:
- Enable the SSN required to create patient in Epic setting if your Epic workflows require a Social Security number to be entered when create a patient.
Type a default value in the Default SSN value if patient does not provide SSN box.
This value is used when the registrar does not know the patient's actual SSN at the time of patient creation but the EMR workflow requires a placeholder SSN. The default value is 000-00-0000.
-
In the Default department ID to create patient in Epic box, enter the department ID to pass to the Epic FHIR API.
-
In the Default department type to create patient in Epic box, enter the department type to pass to the Epic FHIR API.
- Enable the SSN required to create patient in Epic setting if your Epic workflows require a Social Security number to be entered when create a patient.
-
For Cerner, to map an organization:
-
In the Organization Mapping section, select the organization from the Organization name drop-down list. This organization name is the name as created in PatientSecure that is mapped to the Cerner Organization, and may contain the facility name.
-
In the Cerner Organization ID box, enter the Cerner Organization ID to be matched against the organization in PatientSecure.
-
In the EHR Source ID box, enter the EHR Source ID that determines which Cerner Domain is used with the APIs.
-
-
-
Click Add new to add a new patient identifier.
-
Select the patient identifier from the ID Name drop-down list.
-
In the FHIR ID Tag box, enter a name that will be visible to users working with the application.
- In the FHIR ID Type box, enter a FHIR ID type. The FHIR ID Type indicates which format PatientSecure will use when supplying a FHIR ID.
-
For Cerner, to configure additional active patient identifiers:
-
Click Add in the Additional OID column. The Additional OID info dialog opens.
-
In the System box, enter a value for the system.
-
In the Code box, enter a value for the code, and click Save.
-
-
Click the √ (check mark) at the end of the row to save the patient identifier, or click x to remove it.
-
Enable the Client Desktop Setting
Enable the PatientSecure client desktop setting to allow registrars to search and create patients.
To configure settings for client machines:
-
In the Admin Console, go to Settings > Client Settings > Desktop. For more information, see Desktop Settings.
-
Enable the Search the EMR from the PatientSecure client setting.
- Enable the Create patient in the EMR from the PatientSecure client setting to allow registrars to create a net new patient in the EMR from the PatientSecure client and enroll them in PatientSecure.