Skip to main content

Update session note templates​

Updates the note templates for a session, triggering processing for new templates. New templates are added alongside existing documents. If a template already exists for the session, it will be reprocessed.

Path Parameters
  • sessionId string required

    Id of session. Session is created when all participants (provider and clients) join and provider starts the session. Session id is part of the web-hook payload for all session events, e.g. when session is created.

Request Body required

Request body containing note template IDs to add or reprocess

  • noteTemplateIds string[] required

    List of note template IDs to add or reprocess. New templates are added alongside existing documents. If a template already exists for the session, it will be reprocessed.

Responses

Session updated successfully

Schema
  • sessionId string required

    Id of session.

  • partnerAppointmentId string

    Partner's identifier for the session, as provided during session creation.

  • noteTemplateIds string[] required

    List of note template ids for notes generation for the session.

  • date string

    Date and time of the therapy session itself, in ISO 8601 format. This is the editable session datetime (when the session occurred or is scheduled to occur), set by the therapist on the session. May be changed if the therapist edits the session. To get the immutable timestamp of when the session was first added to Upheal, use sessionCreatedAt.

  • sessionCreatedAt string

    Immutable timestamp of when the session was first created in Upheal, in ISO 8601 format. Does not change if the session is later edited. Use this for incremental sync against external systems. Distinct from date, which is the editable session datetime (when therapy occurred or is scheduled).

  • providerUserId string required

    Id of the provider user.

  • clientUserIds string[] required

    Ids of the client users that participated in the session.

  • state TherapySessionStateResponse required

    Possible values: [InProgress, Processing, Done, Error]

    State of the session.

  • error object
  • code string required

    Error code identifying the problem. See Error codes.

  • message string required

    Error message.

  • sessionDurationMs int64

    Session duration in milliseconds, matching the duration displayed on the Upheal session detail page (e.g. "50 min"). Set by the therapist when creating or editing the session. Populated for sessions of any type, including text-to-note sessions that have no audio recording. Distinct from recordingDurationMs, which reflects the actual recorded audio length and is null for sessions without audio. Null when no duration was set on the session.

  • recordingDurationMs integer

    Duration of the session recording in milliseconds. Value becomes available during session processing.

  • recordingUrl uri

    URL to the session recording. Url is valid only for a limited time.

  • transcript object

    Transcript of the recorded session. Value becomes available during session processing.

  • utterances object[]

    List of all utterances.

  • Array [
  • text string required

    Text of the utterance.

  • start integer required

    Relative start time in milliseconds of this utterance in the recording.

  • end integer required

    Relative end time in milliseconds of this utterance in the recording.

  • speaker string required

    Speaker of the utterance. Speakers are labeled with letters, starting with 'A'.

  • words object[] required

    List of words in the utterance.

  • Array [
  • text string required

    text of the single word

  • start integer required

    Relative start time [ms] of this word occurrence in the recording

  • end integer required

    Relative end time [ms] of this word occurrence in the recording

  • ]
  • ]
  • speakerMapping object

    Mapping of speakers (present in utterances) to user identifiers. One user identifier can be assigned to multiple speakers.

  • property name* string
  • topics object[]

    List of topics discussed in the session.

  • Array [
  • headline string required

    Topic headline

  • gist string required
  • start integer required

    Relative start time [ms] of this topic in the recording.

  • end integer required

    Relative end time [ms] of this topic in the recording.

  • ]
  • namedEntities object[]

    List of named entities detected in transcript with their description.

  • Array [
  • entityType string required

    Type of detected entity. E.g. of "medical_condition", "organisation", "location", "person_name"

  • name string required
  • summary string

    Summarized description of the entity

  • ]
  • notes object[]

    List of session notes generated for the session based on the requested template ids.

  • Array [
  • sessionDocumentId string required

    Unique identifier of the session document.

  • noteTemplateId string required

    Identifier of the note template used to generate this document.

  • notes object[] required

    List of progress notes generated for this session document.

  • Array [
  • category string required

    Progress note category. For example "ClientPresentation", "TherapeuticIntervention", "Plan",...

  • categoryName string

    Human readable name for progress note category.

  • text string required

    Progress note text.

  • formatting object
  • nestingLevel integer

    Nesting level of the note in a context of all notes in its category. Notes with leve > 0 can be considered as a bulleted list items.

  • ]
  • ]
  • analyticsSummary object

    The analytics summary section is intended to show session's talking ratio, speech cadence and response time at-a-glance.

  • talkingRatio object

    The talking time divided by the session time. In other words, the speaking time of the client versus the healing professional, during a single session.

  • property name* object (TalkingRatioValue)
  • ratio float
  • ratioLongTerm float
  • duration float
  • durationLongTerm float
  • speechCadence object

    Number of words per minute of talking time. Speech cadence measures both the client’s and therapists’ words per minute across time, i.e. over the course of a session.

  • property name* object (SpeechCadenceValue)
  • cadence float
  • cadenceLongTerm float
  • responseTime object

    The average time (in seconds) that it takes a client to respond to a healing professional’s question or statement and vice versa. In other words, this measures the time to reply or respond between therapist and client.

  • property name* object (ResponseTimeValue)
  • time float
  • timeLongTerm float
  • sentiment object

    Sentiment of participants. We identify the number of sentences with Positive, Neutral or Negative sentiment using something called a polarity value. The aim of polarity detection is to find out whether the opinion expressed in a text is positive or negative in how it connects to the topics discussed.

  • property name* object (SentimentValue)
  • positive float
  • positiveLongTerm float
  • negative float
  • negativeLongTerm float
  • timePerspective object

    This measure identifies the number of words that are verbs in the Past, Present, or Future tense. The tense analysis is helpful for identifying where a client is stuck in their thinking, especially in connection to the topics discussed.

  • property name* object (TimePerspectiveValue)
  • future float
  • futureLongTerm float
  • past float
  • pastLongTerm float
Loading...