UI Patient Manager#
Introduction#
The Patient Manager API is a critical interface designed to manage patient information within ScanHub. It centralizes functionalities around the creation, retrieval, updating, and deletion of patient records, providing a streamlined approach to handle patient-related data. Here’s a brief look at the main endpoints:
Web API#
- GET /#
Get Patient List
Get all patients endpoint.
Returns#
List of patient pydantic output models
- status 200:
Successful Response
- POST /#
Create Patient
Create new patient database entry.
Parameters#
- payload
Patient pydantic base model
Returns#
Patient pydantic output model
Raises#
- HTTPException
404: Could not create patient
- status 201:
Successful Response
- status 422:
Validation Error
- GET /{patient_id}#
Get Patient
Get a patient from database by id.
Parameters#
- patient_id
Id of the requested patient
Returns#
Patient pydantic output model
Raises#
- HTTPException
404: Patient not found
- param integer patient_id:
- status 200:
Successful Response
- status 422:
Validation Error
- PUT /{patient_id}#
Update Patient
Update existing patient endpoint.
Parameters#
- patient_id
Id of the patient to be updated
- payload
Patient data to be updated
Returns#
Updated patient pydantic output model
Raises#
- HTTPException
404: Patient not found
- param integer patient_id:
- status 200:
Successful Response
- status 422:
Validation Error
License#
Patient Manager, including all its source code and associated documentation (collectively, the “Software”), is dual-licensed under the GNU General Public License version 3 (GPLv3) and the ScanHub commercial license.
Open Source License#
If you want to use the Software under the terms of the GPLv3, you may do so for free. Under the GPLv3, you are allowed to modify and distribute the Software, but any derivative works that you distribute must also be licensed under the GPLv3. For the precise terms and conditions, please refer to the text of the GPLv3, which is included with the Software and can also be found at: http://www.gnu.org/licenses/gpl-3.0.html
Commercial License#
If you wish to use the Software without the restrictions of the GPLv3, such as for the purpose of developing proprietary software that includes the Software without the obligation to disclose your source code, you may purchase a commercial license from BRAIN-LINK UG (haftungsbeschränkt).
The commercial license grants you, the licensee, the rights to use, modify, and distribute the Software without the requirement of providing the source code of your proprietary software to the end users. The commercial license also includes access to premium support and services.
For more information on the commercial license, including pricing, please contact us at info@brain-link.de.
Choice of License#
You may choose to use the Software under either the GPLv3 or the commercial license. If you choose to use the Software under the GPLv3, you must comply with all of the terms of the GPLv3. If you choose to use the Software under the commercial license, you must comply with all of the terms of the commercial license.
Disclaimer#
This is not a legal document. The exact terms of the GPLv3 and the commercial license are specified in their respective legal texts. This document is merely intended to provide a general overview of the dual licensing scheme.