Class PrescriptionWidget

Class representing a prescription widget.

Hierarchy

Widget<typeof PRESCRIPTION_EVENTS>
- PrescriptionWidget

Index

Constructors

Methods

destroy importPrescriptionElements onAuthTokenRefresh onPrescriptionReady onPrescriptionSave reload savePrescription setAuthToken setContext setPrescriptionComment

Constructors

constructor

new PrescriptionWidget(
container: Element | null,
options: WidgetOptions,
): PrescriptionWidget
Creates an instance of PrescriptionWidget.
Parameters
- container: Element | null
  The DOM element where the widget will be injected.
- options: WidgetOptions
  The options of the widget.
  - OptionalauthToken?: string
    The authentication token (JWT) for the widget.
  - OptionalbaseUrl?: string
    The base URL of the widget.
  - Optionaldebug?: boolean
    Whether to enable debug mode.
    
    Default
    false
  - Optionalenv?: "preprod" | "production"
    The widget environment.
    
    Default
    "production"
    
    Remarks
    This option has no effect if baseUrl is set.
  - OptionalframeHeight?: number
    The height of the widget’s iframe (in pixels).
    
    Default
    768
    
    Remarks
    The minimum accepted height is 768.
  - OptionalframeWidth?: number
    The width of the widget’s iframe (in pixels).
    
    Default
    600
    
    Remarks
    The minimum accepted width is 600.
  - Optionallocale?: string
    The language for the user interface of the widget.
    
    Default
    "fr"
  - OptionalsigningKey?: string
    The base64-encoded signing key using the ES256 algorithm.
    
    Deprecated
    Please use the new authentication flow with authToken. Check out the documentation for more information.
  - OptionalsoftwareId?: string
    The software identifier making the widget call.
    
    Deprecated
    Please use the new authentication flow with authToken. Check out the documentation for more information.
  - Optionaltheme?: string
    The widget’s user interface theme.
    
    Default
    "posos"
  - OptionaluserId?: string
    The identifier of the user making the widget call.
    
    Deprecated
    Please use the new authentication flow with authToken. Check out the documentation for more information.
Returns PrescriptionWidget
Example
```
const container = document.getElementById("posos-widget");
const widget = new PrescriptionWidget(container, {
  authToken: "your-auth-token",
});
```
Overrides Widget<typeof PRESCRIPTION_EVENTS>.constructor

Methods

destroy

destroy(): void
Destroys the widget instance by cleaning up resources and performing necessary teardown operations.

This method should be called when the widget is no longer needed to ensure proper cleanup and avoid memory leaks.

Returns void
Example
```
widget.destroy();
```
Inherited from Widget.destroy

importPrescriptionElements

importPrescriptionElements(
    elements: (
        | PrescriptionImportElementDrug
        | PrescriptionImportElementFreeText
        | PrescriptionImportElementMedicalDevice
    )[],
    options?: PrescriptionImportOptions,
): void

Imports a list of elements to the current prescription.

Parameters

elements: (
    | PrescriptionImportElementDrug
    | PrescriptionImportElementFreeText
    | PrescriptionImportElementMedicalDevice
)[]
The list of elements to be imported.
Optionaloptions: PrescriptionImportOptions
The import options.

Returns void

Example

widget.importPrescriptionElements([
  {
    coding: {
      code: "64620722",
      terminology: "cis",
    },
    dosage: {
      sequences: [
        {
          doseAndRate: [
            {
              doseQuantity: {
                code: "428641000",
                system: "snomed",
                unit: "gélule(s)",
                value: 3,
              },
            },
          ],
          sequence: 0,
          timing: {
            repeat: {
              boundsDuration: {
                code: "d",
                system: "http://hl7.org/fhir/ValueSet/duration-units",
                unit: "day",
                value: 4,
              },
              frequency: 1,
              period: 1,
              periodUnit: "d",
            },
          },
        },
      ],
      text: "3 gélules 4 fois par jour"
    },
    type: "branded_drug",
  },
  {
    designation: "A free text item",
    type: "free_text",
  },
]);

onAuthTokenRefresh

onAuthTokenRefresh(refreshAuthToken: () => string | Promise<string>): void
Registers a callback to handle authentication token refresh requests.

This function is invoked when the widget detects that a new token is needed, for example when the current token is about to expire or has expired.
Parameters
- refreshAuthToken: () => string | Promise<string>
  A function that returns a fresh authentication token.
Returns void
Throws
- If the invoked function does not return a valid authentication token.
Example
```
widget.onAuthTokenRefresh(async () => {
  // Fetch a new auth token from your server
  const newAuthToken = await fetchNewAuthToken();

  return newAuthToken;
});
```
Inherited from Widget.onAuthTokenRefresh

onPrescriptionReady

onPrescriptionReady(handler: () => void): void
Registers a callback that will be invoked when the prescription is ready.

This event is triggered by the widget once the prescription is available for viewing or interaction.
Parameters
- handler: () => void
  A function to be called when the prescription becomes ready.
Returns void
Example
```
widget.onPrescriptionReady(() => {
  console.log('Prescription is ready!');
  // You can now interact with the widget or update your UI
});
```

onPrescriptionSave

onPrescriptionSave(handler: (payload: PrescriptionExportPayload) => void): void
Registers a callback that will be invoked when a prescription is saved.

This event is triggered when the user (or the widget) initiates a save action, and the prescription export data becomes available.
Parameters
- handler: (payload: PrescriptionExportPayload) => void
  A function that receives the saved prescription payload.
Returns void
Example
```
widget.onPrescriptionSave((payload) => {
  console.log('Prescription saved:', payload);
  // You can now persist or process the prescription data
});
```

reload

reload(): void
Reloads the current widget.

Returns void
Throws
Throws an error if the widget is not accessible.
Example
```
widget.reload();
```
Inherited from Widget.reload

savePrescription

savePrescription(): Promise<PrescriptionExportPayload>
Programmatically requests to save the current prescription and returns its payload.

This method will reject if the widget is not ready or if the operation times out (5s).

Returns Promise<PrescriptionExportPayload>
A promise that resolves with the prescription export payload.
Throws
If the widget is not ready or if no response is received within 5 seconds.
Remarks
- This method will trigger the callback registered with the PrescriptionWidget.onPrescriptionSave method if defined.
- The widget must be in a ready state before calling this method. You can check the readiness by using the PrescriptionWidget.onPrescriptionReady method.
Example
```
// Example by processing the payload directly
try {
  const payload = await widget.savePrescription();
  console.log('Prescription saved:', payload);
} catch (err) {
  console.error('Failed to save prescription:', err);
}

// Example using the `onPrescriptionSave` callback
widget.onPrescriptionSave((payload) => {
  // This will trigger everytime the `savePrescription` method is called
  console.log('Prescription saved:', payload);
});

try {
  // Do not process the payload directly and let the `onPrescriptionSave` callback handle it
  await widget.savePrescription();
} catch (err) {
  console.error('Failed to save prescription:', err);
}
```

setAuthToken

setAuthToken(authToken: string): void
Updates the authentication token in the widget.
Parameters
- authToken: string
  The new authentication token to be set.
Returns void
Throws
- If the given authentication token is invalid.
Example
```
widget.setAuthToken('new-auth-token');
```
Inherited from Widget.setAuthToken

setContext

setContext(payload: PrescriptionContextPayload): void
Sets the contextual data required by the widget.

This method must be called before the widget can complete its loading phase. Without it, the widget will remain in a loading state and will not be interactive.
Parameters
- payload: PrescriptionContextPayload
  The contextual data to apply to the widget.
  - Optionalcomment?: string | null
    If provided, the prescription comment will be set to the specified value.
    
    Remarks
    To clear the prescription comment, pass null as the value.
  - Optionalelements?: (
        | PrescriptionImportElementDrug
        | PrescriptionImportElementFreeText
        | PrescriptionImportElementMedicalDevice
    )[]
    The list of elements to be imported to the ongoing prescription.
  - patientId: string
    The unique patient identifier.
  - patientProfile: PatientProfile
    The patient’s profile data.
  - sessionId: string
    The unique identifier of the ongoing prescription session.
Returns void
Remarks
The widget will remain in loading state until this method is called.
Example
```
widget.setContext({
  patientId: "ed8c3c7b-3313-470f-b706-84a3e127c7cf",
  patientProfile: {
    allergies: [
      {
        coding: {
          code: "47703008",
          terminology: "snomed",
        },
      },
    ],
    birthDate: "1983-11-22",
    concurrentTreatments: [
      {
        coding: {
          code: "MV00001487",
          terminology: "posos",
        },
      },
    ],
    conditions: [
      {
        coding: {
          code: "186963008",
          terminology: "snomed",
        },
        isLongTermIllness: false,
        modifiers: [],
      },
    ],
    gfr: 110,
    height: 185,
    sex: "male",
    weight: 81,
  },
  sessionId: "189ea8f1-1030-4ba8-83a2-526cc6671b06",
});
```

setPrescriptionComment

setPrescriptionComment(comment: string | null): void
Sets a new comment for the current prescription.
Parameters
- comment: string | null
  The new prescription comment.
Returns void
Remarks
To clear the prescription comment, pass null as the argument.
Example
```
widget.setPrescriptionComment('This is a comment for the current prescription.');
```

Class PrescriptionWidget

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

OptionalauthToken?: string

OptionalbaseUrl?: string

Optionaldebug?: boolean

Default

Optionalenv?: "preprod" | "production"

Default

Remarks

OptionalframeHeight?: number

Default

Remarks

OptionalframeWidth?: number

Default

Remarks

Optionallocale?: string

Default

OptionalsigningKey?: string

Deprecated

OptionalsoftwareId?: string

Deprecated

Optionaltheme?: string

Default

OptionaluserId?: string

Deprecated

Returns PrescriptionWidget

Example

Methods

destroy

Returns void

Example

importPrescriptionElements

Parameters

Returns void

Example

onAuthTokenRefresh

Parameters

Returns void

Throws

Example

onPrescriptionReady

Parameters

Returns void

Example

onPrescriptionSave

Parameters

Returns void

Example

reload

Returns void

Throws

Example

savePrescription

Returns Promise<PrescriptionExportPayload>

Throws

Remarks

Example

setAuthToken

Parameters

Returns void

Throws

Example

setContext

Parameters

Optionalcomment?: string | null

Remarks

Optionalelements?: ( | PrescriptionImportElementDrug | PrescriptionImportElementFreeText | PrescriptionImportElementMedicalDevice)[]

patientId: string

patientProfile: PatientProfile

sessionId: string

Returns void

Remarks

Example

setPrescriptionComment

`Optional`authToken?: string

`Optional`baseUrl?: string

`Optional`debug?: boolean

`Optional`env?: "preprod" | "production"

`Optional`frameHeight?: number

`Optional`frameWidth?: number

`Optional`locale?: string

`Optional`signingKey?: string

`Optional`softwareId?: string

`Optional`theme?: string

`Optional`userId?: string

`Optional`comment?: string | null

`Optional`elements?: (
| PrescriptionImportElementDrug
| PrescriptionImportElementFreeText
| PrescriptionImportElementMedicalDevice
)[]