fhir / ig-guidance Goto Github PK
View Code? Open in Web Editor NEWAn implementation guide that explains how to create FHIR implementation guides - including examples of how to do various things
License: Other
An implementation guide that explains how to create FHIR implementation guides - including examples of how to do various things
License: Other
I was not able to create a pull request, so here is my recommendation to be added to the best practice narrative
as per https://plantuml.com/en/graphviz-dot
and/or document workaround
We want to give implementers an idea of the range of possibilities.
The current approach with numbers for each color leads to a messy diagram, and makes adding new variables in an organized manner difficult since they would be added at the end of the list, not with the other variables for the visual element.
Rather than the unordered list of color variables currently presented, consider tables:
Area | Text | Background | Border | Link | Hover |
---|---|---|---|---|---|
1. IG Title | --ig-status-text-color |
--ig-header-container-color |
|||
2. Breadcrumb | --breadcrumb-text-color |
--breadcrumb-bg-color |
|||
3. Table of Contents | --toc-text-color |
--toc-box-bg-color |
--toc-box-border |
--toc-link-color |
--toc-link-hover-color |
etc. |
We probably need 3 tables:
Also separator text color (and any other "1 offs")
Number the rows in the tables. Replace the diagram with one that shows only the areas. That is, replace current numbers 1 and 22 with the number for the new "IG title" area; replace current number 17 and 18 with the new number for the TOC area.
The page source, or at least the included diagram (perhaps diagrams) should show all defined styles, which should be listed in the tables.
Since the variables will be listed in the table, reduce the existing "CSS color definitions" section to only an example of overriding a couple of colors.
Someone recently reached out to me and noted that this IG says very little about developing with FSH, even though FSH is now a very popular approach to development of template-based IGs. I am wondering if it might make sense to note that this approach supports FSH (along w/ a link or two to the spec and/or FSH School) as well as to call out [ig-root]/sushi-config.yaml
and [ig-root]/input/fsh
in the section that documents the contents of an IG project. What do you think?
I recommend we always recommend the include for plantuml are inside div
if you write a constraint on an element that follows this pattern:
(name | name | name).count = 1
(or <= 1)
where all the names in the union are children of the element on which this invariant sits, then the IG publisher will understand that the named elements are a mutually exclusive group. That means that:
I added this to reduce the comprehension impedence for CCDA guide readers
Discussed on Security and Privacy Considerations, but likely applicable to other sections (e.g. Terminology).
Links to topic specific written guidance
Apparently plantUml supports themes (https://plantuml.com/theme). Add an example showing use of themes, and potentially how to point to a local defined theme.
In section 7.0.2, there is a link to the HL7 wiki. This should be replaced by a link to an appropriate page in confluence, after ensuring that all content on the Wiki page is covered in Confluence.
To create the package.json, you might find it easiest to copy the one from the HL7 official template. See here more about the contents of package.json.
I often have difficulty figuring out what an IG is for. Explicit description of the functionality, either with use cases or references to DAMs or other requirements assets, will help people not involved in the IG creation understand what it's for and how it fits in the landscape.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.