Create therapy session

Work in Progress. Create new therapy session based on input data - either a recording uploaded to S3 or text notes. To upload a recording file to S3, you should use the /recording-url endpoint to get a pre-signed URL and PUT the file there. Couple sessions are not yet supported

application/json

Request Body required

Therapy session creation request

• providerUserId string required

  Provider user id.

• clientUserId string

  Id of the client user that the provider wants to have a session with. Provider must have access to the client user.

• clientPronouns string

  Possible values: [MasculineHim, FeminineHer, NeutralThem]

  Pronouns of the client user. Used when clientUserId is not defined. Cannot be used together with clientUserId.

• sessionType string required

  Session type to set. Allowed values are Intake, Standard, Soap, Dap, Girp, Birp, Mse, Emdr, PsychiatricSoap, PsychiatricIntake, CoupleStandard, CoupleSoap, CoupleDap, GpSoap, Bps, HeadwaySoap.

• input object required

  Input data for the session. Either a recording url or text note.

  oneOf

  • MOD1
  • MOD2

  ---

  recording object

  recordingUrls uri[] required

  URLs to the session recording files. If more than one file is provided, they are concatenated.

  recordingContent string required

  Possible values: [DictatedNotes, Recording]

  Type of the recorded content, DictatedNotes or Recording.

  text object

  Text note input for the session.

  text string required

  Provider's text notes from the session.

date string

Optional date and time of the session. ISO 8601 format. If not specified, current time is used.

partnerAppointmentId string

Optional identifier that will be included in the web-hook payload. Can be used to correlate upheal session with partner's identifier.