Creates a new custom assessment instance for a patient.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The requested API version

Body Params

The request containing patient MRN, template ID, and optional configuration.

Request to create a custom assessment instance for a patient.

string
required
length ≥ 1

The medical record number of the patient.

int64
required
≥ 1

The ContainerGroupId (template ID) for the custom assessment template.
Obtain from POST /commands/v4/customassessments/template or from the database.

int64 | null
≥ 1

Optional: The employee ID of the clinician performing the assessment.
If not provided, no clinician is assigned.

date-time | null

Optional: The effective/visit date for the assessment.
Defaults to current UTC date/time if not provided.

string | null

Optional: The assessment status name. Defaults to "Incomplete".
Valid values: Complete, Incomplete, InProgress, Pending, Working.

string | null

Optional: The visit location name. Resolved to VisitLocation_Id.

string | null

Optional: The visit type name. Resolved to VisitType_Id.

Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json