Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarifying https://nih-ncpi.github.io/ncpi-fhir-ig-2/module_overview.html #93

Open
mingward opened this issue Jan 3, 2025 · 3 comments
Assignees

Comments

@mingward
Copy link

mingward commented Jan 3, 2025

What were you reviewing?

https://nih-ncpi.github.io/ncpi-fhir-ig-2/module_overview.html

Should we look at this diagram? What does the arrow and diamond mean?
We tried to deduce and also looked at each profile's code, but we seemed to get different inferences based on the code.
For example. please see a snapshot of the diagram image below:
image

If we think the "arrow" means "1 or more", then an NCPI Study participant is related to

Could you help us clarify this? Thank you!

@RobertJCarroll
Copy link
Contributor

I think it's an "illustrative draft figure" at this point versus an "accurate technical diagram". Broadly, arrows are cardinality of 1 and diamonds are 0/1 or more. We can add this as an item to refine when we have finalized content.

@RadixSeven
Copy link

RadixSeven commented Jan 7, 2025

We should generate the diagrams from the FHIR shorthand source code. As figures are the part of a paper we read first, diagrams are the part of a standard people read first.

Broadly, arrows are cardinality of 1 and diamonds are 0/1 or more.

Do you mean that broadly, arrows are 1..1 and diamonds are 0..? where ? is undetermined between 1 and *.

@RobertJCarroll
Copy link
Contributor

Are you aware of a tool that can generate the diagram from FSH? My other concern is such automatically generated diagrams tend to be hard to read; by curating them manually we can craft something that's more legible. EG, the goal of this main figure is to point people to read more details in the modules, not to describe the exact relationships among every entity. We need to align on expectations and clearly communicate them.

Arrows: 1..1 (though sometimes multiple arrows are condensed into one)
Diamonds: 0..* (though sometimes it's 1..*)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

4 participants