Protocols for Clinical Registry Extraction and Data Submission (CREDS) IG
0.1.0 - ci-build

Protocols for Clinical Registry Extraction and Data Submission (CREDS) IG, published by Clinical Interoperability Council. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of and changes regularly. See the Directory of published versions


About This Guide

The IG demonstrates a process and workflow to support the needs of clinical registries to define how registry submissions can be automatically extracted from multiple data sources and combined into a registry submission. It profiles the definitional resources needed to collect data and construct a registry submission using existing FHIR resource profiles.

Organization of This Guide

This guide is organized into four main sections:

  1. Introduction and Scope - General introduction to the CREDS use case
    1. Overview - Provides an overview of the challenges this effort is trying to address.
    2. Use Cases - Illustrates key use cases
  2. Architecture - Illustrates the conversion steps and transactions
    1. Technology Environment - Describes the technology environment for uninitiated.
    2. Security Considerations - Documents security concerns and mitigations
    3. Actors - Provides an overview of technical components
    4. Profiles - FHIR Resource Profiles created by this IG
  3. Transactions
    1. Search / Retrieve Registry Definition
    2. Create / Update Registry Definition
    3. Retrieve Registry Submission Data
    4. Create / Update Registry Submission
    5. Validate Registry Submission
  4. Test Plan - Testing for a conformant system
    1. Conformance - Conformance requirements

Click on any of the links above or refer to the table of contents, or if you are looking for a specific artifact, refer to the index.

You can also download:

The source code for this Implementation Guide can be found on

CREDS and MedMorph

CREDS focuses on providing healthcare provider organizations information on how to collect the data needed to submit to registries. This may include but is not limited to data sources such as EHRs, HIEs and other sources using FHIR, HL7 CDA documents, and HL7 V3 messages that are not available via FHIR APIs.

The MedMorph Reference Architecture (RA) specifies the use of standard FHIR APIs to collect data from EHRs and potentially other systems and exchange with systems that can receive data in FHIR format. The RA can support multiple use cases through content IGs based on the MedMorph RA IG, including but not limited to case-based surveillance, registry reporting, national health care surveys, and research.

Use cases that can obtain all the needed data via FHIR APIs should consider the use of the MedMorph RA as the basis for their efforts. Use cases that need to obtain data not available via FHIR APIs should consider the use of CREDS. Once there is a CREDS FHIR bundle, the MedMorph RA could be used for transport.