search

HL7 / fhir-shc-vaccination-ig

FHIR Implementation Guide describing clinical and patient data contained within a SMART Health Card
https://vci.org/ig/vaccination-and-testing
35 stars 18 forks source link

Reorganize profile navigation, rename profiles, add non-US Patient profile #167

Closed masnick closed 3 years ago

masnick commented 3 years ago

This PR reorganizes the profile navigation with three aims:

  1. Make it easier to understand the connections between the DM and AD profiles, and any additional implementation instructions.
  2. Make the IG structure support the conformance guidance that implementers should start with DM profiles, and only use the AD profiles as a fallback.
  3. Allow us additional flexibility with multiple versions of a given profile -- for example a general profile of Patient + a US-only profile of Patient

This PR does also implement (3), fixing #164 (duplicate of #161).

To make all this work, I had to rename some of the profiles. I figured since I was renaming some, I might as well standardize the names for all. We are now consistently using the SHR prefix on all our profiles, and the AD or DM suffix.

The primary pages that have changed are:

The dropdown menu with the profiles has been removed in favor of a single link to the Profiles page. It's still the same number of clicks to get to a specific profile, but the menu was going to get out of control as we add more profiles to the IG.

The canonical URL for the IG has been updated to match what we will go to ballot with for HL7. It is now http://hl7.org/fhir/uv/shc-vaccination.

p9g commented 3 years ago

Consider using/explaining the term "fallback" on http://build.fhir.org/ig/dvci/vaccine-credential-ig/branches/reorganize/conformance.html#data-minimization since that term is used on http://build.fhir.org/ig/dvci/vaccine-credential-ig/branches/reorganize/profiles.html (where I think it is explained well. That profiles page links to the conformance page, so someone may navigate to conformance before reading the explanation of "fallback" further down on the profiles page.

masnick commented 3 years ago

Consider using/explaining the term "fallback" on http://build.fhir.org/ig/dvci/vaccine-credential-ig/branches/reorganize/conformance.html#data-minimization since that term is used on http://build.fhir.org/ig/dvci/vaccine-credential-ig/branches/reorganize/profiles.html (where I think it is explained well. That profiles page links to the conformance page, so someone may navigate to conformance before reading the explanation of "fallback" further down on the profiles page.

@p9g Thanks -- I will take another pass through the conformance page in light of the changes to make the language consistent.