Tutorials

Use Cases

Interface

Examples & Testing

Endpoints

Understanding Resources

All FHIR requests are based on resources - modular health data components. For example, a Patient is a resource, as is a Medication. Resources stand on their own, but may have relationships with each other. An Encounter may relate back to a particular Patient and involve several Observations.

Contents

Supported Resources

Below is a list of all possible resources supported by the CareEvolution FHIR Interface. The exact list of available resources may vary from site to site and from endpoint to endpoint.

Resource Description
Allergy Intolerance Includes allergies, intolerances, and other adverse reactions to substances.
Audit Event Includes a variety of informational messages about application security, such as failed login attempts and resource access.
Basic Concepts not covered by the base FHIR standard.
Binary Contains static content, such as a PDF file or image. Binary resources are commonly referenced from other resources.
Care Plan A general resource that represents a provider’s intention to care for patients.
Care Team The team and tasks used in Care Management.
Claim Represents a list of services given to an insurance company for recovering payment.
Condition Tracks problems, conditions or diseases recorded by a clinician.
Coverage Represents insurance plans to cover claims or other health care services.
Device Used to represent any form of durable equipment or device used in the course of treatment.
Diagnostic Order Represents a request for a diagnostic service.
Diagnostic Report Represents the results or findings of a diagnostic test.
Document Manifest A set of related documents.
Document Reference Represents some form of document available to the information system, such as a CDA or FHIR document. The reference can point to another external system or to a Binary resource.
Encounter Represents interactions between a healthcare provider and patient.
Explanation Of Benefit Summarizes information from claims and claim responses to inform a patient about their coverage for services provided.
Family Member History Placeholder. Not currently implemented.
Goal Used to document the objectives related to a patient’s care.
Group A group of patients.
Immunization Represents a vaccination administered to a patient.
List Summarizes information from other resources.
Location Represents a physical location where providers or services can be found.
Medication Administration Represents an instance of a medication being administered to a patient.
Medication Dispense Records when a medication has been dispensed from a supply area for a patient.
Medication Order Represents a prescription or any other more general order for supplying medication to a patient.
Medication Request A request to provide medication to a patient. Includes prescriptions, orders, and other general medication requests across different settings.
Medication Statement A general statement that a medication is being taken by a patient. This can include over the counter medications as well as prescriptions.
Observation Represents information gathered about a patient, including vital signs, laboratory data, and other assessments.
OperationDefinition API operations or named queries.
Organization Any group, including a department, company or institution.
Patient Represents an individual receiving medical care.
Person Stores information about a person outside of a health context; e.g., for administrative purposes.
Practitioner Represents an individual involved in providing health care services.
Procedure Represents an action or intervention performed on a patient.
Provenance Helps to track the source and authenticity of other resources.
Questionnaire Represents surveys and other lists of questions.
Referral Request Used to capture a patient care referral or transfer request.
Related Person Can represent anyone involved in the care of a patient who has no formal responsibility (e.g., a home caregiver or family member).
Risk Assessment An assessment about potential outcomes for a patient.
Service Request A request for services such as diagnostic tests or treatments.
Specimen Represents a sample used for analysis.
Subscription A push-based subscription to the server.
Task A task to be performed.
Value Set A set of codes used in coding systems.

Identifiers

Each resource has a unique internal ID that permanently identifies it within the HIEBus system. For example, a particular patient my have the ID “d11cf621-ccc0-4492-9e0e-20ee5361fb6e.”

You can use this ID in FHIR operations to access the resource. For example, you could access that patient through the endpoint using [base]/Patient/d11cf621-ccc0-4492-9e0e-20ee5361fb6e.

In addition, resources may have zero or more external identifiers that identify it outside of HIEBus. For example, a patient may have some Medical Record Numbers from different facilities, a state Driver’s License Number, and so on. Unlike the internal ID, external identifiers cannot be used to reference the resource directly. They may be used in searches, as described in requests.

Have questions about the HIEBus FHIR interface? Contact us at fhir@careevolution.com.

Terms of Use

© 2023 CareEvolution, LLC