@oystehr/sdk/src/resources/types/ConversationAddParticipantParams.ts

Oystehr SDK

// AUTOGENERATED -- DO NOT EDIT

export interface ConversationAddParticipantParams {
  /**
   * A valid FHIR Encounter relative reference in the format: `Encounter/some-uuid`. This reference must be a valid Encounter in the FHIR store which has the https://extensions.fhir.oystehr.com/encounter-virtual-service-pre-release extension from being created by `POST /message/conversation`.
   */
  encounterReference: string;
  participants: {
    /**
     * A valid FHIR Patient, RelatedPerson, or Practitioner relative reference in the format: `Patient/some-uuid`, `RelatedPerson/some-uuid`, or `Practitioner/some-uuid`. Each participantReference must be present in `Encounter.participant` for the Encounter specified in `encounterReference`.
     */
    participantReference: string;
    /**
     * The channel to use to communicate with the participant. The `chat` channel allows the Developer or User whose `profile` resource is in `participantReference` to join the Conversation via the Twilio Conversations SDK which enables web and native mobile chat. If channel is `sms` then `phoneNumber` must be supplied. The participant's phone number, specified in the `phoneNumber`, is added to the Conversation. They will receive SMS messages from the Conversation, and replies to the phone number from which they receive the messages will be sent to the Conversation.
     */
    channel: 'sms' | 'chat';
    /**
     * The phone number of the participant. Required if `channel` is `sms`.
     */
    phoneNumber?: string;
  }[];
  conversationId: string;
}