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

Participant #21

Merged
merged 22 commits into from
Jul 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
7d5b21b
Actual products of the sushi run
torstees Jul 12, 2024
53a0430
Participant initial pass
torstees Jul 12, 2024
7f03f73
Additional clarity for profile 'info'
torstees Jul 12, 2024
cc2d83b
Refinement of the above
torstees Jul 12, 2024
463805a
Added key Aliases for OMB, NCIT and UCUM
torstees Jul 15, 2024
fda2703
Fixed a few lingering errors
torstees Jul 15, 2024
5a8b7e2
Removed draft to strip out extraneous warning/error in QA
torstees Jul 15, 2024
a27ce44
Fixed some issues with broken links
torstees Jul 15, 2024
d8e4c8f
Largely functional participant profile(s) and first example
torstees Jul 15, 2024
bd89e0a
Clearer wording and proper format of link
torstees Jul 15, 2024
8f77876
First example for patient
torstees Jul 15, 2024
9b9ab5f
:see_no_evil: Ignore temp vim files
znatty22 Jul 8, 2024
38cb154
:memo: Initial repo contributors guide
znatty22 Jul 8, 2024
00e862d
:sparkles: Add versioning, release, emoji commits, and emoji PRs
znatty22 Jul 9, 2024
2c04449
:recycle: Add link to contrib guide on readme
znatty22 Jul 9, 2024
d1de7f4
:recycle: Incorporate PR comments
znatty22 Jul 11, 2024
01d6c56
:recycle: Clean up and make sdlc steps more clear
znatty22 Jul 11, 2024
c444212
Added extension relating to sex at birth
torstees Jul 17, 2024
b8f5f6d
Beginnings of the technical writing as example for IG Contributors.
torstees Jul 17, 2024
ef290a3
Fixed some broken links due to case
torstees Jul 22, 2024
cef3501
Add the Person and StudyParticipant profiles to the Participant modul…
brendagutman Jul 30, 2024
e5339b8
Merge branch 'main' into participant
torstees Jul 30, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
.DS_Store
Thumbs.db
/fsh-generated
/input-cache
/output
/temp
/template
*.swp
*.swn
*.swo
*.sh
*.bat
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,14 @@ Defining examples for your IG components will eliminate warnings from your QA lo
#### Technical Documentation for Profiles and Relationships - Artifact Intro and Notes
For intro and notes content that will be merged into the relevant artifact page, the publisher application itself is very specific: The filename should match the resulting HTML file in Humpback notation minus the extension followed by either "-intro.md" or "-notes.md". The material inside -intro.md files will appear *before* the differential table. Material inside -note.md files will appear afterward inside the header, *Notes". These files will be written into the directory, input/pagecontent.

For profiles, we definitely should define:
* **Added Profile Restrictions** Where we list all properties as being **should**, **must**, etc.
* **Recommended Practices** - We should add bullets for each relevant property under headings of **recommended** and **optional**.

Also, under **Recommended Practices** and guidance about any special cases such as we are doing with [Population Details](https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition-ncpi-research-study.html#population-details)

**Notes** (sibling to the **Recommended Restrictions**) Should indicate any other general profile relationships that should be discussed.

> To determine the correct filename corresponding to the artifact of interest, please see the file, fsh-generated/includes/fsh-link-references.md where you can find the resulting HTML filename for each FSH based artifact.

For each profile, there should always be a matching -info file that contains the following information:
Expand All @@ -44,6 +52,8 @@ For each profile, there should always be a matching -info file that contains the

The -notes.md file is optional and should be used to add clarification for unusual cases or other details that should be called out that don't naturally fit within the typical use cases.



#### Example Overview
Each module should have at least a single example page as part of the release. This should, at the very least, link each of the associated example profiles with an explanation of how they fit together if the example spans multiple profiles. To provide context within the example page itself, you can provide -info.md and -notes.md pages similarly to profiles, extensions, etc.

Expand Down
Loading
Loading