-
Notifications
You must be signed in to change notification settings - Fork 1
Stufe 5 - ICU - add docu on parent motivation #870
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
base: main-stufe-5
Are you sure you want to change the base?
Stufe 5 - ICU - add docu on parent motivation #870
Conversation
…github.com/gematik/spec-ISiK-Basismodul into stufe-5/icu/docu-vererbung-new-PTDATQ-1809
…github.com/gematik/spec-ISiK-Basismodul into stufe-5/icu/docu-vererbung-new-PTDATQ-1809
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Adds comprehensive documentation descriptions to ICU profile structures to provide context and motivation for parent profile selections. This addresses the need for tracking design decisions and rationale behind the profile hierarchy.
- Adds German description fields to FSH profile definitions for ICU profiles
- Includes explanatory text about profile purpose and parent selection motivation
- Updates corresponding generated JSON StructureDefinition files with the new descriptions
Reviewed Changes
Copilot reviewed 83 out of 83 changed files in this pull request and generated 4 comments.
File | Description |
---|---|
FSH files | Add German "Description" fields explaining purpose and parent profile choices for ICU monitoring profiles |
JSON files | Generated StructureDefinition resources updated with corresponding description fields |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Resources/input/fsh/ICU/SD_MII_ICU_Koerpertemperatur_Gelenk.fsh
Outdated
Show resolved
Hide resolved
Resources/fsh-generated/resources/StructureDefinition-sd-mii-icu-koerpertemperatur-gelenk.json
Outdated
Show resolved
Hide resolved
Resources/input/fsh/ICU/SD_MII_ICU_Koerpertemperatur_Brustwirbelsaeule.fsh
Outdated
Show resolved
Hide resolved
...-generated/resources/StructureDefinition-sd-mii-icu-koerpertemperatur-brustwirbelsaeule.json
Outdated
Show resolved
Hide resolved
@FErdfelder könntest Du oder jemand aus deinem Team hier bitte auf die Nachdokumentation schauen? |
Grundsätzlich haben wir natürlich keine Einwäde gegen deutsche Descriptions zur Erläuterung. Solange sie korrekt sind, können sie ja nur helfen und nicht schaden. Auf den ersten Blick wirkt alles soweit unproblematisch. Nicht ganz korrekt ist allerdings der Zusatz „im ICU-Umfeld“, da diese Daten ja durchaus auch in anderen Bereichen vorkommen (z. B. im OP oder in der Notfallmedizin). Ich wäre daher dafür, „im ICU-Umfeld“ entweder ganz zu streichen oder z.B. durch „in der Akutmedizin“ zu ersetzen. |
@FErdfelder Der Hintergrund war der, dass wir Gründe und Struktur der Vererbung explizit machen wollten, da die Ableitungen ansonsten arbiträr wirken könnten und von außenstehenden nicht unmittelbar ersichtlich waren |
Danke für den Hinweis, das ändern wir gerne, @FErdfelder. |
Pull Request Short Cut
Add documentation / motivation for parents of ICU profiles for tracking decisions and design choices.
Hintergrund:
Hinweis von Implementierenden, dass die Gründe und Struktur der Vererbung schwer nachvollziehbar. In diesem Sinne nachdokumentiert.