Conventions for repository structures

This page describes conventions and principles for files and folders in this repository.

pages sub-folder naming conventions

In the format: pages/</ImplementationGuideName>, where ImplementationGuideName is the natural language implementation guide name in upper camel case and with no white spaces.

Some examples of pages sub-folder names:

• pages/SharedHealthSummary
• pages/EventSummary
• pages/PersonalHealthRecords

output sub-folder naming conventions

In the format: output/</ImplementationGuideName>, where ImplementationGuideName is the natural language implementation guide name in upper camel case and with no white spaces.

Some examples of output sub-folder names:

• output/SharedHealthSummary
• output/EventSummary
• pages/PersonalHealthRecords

Implementation Guide resource file-name (resources/.xml)

File name in the format: > .xml, where the follows the standard id conventions described on this page.

Some examples of .xml file names:

• implementationguide-shs-1.xml
• implementationguide-eventsummary-1.xml
• implementationguide-personalhealthrecords-1.xml

Implementation Guide control file file-name (.json)

File name in the format: > ig-<usecase>-<major version>, where the <usecase>-<majorversion> equals the <usecase>-<majorversion> part of the implementation guide resource file name (.xml).

Some examples of .json file names:

• ig-shs-1.json
• ig-eventsummary-1.json
• ig-personalhealthrecords-1.json