Get Clinician Documents

GET 
/api/v2/public/clinicians/:clinicianId/documents

General Information

This endpoint allows facilities to retrieve a list of all documents associated with a specific clinician.

Required Parameters

• clinicianId (path parameter): The unique identifier of the clinician
• shiftId (query parameter): The shift ID which the clinician requested

Document Categories

The endpoint returns documents organized by the following categories:

• LICENSE: Professional licenses (nursing, medical, etc.)
• CREDENTIAL: Professional credentials and certifications
• BACKGROUND_CHECK: Background check documents and results
• SSN: Social Security Number verification documents
• CDPH_530: California Department of Public Health 530 forms

Access Control

• The implementation logic requires that a clinician has submitted a shift request to a facility that the facility user is connected to. This requirement is in place to prevent the unauthorized sharing of documentation for users who have not interacted with one of your shifts.

Request

Path Parameters

clinicianId stringrequired
Clinician ID
Example: I7002epLHLhBCypdPCrn9XP4kTN2

Query Parameters

shiftId stringrequired
Id of the shift
Example: 4603117571

Responses

201

application/json

Schema

Schema

data object
clinicianId stringrequired
Id of the clinician
documents object[]required
Array containing clinician documents
Array [
oneOf
Verified Licenses
category stringrequired
Possible values: [background-check, credential, license, ssn, cdph-530]
Category of the document
type stringrequired
Type of the document
documentId stringrequired
Id of the document
hasFile booleanrequired
Whether the document has a file
status stringrequired
Status of the document
compact booleanrequired
Whether the license is compact
state booleanrequired
State of the license
expirationDate daterequired
Expiration date of the license
number stringrequired
Number of the license
Background Checks
category stringrequired
Possible values: [background-check, credential, license, ssn, cdph-530]
Category of the document
type stringrequired
Type of the document
documentId stringrequired
Id of the document
hasFile booleanrequired
Whether the document has a file
status stringrequired
Status of the document
expirationDate daterequired
Type of the document
completedDate daterequired
Type of the document
SSN
category stringrequired
Category of the document
lastFourDigits stringrequired
Last four digits of the SSN
Credentials
category stringrequired
Possible values: [background-check, credential, license, ssn, cdph-530]
Category of the document
type stringrequired
Type of the document
documentId stringrequired
Id of the document
hasFile booleanrequired
Whether the document has a file
status stringrequired
Status of the document
CDPH-530
category stringrequired
Possible values: [background-check, credential, license, ssn, cdph-530]
Category of the document
type stringrequired
Type of the document
documentId stringrequired
Id of the document
hasFile booleanrequired
Whether the document has a file
status stringrequired
Status of the document
]

Example (from schema)

{
  "data": {
    "clinicianId": "gpMEmsoXfWVmhXJIvXipPjo0dc43",
    "documents": [
      {},
      {},
      {},
      {},
      {}
    ]
  }
}

400

Bad request

application/json

Schema

Schema

message string[]

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": [
    "Property must be a string"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

Request Validation

Request Validation Error

{
  "message": [
    "shiftId must be a string"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

401

Unauthorized

application/json

Schema

Schema

message string

Error description

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Unauthorized",
  "statusCode": 401
}

403

Forbidden

application/json

Schema

Schema

message string

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Forbidden Resource",
  "error": "Forbidden",
  "statusCode": 403
}

Loading...