Documentation Rules

Overview

Documentation rules ensure that FHIR resources have proper metadata, descriptions, and identifying information required for implementation guides and resource discovery.

Rules

documentation/missing-metadata

Name: Missing Metadata Severity: 🟡 Warning Fixable: No Implementation: AST

Warns about missing documentation fields such as Description, Title, Publisher, and Contact to encourage good documentation practices

Tags: documentation, metadata, best-practices

Configuration:

{
  "linter": {
    "rules": {
      "documentation/missing-metadata": "warn"
    }
  }
}

Learn more: Missing Metadata

---

documentation/missing-description

Name: Missing Description Severity: 🟡 Warning Fixable: Yes Implementation: GritQL

Detects FHIR resources without description metadata

Tags: documentation, metadata, description

Configuration:

{
  "linter": {
    "rules": {
      "documentation/missing-description": "warn"
    }
  }
}

Learn more: Missing Description

---

documentation/missing-title

Name: Missing Title Severity: 🔵 Info Fixable: Yes Implementation: GritQL

Detects FHIR resources without title metadata

Tags: documentation, metadata, title

Configuration:

{
  "linter": {
    "rules": {
      "documentation/missing-title": "info"
    }
  }
}

Learn more: Missing Title

---

documentation/missing-publisher

Name: Missing Publisher Severity: 🔵 Info Fixable: Yes Implementation: GritQL

Detects FHIR resources without publisher metadata

Tags: documentation, metadata, publisher

Configuration:

{
  "linter": {
    "rules": {
      "documentation/missing-publisher": "info"
    }
  }
}

Learn more: Missing Publisher

---