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

TC 4.0.1 #203

Open
wants to merge 98 commits into
base: main-stufe-4
Choose a base branch
from
Open

TC 4.0.1 #203

wants to merge 98 commits into from

Conversation

f-peverali
Copy link
Contributor

@f-peverali f-peverali commented Sep 23, 2024

… FHIR Validation)

Version Upgrade Template

Version: 4.0.1

Date: 02.12.2024

Description

This is a Pullreuqest that requires an increase in the Version number. Therefore, multiple outside-github, related Task have to be performed and checked.

All jobs with an x in the boxes were performed to the best of knowledge.

Pre-Merge Activities

  • This PR refers to a versioned Branch with a name and a version number in the form of N.n.n, e.g. "TC_3.2.1".
  • The ./github/workflows/main.yml refers to the correct Firetly Terminal and SUSHI Version.
  • By running the Release_Publish.py script, release version and date was updated accordingly. The script ran without errors.
  • Eventually, increase the dependency of to newer Basis Modul (package and sushi-config)
  • New Release Notes were created, aglined to the committ history and cleaned. In Github, go to
    • -> Releases then -> Draft a new release with the Modul Name and Version, then
    • -> Target the main-Branch and ->enter a new Tag according to the Version, then click.
    • Click -> Generate Release notes , ->Adjust them if necessary and -> Copy/Paste the Details in the RealeaseNotes.md of the very Branch you want to merge.
    • Finally -> Save as Draft

Merge and Publishing

  • With the updated Version, Dates, and Release Notes (as described above) with the last committ into the Branch you want to merge.
  • In GitHub -> Actions the ->CI (FHIR Validation) workflow terminates successfully.
  • Add the Approve / the PR gets posivitly reviewed by a collegue.
  • Merge (without squash) the PR, delete the Branch.

Post-Merge Activities

  • Go to the corresponding SIMPLIFIER Project and -> Github -> Reimport the project.
  • Go to the corresponding SIMPLIFIER Project and -> Packages -> Expand the Dropdown for Create -> Create new package for the project.
    • With the corresponding version number, and
    • The Release notes (from above) and a compare-link to the previous Release.
    • Unlist the old package by -> clicking on the old package, -> go to Admininstration and -> click on Unlist
  • Publish IG in Simplifier
    • Provide a version in the IG title --> (x.x.x)
    • Scope the IG to the published package
    • Set URL key to isik-[module-name]-version (version without dots)
    • Publish via Simplifier GUI (set to overwritable)
  • Publish the previosuly drafteted Release, including version number, on GitHub.

Obsolet

  • Provide / Archive the IG in the corresponding gh-pages branch of the GitHub project.
    • Checkout the Branch (no need to merge it later).
    • Export from Simplifier via -> Guides -> Expand the Modul ... -> Export
    • Unpack the zip, remove the packages folder (because its kinda big), and move everything else to a (version coressponding) new folder in the branch folder structure.
    • committ the branch.

Finished

@f-peverali f-peverali changed the title auto-generated file update of TC version by GitHub Actions (CI FSH to… TC 4.0.1 Sep 23, 2024
f-peverali and others added 18 commits September 23, 2024 14:19
Übertragung sämtlicher instanzbezogener Doku aus dem IG in FSH
Update ISiKCapabilityStatementDokumentenaustauschServer.fsh
Motivation aus IG migriert nach DocumentReference.purpose
fix syntax for purpose entry
fix pagelinks in rest.resource.documentation
Dokumentation der MS Elemente
ISiKDokumentenMetadaten Bundle
@f-peverali
Copy link
Contributor Author

f-peverali commented Dec 3, 2024

suggestion: @simoneOnFhir könnten wir den Abschnitt zu "Änderungen zu ISiK Stufe 2" in der Stufe 4 entfernen? https://simplifier.net/guide/isik-dokumentenaustausch-401/Einfuehrung/UebergreifendeFestlegungen/AkteureUndInteraktionen?version=current

2 ) ggf. genauso diesen "Abgrenzung zu ISiK Stufe 2 (Basis) bei der Kommunikation strukturierter Dokumente (FHIR-Document-Bundle)" ... bzw. Überarbeiten, da hier seit Stufe 2 nichts passiert ist?


## Akteure
### Dokumentenserver
Das bestätigungsrelevante System nimmt die Rolle des Dokumentenservers ein. Ein Dokumentenserver nimmt Dokumente von Clients zur Speicherung/Archivierung/Verwaltung entgegen und erlaubt Clients die Suche nach und den Abruf von Dokumenten.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: hier Referenz auf Seite zu "bestätigungsrelevanten Systemen" hinzu, da hier ab Stufe 4 der "Dokumenten-Server" und "-Client" definiert werden

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

zu 1) -> in die releasenotes einfügen (für Stufe 4 ) an der Stelle 3.0.0-rc
zu 2) Abgrenzung zu ISiK Stufe 2 ( -> "Stufe 2" entfernen

f-peverali and others added 2 commits December 3, 2024 09:54
Vor der Bereitstellung von Dokumenten muss ein Client einen Patienten- und Encounterkontext herstellen, damit das Dokument serverseitig anhand der Patient- und Encounter-Verlinkungen in der DocumentReference korrekt zugeordnet werden kann.
Zur Herstellung des Kontextes sind folgende Verfahren möglich:

1. **SMARTApp Launch**: Wenn der Aufruf der App im Rahmen des SMART-Frameworks erfolgt, kennt der Client bereits beim Start den aktuellen Patienten- und ggf. den Encounterkontext. Dabei wählt ein Anwender im Primärsystem (Server) einen Patienten und Fall aus und startet in diesem Kontext die App. Referenzen auf Patient und Encounter werden im Zuge der Autorisierung vom Server an Client übermittelt. (Siehe Modul [Sicherheit - Launch Context und Scopes](https://simplifier.net/guide/isik-sicherheit/ImplementationGuide-markdown-ScopesAndLaunchContext?version=current)).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: hier ist ein veralteter Link.
question: @alexzautke auf was sollen wir hier am Besten verlinken - Stand Stufe 4? https://simplifier.net/guide/isik-connect-v4/ImplementationGuide-markdown-Conformance-ConformanceScopesKontexte?version=current

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

jo

@f-peverali
Copy link
Contributor Author

f-peverali commented Dec 4, 2024

question: @simoneOnFhir sollen wir die "USe Case Seite" Überarbeiten ? https://simplifier.net/guide/isik-dokumentenaustausch-401/Einfuehrung/UseCases/UseCases.page.md?version=current
... entsprechend der Basis https://simplifier.net/guide/isik-basis-401/Einfuehrung/UseCasesAnwendung?version=current ... ggf. streichen? Der eigentliche "Use Case" sit ja in der "Motivation erklärt mit " Voraussetzung dafür, ärztlichem und pflegerischem Personal relevante klinische Informationen an jedem Ort und zu jeder Zeit im benötigten Umfang zur Verfügung zu stellen." etc

-> kann raus

@f-peverali
Copy link
Contributor Author

question: Ist der Satz noch zeitgemäß: "soll künftig jedoch auch Best Practice-Empfehlungen zur Einstellung von Dokumenten in die ePA eines Patienten" https://simplifier.net/guide/isik-dokumentenaustausch-401/Einfuehrung/Motivation.page.md?version=current

f-peverali and others added 3 commits December 4, 2024 11:28
* rm sentence

* update releasenotes

* Update guides/Implementierungsleitfaden-ISiK-Dokumentenaustausch-401/Einfuehrung/Datenobjekte/Index.page.md

* Update guides/Implementierungsleitfaden-ISiK-Dokumentenaustausch-401/Einfuehrung/Datenobjekte/Index.page.md

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

Successfully merging this pull request may close these issues.

5 participants