SP-009-006 Integration workflow helpers
This document is a draft version.
Choosing the right integration option
When discussing the integration with a customer's IT team, it is important to define which approach best suits their objectives and technical capabilities. If dedicated standalone solutions are discarded, there are two primary options: Iframe and JSON Only.
JSON Only
The JSON Only approach provides full flexibility for the frontend. It allows the customer to only consume the endpoints they really need (if they do not need all features).
Best for
- Projects where the final user is an IT professional (e.g., retrospective studies).
- Also for customers with an existing platform or app who want full control over UI/UX, accepting a more complex integration.
Considerations
- Slower integration: Requires significant development effort from the customer.
- Maintenance: The customer's IT team is responsible for ongoing API maintenance.
Iframe
The Iframe approach delegates the complex logic and API maintenance to us, providing a much faster integration process. The customer simply embeds the interface and receives a single JSON response with the final data.
Best for
- Customers who do not yet have a teledermatology feature developed and either do not have an IT team, or have one but do not want to invest resources in developing this functionality due to the integration complexity.
- Customers whose final users are non-technical (e.g., healthcare professionals in hospitals), even if the customer has an IT team.
Why Iframe is the recommended approach for healthcare environments
When dealing with hospitals or clinics where the end user is a doctor or healthcare professional, the Iframe option significantly increases the probability of a successful deal because:
- Easier and faster to integrate: Lowers the technical barrier for the customer's IT department.
- Fewer integration issues: We manage the complexities of the workflows and internal logic.
- Zero API maintenance for the customer: All maintenance and updates remain on our side.
- Quality: It ensures the customer uses the device exactly as intended, providing a validated user experience.
The only trade-off is limited UI customization on the customer's end, but the operational and reliability benefits make it the superior choice in most clinical settings.
Workflows
Iframe integration workflow
JSON Only integration workflow
Data flow using the Legit.Health API (JSON Only) for local severity assessment
Data flow using the Legit.Health API (JSON Only) for local severity assessment
Example of request for APASI severity assessment
{
"resourceType": "ServiceRequest",
"bodySite": "armLeft",
"payload": {
"contentAttachment": {
"title": "string",
"contentType": "image/png",
"data": "imageBase64String"
}
},
"knownCondition": {
"conclusion": {
"coding": [
{
"system": "https://icd.who.int/browse/2024-01/mms/en",
"systemDisplay": "ICD-11",
"version": null,
"code": "EA90",
"display": "Psoriasis"
}
],
"text": "Psoriasis"
}
},
"scoringSystem": {
"apasi": {
"questionnaireResponse": {
"item": {
"surface": 6
}
}
}
}
}
Example of request for APASI severity assessment
{
"resourceType": "ServiceRequest",
"bodySite": "armLeft",
"payload": {
"contentAttachment": {
"title": "string",
"contentType": "image/png",
"data": "imageBase64String"
}
},
"knownCondition": {
"conclusion": {
"coding": [
{
"system": "https://icd.who.int/browse/2024-01/mms/en",
"systemDisplay": "ICD-11",
"version": null,
"code": "EA89",
"display": "Eczematous dermatitis"
}
],
"text": "Eczematous dermatitis"
}
},
"scoringSystem": {
"aeasi": {
"questionnaireResponse": {
"item": {
"surface": 34,
"patientAge": 20 //only needed if age below 7 years or above 7 years
}
}
},
"ascorad": {
"questionnaireResponse": {
"item": {
"surface": 34,
"pruritus": 4,
"sleeplessness": 6
}
}
}
}
}
(TBC before sending) Example of request for APASI, EASI, ASCORAD severity assessment
{
"resourceType": "ServiceRequest",
"bodySite": "armLeft",
"payload": {
"contentAttachment": {
"title": "string",
"contentType": "image/png",
"data": "imageBase64String"
}
},
"knownCondition": {
"conclusion": {
"coding": [
{
"system": "https://icd.who.int/browse/2024-01/mms/en",
"systemDisplay": "ICD-11",
"version": null,
"code": "EA89",
"display": "Eczematous dermatitis"
}
],
"text": "Eczematous dermatitis"
}
},
"scoringSystem": {
"apasi": {
"questionnaireResponse": {
"item": {
"surface": 6
}
}
},
"aeasi": {
"questionnaireResponse": {
"item": {
"surface": 34,
"patientAge": 20 //only needed if age below 7 years or above 7 years
}
}
},
"ascorad": {
"questionnaireResponse": {
"item": {
"surface": 34,
"pruritus": 4,
"sleeplessness": 6
}
}
}
}
}
ㅤㅤ ㅤ