ConsultInvitation

Consult invitation

  • agentId
    Type: string Pattern: ^[0-9a-z]+$Format: cuid2
    required
  • createdAt
    Type: string Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Format: date-time
    required

    An ISO 8601 compatible date time string in the format YYYY-MM-DDTHH:mm:ss.sssZ, e.g. 2000-01-01T12:00:00.000Z

  • encounterCompletionLinkUrl
    Type: stringFormat: uri nullable
    required

    The URL to redirect the patient to upon completion of the consultation. If not present, the patient will be shown a thank you screen on Mindoo.

  • encounterId
    Type: string Pattern: ^[0-9a-z]+$Format: cuid2 nullable
    required

    The identifier of an AI consultation encounter (if any) that was initiated via the invitation url.

  • id
    Type: string Pattern: ^[0-9a-z]+$Format: cuid2
    required
  • invitationUrl
    Type: stringFormat: uri
    required

    A publicly accessible URL through which the patient can start their consultation.