User Guide Overview

Comprehensive guides for using ccdakit effectively.

Contents

Core Concepts

• HL7/C-CDA Comprehensive Guide - Complete HL7 and C-CDA primer with detailed section documentation
• Working with Sections - All 29 clinical sections
• Protocols - Protocol reference and adapting your data
• Configuration - Global and document configuration
• Validation - XSD and Schematron validation
• Terminologies - Code systems and value sets

Quick Navigation

Creating Documents

1. Define your data models (or use existing ones)
2. Ensure they satisfy required protocols
3. Create sections from your data
4. Build the clinical document
5. Generate XML output

Common Tasks

Add a new section:

from ccdakit import ProblemsSection, CDAVersion

section = ProblemsSection(
    problems=my_problems,
    version=CDAVersion.R2_1
)

Configure globally:

from ccdakit import configure, CDAConfig, OrganizationInfo

configure(CDAConfig(
    organization=OrganizationInfo(name="My Clinic", npi="123456789")
))

Validate output:

from ccdakit.validators import XSDValidator

validator = XSDValidator()
result = validator.validate(xml)

Learning Path

1. Start with Quick Start
2. Understand Basic Concepts
3. Read Working with Sections
4. Review Examples
5. Explore API Reference