Protocols for Clinical Registry Extraction and Data Submission (CREDS) IG
1.0.0 - STU1 United States of America flag

Protocols for Clinical Registry Extraction and Data Submission (CREDS) IG, published by HL7 International / Clinical Interoperability Council. This is not an authorized publication; it is the continuous build for version 1.0.0. This version is based on the current content of https://github.com/HL7/fhir-registry-protocols-ig/ and changes regularly. See the Directory of published versions

Use Cases

The following use cases were used to identify the requirements addressed by this guide:

These are described in more detail in the sections that follow.

Define Submission

The registry authority defines the logical data model which describes the data to be submitted to the registry, and the transforms which format data stored using that model to the appropriate submission format.

This use case is supported by the following

Registry Authority [Registry Submission Definition Creator]Registry Definition Repository [Registry Submission Definition Repository]1. Create submission definition artifacts for logical model.2. Update submission definition artifacts for logical model.3. Create submission definition transformation for logical model.4. Update submission definition transformation for logical model.
Figure 2.3.1.1-1: Define Submission Process Flow

  1. Create submission definition artifacts. The Registry Authority creates the definition and submits it to a repository for distribution to registry submitters.

  2. Update submission definition artifacts. A previously submitted definition artifact is updated to add data submission requirements.

  3. Create submission definition transformation. The Registry Authority creates a transformation and submits it to a repository for distribution to registry submitters.

  4. Update submission definition transformation. The Registry Authority updates a transformation and submits it to a repository for distribution to registry submitters.

Search and Read Submission Definition

A registry submitter reads the logical data model and transformations.

This use case is supported by the following

Search and Read Submission Definition Process Flow

Registry Submission Definition CreatorRegistry Submitter [Registry Submitter]1. Search submission definition artifacts in repository.2. Read submission definition artifacts from repository.
Figure 2.3.1.2-1: Search and Read Submission Definition Process Flow

  1. Search submission definition artifacts. The Registry Submitter searches for registry submission definitions and transforms contained in a repository

  2. Read submission definition artifacts. The Registry Submitter reads the registry submission definitions and transforms contained in a repository necessary for creating a submission.

Get Patient List

A registry submitter retrieves the list of patients for whom a submission must be created.

This use case is supported by the following

Registry Submission Definition CreatorRegistry SubmitterRegistry Submission Data Source1. Read submission definition artifacts (logical model).2. Search data repository for matching patients
Figure 2.3.1.4-1: Get Patient List Process Flow

Get or Refresh Patient Data

Collect new or refresh existing patient data from data sources.

This use case is supported by the following

Registry Submitter [Registry Submitter]Registry Submission Data Source [Registry Submission Data Source]1. Identify data sources to query for new, missing or stale data2. Retrieve data from selected data sources3. Extract essential data for submission from the selected data sources4. Store essential data for later submission.
Figure 2.3.1.3-1: Get or Refresh Patient Data Process Flow

  1. Identify data sources to query for new, missing or stale data

  2. Retrieve data from selected data sources

  3. Extract essential data for submission from the selected data sources

  4. Store essential data for later submission.