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

Oystehr SDK

// AUTOGENERATED -- DO NOT EDIT

export interface FaxSendParams {
  /**
   * A Z3 URL of the document you want to send. Your user must have access to this document.
   */
  media: string;
  /**
   * The patient who is the subject of the fax. This must be a valid FHIR Patient relative reference in the format: `Patient/some-valid-uuid`. This reference must be a valid resource.
   */
  patient?: string;
  /**
   * The quality of the document you want sent.
   */
  quality: 'standard' | 'fine' | 'superfine';
  /**
   * The recipient of the fax. This must be a valid FHIR CareTeam, HealthcareService, Organization, Patient, Practitioner, PractitionerRole, or RelatedPerson relative reference in the format: `the-resource-type/some-valid-uuid`. This reference must be a valid resource and have a number in the `telecom` field with a `system` of `fax`.
   *
   * Note: One of `recipient` or `recipientNumber` must be provided, but not both.
   */
  recipient?: string;
  /**
   * The fax number of the recipient. This must be a valid E.164 format fax number.
   *
   * Note: One of `recipient` or `recipientNumber` must be provided, but not both.
   */
  recipientNumber?: string;
  /**
   * The sender of the fax. This must be a valid FHIR HealthcareService, Organization, Patient, Practitioner, PractitionerRole, or RelatedPerson relative reference in the format: `the-resource-type/some-valid-uuid`. This reference must be a valid resource and have your [onboarded fax number](https://docs.oystehr.com/oystehr/services/fax/number/) in the `telecom` field with a `system` of `fax`.
   */
  sender: string;
}