FHIR Foundation Implementation Guides - Hosting Requirements

Implementers are welcome to ask for the FHIR implementation guides to be hosted on fhir.org. In order to host an implementation guide on fhir.org, the following requirements apply:

  1. The responsible organization must be clearly identified, and that organization must be a member of HL7 International in good standing, or must be an open source project (and the IG must relate to the open source content)
  2. The Implementation Guide SHOULd be managed using a process that meets the requirements of the FHIR Community Process. This may become a formal requirement in the future, but is not to allow already existing IGs to be hosted
  3. The implementation guide must have a formal open source license. Creative commons licenses are preferred, or an OSI approved license
  4. The home page of the IG (index.html) must describe how the IG is managed, and how stakeholders can get involved
  5. The implementation guide must be built with the Implementation Guide Publisher, and the QA must have no errors, or as agreed by fhir.org when publishing
  6. The content for the IG must live in a public github repository, and the IG must build on the CI build
  7. The implementation guide template must meet these technical requirements:
    • The page must have a header and a footer
    • The header must include the FHIR icon, the name of the IG, the publication name of the IG and the the version of the IG
    • The footer must include a copyright claim, the package id and version, the date generated, a link to the license + statement of the what the license is, a link to propose a change or to otherwise get involved, a link to the QA page, and a link to the history/directory of published versions
    • implementation guides shall present information to the user such that by default, nothing is hidden unless there are clearly defined tabs for changing views
    • implementation guides shall not contain any server side active content except that required by redirects for canonical URL management
    • it shall be possible to print pages from the IG for review/display
    • implementation guides shall include a downloadable version so people can host it locally
  8. The canonical URL for the IG SHOULD match the location where it is published on fhir.org