PatientStatus

Create PatientStatus

Creates a new PatientStatus

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
patient_Status
required
string [ 1 .. 8 ] characters

Identifier for the specific patient status

description
string or null <= 128 characters

Description for the specific patient status

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/patient-statuses
Request samples
{
  • "patient_Status": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PatientStatus

Lists all PatientStatus

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/patient-statuses
Request samples
Response samples
No sample

Get PatientStatus

Gets PatientStatus

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
Patient_Status
required
string

Patient Status

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/patient-statuses/{Patient_Status}
Request samples
Response samples
No sample

Update PatientStatus

Updates a specific PatientStatus.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
Patient_Status
required
string

Patient Status

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
patient_Status
required
string [ 1 .. 8 ] characters

Identifier for the specific patient status

description
string or null <= 128 characters

Description for the specific patient status

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

put/patient-statuses/{Patient_Status}
Request samples
{
  • "patient_Status": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete PatientStatus

Deletes an PatientStatus

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
Patient_Status
required
string

Patient Status

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/patient-statuses/{Patient_Status}
Request samples

Create or Update Batch PatientStatus

Create or Update multiple PatientStatus at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
patient_Status
required
string [ 1 .. 8 ] characters

Identifier for the specific patient status

description
string or null <= 128 characters

Description for the specific patient status

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
207

Success

401

Unauthorized

put/patient-statuses-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}