CAREWareFHIRDataDictionary - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Implementation Prerequisites

Implementation Prerequisites

This page documents requirements common to all CAREWare FHIR actors used in this guide. The conformance verbs — SHALL, SHOULD, and MAY — used throughout this guide are defined in the FHIR Conformance Rules.

Before implementing the CAREWare FHIR interface, the implementing organization must have the necessary access, permissions, and information to establish a connection between CAREWare and the organization's electronic health record (EHR) system.

The exact requirements vary by EHR vendor and organizational configuration.

EHR Access and Administrative Privileges

The implementing organization SHALL have access to personnel with sufficient privileges within the EHR to register, approve, or configure CAREWare as an application.

The application registration process varies by EHR vendor. Depending on the EHR, registration may be performed through an application marketplace, developer portal, administrative console, or another vendor-specific process.

The organization SHALL be able to authorize CAREWare to access the FHIR resources required for the intended CAREWare workflows.

FHIR API Access

The EHR SHALL provide access to a FHIR R4 API containing the resources and data required for the intended CAREWare workflows.

The implementing organization SHALL obtain the connection information required to configure CAREWare. Depending on the EHR implementation, this may include:

• FHIR R4 base URL.
• OAuth 2.0 authorization or token endpoint.
• Client or application identifier.
• Required FHIR scopes or permissions.
• Authentication credentials or certificates.
• Vendor-specific application or organization identifiers.

Additional configuration MAY be required by individual EHR vendors.

CAREWare Access

The implementing organization SHALL have access to CAREWare personnel or users with sufficient permissions to configure the FHIR interface.

This includes the ability to configure the EHR connection, authentication information, FHIR resources, queries, and CAREWare mappings required by the implementation.

Vendor-Specific Requirements

EHR vendors MAY impose additional requirements for application registration, authentication, authorization, production approval, or FHIR API access.

Implementers SHOULD review the applicable EHR vendor's FHIR implementation documentation before configuring the CAREWare integration.

Vendor-specific requirements are outside the scope of the CAREWare FHIR profiles and do not affect conformance to those profiles.