DOCSEARCHbyAlgolia
Submit Docs

Nursa API Documentation

website·Indexed 35 days ago

https://docs.nursa.com

API reference for the Nursa platform, featuring endpoints for managing facilities, clinicians, and shifts. Includes functionality for creating and updating shifts, handling shift reports, managing clinician documents, and configuring user and facility webhooks via the /api/v2/public namespace.

Tokens
26.7K
Snippets
109
Records
193
Agent score
54%

What's inside Nursa

  1. Overview of the Nursa Public API

    The Nursa public API provides integration capabilities for healthcare facilities and application developers to connect with a network of qualified and credentialed clinicians. It is designed to streamline healthcare staffing by facilitating real-time connections between facilities and clinical talent to meet staffing needs promptly.

  2. Handle Nursa User webhook events

    Nursa provides webhook events to notify systems about user connections and facility creation requests. Use the all event to receive all user-related notifications.
    EventDescription
    facility.user-connection.acceptedTriggered when a facility user connection is accepted.
    facility.user-connection.rejectedTriggered when a facility user connection is rejected.
    facility.creation.acceptedTriggered when a facility creation request is accepted.
    facility.creation.rejectedTriggered when a facility creation request is rejected.
    allTriggers notifications for all User events.

  3. Response schema for scheduled shift confirmation

    A successful request returns a 201 status code with a JSON body containing a data object. The response includes details about the facility, the shift timing, and the clinician's contact information.
    {
  "data": {
    "facilityId": "string",
    "shiftId": "string",
    "from": "date-time",
    "to": "date-time",
    "licenseType": "string",
    "clinician": {
      "id": "string",
      "firstName": "string",
      "lastName": "string",
      "contactEmail": "string",
      "contactPhone": "+1##########"
    },
    "scheduledBy": "string",
    "breakTime": "ISO 8601 duration"
  }
}

  4. Update shift API request parameters

    The Update Shift endpoint requires the following parameters:

    Path Parameters:

    • shiftId (string, required): The unique Nursa ShiftId (e.g., 8222234296).

    Request Body (JSON):

    • description (string): Detailed information about the shift to help nurses understand requirements.
    • bonus (number): A monetary bonus provided to the clinician.

  5. Handle Nursa Facilities webhook events

    Nursa provides a set of webhook events to notify external systems about shift and report lifecycle changes. You can subscribe to specific events or use the all event to receive all facility-related notifications.
    EventDescription
    shift.createdTriggered when a shift is created.
    shift.request.createdTriggered when a shift request is created.
    shift.request.cancelledTriggered when a shift request is cancelled.
    shift.report.createdTriggered when a shift report is created.
    shift.scheduled.cancelledTriggered when a scheduled shift is cancelled.
    shift.scheduledTriggered when a shift is scheduled.
    shift.report.accepted-automaticallyTriggered when a shift report is automatically accepted.
    shift.report.acceptedTriggered when a shift report is accepted.
    shift.report.rejectedTriggered when a shift report is rejected.
    shift.cancelledTriggered when a shift is cancelled.
    allTriggers notifications for all Facilities events.

  6. Retrieve requested shifts using the Get Requested Shifts endpoint

    Facility Users can retrieve information about shifts for which clinicians have submitted requests using the Get requested shift endpoint.

    Required Parameter:

    • facilityId: The ID of the facility for which you want to retrieve requested shifts.

    Optional Parameters:

    • shiftId: Retrieve requests for a specific shift.
    • licenseType: Filter by license type (CNA, LPN, RN).
    • startDate: Filter by start date.
    • limit: Maximum number of returned shifts.
    • sortDirection: Sort order for returned shifts.
    • offset: Pagination offset.

  7. Manage healthcare staffing via Nursa API

    The Nursa API allows platforms to integrate directly with Nursa's marketplace of qualified healthcare professionals to automate staffing workflows. Key capabilities include:

    • Posting Shifts: Directly post open shifts to the Nursa marketplace to be filled by experienced clinicians.
    • Shift Management: Synchronize data between a third-party platform and Nursa, allowing users to edit or cancel shifts.
    • Data Tracking: Monitor external staffing hours, total spend, and clinician credentials directly within the integrated platform.

  8. Retrieve authenticated user information via UserInfo endpoint

    The /oidc/userinfo endpoint returns claims about the authenticated end-user. To use this endpoint, you must provide a valid access_token obtained through an authorization grant. The specific claims returned depend on the scopes requested and approved during authentication.
    GET https://auth.nursa.com/oidc/userinfo
Authorization: Bearer eyJhbGciOiJSUzI1Ni...CIsImtpZCI6ImI0NTA0Z

  9. Understand Facility and Facility User roles in Nursa

    In the Nursa ecosystem, a Facility is a physical healthcare location (e.g., Hospital, ICU, Long-term care facility, or Clinic department) where job shifts are posted.

    A Facility User is an individual authorized to manage and post shifts for associated facilities. Key constraints include:

    • Facility Users cannot post shifts for themselves.
    • Facility Users can only post shifts for facilities to which they are officially connected.

  10. Retrieve clinician details by ID

    Use the GET /api/v2/public/clinicians/:clinicianId/details endpoint to retrieve detailed information about a specific clinician. This includes their name, contact details, and associated license types.
    # Example request
GET /api/v2/public/clinicians/I7002epLHLhBCypdPCrn9XP4kTN2/details

  11. Manage the clinician scheduling process

    The scheduling workflow consists of three primary stages:

    1. Review and Schedule: Facility Users review shift requests via the Get requested shift endpoint. If approved, the scheduling endpoint is called to assign the clinician to the shift.
    2. Notifications: Once scheduled, clinicians receive confirmation, pre-shift reminders, and prompts to log their arrival time.
    3. Information Access: Scheduled clinicians can view all shift-specific details, including location and job requirements, within the application.

  12. Implement Progressive Sign Up for Nursa users

    Progressive Sign Up allows you to initiate registration via OAuth and then programmatically complete the user profile.

    1. Redirect the user to sign up using the Authorization Code Flow (or PKCE) with the parameter screen_hint=signup.
    2. After the user provides email and password, exchange the resulting Authorization Code for an Access Token.
    3. Check the id_token or access_token for a role claim. If the claim is missing, you must provide additional profile data.
    4. Call the Create Facility User Profile API to complete the profile.
    5. Redirect the user through the authorization flow again (without prompt or screen_hint parameters) to obtain a new Access Token containing the role claim.