Software Architecture Documentation

Click here to view the PDF Version and print the entire document.

Executive Summary

Document Roadmap

• Document Management and Configuration Control Information
• Purpose and Scope
• How this Document Is Organized
• Stakeholder Representation
• How a View Is Documented
• Relationship to Other Documents
• Process for Updating this Document

Architecture Background

• Problem Background
  • Goals and Context
  • Significant Driving Requirements
• Solution Background
  • System Overview
  • Architectural Approaches
  • Analysis Results
  • Requirements Coverage
  • Summary of Background Changes Reflected in Current Version
• Product Line Reuse Considerations

Architecture Views

• Architecture Overview
  • Pass-through Modes
  • Enabling Services
• Service View - Patient Discovery
  • View Description
  • Component and Sequence Diagrams
  • Element Catalog
  • Context Diagram
  • Variability Guide
  • Architectural Background
• Service View - Query for Documents
  • View Description
  • Component and Sequence Diagrams
  • Element Catalog
  • Context Diagram
  • Variability Guide
  • Architectural Background
• Service View - Retrieve Documents
  • View Description
  • Component and Sequence Diagrams
  • Element Catalog
  • Context Diagram
  • Variability Guide
  • Architectural Background
• Service View - Health Information Event Messaging
  • View Description
  • Component and Sequence Diagrams
  • Element Catalog
  • Context Diagram
  • Variability Guide
  • Architectural Background
• Service View - Document Submission
  • View Description
  • Component and Sequence Diagrams
  • Element Catalog
  • Context Diagram
  • Variability Guide
  • Architectural Background
• Service View - Query Audit Log
  • View Description
  • Component and Sequence Diagrams
  • Element Catalog
  • Context Diagram
  • Variability Guide
  • Architectural Background
• Service View - Authorized Case Follow-up
  • View Description
  • Component and Sequence Diagrams
  • Element Catalog
  • Context Diagram
  • Variability Guide
  • Architectural Background
• Enterprise Service Component - Policy Engine
  • Component Description
  • Component and Sequence Diagrams
  • Element Catalog
  • Variability Guide
  • Architectural Background
• Enterprise Service Component - Audit Log
  • Component Description
  • Component and Sequence Diagrams
  • Element Catalog
  • Variability Guide
  • Architectural Background
• Adapter Interfaces and Service Bus Components
• NHIE Service Registry

Referenced Materials

Acronyms and Terms