@oystehr/sdk 3.0.15 → 3.0.16

package/dist/cjs/resources/types/FaxSendParams.d.ts

@@ -3,14 +3,26 @@ 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.
      */
-    recipient: string;
+    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`.
      */

package/dist/cjs/resources/types/FaxSendResponse.d.ts

@@ -4,7 +4,7 @@ import { Communication } from 'fhir/r4b';
  */
 export interface FaxSendResponse {
     /**
-     * The FHIR Communication resource that represents the sent fax in the FHIR Store modified to include the https://extensions.fhir.oystehr.com/outbound-fax-status extension which holds the fax status that will be updated automatically.
+     * The FHIR Communication resource that represents the sent fax in the FHIR Store modified to include the https://extensions.fhir.oystehr.com/outbound-fax-status extension which holds the fax status that will be updated automatically. If a `recipientNumber` is used instead of a `recipient`, the resource will contain a contained Practitioner resource with the fax number.
      */
     communicationResource: Communication;
 }

package/dist/esm/resources/types/FaxSendParams.d.ts

@@ -3,14 +3,26 @@ 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.
      */
-    recipient: string;
+    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`.
      */

package/dist/esm/resources/types/FaxSendResponse.d.ts

@@ -4,7 +4,7 @@ import { Communication } from 'fhir/r4b';
  */
 export interface FaxSendResponse {
     /**
-     * The FHIR Communication resource that represents the sent fax in the FHIR Store modified to include the https://extensions.fhir.oystehr.com/outbound-fax-status extension which holds the fax status that will be updated automatically.
+     * The FHIR Communication resource that represents the sent fax in the FHIR Store modified to include the https://extensions.fhir.oystehr.com/outbound-fax-status extension which holds the fax status that will be updated automatically. If a `recipientNumber` is used instead of a `recipient`, the resource will contain a contained Practitioner resource with the fax number.
      */
     communicationResource: Communication;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oystehr/sdk",
-  "version": "3.0.15",
+  "version": "3.0.16",
   "description": "Oystehr SDK",
   "scripts": {
     "lint": "eslint .",

package/src/resources/types/FaxSendParams.ts

@@ -5,14 +5,26 @@ 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.
    */
-  recipient: string;
+  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`.
    */

package/src/resources/types/FaxSendResponse.ts

@@ -6,7 +6,7 @@ import { Communication } from 'fhir/r4b';
  */
 export interface FaxSendResponse {
   /**
-   * The FHIR Communication resource that represents the sent fax in the FHIR Store modified to include the https://extensions.fhir.oystehr.com/outbound-fax-status extension which holds the fax status that will be updated automatically.
+   * The FHIR Communication resource that represents the sent fax in the FHIR Store modified to include the https://extensions.fhir.oystehr.com/outbound-fax-status extension which holds the fax status that will be updated automatically. If a `recipientNumber` is used instead of a `recipient`, the resource will contain a contained Practitioner resource with the fax number.
    */
   communicationResource: Communication;
 }