Metadata Rules
Overview
Section titled “Overview”Metadata rules ensure all FHIR resources have proper documentation and identifying information.
documentation/title-required
Section titled “documentation/title-required”Severity: Warning Fixable: No
All profiles, extensions, and value sets must have a title.
Example:
// ✓ GoodProfile: PatientProfileTitle: "Patient Profile for Clinical Use"* name 1..1
// ✗ BadProfile: PatientProfile* name 1..1documentation/description-required
Section titled “documentation/description-required”Severity: Warning Fixable: No
All profiles, extensions, and value sets must have a description.
Example:
// ✓ GoodProfile: PatientProfileDescription: "Profile defining constraints for patient demographics in clinical workflows"* name 1..1
// ✗ BadProfile: PatientProfile* name 1..1documentation/id-format
Section titled “documentation/id-format”Severity: Warning Fixable: Yes (safe)
Resource IDs should use kebab-case format.
Example:
// ✓ GoodProfile: PatientProfileId: patient-profile
// ✗ BadProfile: PatientProfileId: PatientProfileRationale
Section titled “Rationale”Proper metadata:
- Improves documentation quality
- Aids in resource discovery
- Required for IG publication
- Helps users understand resource purpose