doctorlink
  • Home
  • Authentication
  • Traversal API
    • Quickstart
    • Answer
    • Conclusion
    • Conclusion report
    • Injected History
    • Node
    • Postman
    • Question
    • Question summary
    • Revisiting questions
    • Traversal create
    • Traversal response
    • Members
  • Traversal Client

Conclusion report

Introduction
Visual example
Response
Handling the response

Introduction

The conclusion report endpoint (ReDoc), /api/v2/{tenantId}/Traversals/{traversalId}/conclusion-report, is used soley for Online triage reports. It is ordered and categorised for you that can easily be bound to UI components.

Visual example

An Online triage Conclusion Report

Response

Below is a sample response that was used to create the above screenshot. Note: this data has been truncated (...) due to its size.

{
    "highestPriority": 50014,
    "symptomConclusions": [{
            "category1": "A&E",
            "subCategory": "now",
            "category2": "doctor",
            "title": "Go to A&E now|1|Get someone to drive you to A&E now...",
            "moreDetail": "",
            "priority": 50014,
            ...,
            "displayText": "Cut or puncture with wound that may have damaged vital organs or important structures",
            "clinicalText": "Cut or puncture with wound that may have damaged vital organs or important structures",
            ...,
            "explanation": "This is a very serious injury. Go to A&E now. If there is any sign that you are...",
            "bullets": [...],
            "truncated": "This is a very serious injury. Go to A&E now. If there is any sign that you are..."
        }, {
            "category1": "Urgent treatment centre",
            "subCategory": "now",
            "category2": "doctor",
            "title": "Go to Minor Injuries Unit or A&E|1|Get someone to drive you to the nearest Minor Injuries...",
            "moreDetail": "",
            "priority": 50019,
            "propertyPriority": 0,
            "information": false,
            "categoryTypeId": 1,
            ...,
            "displayText": "Continued bleeding of a wound",
            "clinicalText": "Continued bleeding of a wound",
            ...,
            "explanation": "Since your wound has continued to bleed despite firm pressure, it needs to be...",
            "bullets": [...],
            "truncated": "Since your wound has continued to bleed despite firm pressure, it needs..."
        }, {
            "category1": "Self-care",
            "subCategory": "Advised",
            "category2": "self",
            "title": "Self care recommended|3|Your symptoms are unlikely to need medical attention...",
            "moreDetail": "",
            "priority": 260038,
            ...,
            "displayText": "First aid instructions for cuts, scrapes or punctures",
            "clinicalText": "First aid instructions for cuts, scrapes or punctures",
            ...,
            "explanation": "Most cuts, grazes and minor wounds can be treated at home. However, you...",
            "bullets": [...],
            "truncated": "Most cuts, grazes and minor wounds can be treated at home. However..."
        }
    ],
    "reasonConclusionTitle": "Why we recommend this",
    "reasonConclusions": [{
            "category1": "A&E",
            "subCategory": "now",
            "category2": "doctor",
            "title": "Go to A&E now|1|Get someone to drive you to A&E now. Do not drive yourself...",
            "moreDetail": "",
            "priority": 50014,
            ...,
            "displayText": "Cut or puncture with wound that may have damaged vital organs or important structures",
            "clinicalText": "Cut or puncture with wound that may have damaged vital organs or important structures",
            ...,
            "explanation": "This is a very serious injury. Go to A&E now. If there is any sign that...",
            "bullets": [...],
            "truncated": "This is a very serious injury. Go to A&E now. If there is any sign that you are..."
        }
    ],
    "otherConclusionTitle": "Other Concerns",
    "otherConclusions": [{
            "category1": "Urgent treatment centre",
            "subCategory": "now",
            "category2": "doctor",
            "title": "Go to Minor Injuries Unit or A&E|1|Get someone to drive you to the nearest Minor...",
            "moreDetail": "",
            "priority": 50019,
            ...,
            "displayText": "Continued bleeding of a wound",
            "clinicalText": "Continued bleeding of a wound",
            ...,
            "explanation": "Since your wound has continued to bleed despite firm pressure, it needs to be...",
            "bullets": [...],
            "truncated": "Since your wound has continued to bleed despite firm pressure, it needs to be..."
        }, {
            "category1": "Self-care",
            "subCategory": "Advised",
            "category2": "self",
            "title": "Self care recommended|3|Your symptoms are unlikely to need medical attention at...",
            "moreDetail": "",
            "priority": 260038,
            ...,
            "displayText": "First aid instructions for cuts, scrapes or punctures",
            "clinicalText": "First aid instructions for cuts, scrapes or punctures",
            ...,
            "explanation": "Most cuts, grazes and minor wounds can be treated at home. However, you...",
            "bullets": [...],
            "truncated": "Most cuts, grazes and minor wounds can be treated at home. However, you..."
        }
    ],
    "informationConclusionTitle": "Helpful Information",
    "informationConclusions": [{
            "category1": "Information",
            "subCategory": "General information",
            "category2": "self",
            "title": "The following information could be helpful in assessing your <problem>",
            "moreDetail": "",
            "priority": 1330044,
            ...,
            "displayText": "Head injury - what to do",
            "clinicalText": "Head injury - what to do",
            ...,
            "explanation": "Even seemingly minor head injuries need to be carefully evaluated...",
            "bullets": [...],
            "truncated": "Even seemingly minor head injuries need to be carefully evaluated. Anyone who is..."
        }
    ],
    "contactBulletTitle": "",
    "contactBullets": [],
    "dangerBulletTitle": "When to seek care sooner",
    "dangerBullets": [{
            "data": {},
            "bulletId": 6657,
            "bulletUniqueId": 42005,
            "conclusionId": 14977,
            "priority": 2,
            "displayText": "If you feel that you need help immediately, call 999 for an ambulance...",
            "category2": "Alert: Danger Signs|1"
        }, {
            "data": {},
            "bulletId": 822,
            "bulletUniqueId": 28819,
            "conclusionId": 14977,
            "priority": 5,
            "displayText": "If you have lost consciousness, have rapid bleeding that cannot be...",
            "category2": "Alert: Danger Signs|1"
        },...
    ],
    "reasonBulletTitle": "What you should do now",
    "reasonBullets": [{
            "data": {},
            "bulletId": 106,
            "bulletUniqueId": 28734,
            "conclusionId": 14977,
            "priority": 1,
            "displayText": "Follow this advice on the way to the hospital:",
            "category2": "Bullet: title"
        }, {
            "data": {},
            "bulletId": 6744,
            "bulletUniqueId": 42925,
            "conclusionId": 14977,
            "priority": 3,
            "displayText": "If you don't know where the nearest A&E is located, call 111 for...",
            "category2": "Multiple System"
        },...
    ],
    "mainBullets": [{
            "data": {},
            "bulletId": 106,
            "bulletUniqueId": 28734,
            "conclusionId": 14977,
            "priority": 1,
            "displayText": "Follow this advice on the way to the hospital:",
            "category2": "Bullet: title"
        }, {
            "data": {},
            "bulletId": 6657,
            "bulletUniqueId": 42005,
            "conclusionId": 14977,
            "priority": 2,
            "displayText": "If you feel that you need help immediately, call 999 for an ambulance if...",
            "category2": "Alert: Danger Signs|1"
        },...
    ],
    "reasonCategory": "A&E",
    "reasonSubCat1": "now",
    "reasonDisposition": "A&E now",
    "messageTitle": "Go to A&E now",
    "messageLevel": 1,
    "messageDescription": "Get someone to drive you to A&E now. Do not drive yourself. If someone is...",
    "reasonTimeInMinutes": 0
}

Handling the response

It's important to realise that a large amount of data is passed from this endpoint, and not all of it will be seen by the user. Some of it could be hidden, only to be shown to a healthcare practitioner. Others parts will simply be overridden by a higher priorities.

The most important section of the report are the top-level properties and the symptomConclusions array. The symptomConclusions array is an ordered list of what the system believes is wrong. The first conclusion "category1": "A&E" is the most important. So, even though we still have less-important conclusions in the data, it has overridden conclusions picked up earlier in the traversal due to it's higher priority. Note: the lower the number the higher priority.

In the screenshot above, the main focus is the large, red box at the top. In the example, the colour depends on the messageLevel 1-3; 1 being the highest/most dangerous. The title comes from messageTitle, and the body text from messageDescription. Each of the arrays in the response are represented by its own box: reasonConclusions are displayed in the "Why we recommend this" box (reasonConclusionTitle); otherConclusions by the "Other concerns" box (otherConclusionTitle); and so on...

After getting the whole data package from your own conclusion-report request, if you're still having trouble figuring it out, you can book some time with one of our Content Creators to further explain all the properties and what they are used for.