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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

The Registry Upload of NDJSON data

When the Registry periodic submission upload would exceed timeout limits or is requested as an NDJSON file, use of this Upload operation is suggested. See the FHIR Asynchronous API for more details on asynchronous FHIR exchange.

Structures: Abstract Profiles

These are profiles on resources or data types that describe patterns used by other profiles, but cannot be instantiated directly. I.e. instances can conform to profiles based on these abstract profiles, but do not declare conformance to the abstract profiles themselves.

Capability Statements with Slices

A Capability Statement with slicing defined

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

CREDS Structure Definition

StructureDefinition for use with CREDS mapping creating the base mappings for FHIR, CDA and V2

CREDS Submission Bundle

This is the standard Bundle to be used with a CREDS submission

CREDSOperationOutcome

The Profile for validation responses for CREDS submitted bundles.
Each Operation Outcome begins with the Submission identifier as the first issue entry. Each following issue element contains a single validation message

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Abnormal Electrocardiac Assessment

All SNOMED codes that are an abnormal Electrocardiac Assessment result

All Antiarrhythmics

Listing of all antiarrythmics used in CathPCI procedures

All codes used as NCDR questions for CathPCI

Full NCDR Question Set

Arterial Access Site

Arterial Access Site

CABG Indication

ACC coronary artery bypass graft (CABG) Indications

CABG Status

Coronary Artery Bypass Status

CTA Heart and Coronary arteries

CTA Heart and Coronary arteries

Cardiac Arrest

All SNOMED Codes related to Cardiac Arrest

Cardiac CTA Results

Cardiac CTA Results

Cardiac Instability Type

Cardiac Instability Type

Cardiac Rehabilitation Referral

Was Patient Referred for Cardiac Rehab

Cardiac Valves

aortic valve, mitral valve, pulmonary valve and tricuspid valve

Cardiovascular Treatment Decision Options

Decision options for Cardiovascular Treatment consult

Cath PCI Selected Stress Test

All ACC Selected Stress Tests for the CathPCI submission

Cath PCI qualified list of Events

Cath PCI qualified list of Events

CathPCI List of Stent Types

Major Types of Stents used in CathPCI procedures

Cerebrovascular Disease

All SNOMED Codes that are Cerebrovascular Disease

Chest Pain Symptom Assessment

Chest Pain Symptom Assessment Options

Chronic Lung Disease

Chronic Lung Disease as defined by ACC

Complexity of the Lesion

ACC categories for complexity

Concomitant Procedures Performed Type

Concomitant Procedures Performed Type

Coronary Artery Bypass Graft Type

Major Types of CABG

Coronary artery bypass grafting

All SNOMED Codes that are CABG Procedures

Diabetes Mellitus

All SNOMED Codes that are Diabetes Mellitus

Dyslipidemia

All SNOMED Codes that are Dyslipidemia

Electrocardiac Abnormality Type

Electrocardiac Abnormality Type

Electrocardiac Assessment Method

Electrocardiac Assessment Method

Electrocardiac Assessment Results

Electrocardiac Assessment Results

Family History of Premature CAD

All codes in SNOMED and LOINC indicating a family history of Premature Coronary Artery Disease Where premature means under 55 if male and under 65 if female

First Cardiac Arrest Rhythm

First Cardiac Arrest Rhythm

Functional Capacity

Functional Capacity in METS

Graft Vessel CABG Vessel

Vessels used for the coronary artery bypass graft

Health Insurance Payment Source

ValueSet listing payment source codes used by ACC

Heart Failure codes from SNOMED

All SNOMED Codes that are Heart Failure

Hypertension

All SNOMED Codes that are Hypertension

Induced Hypothermia Codes

All SNOMED codes about Induced Hypothermia

Intervention Types

Intervention Types Listed at Discharge

Lesion Segment Number

Lesion Segment Number

Location in the CABG Graft

Location in the CABG Graft

Mechanical Ventricular Support Timing

Mechanical Ventricular Support Timing

Multi-vessel Procedure Type

Type of Multi-vessel Procedure Performed

Myocardial Infarction

Full SNOMED set for MI

NCDRErrorsVS

Validation errors from CathPCI submissions

New York Heart Association Assessment Scale

Includes codes from SNOMED and LOINC

New York Heart Association OA Answer List

NYHA Loinc AnsWerlist

Non-Sustained Ventricular Tachycardia Type

Non-Sustained Ventricular Tachycardia Type

PCI

All SNOMED Codes that are PCI Procedures

PCI Operator SNOMED codes

POssible codes for PCI Operator

PCI Status Options

The status of the PCI

Packed Red Blood Ceels

SNOMED codes for PRBC

Patient Centered Reason for Delay

Patient Centered Reason for Delay in PCI Reason

Percutaneous Coronary Intervention Indication

Reasons the percutaneous coronary intervention PCI may be performed

Peripheral Arterial Occlusive Disease

All SNOMED Codes that are Chronic Lung Disease

Prior Diagnostic Coronary Angiography Procedure Results

Prior Diagnostic Coronary Angiography Procedure Results

Prior History of Coronary Artery Bypass Graft

All SNOMED and LOINC codes for CABG or Prior CABG

Prior Myocardial Infarction

SNOMED CT codes for MI

Rose Dyspnea Questions

LOINC codes for Rose Dyspnea Questions

SNOMED Cardiac Catheters

SNOMED Cardiac Catheters set

SNOMED Valueset of Organ Donor codes

All SNOMED codes that are an Organ Donor (person)

STEMI or STEMI Equivalent First Noted

ECG where STEMI or STEMI Equivalent First Noted

Seattle Angina Answers

LOINC codes for the answers to SA Questions

Seattle Angina Questions

All LIONC codes for Seattle Angina Questions

Smoking Status
  • ^experimental = true Patient’s smoking status.
    Includes all SNOMED codes related to smoking status under ‘Finding of tobacco use and exposure (finding)’
Stress Test Results

Stress Test Results

Stress Test Risk/Extent of Ischemia

Stress Test Risk/Extent of Ischemia

Submission Type

Submission Type

SurgicalRisk

Surgeon Identified Risk

Syntax Score for the PCI procedure

Syntax Score options for the PCI procedure

TIMI Flow

TIMI (Thrombolysis in Myocardial Infarction) flow grades

Valvular Disease Regurgitation Severity

Valvular Disease Regurgitation Severity

Valvular Disease Stenosis Severity

Valvular Disease Stenosis Severity

Valvular Regurgitation

Existance of Valvular Regurgitation

Valvular Stenosis

Loinc codes for Valvular Stenosis

Ventricular Support Device Type

Specific Options for Ventricular Support Devices

VentricularSupport

Forms Of Mechanical Support

Yes or No

Affirmative or Negative

hemodialysis or peritoneal dialysis

All SNOMED Codes regarding hemodialysis or peritoneal dialysis

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

CathPCI Associated NCDR Selection Codes

This is the complete list of all codes from the NCDR code list used in selections for the CathPCI questionnaire.

Health Insurance Payment Source CodeSystem

Sources for Payment for Element 3010

NCDR Question Codes

Codes used for CathPCI Question Codes

NCDRValidationErrors

All errors for CathPCI Validation

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

ACCCathPCIOutcome

Example feedback from a CathPCI Submission

An Example Discharge Encounter

Example of a US Core R4 Encounter

CREDS Submission Bundle Example

A simple example of the CREDS Submission Bundle

Cath-PCI Detailed Submission Map

This is an example of the data that would be used for a Cath-PCI Submission. The full map is a logical model as that allows conformance to the FHIR Standard the way a custom Resource would not. Each element has the short name of the data, a full description and the paths to fetch and place the information, by data standard type, for each. A section (such as Demographics) is a BackboneElement (holds no values). All subordinate elements are strings. Each mapping includes the following:

  • identity = standard used for the mapping (e.g., FHIR)
  • language = mime type that matches identity
  • map = FHIRPath expression of the path to the data
  • comment = Output mapping only Profile for inclusion in the Submission Bundle if not the Core resource

Environment Variables used: %patient (Patient resource for the subject of the procedure) %period (Encounter period i.e. Encounter.period) %procedure (Cath PCI Procedure resource) %procedure.period (CathPCI Procedure period i.e., Procedure.performedPeriod)

Example Encounter

Example Encounter for use within the Example Notification Bundle

Example Location

Example Location for use within the Example Encounter

Example Submission Map

This is an example of the data that would be used for a Resgistry Submission. The full map is a logical model as that allows conformance to the FHIR Standard the way a custom Resource would not. Each element has the short name of the data, a full description and the paths to fetch and place the information, by data standard type, for each. A section (such as Demographics) is a BackboneElement (holds no values). All subordinate elements are strings. Each mapping includes the following:

  • identity = standard used for the mapping (e.g., FHIR)
  • language = mime type that matches identity
  • map = FHIRPath expression of the path to the data
  • comment = Output mapping only Resource/Profile for inclusion in the Submission Bundle
MessageHeader for CREDSSubmission Example

An example MessageHeader for use within a CREDS Submission Bundle

Patient Example

This is a patient example for the US Core Patient Profile

Practitioner 1 Example

This is a practitioner 1 example for the US Core Practitioner Profile

Registry Submission Definition Creator implementing the Create / Update Registry Definition transaction.

Defines the requirements for the Registry Submission Definition Creator implementing the Create / Update Registry Definition transaction.

Registry Submission Definition Creator.

Defines the requirements for the Registry Submission Definition Creator.

Registry Submission Definition Repository implementing the Create / Update Registry Definition transaction.

Defines the requirements for the Registry Submission Definition Repository implementing the Create / Update Registry Definition transaction.

Registry Submission Definition Repository implementing the Search / Retrieve Registry Definition transaction.

Defines the requirements for the Registry Submission Definition Repository implementing the Search / Retrieve Registry Definition transaction.

Registry Submission Definition Repository.

Defines the requirements for the Registry Submission Definition Repository.

Registry Submitter implementing the Search / Retrieve Registry Definition transaction.

Defines the requirements for the Registry Submitter implementing the Search / Retrieve Registry Definition transaction.

Registry Submitter.

Defines the requirements for the Registry Submitter.

Veterinarian's Hospital

Example of a US Core R4 Organization