-
Notifications
You must be signed in to change notification settings - Fork 14
Naming Conventions
Jörn Guy Süß edited this page May 23, 2025
·
3 revisions
Below are the naming conventions of the project. These will be checked mechanically in the future.
1. Resource URLs
-
Domain: All canonical URLs for artifacts in this IG use the base domain:
$BASE=urn://example.com/ph-core -
Structure: The artifact ID is appended to the domain.
-
Format:
{$BASE}/{artifact-id} -
Examples:
- urn://example.com/ph-core/ph-core-allergyintolerance
- urn://example.com/ph-core/ph-core-patient
- urn://example.com/ph-core/birth-place (for an extension)
2. Profile Names
- Format: CamelCase
-
Prefix: All profile names must begin with PHCore
- "PH" (for Philippines) is capitalized.
- This is followed by the name of the base FHIR resource.
-
Examples:
- PHCoreAllergyIntolerance
- PHCorePatient
3. Profile IDs
- Format: Lowercase, hyphen-separated
- Prefix: ph-core-, followed by the base resource name in lowercase.
-
Examples:
- ph-core-allergyintolerance
- ph-core-patient
4. Profile Titles
- Format: Human-readable, Title Case
- Prefix: "PH Core", followed by the base resource name.
-
Examples:
- PH Core AllergyIntolerance
- PH Core Patient
5. Extension Naming Conventions
Extensions follow the same structure as profiles, with the following exceptions:
- Name: CamelCase, but does not include PHCore
- ID: Lowercase, hyphen-separated, and does not include ph-core
- Title: Human-readable, Title Case, and does not include PH Core
-
Examples:
- Name: BirthPlace
- ID: birth-place
- Title: Birth Place
- Canonical URL: urn://example.com/ph-core/birth-place