search

IHE / supplement-template

IHE Supplement Template
Creative Commons Attribution 4.0 International
7 stars 0 forks source link

Overall structure of an IHE IG #11

Closed JohnMoehrke closed 2 years ago

JohnMoehrke commented 4 years ago

what content should be in a FHIR IG - what pages, what diagrams, what content structure?

JohnMoehrke commented 4 years ago

Note that much of what you seek is already defined in our current supplement template. It is in a WORD document format, but the components you are describing are there. Pulling them out into a diagram will help everyone, not just IG builders. I suspect that if you could start the diagramming, others will jump in and help adjust and improve it.

Note that we do have to recognize, as our supplement already does, that there are a few different flavors of IG:

These different flavors are a strength that IHE has learned from our experience at doing this. HL7 has not yet figured this out.

Not sure if these flavors should be integrated into one diagram, or get represented as independent diagrams with one overall.

keithboone commented 4 years ago

See http://build.fhir.org/ig/IHE/ACDC for one proposal for structure.

JohnMoehrke commented 3 years ago

see my update to the readme

costateixeira commented 3 years ago

The schema you have there seems a replica of the current IHE document. I may have some alternative suggestions for structuring the content, looking at a "newer" way of publishing. BTW, the glossary is missing or not in the right place.

I'll document an alternative in the other IG, hoping we can discuss it soon.

Kind regards

José

On Fri, Oct 2, 2020 at 5:56 PM John Moehrke notifications@github.com wrote:

see my update to the readme

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/IHE/supplement-template/issues/11#issuecomment-702814845, or unsubscribe https://github.com/notifications/unsubscribe-auth/AD3HUUHNY2GRAX5M6RT57R3SIXZ4FANCNFSM4OO7XYEQ .

JohnMoehrke commented 3 years ago

alternatives are welcome, that is how we can move forward.

Yes it is based on the current supplement. This is deeply part of the governance and identity of IHE. If we do everything like HL7, then we are not distinguished from HL7. Note that the "Volume" indicators are not indication of standalone document, like they are today. I included that tag simply as a grouping mechanism. An implementation guide is still a complete unit, like is produced by the IG publisher.

I was expecting that glossary terms were throughout, but I would agree that new terms would be defined in Volume 1. The glossary is recognized as a managed artifact at the IHE level, not at each IG.

costateixeira commented 3 years ago

Didn't mean to discuss and challenge the current ideas, just to say that I'll present an overall alternative that will allow IHE to get ahead. (I don't understand the part where we'd do everything like HL7..).

Perhaps sending my diagram without a context was not a good idea - I will explain it with a context, as a new way of doing things. Glossary included.

On Sat, Oct 3, 2020 at 12:20 AM John Moehrke notifications@github.com wrote:

alternatives are welcome, that is how we can move forward.

Yes it is based on the current supplement. This is deeply part of the governance and identity of IHE. If we do everything like HL7, then we are not distinguished from HL7. Note that the "Volume" indicators are not indication of standalone document, like they are today. I included that tag simply as a grouping mechanism. An implementation guide is still a complete unit, like is produced by the IG publisher.

I was expecting that glossary terms were throughout, but I would agree that new terms would be defined in Volume 1. The glossary is recognized as a managed artifact at the IHE level, not at each IG.

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/IHE/supplement-template/issues/11#issuecomment-702982150, or unsubscribe https://github.com/notifications/unsubscribe-auth/AD3HUUFC6GMC3UVF6AV4RMTSIZG3HANCNFSM4OO7XYEQ .