ccdakit/mkdocs.yml at main · Itisfilipe/ccdakit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
site_name: ccdakit Documentation
site_description: Python library for generating HL7 C-CDA clinical documents
site_author: Filipe Amaral
site_url: https://docs.ccdakit.com

repo_name: Itisfilipe/ccdakit
repo_url: https://github.com/Itisfilipe/ccdakit
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    # Light mode
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_object_full_path: false
            show_category_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            heading_level: 2

hooks:
  - docs/hooks.py

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - Basic Concepts: getting-started/concepts.md
  - User Guide:
    - Overview: guides/overview.md
    - Working with Sections: guides/sections.md
    - Protocols: guides/protocols.md
    - Configuration: guides/configuration.md
    - Validation: guides/validation.md
    - Code Systems & Value Sets: guides/terminologies.md
  - Reference:
    - Code Systems: reference/code-systems.md
    - Sections Reference: reference/sections.md
    - UV Guide: development/uv-guide.md
  - HL7/C-CDA Guide:
    - Introduction: guides/hl7-guide/index.md
    - Foundation:
      - Introduction to HL7: guides/hl7-guide/01-introduction-to-hl7.md
      - CDA Architecture: guides/hl7-guide/02-cda-architecture.md
      - Templates & Conformance: guides/hl7-guide/03-templates-and-conformance.md
      - Code Systems & Terminologies: guides/hl7-guide/04-code-systems-and-terminologies.md
      - Document Types: guides/hl7-guide/05-document-types.md
    - Clinical Sections:
      - Sections Overview: guides/hl7-guide/sections/index.md
      - Core Sections:
        - Problems Section: guides/hl7-guide/sections/problems-section.md
        - Medications Section: guides/hl7-guide/sections/medications-section.md
        - Allergies Section: guides/hl7-guide/sections/allergies-section.md
        - Immunizations Section: guides/hl7-guide/sections/immunizations-section.md
        - Vital Signs Section: guides/hl7-guide/sections/vital-signs-section.md
        - Procedures Section: guides/hl7-guide/sections/procedures-section.md
        - Results Section: guides/hl7-guide/sections/results-section.md
        - Social History Section: guides/hl7-guide/sections/social-history-section.md
        - Encounters Section: guides/hl7-guide/sections/encounters-section.md
      - Extended Sections:
        - Past Medical History: guides/hl7-guide/sections/past-medical-history-section.md
        - Goals Section: guides/hl7-guide/sections/goals-section.md
        - Health Concerns: guides/hl7-guide/sections/health-concerns-section.md
        - Functional Status: guides/hl7-guide/sections/functional-status-section.md
        - Mental Status: guides/hl7-guide/sections/mental-status-section.md
        - Assessment and Plan: guides/hl7-guide/sections/assessment-and-plan-section.md
        - Advance Directives: guides/hl7-guide/sections/advance-directives-section.md
        - Family History: guides/hl7-guide/sections/family-history-section.md
        - Medical Equipment: guides/hl7-guide/sections/medical-equipment-section.md
      - Specialized Sections:
        - Plan of Treatment: guides/hl7-guide/sections/plan-of-treatment-section.md
        - Hospital Discharge Instructions: guides/hl7-guide/sections/hospital-discharge-instructions-section.md
        - Discharge Medications: guides/hl7-guide/sections/discharge-medications-section.md
        - Physical Exam: guides/hl7-guide/sections/physical-exam-section.md
        - Reason for Visit: guides/hl7-guide/sections/reason-for-visit-section.md
        - Chief Complaint & Reason for Visit: guides/hl7-guide/sections/chief-complaint-reason-for-visit-section.md
        - Nutrition Section: guides/hl7-guide/sections/nutrition-section.md
        - Payers Section: guides/hl7-guide/sections/payers-section.md
        - Admission Medications: guides/hl7-guide/sections/admission-medications-section.md
        - Interventions Section: guides/hl7-guide/sections/interventions-section.md
        - Health Status Evaluations: guides/hl7-guide/sections/health-status-evaluations-section.md
      - Hospital and Surgical Sections:
        - Admission Diagnosis: guides/hl7-guide/sections/admission-diagnosis-section.md
        - Discharge Diagnosis: guides/hl7-guide/sections/discharge-diagnosis-section.md
        - Hospital Course: guides/hl7-guide/sections/hospital-course-section.md
        - Instructions: guides/hl7-guide/sections/instructions-section.md
        - Anesthesia: guides/hl7-guide/sections/anesthesia-section.md
        - Postoperative Diagnosis: guides/hl7-guide/sections/postoperative-diagnosis-section.md
        - Preoperative Diagnosis: guides/hl7-guide/sections/preoperative-diagnosis-section.md
        - Complications: guides/hl7-guide/sections/complications-section.md
        - Hospital Discharge Studies: guides/hl7-guide/sections/hospital-discharge-studies-section.md
        - Medications Administered: guides/hl7-guide/sections/medications-administered-section.md
    - Appendices:
      - OID Reference: guides/hl7-guide/appendices/oid-reference.md
      - Conformance Verbs: guides/hl7-guide/appendices/conformance-verbs.md
      - Resources: guides/hl7-guide/appendices/resources.md
      - Glossary: guides/hl7-guide/appendices/glossary.md
  - Examples:
    - Complete Document: examples/complete-document.md
    - Builder API: examples/builder-api.md
    - All Sections: examples/all-sections.md
    - Validation: examples/validation.md
    - Custom Data Models: examples/custom-models.md
  - API Reference:
    - Core: api/core.md
    - Builders: api/builders.md
    - Sections: api/sections.md
    - Protocols: api/protocols.md
    - Validators: api/validators.md
    - Utilities: api/utilities.md
  - Architecture:
    - Design Principles: development/architecture.md
    - Protocol System: development/protocols.md
    - Builder Pattern: development/builders.md
    - Version Management: development/versions.md
  - Development:
    - Contributing: development/contributing.md
    - Development Setup: development/setup.md
    - Testing: development/testing.md
    - Roadmap: development/roadmap.md
  - About:
    - Changelog: about/changelog.md
    - Disclaimer: about/disclaimer.md
    - License: about/license.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Itisfilipe/ccdakit
  version:
    provider: mike

copyright: |
  Copyright &copy; 2024 Filipe Amaral<br>
  <small>Not affiliated with HL7 International. Developed with AI assistance. See <a href="/about/disclaimer/">Disclaimer</a>.</small>