Get a consultation

GET

/consultation/{consultationId}

const url = 'https://example.com/consultation/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/consultation/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

consultationId

required

string

Responses

200

Consultation found.

application/json

The durable record of a user’s medical question and its Abi service workflow.

object

consultationId

The Abi identifier for the consultation.

string

userId

The Abi identifier of the user who submitted the consultation.

string

status

The current consultation workflow status.

string

Allowed values: open claimed resolved canceled closed

createdAt

The date and time the consultation was created in Abi.

string

questions

The medical questions and, when available, their answers and professional information.

Array<object>

<= 3 items

object

question

The question submitted by the user.

string

answer

The response provided by the healthcare professional

string

attachments

Images or documents provided through the approved journey.

Array<string>

professional

Information about the professional who resolved a consultation, when available.

object

name

string

title

string

specialties

Array<string>

licenses

Array<object>

object

licenseNumber

string

countries

Array<string>

profileUrl

string format: uri

Example

{
  "consultationId": "8910zyx321cba",
  "userId": "abi12345",
  "status": "open",
  "createdAt": "2020-11-27",
  "questions": [
    {
      "professional": {
        "name": "John Doe",
        "title": "physician",
        "licenses": [
          {
            "licenseNumber": "abi-XXX",
            "countries": [
              "ie",
              "gb"
            ]
          }
        ]
      }
    }
  ]
}