Skip to content

Commit

Permalink
add clarification basis ressources ptdata 733 (#137)
Browse files Browse the repository at this point in the history
* add link to Basis + fix Link+typos

* Update sushi-config.yaml

* issue and pr templates

* fixing r4 references (#134)

* add profile steatement

* Update ImplementationGuide/markdown/AnmerkungenMS.md

Co-authored-by: Yannick Börner <[email protected]>

* Update ImplementationGuide/markdown/CapabilityStatement.md

Co-authored-by: Yannick Börner <[email protected]>

* Update ImplementationGuide/markdown/CapabilityStatement.md

Co-authored-by: Yannick Börner <[email protected]>

* Update ImplementationGuide/markdown/CapabilityStatement.md

Co-authored-by: Yannick Börner <[email protected]>

* Update ImplementationGuide/markdown/Interaktionen.md

Co-authored-by: Yannick Börner <[email protected]>

* Update ImplementationGuide/markdown/Interaktionen.md

Co-authored-by: Yannick Börner <[email protected]>

* Update ImplementationGuide/markdown/Interaktionen.md

Co-authored-by: Yannick Börner <[email protected]>

* Update Resources/sushi-config.yaml

---------

Co-authored-by: Max Theilig <[email protected]>
Co-authored-by: Yannick Börner <[email protected]>
  • Loading branch information
3 people authored Jan 5, 2024
1 parent 2d00c0a commit e8addea
Show file tree
Hide file tree
Showing 11 changed files with 207 additions and 22 deletions.
76 changes: 76 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG-REPORT.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: "🐛 Bug Report"
description: Create a new ticket for a bug.
title: "🐛 [BUG] - <title>"
labels: [
"bug",
"invalid"
]
body:
- type: textarea
id: description
attributes:
label: "Description"
description: Please enter an explicit description of the issue.
placeholder: |
Short and explicit description of the incident...
If you are able to specify, please also select the appropriate label:
- Bug, if something is technically not working, e.g. not compiling.
- Invalid, if something is technically working but does not seem to yield to correct outcome, e.g. 1+1 is 3.
validations:
required: true
- type: input
id: reprod-url
attributes:
label: "Reproduction URL"
description: Please enter the corresponding Simplifier URL (or other, e.g. GitHub) to provide a source for reproduction of the issue.
placeholder: ex. https://simplifier.net/REPO-NAME/RESOURCE-NAME
validations:
required: true
- type: input
id: version
attributes:
label: "Version or Branch"
description: If this bug occures only in a specific version or development branch, please tell us here.
placeholder: ex. Only occurs with ISiK 2.0.4.
validations:
required: false
- type: textarea
id: reprod
attributes:
label: "Reproduction Steps"
description: Please enter a step by step description of the issue.
value: |
1. At the interface '....'
2. With Data '....'
3. Execute Operation '....'
4. See error
render: bash
validations:
required: true
- type: textarea
id: logs
attributes:
label: "Stack Trace and Logs"
description: Please copy and paste any relevant stack trace or log output. This will be automatically formatted into code.
render: bash
validations:
required: false
- type: textarea
id: screenshot
attributes:
label: "Screenshots"
description: If applicable, add screenshots to help explain your problem.
value: |
![DESCRIPTION](LINK.png)
render: bash
validations:
required: false
- type: textarea
id: environment
attributes:
label: "Software and Environment"
description: Please describe the used software and your environment further.
placeholder: ex. I Use dotnet sdk 4.x and Firely Terminal to manage fhir packages
validations:
required: false
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: "💡 Feature Request"
description: Create a new ticket for a new feature request
title: "💡 [REQUEST] - <title>"
labels: [
"question",
"enhancement"
]
body:
- type: input
id: target_date
attributes:
label: "Target Date"
description: When would you need this feature to be available?
placeholder: "MM YYYY"
validations:
required: false
- type: input
id: implementation_pr
attributes:
label: "Implementation PR"
description: In case you already developed the feature yourself, please tell us the corresponding PR. Also, maybe you have seen this feature somewhere else?
placeholder: "Your Pull Request ID or link to a similar PR."
validations:
required: false
- type: textarea
id: reference_issues
attributes:
label: "Reference Issues"
description: Some common issues this feature would address.
placeholder: "Issues IDs and references"
validations:
required: false
- type: textarea
id: summary
attributes:
label: "Summary"
description: Please provide a brief explanation of the feature.
placeholder: |
Describe in a few lines your feature request ...
If you are able to specify, please also select the appropriate label:
- Question, if you would also be fine with more information, on how to address your request, e.g. with a workaround.
- Enhancement, if you are kinda sure your Request is an independent new addition, that could not be achieved otherwise.
validations:
required: true
- type: textarea
id: basic_example
attributes:
label: "Common Examples"
description: Indicate some basic examples of your feature or a common flow in which it would be used.
placeholder: |
In the use case of '...'
The necessary data will flow like '....'
Feature will be used '....'
With the result of '....'
validations:
required: true
- type: textarea
id: drawbacks
attributes:
label: "Drawbacks"
description: What are the drawbacks or mutual impacts of your feature request?
placeholder: Identify the drawbacks and mutual impacts with respect to other features.
validations:
required: true
- type: textarea
id: unadress_question
attributes:
label: "Unadressed questions"
description: What issues or questions still remain unadressed?
placeholder: Identify any unresolved issues or questions.
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
30 changes: 30 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->
<!--- If it full fills an open feature request, please link to the feature request here. -->

## How has this been tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, especially -->
<!--- the software you teste your change with. -->
<!--- Are other areas of the specification affected? -->

## Snippets or Screenshots (if necessary):

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My code follows the code style of this IG / specification.
- [ ] My change requires a change to the documentation or narrative (intend) of the IG.
- [ ] I have already updated the documentation / narrative (intend) accordingly.
2 changes: 1 addition & 1 deletion ImplementationGuide/markdown/AnmerkungenMS.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
**Bedeutung:** Der Status MUSS insbesondere zur Differenzierung von abgeschlossenen, vorläufigen oder korrigierten Beobachtungen angegeben werden.
Es ist möglich, dass einzelne Systeme nur Werte vom Status `final` bereitstellen. Empfangende Systeme müssen jedoch in der Lage sein, sämtliche Status-Codes zu interpretieren.

**Hinweis:** Siehe Beschreibung in der [FHIR Kernspezifikation](http://hl7.org/fhir/observation-definitions.html#Observation.status).
**Hinweis:** Siehe Beschreibung in der [FHIR Kernspezifikation](https://hl7.org/fhir/R4/observation-definitions.html#Observation.status).

### `Observation.category`

Expand Down
14 changes: 7 additions & 7 deletions ImplementationGuide/markdown/CapabilityStatement.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# Konformitätserklärung [(CapabilityStatement)](http://hl7.org/fhir/capabilitystatement.html)
# Konformitätserklärung [(CapabilityStatement)](https://hl7.org/fhir/R4/capabilitystatement.html)

Jede Instanz eines bestätigungsrelevanten Systems MUSS an ihrem Endpunkt eine [CapabilityStatement](http://hl7.org/fhir/capabilitystatement.html)-Ressource bereitstellen.
Jede Instanz eines bestätigungsrelevanten Systems MUSS an ihrem Endpunkt eine [CapabilityStatement](https://hl7.org/fhir/R4/capabilitystatement.html)-Ressource bereitstellen.

Hierzu MUSS die [capabilities-Interaktion gemäß FHIR-Spezifikation](http://hl7.org/fhir/http.html#capabilities) unterstützt werden.
Hierzu MUSS die [capabilities-Interaktion gemäß FHIR-Spezifikation](https://hl7.org/fhir/R4/http.html#capabilities) unterstützt werden.
Der MODE-Parameter kann ignoriert werden.

Das CapabilityStatement in dieser Spezifikation stellt die Anforderungen seitens der gematik dar (`kind` = "requirements"). Zur Unterscheidung von Anforderungen, die erfüllt werden MÜSSEN gegenüber jenen, die erfüllt werden KÖNNEN, wird die [CapabilityStatement-Expectation-Extension](http://hl7.org/fhir/extension-capabilitystatement-expectation.html) mit den möglichen Werten "SHALL" (=MUSS) und "MAY" (=KANN) verwendet.
Das CapabilityStatement in dieser Spezifikation stellt die Anforderungen seitens der gematik dar (`kind` = "requirements"). Zur Unterscheidung von Anforderungen, die erfüllt werden MÜSSEN gegenüber jenen, die erfüllt werden KÖNNEN, wird die [CapabilityStatement-Expectation-Extension](https://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html) mit den möglichen Werten "SHALL" (=MUSS) und "MAY" (=KANN) verwendet.

Eine Server-Instanz MUSS ihrerseits ein CapabilityStatement vom `kind`= "instance" liefern und im Element `software` den Namen und die Versionsnummer angeben.

Das CapabilityStatement der Instanz MUSS alle Funktionalitäten auflisten, die im folgenden CapabilityStatement mit "SHALL" gekennzeichnet sind. Das CapabilityStatement KANN darüber hinaus die mit "MAY" gekennzeichneten Funktionalitäten sowie weitere Funktionalitäten auflisten, sofern diese in der Instanz implementiert wurden.

Die Verwendung der [CapabilityStatement-Expectation](http://hl7.org/fhir/extension-capabilitystatement-expectation.html)-Extension ist im CapabilityStatement der Server-Instanz nicht erforderlich.
Die Verwendung der [CapabilityStatement-Expectation](https://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html)-Extension ist im CapabilityStatement der Server-Instanz nicht erforderlich.

## CapabilityStatement (Requirement) ISiK-Vitalparameter

Die Bereitstellung des CapabilityStatments für das Modul "Vitalparameter" erfolgt zusammen mit der Festlegung der bestätigungsrelevanten Systeme in Stufe 2.

Für Systeme, die das Modul "Vitalparameter" implementieren, ist außerdem die Erfüllung der Mindestanforderungen des [Moduls "Basis"](https://simplifier.net/guide/ImplementierungsleitfadenISiK-Basismodul/Einfuehrung) erfoderlich:
Für Systeme, die das Modul "Vitalparameter" implementieren, ist außerdem die Erfüllung der Mindestanforderungen des [Moduls "Basis"](https://simplifier.net/guide/Implementierungsleitfaden-ISiK-Basismodul-Stufe-3/ImplementationGuide-markdown-Einfuehrung?version=current) erforderlich:

Canonical: https://gematik.de/fhir/isik/v3/VitalparameterUndKoerpermasze/CapabilityStatement/core-server

[Link Simplifier Profil Übersicht](https://simplifier.net/isik-modulvitalparameter/isik-capabilitystatement-vitalparameter-server)
[Link Simplifier Profil Übersicht](https://simplifier.net/isik-vitalparameter-und-koerpermasze-v3/isik-capabilitystatement-vitalparameter-server)

{{render:https://gematik.de/fhir/isik/v3/VitalparameterUndKoerpermasze/CapabilityStatement/vitalparameter-server}}

Expand Down
6 changes: 6 additions & 0 deletions ImplementationGuide/markdown/Datenobjekte.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# Datenobjekte

Folgende Datenobjekte und Interaktionen aus dem Modul [ISiK Basis Stufe 3](https://simplifier.net/guide/implementierungsleitfaden-isik-basismodul-stufe-3?version=current) sind in diesem Modul bestätigungsrelevant:
* [Patient](https://simplifier.net/guide/Implementierungsleitfaden-ISiK-Basismodul-Stufe-3/ImplementationGuide-markdown-Datenobjekte-Datenobjekte-Patient?version=current)
* [Kontakt/Fall (Encounter)](https://simplifier.net/guide/Implementierungsleitfaden-ISiK-Basismodul-Stufe-3/ImplementationGuide-markdown-Datenobjekte-Datenobjekte-Kontakt?version=current)

Darüber hinaus gelten in diesem Modul folgende Datenobjekt-spezifische Festlegungen:

{{index:current}}
2 changes: 1 addition & 1 deletion ImplementationGuide/markdown/Einfuehrung.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Realm: Deutschland

# Interoperabler Datenaustausch durch Informationssysteme im Krankenhaus (ISiK)

Die gematik wurde vom Gesetzgeber beauftragt, im Benehmen mit der Deutschen Krankenhausgesellschaft (DKG) und den maßgeblichen Bundesverbänden der Industrie im Gesundheitswesen verbindliche Standards für den Austausch von Gesundheitsdaten mit Informationssystemen im Krankenhaus zu erarbeiten. Dieser FHIR ImplementationGuide (IG) beschreibt die für diesen Zweck entwickelten FHIR Profile und das [REST](https://de.wikipedia.org/wiki/Representational_State_Transfer)-basierte Application Programming Interface (API). Die REST-API wird im Wesentlichen [vom FHIR Standard vorgegeben](https://www.hl7.org/fhir/http.html). Dieser Leitfaden konkretisiert die ISiK-relevanten Funktionen der Standard-REST-API und trifft inhaltliche Festlegungen zu den ISiK-relevanten Ressourcen in Form von Ressourcen-Profilen.
Die gematik wurde vom Gesetzgeber beauftragt, im Benehmen mit der Deutschen Krankenhausgesellschaft (DKG) und den maßgeblichen Bundesverbänden der Industrie im Gesundheitswesen verbindliche Standards für den Austausch von Gesundheitsdaten mit Informationssystemen im Krankenhaus zu erarbeiten. Dieser FHIR ImplementationGuide (IG) beschreibt die für diesen Zweck entwickelten FHIR Profile und das [REST](https://de.wikipedia.org/wiki/Representational_State_Transfer)-basierte Application Programming Interface (API). Die REST-API wird im Wesentlichen [vom FHIR Standard vorgegeben](https://www.hl7.org/fhir/R4/http.html). Dieser Leitfaden konkretisiert die ISiK-relevanten Funktionen der Standard-REST-API und trifft inhaltliche Festlegungen zu den ISiK-relevanten Ressourcen in Form von Ressourcen-Profilen.

Hersteller bestätigungsrelevanter Systeme sollen durch diesen IG in die Lage versetzt werden, eine konforme Implementierung zu erstellen und das Bestätigungsverfahren der gematik erfolgreich zu absolvieren.

Expand Down
Loading

0 comments on commit e8addea

Please sign in to comment.