Skip to content

Commit

Permalink
TC 3.0.3 - update HTTP response requirement #308 (#353)
Browse files Browse the repository at this point in the history
* init TC 3.0.3

* update HTTP response requirement #308

* Update ImplementationGuide/markdown/UebergreifendeFestlegungen/UebergreifendeFestlegungen_Rest.md

* Update ImplementationGuide/markdown/UebergreifendeFestlegungen/UebergreifendeFestlegungen_Rest.md

* Feature/devops automation (#355)

* initial devcontainer added

* enhancement of workflow files

* restrcuted image folders

* auto-generated diagrams by GitHub Action after source code change

Co-Authored-By: MaxMTheilig <[email protected]>

* update releasenotes

* update version

* auto-generated FHIR files by GitHub Actions (CI FSH to FHIR Validation)

---------

Co-authored-by: Alexander Zautke <[email protected]>
Co-authored-by: Max Theilig <[email protected]>
Co-authored-by: MaxMTheilig <[email protected]>
Co-authored-by: f-peverali <[email protected]>
  • Loading branch information
5 people authored Jan 15, 2024
1 parent 0bdef09 commit 543f959
Show file tree
Hide file tree
Showing 33 changed files with 76 additions and 66 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"resourceType": "ImplementationGuide",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/ImplementationGuide/ISiK-Basismodul",
"version": "3.0.2",
"version": "3.0.3",
"name": "Implementierungsleitfaden ISiK-Basismodul Stufe 3",
"status": "active",
"fhirVersion": [
Expand Down
4 changes: 2 additions & 2 deletions ImplementationGuide/markdown/Einfuehrung.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<img src="https://raw.githubusercontent.com/gematik/spec-ISiK-Basismodul/main-isik-stufe-3/Material/images/Gematik_Logo_Flag.svg" alt="gematik logo" width="400"/>

----
Version: 3.0.2
Version: 3.0.3

Datum: 09.01.2024
Datum: 15.01.2024

Status: Aktiv

Expand Down
9 changes: 9 additions & 0 deletions ImplementationGuide/markdown/ReleaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ Im Rahmen der ISiK-Veröffentlichungen wird das [Semantic Versioning](https://se

Die erste Ziffer X bezeichnet ein Major-Release und regelt die Gültigkeit von Releases. Die dritte Ziffer Y (Release x.0.y) bezeichnet eine technische Korrektur und versioniert kleinere Änderungen (Packages) während eines Jahres, z. B. 1.0.1.

----
Version: 3.0.3

Datum: 15.01.2024

* Anpassung und Harmonisierung der Anforderungen zu HTTP-Responses: update HTTP response requirement #308 by @f-peverali in https://github.com/gematik/spec-ISiK-Basismodul/pull/354

**Full Changelog**: https://github.com/gematik/spec-ISiK-Basismodul/compare/v.3.0.2...v.3.0.3

----
Version: 3.0.2

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,11 @@ Sollte die erzeugte Ressource dauerhaft in das bestätigungsrelevante System üb

Per Create-Interaktion erzeugte Ressourcen MÜSSEN im Falle einer erfolgreichen Übermittlung direkt über die READ- und SEARCH-Interaktionen zur Verfügung gestellt werden.

Ressourcen, die zu einem entsprechenden ISiK-Profil nicht konform sind, MÜSSEN durch das bestätigungsrelevante System abgelehnt werden. Als Antwort MUSS ein HTTP 400 Status Code mit einer ```OperationOutcome```-Ressource zurückgegeben werden. Diese enthält eine Auflistung aller Fehler in der übermittelten Ressource in kodierter Form.
Ressourcen, die zu einem entsprechenden ISiK-Profil nicht konform sind, MÜSSEN durch das bestätigungsrelevante System abgelehnt werden. Als Antwort MUSS ein HTTP Status-Code 400 - Bad Request mit einer ```OperationOutcome```-Ressource zurückgegeben werden, falls es sich um einen syntaktischen Fehler in der Repräsentation der Ressource handelt. Die ```OperationOutcome``` MUSS eine Auflistung aller Fehler in der übermittelten Ressource in kodierter Form vorweisen. Anderweitig (semantisch) invalide Ressourcen MÜSSEN ebenfalls mit einer entsprechenden OperationOutcome-Ressource abgewiesen werden. In diesem Fall SOLLTE der HTTP Status-Code HTTP 422 - Unprocessable Entity verwendet werden.


## Update-Interaktionen
Das Update einer Ressource KANN per HTTP PUT (vgl. [FHIR RESTful API - update](https://www.hl7.org/fhir/R4/http.html#update)) unterstützt werden. Es ist zu beachten, dass beim Update einer Ressource bestimmte dazugehörige [Metadaten](https://www.hl7.org/fhir/R4/resource.html#Meta) beibehalten werden SOLLTEN.
Das Update einer Ressource KANN per HTTP PUT (vgl. [FHIR RESTful API - update](https://www.hl7.org/fhir/R4/http.html#update)) unterstützt werden. Es ist zu beachten, dass beim Update einer Ressource bestimmte dazugehörige [Metadaten](https://www.hl7.org/fhir/R4/resource.html#Meta) beibehalten werden SOLLTEN. Die gleichen Vorgaben für die Handhabung von invaliden Ressourcen wie beschrieben im Abschnitt "Create-Interaktionen", gelten auch für Update-Interaktionen.


## Sicherheitsaspekte
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
"resourceType": "CapabilityStatement",
"id": "ISiKCapabilityStatementBasisServer",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/CapabilityStatement/basis-server",
"version": "3.0.2",
"version": "3.0.3",
"status": "active",
"experimental": false,
"publisher": "gematik GmbH",
"date": "2024-01-09",
"date": "2024-01-15",
"implementationGuide": [
"https://gematik.de/fhir/isik/v3/Basismodul/ImplementationGuide|3.0.2"
"https://gematik.de/fhir/isik/v3/Basismodul/ImplementationGuide|3.0.3"
],
"name": "ISiKCapabilityStatementBasisServer",
"title": "ISiK CapabilityStatement Basis Server",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
"https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKCodeSystem"
]
},
"version": "3.0.2",
"version": "3.0.3",
"status": "active",
"experimental": false,
"publisher": "gematik GmbH",
"date": "2024-01-09",
"date": "2024-01-15",
"url": "http://example.org/fhir/CodeSystem/TestKatalog",
"name": "TestKatalog",
"content": "complete",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
"id": "Encounter-date-start",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/SearchParameter/Encounter-date-start",
"description": "The actual start date of the Encounter (Backport from R5). The parameter cannot repeat or have multiple values.",
"version": "3.0.2",
"version": "3.0.3",
"status": "active",
"experimental": false,
"publisher": "gematik GmbH",
"date": "2024-01-09",
"date": "2024-01-15",
"name": "date-start",
"code": "date-start",
"base": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
"id": "Encounter-end-date",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/SearchParameter/Encounter-end-date",
"description": "The actual end date of the Encounter (Backport from R5). The parameter cannot repeat or have multiple values.",
"version": "3.0.2",
"version": "3.0.3",
"status": "active",
"experimental": false,
"publisher": "gematik GmbH",
"date": "2024-01-09",
"date": "2024-01-15",
"name": "end-date",
"code": "end-date",
"base": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
"resourceType": "StructureDefinition",
"id": "ISiKAbrechnungsfall",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKAbrechnungsfall",
"version": "3.0.2",
"version": "3.0.3",
"name": "ISiKAbrechnungsfall",
"status": "active",
"experimental": false,
"date": "2024-01-09",
"date": "2024-01-15",
"publisher": "gematik GmbH",
"description": "Dieses Profil beschreibt die Gruppierung von medizinischen Leistungen in ISiK-Szenarien",
"fhirVersion": "4.0.1",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
"resourceType": "StructureDefinition",
"id": "ISiKAngehoeriger",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKAngehoeriger",
"version": "3.0.2",
"version": "3.0.3",
"name": "ISiKAngehoeriger",
"status": "active",
"experimental": false,
"date": "2024-01-09",
"date": "2024-01-15",
"publisher": "gematik GmbH",
"description": "Dieses Profil ermöglicht die Nutzung von Angehörigen in ISiK Szenarien.",
"fhirVersion": "4.0.1",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
"resourceType": "StructureDefinition",
"id": "ISiKBerichtBundle",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKBerichtBundle",
"version": "3.0.2",
"version": "3.0.3",
"name": "ISiKBerichtBundle",
"title": "ISiKBerichtBundle",
"status": "active",
"experimental": false,
"date": "2024-01-09",
"date": "2024-01-15",
"publisher": "gematik GmbH",
"description": "A document style representation of the receipt (complete, self-contained, signed)",
"fhirVersion": "4.0.1",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
"resourceType": "StructureDefinition",
"id": "ISiKBerichtSubSysteme",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKBerichtSubSysteme",
"version": "3.0.2",
"version": "3.0.3",
"name": "ISiKBerichtSubSysteme",
"status": "active",
"experimental": false,
"date": "2024-01-09",
"date": "2024-01-15",
"publisher": "gematik GmbH",
"description": "Dieses Profil ermöglicht die Krankenhaus-interne Übermittlung eines Berichtes in Form eines Dokumentes, die in ISiK Szenarien von Subsystemen an Primärsysteme gesendet werden.",
"fhirVersion": "4.0.1",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
"resourceType": "StructureDefinition",
"id": "ISiKBinary",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKBinary",
"version": "3.0.2",
"version": "3.0.3",
"name": "ISiKBinary",
"title": "ISiKBinary",
"status": "active",
"experimental": false,
"date": "2024-01-09",
"date": "2024-01-15",
"publisher": "gematik GmbH",
"description": "Die Binary-Ressource erlaubt den Umgang mit FHIR-fremden Formaten (z.B. PDFs, Bilder, CDA) innerhalb des FHIR-Frameworks.\r\nDazu werden die Daten base64-codiert in der Binary-Ressource (in XML oder JSON) transportiert oder \r\nüber die REST-API am Binary-Endpunkt in ihrem nativen Format bereitgestellt. \r\nBinary-Ressourcen werden von Attachment-Elementen in DocumentReference-Ressourcen verlinkt und damit in den Kontext anderer FHIR-Ressourcen\r\n(z.B. Patient und Encounter) gestellt. ",
"fhirVersion": "4.0.1",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
"resourceType": "StructureDefinition",
"id": "ISiKCodeSystem",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKCodeSystem",
"version": "3.0.2",
"version": "3.0.3",
"name": "ISiKCodeSystem",
"status": "active",
"experimental": false,
"date": "2024-01-09",
"date": "2024-01-15",
"publisher": "gematik GmbH",
"description": "Dieses Profil beschreibt die maschinenlesbare Repräsentation von system-sepzifischen Kodierungen in ISiK-Szenarien",
"fhirVersion": "4.0.1",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
"resourceType": "StructureDefinition",
"id": "ISiKDiagnose",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKDiagnose",
"version": "3.0.2",
"version": "3.0.3",
"name": "ISiKDiagnose",
"status": "active",
"experimental": false,
"date": "2024-01-09",
"date": "2024-01-15",
"publisher": "gematik GmbH",
"description": "Dieses Profil ermöglicht die Nutzung von Diagnosen in ISiK Szenarien.",
"fhirVersion": "4.0.1",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
"resourceType": "StructureDefinition",
"id": "ISiKKontaktGesundheitseinrichtung",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKKontaktGesundheitseinrichtung",
"version": "3.0.2",
"version": "3.0.3",
"name": "ISiKKontaktGesundheitseinrichtung",
"status": "active",
"experimental": false,
"date": "2024-01-09",
"date": "2024-01-15",
"publisher": "gematik GmbH",
"description": "Dieses Profil ermöglicht die Herstellung eines Fallbezuges welcher in der Mehrheit der ISiK Szenarien im Krankenhaus essentiell ist.",
"fhirVersion": "4.0.1",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
"resourceType": "StructureDefinition",
"id": "ISiKPatient",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKPatient",
"version": "3.0.2",
"version": "3.0.3",
"name": "ISiKPatient",
"status": "active",
"experimental": false,
"date": "2024-01-09",
"date": "2024-01-15",
"publisher": "gematik GmbH",
"description": "Dieses Profil beschreibt die Nutzung von administrativen Patientendaten in ISiK-Szenarien.",
"fhirVersion": "4.0.1",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
"resourceType": "StructureDefinition",
"id": "ISiKPersonImGesundheitsberuf",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKPersonImGesundheitsberuf",
"version": "3.0.2",
"version": "3.0.3",
"name": "ISiKPersonImGesundheitsberuf",
"status": "active",
"experimental": false,
"date": "2024-01-09",
"date": "2024-01-15",
"publisher": "gematik GmbH",
"description": "Dieses Profil ermöglicht die Nutzung von in Gesundheitsberufen tätigen Personen in ISiK Szenarien.",
"fhirVersion": "4.0.1",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
"resourceType": "StructureDefinition",
"id": "ISiKProzedur",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKProzedur",
"version": "3.0.2",
"version": "3.0.3",
"name": "ISiKProzedur",
"status": "active",
"experimental": false,
"date": "2024-01-09",
"date": "2024-01-15",
"publisher": "gematik GmbH",
"description": "Diese Profil ermöglicht die Nutzung von Prozedur-bezogenen Informationen in ISiK Szenarien.",
"fhirVersion": "4.0.1",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
"resourceType": "StructureDefinition",
"id": "ISiKValueSet",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKValueSet",
"version": "3.0.2",
"version": "3.0.3",
"name": "ISiKValueSet",
"status": "active",
"experimental": false,
"date": "2024-01-09",
"date": "2024-01-15",
"publisher": "gematik GmbH",
"description": "Dieses Profil beschreibt die maschinenlesbare Auswahl von Codes für die Kodierung spezifischer FHIR-Elemente in ISiK-Szenarien",
"fhirVersion": "4.0.1",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
"resourceType": "StructureDefinition",
"id": "ISiKVersicherungsverhaeltnisGesetzlich",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKVersicherungsverhaeltnisGesetzlich",
"version": "3.0.2",
"version": "3.0.3",
"name": "ISiKVersicherungsverhaeltnisGesetzlich",
"status": "active",
"experimental": false,
"date": "2024-01-09",
"date": "2024-01-15",
"publisher": "gematik GmbH",
"description": "Dieses Profil ermöglicht die Darstellung eines gesetzlichen Versicherungsverhältnisses in ISiK Szenarien.",
"fhirVersion": "4.0.1",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
"resourceType": "StructureDefinition",
"id": "ISiKVersicherungsverhaeltnisSelbstzahler",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKVersicherungsverhaeltnisSelbstzahler",
"version": "3.0.2",
"version": "3.0.3",
"name": "ISiKVersicherungsverhaeltnisSelbstzahler",
"status": "active",
"experimental": false,
"date": "2024-01-09",
"date": "2024-01-15",
"publisher": "gematik GmbH",
"description": "Dieses Profil ermöglicht Selbstzahler Szenarien in ISiK.",
"fhirVersion": "4.0.1",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
"resourceType": "StructureDefinition",
"id": "PlannedEndDate",
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedEndDate",
"version": "3.0.2",
"version": "3.0.3",
"name": "PlannedEndDate",
"status": "active",
"experimental": false,
"date": "2024-01-09",
"date": "2024-01-15",
"publisher": "gematik GmbH",
"fhirVersion": "4.0.1",
"mapping": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
"resourceType": "StructureDefinition",
"id": "PlannedStartDate",
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedStartDate",
"version": "3.0.2",
"version": "3.0.3",
"name": "PlannedStartDate",
"status": "active",
"experimental": false,
"date": "2024-01-09",
"date": "2024-01-15",
"publisher": "gematik GmbH",
"fhirVersion": "4.0.1",
"mapping": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
"resourceType": "StructureDefinition",
"id": "identifier-abrechnungsnummer",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/identifier-abrechnungsnummer",
"version": "3.0.2",
"version": "3.0.3",
"name": "IdentifierAbrechnungsnummer",
"title": "Identifier-Profil für die Abbildung einer Abrechnungsnummer (\"Fallnummer\") ",
"status": "active",
"experimental": false,
"date": "2024-01-09",
"date": "2024-01-15",
"publisher": "gematik GmbH",
"description": "Identifier-Profil für die Abbildung einer organisationsspezifischen Abrechnungsnummer (\"Fallnummer\")",
"fhirVersion": "4.0.1",
Expand Down
4 changes: 2 additions & 2 deletions Resources/fsh-generated/resources/ValueSet-DiagnosesSCT.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
"id": "DiagnosesSCT",
"description": "Enthaelt alle SNOMED Clinical finding, Event und Situation with explicit context codes",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/ValueSet/DiagnosesSCT",
"version": "3.0.2",
"version": "3.0.3",
"experimental": false,
"publisher": "gematik GmbH",
"date": "2024-01-09",
"date": "2024-01-15",
"compose": {
"include": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
"id": "ISiKAccountIdentifierType",
"title": "ISiKAccountIdentifierType",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/ValueSet/ISiKAccountIdentifierType",
"version": "3.0.2",
"version": "3.0.3",
"experimental": false,
"publisher": "gematik GmbH",
"date": "2024-01-09",
"date": "2024-01-15",
"compose": {
"include": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
"id": "ISiKAccountType",
"title": "ISiKAccountType",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/ValueSet/ISiKAccountType",
"version": "3.0.2",
"version": "3.0.3",
"experimental": false,
"publisher": "gematik GmbH",
"date": "2024-01-09",
"date": "2024-01-15",
"compose": {
"include": [
{
Expand Down
Loading

0 comments on commit 543f959

Please sign in to comment.