0.1.0 - ci-build

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

Home

Official URL: http://jprog.com/ImplementationGuide/jprog.CAREWare Version: 0.1.0
Draft as of 2026-09-15 Computable Name: CAREWareFHIRDataDictionary

CAREWare FHIR Implementation Guide

Introduction

The CAREWare FHIR Implementation Guide defines the FHIR-based interface used to exchange data between electronic health record (EHR) systems and CAREWare.

CAREWare is a software application for managing and reporting health and supportive service information for programs funded through the Ryan White HIV/AIDS Program. The CAREWare FHIR interface is intended to simplify the exchange of data between EHR systems and CAREWare by using standardized FHIR resources, terminology, and APIs.

This Implementation Guide is based on HL7 FHIR R4 and builds upon the US Core Implementation Guide.

Purpose

The purpose of this guide is to provide a consistent, implementable specification for exchanging data required by CAREWare.

The guide defines:

  • FHIR profiles and terminology used by CAREWare.
  • Data elements required or supported by the CAREWare FHIR interface.
  • Mappings between FHIR data and CAREWare data elements.
  • FHIR REST API and search requirements used to retrieve data from an EHR.
  • Authentication and security requirements.
  • Implementation guidance for connecting EHR systems to CAREWare.
  • Examples demonstrating expected FHIR representations.

The goal is to minimize implementation-specific mapping and reduce duplicative data entry by providing a common FHIR representation for data consumed by CAREWare.

Scope

This guide defines requirements for FHIR-based data exchange between CAREWare and EHR systems.

The current version focuses on data used by CAREWare for Ryan White Services Report (RSR) reporting and related CAREWare workflows.

This guide covers:

  • FHIR R4 resources used by CAREWare.
  • CAREWare-specific FHIR profiles and constraints.
  • Required and supported terminology.
  • FHIR search interactions used by CAREWare.
  • Mapping FHIR resources to CAREWare and RSR data elements.
  • Authentication and authorization requirements.
  • CAREWare configuration requirements.
  • EHR-specific implementation guidance where necessary.

This guide does not define the RSR specification itself. RSR reporting requirements are established by the Health Resources and Services Administration (HRSA). This guide defines how applicable data can be represented and exchanged using FHIR for use by CAREWare.

Intended Audience

This guide is intended for:

  • EHR developers and integration engineers implementing a CAREWare interface.
  • CAREWare administrators configuring FHIR integrations.
  • Health information technology staff supporting Ryan White HIV/AIDS Program organizations.
  • Developers maintaining or extending CAREWare FHIR functionality.

FHIR and US Core

This Implementation Guide is based on HL7 FHIR R4 (4.0.1).

Where applicable, CAREWare profiles are based on profiles defined by US Core 6.1.0. CAREWare-specific profiles further constrain those profiles when additional requirements are necessary to support CAREWare workflows and RSR-related data.

Implementers SHALL follow the requirements defined by the applicable base FHIR and US Core profiles in addition to the requirements defined by this guide.

How to Read This Guide

Implementers should begin with the Conformance section to understand the requirements for claiming conformance with this guide.

The major sections of this guide are:

  • Conformance – Defines conformance expectations, Must Support behavior, and general requirements.
  • Implementation Prerequisites – Describes the access, permissions, and EHR requirements necessary to implement the CAREWare FHIR interface.
  • Artifacts – Contains the profiles, extensions, terminology, and other computable FHIR artifacts defined by this guide.
  • CAREWare FHIR overview – Provides instructions for configuring the FHIR interface in CAREWare.
  • CAREWare CWFP Mappings – Defines how FHIR data is interpreted and mapped to CAREWare using the CWFP language.
  • Security – Describes security and privacy considerations for implementations.