FHIR Chat · summary table is ugly and obtrusive · IG creation

Stream: IG creation

Topic: summary table is ugly and obtrusive

Eric Haas (Oct 20 2020 at 01:04):

Do we need a summary table at the top of each the profile pages?

• it is ugly and does not promote readability

• is redundant ... 4 of the 9 items are already repeated on the page
  image.png

  

• the description field is markdown which does not lend itself to being in a table cell but rather in a page (and forces authors to short paragraphs. might as well be a string field)

• it is ugly

Why are all the resource page titles names which is computer friendly and not titles? which is intended for human consumption.

here is the liquid template

  <a name="root"> </a>
  <h2 id="root">{{modelType}}: {{[title]}}</h2>

should be something like this:

  <a name="root"> </a>
  <h2 id="root">{{modelType}}: {{site.data.resources[type/id].title}} ({{site.data.resources[type/id].name}})</h2>

so instead of

Resource Profile: USCoreAllergyIntolerance

we get

Resource Profile: US Core AllergyIntolerance Profile (USCoreAllergyIntolerance)

Lloyd McKenzie (Oct 20 2020 at 01:35):

It shouldn't be at the 'top' - it should be one tab among many. We've agreed that we're going to revamp the 'summary' to be something more useful- better aligned with one of the ones you had created. We just haven't agreed on exactly what it needs to contain or got it into the template yet.

Grahame Grieve (Oct 20 2020 at 01:39):

if it's not at the top, then the version MUST be clearly shown. I don't know why it's a problem, but it seems as though it is. Showing the version really clearly MUST Happen

Grahame Grieve (Oct 20 2020 at 01:40):

and the status

Lloyd McKenzie (Oct 20 2020 at 01:40):

Are we talking about the content shown in the tab or the little table at the very top of the profile?

Grahame Grieve (Oct 20 2020 at 01:40):

you might think that the table is "ugly" but it's consistent with all the other resources, and your readers are asking for this consistency

Lloyd McKenzie (Oct 20 2020 at 01:42):

I was speaking about the former. If the latter - i.e. the little table at the top, then I agree we can/should trim it a bit. Prettifying is fine too. But it should not be customized by IGs. We should fix it in the template and have it the same everywhere.

Grahame Grieve (Oct 20 2020 at 01:43):

I don't know what you think former and latter is

Grahame Grieve (Oct 20 2020 at 01:43):

Eric asked about one table

Lloyd McKenzie (Oct 20 2020 at 01:43):

My initial answer was about the summary tab for profiles - which we agreed to revamp. I now realize he was talking about the little table at the top.

Lloyd McKenzie (Oct 20 2020 at 01:47):

The little table at the top shouldn't include links to the XML/JSON/TTL as there are already tabs for that (and those tabs are set up to auto-vanish if certain formats are disabled). The name is redundant. Version, status and date should be combinable into one line. Publisher should be a hyperlink. Defining URL should be removed from below the table if it's going to be in the table.

Grahame Grieve (Oct 20 2020 at 01:48):

which resources have tabs for that?

Eric Haas (Oct 20 2020 at 02:38):

Grahame Grieve said:

which resources have tabs for that?

all of them have tabs for xml/json/ttl

Eric Haas (Oct 20 2020 at 02:38):

I was talking about the table at the top of profiles

Grahame Grieve (Oct 20 2020 at 02:38):

all meaning all canonical resources?

Eric Haas (Oct 20 2020 at 02:44):

RE: and your readers are asking for this consistency - I have not gotten a single comment re this?

right now is only on terminology and profiles

A smaller table is fine but I think it should be consolidated at the top of the formal definition as before:

image.png

Eric Haas (Oct 20 2020 at 02:47):

and the description in a table cell is problematic if you want to render it into an intro like this (and this is the direction I was heading...)

This profile sets minimum expectations for the [AllergyIntolerance] resource to record, search, and fetch allergies/adverse reactions associated with a patient. It identifies the mandatory core elements, extensions, vocabularies and value sets which SHALL be present in the AllergyIntolerance resource when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the US Core AllergyIntolerance
profile:

• Query for Allergies belonging to a Patient
• [Record or update] a Patient Allergy

Mandatory and Must Support Data Elements

The following data-elements are mandatory (i.e data MUST be present) or must be supported if the data is present in the sending system ([Must Support] definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The [Formal Profile Definition] below provides the formal summary, definitions, and terminology requirements.

Each AllergyIntolerance must have:

1. a status of the allergy*
2. a code which tells you what the patient is allergic to
3. a patient

*The clinicalStatus element has the following constraints: SHALL be present if verification status is not entered-in-error and SHALL NOT be present if verification Status is entered-in-error.

Each AllergyIntolerance must support:

1. a verification status
2. a reaction manifestation

Profile specific implementation guidance:

• No Known Allergies may be represented using the US Core-AllergyIntolerance profile with appropriate negation code in AllergyIntolerence.code and the appropriate verification status in AllergyIntolerance.verificationStatus.

  If a patient has not been asked about their allergies, this would be represented as:

  * AllergyIntolerance.code = "716186003" (No known allergy (situation))

  * AllergyIntolerance.verificationStatus = "unconfirmed"

  If a patient has been asked, but has indicated they have no known allergies, this would be represented as:

  • AllergyIntolerance.code = "716186003" (No known allergy (situation))

  • AllergyIntolerance.verificationStatus = "confirmed"

Eric Haas (Oct 20 2020 at 02:55):

Grahame Grieve said:

all meaning all canonical resources?

yes

Lloyd McKenzie (Oct 20 2020 at 03:04):

Canonical resources and examples all have tabs for the different formats

Grahame Grieve (Oct 20 2020 at 03:34):

and do they all show the definition?

Lloyd McKenzie (Oct 20 2020 at 05:42):

Not all resources have a definition

Grahame Grieve (Oct 20 2020 at 06:13):

any that do, then

Lloyd McKenzie (Oct 20 2020 at 15:10):

I don't know that we have layouts for all of the conformance resources. Any that don't have assigned layouts would default to the 'example' layout, which would not.

Eric Haas (Oct 20 2020 at 17:03):

Only custom templates for SD, and Terminology

The SD template used to grab the description element directly
the Terminology use the Table (which works fine in that context IMO)

For Operations, SP, CapStatements use the standard layouts that displays the narrative generated by the publisher or the author.

Brett Marquard (Oct 21 2020 at 15:09):

I am late to party, where did we approve/discuss adding this table?

Brett Marquard (Oct 21 2020 at 15:09):

it's a lot of noise...for example

• profile title is repeated in heading, url, name, title....and then official url below
• does copyright need to be at top
• does publisher important at this level?
• status date

Brett Marquard (Oct 21 2020 at 15:09):

It pushes the stuff down folks want to read.

Brett Marquard (Oct 28 2020 at 20:11):

@Grahame Grieve @Lloyd McKenzie What/where is the place to propose concrete feedback on tables?

Grahame Grieve (Oct 28 2020 at 20:40):

well, discussion here, and formal change proposals on github here: https://github.com/HL7/fhir-ig-publisher/issues

I have made some changes based on this discussion, but I am chasing down and fixing a very difficult validation Lloyd has presented to me before doing a release

Lloyd McKenzie (Oct 29 2020 at 03:41):

You're welcome for keeping your life interesting... ;)

Grahame Grieve (Oct 29 2020 at 06:58):

this one went beyond interesting

Grahame Grieve (Oct 29 2020 at 06:58):

release due tomorrow

Brett Marquard (Nov 18 2020 at 21:02):

Where did the discussion occur on the summary table?

Grahame Grieve (Nov 18 2020 at 22:59):

here

Brett Marquard (Nov 19 2020 at 13:14):

ha, ok! Any thoughts on these comments -

profile title is repeated in heading, url, name, title....
official url immediately below table
does copyright need to be at top
Is publisher important at this level?
status date

Brett Marquard (Nov 19 2020 at 13:16):

Pick 3-4 rows, I find the 9 rows pushing the content down as a distraction.

Last updated: Apr 12 2022 at 19:14 UTC