¶ Patient
Maintaining unique patient records in the system is critical to ensuring data integrity, accuracy, and quality of care. However, achieving patient uniqueness can be challenging when multiple integrators use different identifiers across systems.
¶ National ID Support
To address this, we support the use of national identification numbers as a means of establishing patient uniqueness. Currently, this support is limited to Belgium only. This national ID serves as a consistent identifier across different systems and integrations, reducing the risk of duplication or misidentification.
¶ Security and Privacy Measures
¶ Usage
The national ID is strictly used for patient identification purposes within the system.
¶ Logging
National IDs are never logged or stored in logs, in adherence to privacy and data protection principles.
¶ Transmission
All data, including the national ID, is accepted only through secure, encrypted HTTPS channels to ensure confidentiality and prevent interception during communication.
¶ Future Considerations
Support for national ID identifiers may be extended to other countries in the future, depending on regulatory compliance and integration needs.
¶ Create New Patient
This endpoint enables you to create patient in Salvus-Health.
¶ Endpoint
POST /public/patient/{organizationIdentifier}
¶ Route Parameters
| Name | Type | Required | Description |
|---|---|---|---|
organizationIdentifier |
string | Yes | Identifier of the organization. E.g. APB number for Belgian pharmacies. |
¶ Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
identifier |
String | Yes | identifier of patient e.g. national id. Note: Salvus currently only supports Belgian national identifiers |
firstName |
String | Yes | Patient Given Name |
lastName |
String | Yes | Patient Family Name |
email |
String | No | Recommended. |
phoneNumber |
String | No | Recommended. |
streetName |
String | No | |
city |
String | No | |
postalCode |
String | No | If no postal code is provided, the postal code of pharmacy will be assigned to the patient. |
country |
String | No | |
isTestPatient |
Boolean | No | Patient for testing purposes. Accepts dummy national id's. |
preferedLanguage |
String | No | ISO2 country code. Accepted values nl | fr |en. The language used for communication with the patient. |
Important
Salvus currently only supports Belgian national IDs. The nationalId must be a valid Belgian ID. To use random numbers for testing, set theisTestPatientproperty to true in the body request.
Note
Patient birth date and gender are not required in the body request. Because they are derived from national id.
¶ Body Request Example
{
"firstName": "Sophie",
"lastName": "Van Damme",
"identifier": "91050612345",
"email": "sophie.vandamme@example.com",
"phoneNumber": "+32470123456",
"postalCode": "1000",
"streetName": "Rue Royale",
"city": "Brussels",
"country": "Belgium",
"isTestPatient": true,
"preferedLanguage": "nl-BE"
}
¶ Responses
Patient is created.
Invalid Request:
- INVALID_NATIONAL_ID: Invalid Belgian National Id.
- MISSING_PATIENT_NATIONAL_ID: national id is required, so must be provided in the body request.
- INVALID_ORGANIZATION_IDENTIFIER: Invalid organization identifier
- MISSING_PATIENT_IDENTIFIER: Patient minumum data is missing e.g. FirstName, LastName
- INVALID_PATIENT_IDENTIFIERS: Patient identifiers are in wrong format.
- Your access token is not authorized for the resource.
- Unexpected issue occured in server. Salvus support needs to be contacted.
¶ Find Existing Patient
This endpoint enables you to find existing patient for given organization based on patient national id.
Why national id?
It’s currently the only shared identifier across different integrations, which makes it essential for matching patients accurately.
¶ Endpoint
POST /public/patient/exists/{organizationIdentifier}
¶ Route Parameters
| Name | Type | Required | Description |
|---|---|---|---|
organizationIdentifier |
string | Yes | Identifier of the organization. E.g. APB number for Belgian pharmacies. |
¶ Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
identifier |
string | Yes | identifier of patient e.g. national id |
¶ Example of Response
{
"FirstName": "Emma",
"LastName": "Janssens",
"Gender": "Female",
"BirthDate": "1984-03-15",
"Email": "emma.janssens@example.com",
"PhoneNumber": "+32475123456",
"StreetName": "Koningin Astridlaan",
"PostalCode": "2000",
"City": "Antwerp",
"Country": "Belgium",
"IsDeceased": false,
"IsTestPatient": false,
"DeceasedDate": null
}
¶ Responses
- Patient is found and data is provided.
- Patient data not found
- Invalid rout parameters
- Your access token is not authorized for the resource.
¶ Modify Patient Data
This endpoint enables you to modify patient that you have created in Salvus Health.
You are only authorized to modify patients that you have created for the pharmacy. Otherwise, a 401 response will be returned.
¶ Endpoint
PUT /public/patient/{organizationIdentifier}
¶ Route Parameters
| Name | Type | Required | Description |
|---|---|---|---|
organizationIdentifier |
string | Yes | Identifier of the organization. E.g. APB number for Belgian pharmacies. |
¶ Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
identifier |
string | Yes | identifier of patient e.g. national id |
firstName |
String | No | Patient Given Name |
lastName |
String | No | Patient Family Name |
email |
String | No | email of patient used for communications. |
phoneNumber |
String | No | phone number of patient used for communications. |
streetName |
String | No | Street address including the number |
city |
String | No | |
postalCode |
String | No | If no postal code is provided, the postal code of pharmacy will be assigned to the patient. |
country |
String | No | |
preferedLanguage |
String | No | ISO2 country code. Accepted values nl | fr |en. The language used for communication with the patient. |
¶ Example Body Request
This example makes the patient as deceased on a specific date
{
"IsDeceased": true,
"DeceasedDate": "2024-08-14"
}
¶ Responses
- Patient data is updated and new data model is returned.
- Patient not found
- Invalid rout parameters
- Your access token is not authorized for the resource.
- Your access token is not authorized for the resource.