diff --git a/HTTP-Validator/release-note.md b/HTTP-Validator/release-note.md index 1338895453c55c45c6e6732b0508406c1f8d3678..50e5d839f25242dbd43223211a349a2c2ae1ff27 100644 --- a/HTTP-Validator/release-note.md +++ b/HTTP-Validator/release-note.md @@ -9,6 +9,16 @@ customer: IHE Europe reference: KER1-RNO-IHE-HTTP_VALIDATOR --- +# 0.3.1 +_Release date: 2024-06-27_ + +__Story__ + +__Improvement__ +* \[[HTTP-58](https://gazelle.ihe.net/jira/browse/HTTP-58)\] POST x-www-url-encoded parameters not taken in account. + + + # 0.3.0 _Release date: 2023-09-19_ diff --git a/HTTP-Validator/user.md b/HTTP-Validator/user.md index 5cdf4f836de8e3c71e54192d036c04f7c201ab3b..3ee3ce79931fcd2da717dc4178a31ac7cd1faae8 100644 --- a/HTTP-Validator/user.md +++ b/HTTP-Validator/user.md @@ -4,7 +4,7 @@ subtitle: HTTP Validator author: Clément LAGORCE function: Software Engineer date: 21=2/08/2023 -toolversion: 0.3.0 +toolversion: 0.3.1 version: 1_03 status: Reviewed reference: KER1-MAN-IHE-HTTP-VALIDATOR_USER-1_03 diff --git a/MHD-FHIR-Simulators/Makefile b/MHD-FHIR-Simulators/Makefile new file mode 100755 index 0000000000000000000000000000000000000000..cbbc56c706e2a9d7c1b43999f7199c4c956757ea --- /dev/null +++ b/MHD-FHIR-Simulators/Makefile @@ -0,0 +1,3 @@ +SHELL := /bin/bash + +include ../Makefile.generic diff --git a/MHD-FHIR-Simulators/release-note.md b/MHD-FHIR-Simulators/release-note.md new file mode 100755 index 0000000000000000000000000000000000000000..c24533b8cbc99c4ace819a41d615f045f9b2f0d6 --- /dev/null +++ b/MHD-FHIR-Simulators/release-note.md @@ -0,0 +1,24 @@ +#--- +#title: Release note +#subtitle: MHD FHIR Simulator +#toolversion: 1.0.0 +#releasedate: 2024-06-27 +#authors: Romuald DUBOURG +#function: Software Engineer +#customer: eHealthsuisse +#reference: +#--- + +# 1.0.0 +_Release date: 2024-06-27_ + +__Story__ +* \[[CHMHD-3](https://gazelle.ihe.net/jira/browse/CHMHD-3)\] Create gitlab project with quarkus / java 17 and create a hapi fhir servlet Medium - Medium priority, must be plan in one of the next cycles. +* \[[CHMHD-4](https://gazelle.ihe.net/jira/browse/CHMHD-4)\] [CH ITI-65] Provide Document Bundle +* \[[CHMHD-5](https://gazelle.ihe.net/jira/browse/CHMHD-5)\] [CH ITI-66] Find Document Lists +* \[[CHMHD-6](https://gazelle.ihe.net/jira/browse/CHMHD-6)\] [CH ITI-67] Find Document References +* \[[CHMHD-7](https://gazelle.ihe.net/jira/browse/CHMHD-7)\] [CH ITI-68] Retrieve Document +* \[[CHMHD-8](https://gazelle.ihe.net/jira/browse/CHMHD-8)\] Create client for Nist Tool kit +* \[[CHMHD-11](https://gazelle.ihe.net/jira/browse/CHMHD-11)\] HTTP Validator Profile +* \[[CHMHD-12](https://gazelle.ihe.net/jira/browse/CHMHD-12)\] Interceptor configuration/instanciation + diff --git a/MHD-FHIR-Simulators/user.md b/MHD-FHIR-Simulators/user.md new file mode 100644 index 0000000000000000000000000000000000000000..6ff152fa5cd5a38313ad76fa555b15cacb7d9716 --- /dev/null +++ b/MHD-FHIR-Simulators/user.md @@ -0,0 +1,109 @@ +--- +title: User Manual +subtitle: MHD Fhir Simulator +author: Romuald DUBOURG +releasedate: 2024-06-27 +toolversion: 1.0.0 +function: Engineer +version: 1.0.0 +status: validated +--- + +# MHD Fhir Simulator + +## Description + +The MHD FHIR Simulator acts like a server to return queried resources fetch from Nist FHIR Toolkit (asbestos) . +It had a validation process to check if the Header + Body + URL are compliant regarding the IHE specification. +And a validation process to check if sent resource is compliant regarding the IHE specification. +Only Documents, Document References and Lists are fetched from the Patient Registry. + + +## [IHE ITI-65] Provide Document Bundle + +- [IHE Specifications](https://profiles.ihe.net/ITI/MHD/ITI-65.html) + +## Overview + +Here is a quick overview of the available functionality from MHD Fhir Simulator + +| Operation | HTTP Methods | URL to call | Entry parameter | Returned value | Remarks| +|-----------------------------|--------------|---------------------------------------------------|----------------------------------------|----------------------|---| +| Provide Document Bundle | POST | ```https://example.com/mhd-fhir-simulator/fhir``` | Document bundle int the request's body | Transaction response |/| + + +## [CH ITI-66] Find Document Lists + +- [IHE Specifications](https://profiles.ihe.net/ITI/MHD/ITI-66.html) + +## Overview + +Here is a quick overview of the available functionality from MHD Fhir Simulator + +| Operation | HTTP Methods | URL to call | Entry parameter | Returned value | Remarks| +|-----------------------------|--------------|---------------------------------------------------------------------|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------|---| +| Find Document Lists | GET | ```https://example.com/mhd-fhir-simulator/fhir/List?{parameters}``` | Parameters to search for specific ITI-66 MHD Fhir resource ITI-66 | A bundle containing 0 to many ITI-66 MHD Fhir Specific corresponding to search criteria |/| + +## [CH ITI-67] Find Document References + +- [IHE Specifications](https://profiles.ihe.net/ITI/MHD/ITI-67.html) + +## Overview + +Here is a quick overview of the available functionality from MHD Fhir Simulator + +| Operation | HTTP Methods | URL to call | Entry parameter | Returned value | Remarks| +|-------------------------|--------------|----------------------------------------------------------------------------------|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------|---| +| Find Document Reference | GET | ```https://example.com/mhd-fhir-simulator/fhir/DocumentReference?{parameters}``` | Parameters to search for specific ITI-67 MHD Fhir resource ITI-67 | A bundle containing 0 to many ITI-67 MHD Fhir Specific corresponding to search criteria |/| + +## [CH ITI-68] Retrieve Document + +- [IHE Specifications](https://profiles.ihe.net/ITI/MHD/ITI-68.html) + +## Overview + +Here is a quick overview of the available functionality from MHD Fhir Simulator + +| Operation | HTTP Methods | URL to call | Entry parameter | Returned value | Remarks| +|-------------------------|--------------|-----------------------------------------------------------------|--------------------------------------------|-----------------------------|---| +| Find Document Reference | GET | ```https://example.com/mhd-fhir-simulator/fhir/Document/{id}``` | ID for a specific ITI-68 MHD Fhir resource | the desired ITI-68 Resource |/| + + + +Capability statement of the application can be found with : <https://example.com/mhd-fhir-simulator/fhir/metadata> + +As described in [HAPI FHIR resources](https://hapifhir.io/hapi-fhir/docs/server_plain/rest_operations_operations.html), some strings are automatically escaped when the FHIR server parses URLs: + +|Given String|Parsed as| +| :---: | :---: | +|\||%7C| + + +## Validation process + +Each operation implies a validation of requests for `ITI-65`, `ITI-66`, `ITI-67` and `ITI-68` +Validation is done by calling: + +- [HTTP Validator](https://gitlab.inria.fr/gazelle/applications/test-execution/validator/http-validator) for URL and Headers for `ITI-65`, `ITI-66`, `ITI-67` and `ITI-68`. +- [FHIR Validator](https://gitlab.inria.fr/gazelle/applications/test-execution/validator/fhir-validator) or Matchbox for the body of the request for `ITI-65`. + +The validation is done by default but can be switched with options: + +- `evs.endpoint=https://${FQDN}/evs/rest/validations` + +- `http.validation.name=HTTP Message Validator` +- `http.validation.schematron.name-iti-65=CH_ITI-65-ProvideDocumentBundle_POST_MHD_Request` +- `http.validation.schematron.name-iti-66=CH_ITI-66-FindDocumentLists-GET_MHD_Request` +- `http.validation.schematron.name-iti-67=CH_ITI-67-FindDocumentReferences-GET_MHD_Request` +- `http.validation.schematron.name-iti-68=CH_ITI-68-RetrieveDocument-GET_MHD_Request` + +- `fhir.validation.name=Gazelle FHIR Validator R4` +- `fhir.validation.schematron.name-iti-65=CH:MHD [ITI-65] Provide Document Bundle Comprehensive Request` + + +Resources are fetched from the NIST FHIR Toolkit (https://gitlab.inria.fr/gazelle/public/processing/patient-registry). + +You can choose which NIST FHIR Toolkit target by setting the `nist.fhir.toolkit.endpoint` parameter + + + diff --git a/PDQm-FHIR-Simulators/Makefile b/PDQm-FHIR-Simulators/Makefile new file mode 100755 index 0000000000000000000000000000000000000000..cbbc56c706e2a9d7c1b43999f7199c4c956757ea --- /dev/null +++ b/PDQm-FHIR-Simulators/Makefile @@ -0,0 +1,3 @@ +SHELL := /bin/bash + +include ../Makefile.generic diff --git a/PDQm-FHIR-Simulators/release-note.md b/PDQm-FHIR-Simulators/release-note.md new file mode 100755 index 0000000000000000000000000000000000000000..ea3b9d5b625b434830d12bf43bb11af1624c85d9 --- /dev/null +++ b/PDQm-FHIR-Simulators/release-note.md @@ -0,0 +1,22 @@ +#--- +#title: Release note +#subtitle: PDQm FHIR Simulator +#toolversion: 1.0.0 +#releasedate: 2024-06-25 +#authors: Romuald DUBOURG +#function: Software Engineer +#customer: eHealthsuisse +#reference: +#--- + +# 1.0.0 +_Release date: 2024-06-25_ + +__Story__ +* \[[PDQM-5](https://gazelle.ihe.net/jira/browse/PDQM-5)\] [IHE ITI-78] Read a resource +* \[[PDQM-6](https://gazelle.ihe.net/jira/browse/PDQM-6)\] [CH ITI-78] Search a Resource +* \[[PDQM-7](https://gazelle.ihe.net/jira/browse/PDQM-7)\] Load resources at startup +* \[[PDQM-8](https://gazelle.ihe.net/jira/browse/PDQM-8)\] [CH ITI-78] Read a Resource +* \[[PDQM-9](https://gazelle.ihe.net/jira/browse/PDQM-9)\] [IHE ITI-78] Search resources +* \[[PDQM-10](https://gazelle.ihe.net/jira/browse/PDQM-10)\] Integrate HAPI Fhir with Quarkus + diff --git a/PDQm-FHIR-Simulators/user.md b/PDQm-FHIR-Simulators/user.md new file mode 100644 index 0000000000000000000000000000000000000000..e4d5b17311ba442f22fe86dd3ac469389db534c6 --- /dev/null +++ b/PDQm-FHIR-Simulators/user.md @@ -0,0 +1,92 @@ +--- +title: User Manual +subtitle: PDQm Fhir Simulator +author: Romuald DUBOURG +releasedate: 2024-06-25 +toolversion: 1.0.0 +function: Engineer +version: 1.0.0 +status: validated +--- + +# PDQm Fhir Simulator + +## Description + +The PDQm FHIR Simulator acts like a server to return queried resources fetch from Patient Registry. +It had a validation process to check if the Header + Body + URL are compliant regarding the IHE specification. + +Only Patients are fetched from the Patient Registry. + + +## Find Matching Patients (ITI-78) - IHE + +- [IHE Specifications](https://profiles.ihe.net/ITI/PDQm/ITI-78.html) + +## Overview + +Here is a quick overview of the available functionality from PDQm Fhir Simulator + +| Operation | HTTP Methods | URL to call | Entry parameter | Returned value | Remarks| +|-----------------------------|--------------|-----------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|------------------------------------------------------------------------------------------|---| +| Retrieve Patient Resource | GET | ```https://example.com/pdqm-fhir-simulator/IHE/fhir/Patient/{id}``` | ID for a specific ITI-78 PDQm Fhir resource | the desired ITI-78 Resource |/| +| Find Matching Patients | GET | ```https://example.com/pdqm-fhir-simulator/IHE/fhir/Patient?name=value&...{&_format=[mime-type]}}``` | Parameters to search for specific ITI-78 PDQm Fhir resource ITI-78 | A bundle containing 0 to many ITI-78 PDQm Fhir Specific corresponding to search criteria | /| + + +Capability statement of the application can be found with : <https://example.com/pdqm-fhir-simulator/IHE/fhir/metadata> + +As described in [HAPI FHIR resources](https://hapifhir.io/hapi-fhir/docs/server_plain/rest_operations_operations.html), some strings are automatically escaped when the FHIR server parses URLs: + +|Given String|Parsed as| +| :---: | :---: | +|\||%7C| + + +## Find Matching Patients (ITI-78) - CH + +- [CH Specifications](https://fhir.ch/ig/ch-epr-mhealth/iti-78.html) + +## Overview + +Here is a quick overview of the available functionality from PDQm Fhir Simulator + +| Operation | HTTP Methods | URL to call | Entry parameter | Returned value | Remarks| +|-----------------------------|--------------|-----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|------------------------------------------------------------------------------------------|---| +| Retrieve Patient Resource | GET | ```https://example.com/pdqm-fhir-simulator/CH/fhir/Patient/{id}``` | ID for a specific ITI-78 PDQm Fhir resource | the desired ITI-78 Resource |/| +| Find Matching Patients | GET | ```https://example.com/pdqm-fhir-simulator/CH/fhir/Patient?name=value&...{&_format=[mime-type]}}``` | Parameters to search for specific ITI-78 PDQm Fhir resource ITI-78 | A bundle containing 0 to many ITI-78 PDQm Fhir Specific corresponding to search criteria | /| + + +Capability statement of the application can be found with : <https://example.com/pdqm-fhir-simulator/CH/fhir/metadata> + +As described in [HAPI FHIR resources](https://hapifhir.io/hapi-fhir/docs/server_plain/rest_operations_operations.html), some strings are automatically escaped when the FHIR server parses URLs: + +|Given String|Parsed as| +| :---: | :---: | +|\||%7C| + + +## Validation process + +Each operation implies a validation of requests for `ITI-78` +Validation is done by calling: + +- [HTTP Validator](https://gitlab.inria.fr/gazelle/applications/test-execution/validator/http-validator) for URL and Headers. + +The validation is done by default but can be switched with options: + +- `evs.endpoint=https://${FQDN}/evs/rest/validations` +- `MCSD_SERVER_VALIDATION_ENABLED=true` +- `ihe.http.validation.name=HTTP Message Validator` +- `ihe.http.validation.schematron.name-iti-78-search=CH-ITI-78-Patient-PDQmQuery-ValidationProfile` +- `ihe.http.validation.schematron.name-iti-78-read=CH-ITI-78-Patient-PDQmRetrieve-ValidationProfile` + +- `ch.http.validation.name=HTTP Message Validator` +- `ch.http.validation.schematron.name-iti-78-search=CH-ITI-78-Patient-PDQmQuery-ValidationProfile` +- `ch.http.validation.schematron.name-iti-78-read=CH-ITI-78-Patient-PDQmRetrieve-ValidationProfile` + +Patients are fetched from the Patient Registry(https://gitlab.inria.fr/gazelle/public/processing/patient-registry). + +You can choose which Patient Registry target by setting the `patient.registry.service` parameter + + + diff --git a/Patient-Registry/release-note.md b/Patient-Registry/release-note.md index 435f5bd56ef2ad9ab47cea6267fa480a28d83513..5e1842327a6e966b0956abe108097efeb80b2c5f 100755 --- a/Patient-Registry/release-note.md +++ b/Patient-Registry/release-note.md @@ -1,7 +1,7 @@ --- title: Release note subtitle: PatientRegistry -toolversion: 2.2.0 +toolversion: 2.2.1 releasedate: 2024-01-31 author: Franck Desaize / Alexandre POCINHO function: Software Engineer @@ -9,6 +9,13 @@ customer: IHE Europe reference: KER1-RNO-IHE-PATIENT_MANAGER --- +# Patient Registry 2.2.1 +_Release date: 2024-06-27_ +__Epic__ +* \[[PATREG-224](https://gazelle.ihe.net/jira/browse/PATREG-224)\] Implement Search with params + + + # PIXm Connector 2.0.0 _Release date: 2024-02-02_