Create a Consultation

post

https://patient-api.portals.care/consultations

Create a new patient consultation record.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Create a new consultation draft. Authenticate by providing the user's JWT in the Authorization header.

In the request body, you must provide the consultation type and the answers.

Body Params

A Data Transfer Object (DTO) for creating a new patient consultation record, typically associated with a completed questionnaire.

type

string

required

The type of consultation or questionnaire being submitted (e.g., 'facesheet', 'wlusmonthly').

customerId

string

The unique identifier of the patient submitting the consultation. This is the ID of the authenticated user.

status

string

enum

The status of the Consultation.

provinceCode

string

The two-letter code for the patient's province or state.

orderId

string

The unique identifier of the order that this consultation is linked to. This is optional and may be provided if the consultation is part of an order fulfillment process.

createdBy

string

The unique identifier of the user who created the consultation.

internal

boolean

A boolean indicating whether this is an internal consultation record, not directly created by a patient.

Headers

authorization

string

required

A Valid JWT Authentication token.

organization

string

Your unique Organization ID. This header is only required when using a custom portal domain, otherwise it is optional.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201