By Interface Type
FHIR
FHIR, or Fast Healthcare Interoperability Resources, provides a lightweight REST-based access layer for standard HL7-defined data models. If you're looking for more than specs, check out FHIR development sandbox for how you can get client IDs and testing support.
Account
The Account resource acts as a central record against which charges, payments, and adjustments are applied. It contains information about which parties are responsible for payment of the account.
Technical Specifications:
AdverseEvent
The AdverseEvent resource returns data about an event that caused unintended physical injury resulting from or contributed to by medical care, a research study, or other healthcare setting factors. These events might require additional monitoring, treatment, or hospitalization, or might result in the death of a patient.
Technical Specifications:
AllergyIntolerance
The AllergyIntolerance data models describe a patient's intolerance to a foreign substance and an associated reaction that occurs from exposure.
Appointment, Schedule, Slot
Appointment describes a patient's scheduled visit with a health care provider. The slot resource provides time-slots that can be booked using an appointment. They do not provide any information about appointments that are available, just the time, and optionally what the time can be used for. The Schedule resource is the link from a slot to a practitioner and location for an appointment.
Technical Specifications:
- Appointment.Read (Appointments) (STU3)
- Schedule.Read (STU3)
- Appointment $book (STU3)
- Appointment $find (STU3)
- Slot.Read (STU3)
- Appointment.Search (Appointments) (STU3)
- Appointment.Read (Appointments) (R4)
- Appointment.Search (Appointments) (R4)
- Appointment.Read (Scheduled Surgeries) (R4)
- Appointment.Search (Scheduled Surgeries) (R4)
Authentication and Single Sign-On (SSO)
See Tutorial
Binary
Binary provides the ability to retreive a particular document.
Technical Specifications:
- Binary.Read (Generated CCDA) (DSTU2)
- Binary.Read (Clinical Notes) (STU3)
- Binary.Read (Practitioner Photo) (R4)
- Binary.Read (Clinical Notes) (R4)
- Binary.Read (Document Information) (R4)
- Binary.Read (OASIS) (R4)
- Binary.Read (HIS) (R4)
- Binary.Read (Handoff) (R4)
- Binary.Read (Labs) (R4)
- Binary.Read (External CCDA) (R4)
- Binary.Read (Radiology Results) (R4)
- Binary.Read (Correspondences) (R4)
- Binary.Read (Radiology Results) (STU3)
- Binary.Read (Correspondences) (STU3)
- Binary.Read (IRF-PAI) (R4)
- Binary.Read (MDS) (R4)
- Binary.Read (Clinical Reference) (R4)
- Binary.Read (Patient-Entered Questionnaires) (STU3)
- Binary.Read (Patient-Entered Questionnaires) (R4)
- Binary.Read (Generated CCDA) (R4)
- Binary.Search (Clinical Notes) (R4)
- Binary.Search (Handoff) (R4)
- Binary.Search (Clinical Reference) (R4)
- Binary.Search (HIS) (R4)
- Binary.Search (IRF-PAI) (R4)
- Binary.Search (Labs) (R4)
- Binary.Search (Practitioner Photo) (R4)
- Binary.Search (Correspondences) (R4)
- Binary.Search (Generated CCDA) (R4)
- Binary.Search (External CCDA) (R4)
- Binary.Search (Document Information) (R4)
- Binary.Search (MDS) (R4)
- Binary.Search (OASIS) (R4)
- Binary.Search (Radiology Results) (R4)
- Binary.Search (Patient-Entered Questionnaires) (R4)
- Binary.Read (Practitioner Photo) (STU3)
- Binary.Read (Outside Record – Clinical Notes) (R4)
- Binary.Search (Outside Record — Clinical Notes) (R4)
- Binary.Read (Study) (R4)
BodyStructure
BodyStructure describes anatomical details about a specimen or body part, including patient information, descriptions, and images. For example, this resource can return tooth information from the patient record.
Bulk Data Access
FHIR Bulk Data Access, also known as Flat FHIR, is a framework for efficiently accessing large volumes of information about a group of individuals. For more information, refer to the HL7 specification, or Epic's FHIR Bulk Data Access Tutorial.
Technical Specifications:
CarePlan, Goal
Careplan describes the assessment and treatment plan for a particular patient. Goal describes provider-documented targeted outcomes for a patient to achieve.
Technical Specifications:
- CarePlan.Read (Encounter-Level) (DSTU2)
- CarePlan.Search (Encounter-Level) (DSTU2)
- Goal.Read (Patient) (DSTU2)
- Goal.Search (Patient) (DSTU2)
- Goal.Read (Patient) (STU3)
- Goal.Create (Patient) (STU3)
- Goal.Search (Patient) (STU3)
- Goal.Read (Patient) (R4)
- Goal.Search (Patient) (R4)
- CarePlan.Read (Longitudinal) (R4)
- CarePlan.Search (Longitudinal) (R4)
- CarePlan.Read (Encounter-Level) (R4)
- CarePlan.Search (Encounter-Level) (R4)
- CarePlan.Read (Dental) (R4)
- CarePlan.Search (Dental) (R4)
- CarePlan.Read (Questionnaires Due) (R4)
- CarePlan.Search (Questionnaires Due) (R4)
- CarePlan.Read (Inpatient) (R4)
- CarePlan.Search (Inpatient) (R4)
- CarePlan.Read (Outpatient) (R4)
- CarePlan.Search (Outpatient) (R4)
- Goal.Read (Care Plan) (R4)
- Goal.Search (Care Plan) (R4)
- CarePlan.Read (Oncology) (R4)
- CarePlan.Search (Oncology) (R4)
- Goal.Read (Pathway Step) (R4)
- Goal.Search (Pathway Step) (R4)
- CarePlan.Read (Inpatient Pathway) (R4)
- CarePlan.Search (Inpatient Pathway) (R4)
- CarePlan.Read (Care Path) (R4)
- CarePlan.Search (Care Path) (R4)
- Goal.Read (Care Path) (R4)
- Goal.Search (Care Path) (R4)
- CarePlan.Read (Patient Education) (R4)
- CarePlan.Search (Patient Education) (R4)
- Goal.Search (Care Plan) (STU3)
- Goal.Read (Care Plan) (STU3)
- CarePlan.Read (Longitudinal) (DSTU2)
- CarePlan.Search (Longitudinal) (DSTU2)
CareTeam
The CareTeam resource returns information about a patient’s care team and care team members. The care team includes longitudinal care team assignments as well as providers who have had recent visits with the patient. The patient's inpatient treatment team is not included in this resource. Inpatient treatment team members are instead included as participants in the relevant Encounter resource.
CDS Hooks read the spec
Communication
The Communication resource represents a record of communication. This resource can convey details about messages between health systems and community-based organizations about referral requests made through continued care and services workflows in Epic, such as a post-discharge service request for durable medical equipment (DME) or social services.
Technical Specifications:
Condition
Conditions can encompass acute and chronic problems and conditions, as well as encounter diagnoses.
Technical Specifications:
- Condition.Read (Problems) (DSTU2)
- Condition.Search (Problems) (DSTU2)
- Condition.Create (Problems) (STU3)
- Condition.Read (Encounter Diagnosis, Problems) (STU3)
- Condition.Search (Encounter Diagnosis, Problems) (STU3)
- Condition.Create (Problems) (R4)
- Condition.Read (Encounter Diagnosis) (R4)
- Condition.Read (Problems) (R4)
- Condition.Search (Encounter Diagnosis) (R4)
- Condition.Search (Problems) (R4)
- Condition.Read (Health Concern) (R4)
- Condition.Search (Health Concern) (R4)
- CDS Hooks Condition.Create (Problems) (R4)
- CDS Hooks Condition.Create (Encounter Diagnosis) (R4)
- CDS Hooks Condition.Create (Encounter Diagnosis, Problems) (STU3)
- Condition.Read (Genomics) (R4)
- Condition.Search (Genomics) (R4)
- Condition.Read (Care Plan Problem) (R4)
- Condition.Search (Care Plan Problem) (R4)
- Condition.Read (Dental Finding) (R4)
- Condition.Search (Dental Finding) (R4)
- Condition.Read (Infection) (R4)
- Condition.Search (Infection) (R4)
- Condition.Read (Reason for Visit) (R4)
- Condition.Search (Reason for Visit) (R4)
- Condition.Read (Medical History) (R4)
- Condition.Search (Medical History) (R4)
Consent
The FHIR Consent resource defines a concept around collected consent for some action. Consent resources correspond to Documents in Epic. The Consent.Search interaction returns only metadata about the patient consent document(s) on file, such as the type of consent and the effective period. This resource does not return the consent document itself. Typically this resource is used to check whether a consent document is on file for a particular patient. The Consent resource is intended only for provider-facing applications. Patient-facing applications cannot use this resource.
Contract
The Contract resource is primarily used for read interactions and can be used as a reference when calling the DocumentReference.Create interaction.
Coverage
Coverage resources represent an insurance coverage associated with the patient. A patient might have a long list of possible coverages, some of which are applicable only for specific services. Examples include third party liability, worker's comp, black lung insurance, Medicaid for ESRD, Medicare, commercial, etc.
Technical Specifications:
COVID SMART Scheduling Links
Provides an Epic implementation of the SMART Scheduling Links standard, a lightweight appointment availability publishing API designed to make it easy for organizations to publish COVID vaccine appointment slot availability in cooperation with outside websites, vendors, or government programs.
Technical Specifications:
Device, DeviceRequest, DeviceUseStatement
The Device, DeviceRequest, and DeviceUseStatement resources define data about a patient's implanted and external devices, requests for devices, and information about how those devices are used.
Technical Specifications:
- Device.Read (Implants) (DSTU2)
- Device.Search (Implants) (DSTU2)
- Device.Read (Implants and External Devices) (STU3)
- Device.Search (Implants and External Devices) (STU3)
- Device.Read (Implants) (R4)
- Device.Search (Implants) (R4)
- DeviceRequest.Read (STU3)
- DeviceRequest.Search (STU3)
- DeviceRequest.Search (R4)
- DeviceUseStatement.Read (Implants and External Devices) (STU3)
- DeviceUseStatement.Search (Implants and External Devices) (STU3)
- DeviceUseStatement.Read (Implants) (R4)
- DeviceUseStatement.Search (Implants) (R4)
- Device.Read (External Devices) (R4)
- Device.Search (External Devices) (R4)
- DeviceUseStatement.Read (External Devices) (R4)
- DeviceUseStatement.Search (External Devices) (R4)
- DeviceUseStatement.Search (LDAs) (R4)
- DeviceUseStatement.Search (LDAs) (STU3)
- DeviceUseStatement.Read (LDAs) (STU3)
- DeviceUseStatement.Read (LDAs) (R4)
- Device.Search (LDA) (R4)
- Device.Search (LDA) (STU3)
- Device.Read (LDA) (R4)
- Device.Read (LDA) (STU3)
DiagnosticReport
DiagnosticReport describes the findings associated with a diagnostic laboratory procedure.
Technical Specifications:
- DiagnosticReport.Read (Results) (DSTU2)
- DiagnosticReport.Search (Results) (DSTU2)
- DiagnosticReport.Read (Results) (STU3)
- DiagnosticReport.Search (Results) (STU3)
- DiagnosticReport.Read (Results) (R4)
- DiagnosticReport.Search (Results) (R4)
- DiagnosticReport.Read (Care Plan Goal) (R4)
- DiagnosticReport.Search (Care Plan Goal) (R4)
- DiagnosticReport.Read (Care Plan Goal) (STU3)
- DiagnosticReport.Search (Care Plan Goal) (STU3)
Document & Image Management read the spec
DocumentReference
DocumentReference provides a list of available documents for a patient. CDA documents and clinical notes are examples of documents that this resource may return.
Technical Specifications:
- DocumentReference.Read (Generated CCDA) (DSTU2)
- DocumentReference.Search (Generated CCDA) (DSTU2)
- DocumentReference.Read (Clinical Notes) (STU3)
- DocumentReference.Create (Clinical Notes) (STU3)
- DocumentReference.Search (Clinical Notes) (STU3)
- DocumentReference.Create (Clinical Notes) (R4)
- DocumentReference.Read (Clinical Notes) (R4)
- DocumentReference.Search (Clinical Notes) (R4)
- DocumentReference.Read (Document Information) (R4)
- DocumentReference.Create (Document Information) (R4)
- DocumentReference.Update (Document Information) (R4)
- DocumentReference.Read (OASIS) (R4)
- DocumentReference.Search (OASIS) (R4)
- DocumentReference.Read (HIS) (R4)
- DocumentReference.Search (HIS) (R4)
- DocumentReference.Read (Handoff) (R4)
- DocumentReference.Search (Handoff) (R4)
- DocumentReference.Read (Labs) (R4)
- DocumentReference.Search (Labs) (R4)
- DocumentReference.Read (External CCDA) (R4)
- DocumentReference.Search (External CCDA) (R4)
- DocumentReference.Read (Radiology Results) (R4)
- DocumentReference.Search (Radiology Results) (R4)
- DeviceRequest.Read (R4)
- DocumentReference.Read (Radiology Results) (STU3)
- DocumentReference.Read (Correspondences) (R4)
- DocumentReference.Read (Correspondences) (STU3)
- DocumentReference.Search (Correspondences) (STU3)
- DocumentReference.Search (Correspondences) (R4)
- DocumentReference.Search (Radiology Results) (STU3)
- DocumentReference.Read (MDS) (R4)
- DocumentReference.Search (MDS) (R4)
- DocumentReference.Read (IRF-PAI) (R4)
- DocumentReference.Search (IRF-PAI) (R4)
- DocumentReference.Read (Non-Patient Document Information) (R4)
- DocumentReference.Create (Non-Patient Document Information) (R4)
- DocumentReference.Search (Document Information) (R4)
- DocumentReference.Read (Clinical Reference) (R4)
- DocumentReference.Search (Clinical Reference) (R4)
- DocumentReference.Read (Patient-Entered Questionnaires) (STU3)
- DocumentReference.Search (Patient-Entered Questionnaires) (STU3)
- DocumentReference.Read (Patient-Entered Questionnaires) (R4)
- DocumentReference.Search (Patient-Entered Questionnaires) (R4)
- DocumentReference.Read (Generated CCDA) (R4)
- DocumentReference.Search (Non-Patient Document Information) (R4)
- DocumentReference.Search (Generated CCDA) (R4)
- Communication.Search (Non-Patient Customer Relationship Management) (R4)
- Communication.Search (Customer Relationship Management) (R4)
- DocumentReference.Search (Outside Record - Clinical Notes) (R4)
- DocumentReference.Read (Outside Record — Clinical Notes) (R4)
Encounter
The Encounter resource defines the setting where patient care takes place. This includes ambulatory, inpatient, emergency, home health, and virtual encounters. If you want to store upcoming appointment information, use the Appointment resource instead of Encounter.
Endpoint
The FHIR Endpoint resource describes the technical details of a location that can be connected for the delivery or retrieval of information. The resource contains information on how to connect and for what purposes. This endpoint does not need to be the current system, it can describe locally hosted services, regional services, or national services. Talk to the target organization for their supported protocols when using this resource.
Technical Specifications:
EpisodeOfCare
The EpisodeOfCare resource returns information about a patient's episode of care, including the episode type, care team members, diagnoses, and start and end dates.
Technical Specifications:
ExplanationOfBenefit
ExplanationOfBenefit resources represent claims data received and processed by health plans, including services rendered to a patient and the cost information associated with those services.
Technical Specifications:
FamilyMemberHistory
FamilyMemberHistory describes the conditions, history, and relationship information of a patient's family members.
Technical Specifications:
Flag
The Flag resource retrieves patient FYI flags from the patient chart. Patient FYIs are short, free-text notes associated with a patient or with a specific encounter for that patient.
Technical Specifications:
- Flag.Read (Patient FYI) (R4)
- Flag.Search (Patient FYI) (R4)
- Flag.Read (Patient FYI) (STU3)
- Flag.Search (Patient FYI) (STU3)
- Flag.Search (Isolation) (R4)
- Flag.Read (Isolation) (R4)
- Flag.Read (Health Concern) (R4)
- Flag.Search (Health Concern) (R4)
- Flag.Read (Infection) (R4)
- Flag.Search (Infection) (R4)
- Flag.Read (Infection) (STU3)
- Flag.Search (Infection) (STU3)
- Flag.Read (Health Concern) (STU3)
- Flag.Search (Health Concern) (STU3)
Group
The Group resource represents information about a collection of people or other entities. In Epic workflows, for example, this resource is used to represent an employer group that is part of a health plan.
Technical Specifications:
ImagingStudy
The ImagingStudy resource returns information related to a DICOM imaging study.
Technical Specifications:
Immunization, ImmunizationRecommendation
Immunization describes the details of a vaccine administered to a patient. ImmunizationRecommendation is available only to organizations in the Netherlands, and describes which immunizations are recommended for a patient.
Technical Specifications:
- Immunization.Read (DSTU2)
- Immunization.Search (DSTU2)
- Immunization.Read (STU3)
- Immunization.Search (STU3)
- Immunization.Read (R4)
- Immunization.Search (R4)
- ImmunizationRecommendation.Read (R4)
- ImmunizationRecommendation.Search (R4)
- ImmunizationRecommendation.Read (STU3)
- ImmunizationRecommendation.Search (STU3)
Incoming FHIR Message Acknowledgement - Denmark
Introspect
The Introspect web service allows an application using OAuth2 secured services to get data associated with an OAuth2 token. One useful function of this service is to allow the client application to determine the user associated with the OAuth2 token.
Technical Specifications:
List
The FHIR List resource defines a collection of records that can be used within many places. We support direct reading of the List resource to give access to Patient Lists. Reading is supported for those types of lists and system lists.
Technical Specifications:
- List.Read (Patient List) (STU3)
- List.Search (Patient List) (STU3)
- List.Search (Medications) (R4)
- List.Read (Medications) (R4)
- List.Read (Problems) (R4)
- List.Search (Problems) (R4)
- List.Read (Allergies) (R4)
- List.Search (Allergies) (R4)
- List.Read (Hospital Problems) (R4)
- List.Search (Hospital Problems) (R4)
- List.Read (Family History) (R4)
- List.Search (Family History) (R4)
- List.Read (Immunizations) (R4)
- List.Search (Immunizations) (R4)
- List.Search (Patient List) (R4)
- List.Read (Patient List) (R4)
Location
The FHIR Location resource defines details and position information for a physical place where resources and participants can be found.
Technical Specifications:
Medication, MedicationOrder, MedicationRequest, MedicationStatement, MedicationDispense
The Medication, MedicationOrder, MedicationRequest and MedicationStatement data models combine to model a patient's reported and prescribed medication orders and instructions. Medication provides information about each medication, independent of a patient. The MedicationOrder and MedicationRequest resources give a summary of the medication orders placed for the patient along with their status. The MedicationStatement resource gives a full-picture summary of all medications a patient may be taking, whether they are prescriptions or patient-reported medications. The MedicationDispense resource is available only to organizations in the Netherlands, and indicates how a medication product is to be or has been dispensed for a patient.
Technical Specifications:
- Medication.Read (DSTU2)
- MedicationOrder.Read (DSTU2)
- MedicationOrder.Search (DSTU2)
- MedicationStatement.Read (DSTU2)
- MedicationStatement.Search (DSTU2)
- Medication.Read (STU3)
- MedicationRequest.Read (Orders) (STU3)
- MedicationRequest.Search (Orders) (STU3)
- MedicationStatement.Read (STU3)
- MedicationStatement.Search (STU3)
- Medication.Search (DSTU2)
- Medication.Read (R4)
- MedicationRequest.Read (Signed Medication Order) (R4)
- MedicationRequest.Search (Signed Medication Order) (R4)
- CDS Hooks MedicationRequest.Create (Unsigned Order) (R4)
- CDS Hooks MedicationRequest.Create (Unsigned Order) (STU3)
- CDS Hooks MedicationRequest.Read (Unsigned Order) (R4)
- Medication.Search (R4)
- MedicationRequest.Read (Order Template) (R4)
- MedicationRequest.Search (Order Template) (R4)
- CDS Hooks MedicationRequest.Delete (Unsigned Order) (R4)
- CDS Hooks MedicationRequest.Delete (Unsigned Order) (STU3)
- MedicationDispense.Read (Verified Orders) (R4)
- MedicationDispense.Read (Verified Orders) (STU3)
- MedicationDispense.Search (Verified Orders) (STU3)
- MedicationDispense.Search (Verified Orders) (R4)
- MedicationAdministration.Search (LDAs) (R4)
- MedicationAdministration.Search (LDAs) (STU3)
- MedicationAdministration.Read (LDAs) (R4)
- MedicationAdministration.Read (LDAs) (STU3)
- MedicationDispense.Search (Fill Status) (R4)
- MedicationDispense.Read (Fill Status) (R4)
NutritionOrder
NutritionOrder describes diet order data including oral diets, oral nutrition supplements, enteral nutrition (tube feedings), and infant formula. It can also include details about a patient's food allergies, intolerances, and personal/cultural requirements or preferences.
Observation
This implementation of the Observation resource supports querying for vital signs, lab results, lines drains and airways (LDA-W), obstetric details, core characteristics, and smoking history.
Technical Specifications:
- Observation.Read (Labs) (DSTU2)
- Observation.Search (Labs) (DSTU2)
- Observation.Read (Social History) (DSTU2)
- Observation.Search (Social History) (DSTU2)
- Observation.Read (Vitals) (DSTU2)
- Observation.Search (Vitals) (DSTU2)
- Observation.Read (Labs) (STU3)
- Observation.Search (Labs) (STU3)
- Observation.Create (Vitals) (STU3)
- Observation.Read (Vitals) (STU3)
- Observation.Search (Vitals) (STU3)
- Observation.Read (Core Characteristics) (STU3)
- Observation.Search (Core Characteristics) (STU3)
- Observation.Read (Social History) (STU3)
- Observation.Search (Social History) (STU3)
- Observation.Create (LDA-W) (STU3)
- Observation.Read (LDA-W) (STU3)
- Observation.Search (LDA-W) (STU3)
- Observation.Update (LDA-W) (STU3)
- Observation.Create (LDA-W) (R4)
- Observation.Create (Vitals) (R4)
- Observation.Read (Core Characteristics) (R4)
- Observation.Read (LDA-W) (R4)
- Observation.Read (Social History) (R4)
- Observation.Read (Vitals) (R4)
- Observation.Search (Core Characteristics) (R4)
- Observation.Search (LDA-W) (R4)
- Observation.Search (Social History) (R4)
- Observation.Search (Vitals) (R4)
- Observation.Update (LDA-W) (R4)
- Observation.Read (Labs) (R4)
- Observation.Search (Labs) (R4)
- Observation.Read (Periodontal) (R4)
- Observation.Search (Periodontal) (R4)
- Observation.Read (SmartData Elements) (R4)
- Observation.Search (SmartData Elements) (R4)
- Observation.Read (Activities of Daily Living) (R4)
- Observation.Search (Activities of Daily Living) (R4)
- Observation.Read (Activities of Daily Living) (STU3)
- Observation.Search (Activities of Daily Living) (STU3)
- Observation.$lastn (Labs) (STU3)
- Observation.$lastn (Social History) (STU3)
- Observation.$lastn (Activities of Daily Living) (STU3)
- Observation.Read (Study Finding) (R4)
- Observation.Read (Obstetrics-Gynecology) (R4)
- Observation.Search (Obstetrics-Gynecology) (R4)
- Observation.Search (Study Finding) (R4)
- Observation.Search (Genomics) (R4)
- Observation.Read (Labor and Delivery) (R4)
- Observation.Search (Labor and Delivery) (R4)
- Observation.Read (Genomics) (R4)
- Observation.Read (Newborn Delivery) (R4)
- Observation.Search (Newborn Delivery) (R4)
- Observation.Read (Family Situation) (STU3)
- Observation.Read (Family Situation) (R4)
- Observation.Search (Family Situation) (R4)
- Observation.Search (Family Situation) (STU3)
- Observation.$lastn (Vitals) (STU3)
- Observation.Search (Assessments) (R4)
- Observation.Read (Assessments) (R4)
- Observation.Search (SDOH Assessments) (R4)
- Observation.Read (SDOH Assessments) (R4)
Organization
The read interaction of the Organization resource allows you to look up an organization using a constant server ID. The read interaction allows clients to store only the server ID, and with a single request, retrieve the most up-to-date information about an organization. Read interactions typically begin with a client having previously established a relationship, often through querying for Organization or PractitionerRoles through the search interaction.
Technical Specifications:
Outgoing Hospital Notification
Patient
This basic FHIR service covers data about persons receiving care or other health-related services. It focuses on the demographic information necessary to support administrative, financial, or logistic purposes.
Practitioner, PractitionerRole
The Practicioner service covers data about providers of care or other health-related services.
Procedure, ProcedureRequest, ServiceRequest
Procedure describes performed surgical, dental, and diagnostic procedures on a patient. ProcedureRequest and ServiceRequest define a request for a procedure to be planned, proposed, or performed. The results of ProcedureRequest and ServiceRequest are available in the Procedure resource or the DiagnosticReport resource.
Technical Specifications:
- Procedure.Read (Orders) (DSTU2)
- Procedure.Search (Orders) (DSTU2)
- ProcedureRequest.Read (Orders) (STU3)
- ProcedureRequest.Search (Orders) (STU3)
- Procedure.Read (Orders, Surgeries) (STU3)
- Procedure.Search (Orders, Surgeries) (STU3)
- Procedure.Read (Orders) (R4)
- Procedure.Search (Orders) (R4)
- ServiceRequest.Read (Order Procedure) (R4)
- ServiceRequest.Search (Order Procedure) (R4)
- CDS Hooks ServiceRequest.Create (Unsigned Order) (R4)
- CDS Hooks ProcedureRequest.Create (Unsigned Order) (STU3)
- ServiceRequest.Read (Dental Procedure) (R4)
- ServiceRequest.Search (Dental Procedure) (R4)
- Procedure.Read (Surgical History) (R4)
- Procedure.Search (Surgical History) (R4)
- CDS Hooks ServiceRequest.Read (Unsigned Order) (R4)
- Procedure.Read (Surgeries) (R4)
- Procedure.Search (Surgeries) (R4)
- ServiceRequest.Read (Community Resource) (R4)
- ServiceRequest.Search (Community Resource) (R4)
- ServiceRequest.Read (Order Template) (R4)
- ServiceRequest.Search (Order Template) (R4)
- CDS Hooks ServiceRequest.Delete (Unsigned Order) (R4)
- CDS Hooks ProcedureRequest.Delete (Unsigned Order) (STU3)
- ServiceRequest.Read (Referral) (R4)
- ServiceRequest.Read (Pregnancy Plans) (R4)
- ServiceRequest.Search (Pregnancy Plans) (R4)
- Procedure.Read (Surgical History) (STU3)
- Procedure.Search (Surgical History) (STU3)
- Procedure.Read (Nursing Intervention) (R4)
- Procedure.Search (Restricting Intervention) (R4)
- Procedure.Search (Restricting Intervention) (STU3)
- Procedure.Read (Restricting Intervention) (R4)
- Procedure.Read (Restricting Intervention) (STU3)
- Procedure.Read (Nursing Intervention) (STU3)
- Procedure.Search (Nursing Intervention) (R4)
- Procedure.Search (Nursing Intervention) (STU3)
- CDS Hooks ServiceRequest.Update (Unsigned Order) (R4)
- CDS Hooks ProcedureRequest.Update (Unsigned Order) (STU3)
- Procedure.Search (SDOH Intervention) (R4)
- Procedure.Read (SDOH Intervention) (R4)
Provenance
Provenance returns contextual metadata about the origin of a different resource, such as who authored the data for the target resource, who transmitted it, or which organization such actions were performed on behalf of.
Technical Specifications:
Questionnaire, QuestionnaireResponse
The Questionnaire resource is an organized collection of questions intended to solicit information from patients, providers or other individuals involved in the healthcare domain. The QuestionnaireResponse resource provides a complete or partial list of answers to a set of questions filled when responding to a questionnaire.
Technical Specifications:
RelatedPerson
The FHIR RelatedPerson resource is typically an entity with a personal or professional relationship to the patient. RelatedPersons are often a source of information about the patient. For integrations with Epic, the RelatedPerson is represented by a MyChart account record ID and their link to a Patient record ID. Typically the RelatedPerson represents a MyChart proxy for the patient.
RequestGroup
A RequestGroup represents a group of related requests, such as MedicationRequest or ServiceRequest resources, that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
ResearchStudy
The ResearchStudy resource includes general information about the research studies tracked in Epic, including the title, status, identifier, and principal investigator. These studies focus on the safety, efficacy, comparative effectiveness, and other information about medications, devices, therapies, and other intervention and investigative techniques intended to increase the field of healthcare-related knowledge.
Technical Specifications:
ResearchSubject
The ResearchSubject resource includes general information about a research subject tracked in Epic, including the study, study arm, consent status, and other key items. Epic tracks human beings only for research associations.
Technical Specifications:
Security Information and Event Management (SIEM)
Specimen
The specimen resource covers substances used for diagnostic and environmental testing. The specimen resource focuses on the process for gathering, maintaining and processing the specimen as well as where the specimen originated.
Technical Specifications:
Substance
Substance returns basic information about a substance, such as the code or set of codes that identify the substance. For example, this resource can describe an electrolyte ion component of a total parenteral nutrition (TPN) medication.
Technical Specifications:
Task
The Task resource describes activities and tracks the completion state of those activities. It includes details such as the description of the task, the patient to whom it applies, who is expected to perform the task, and the task’s status. This resource can be used to track tasks associated with referral requests made through continued care and services workflows in Epic, such as a post-discharge service request for durable medical equipment (DME) or social services.
ValueSet
The ValueSet resource represents a subset of the codes in a code system that is supported by a given server. The $expand operation of the ValueSet resource can be used by a FHIR API consumer to determine what values to expect back from the server as a result of a Read or Search operation and what values they can pass in to the server when performing a Create or Update operation.
Technical Specifications: