Procedure Code Sets

Create ProcedureCodeSet

Creates a new ProcedureCodeSet

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
procedureCode
required
string

Procedure Code

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
procedure_Code
required
string [ 1 .. 8 ] characters
code_Set
required
string [ 1 .. 6 ] characters
description
string or null <= 64 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/procedure-codes/{procedureCode}/sets
Request samples
{
  • "procedure_Code": "string",
  • "code_Set": "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 ProcedureCodeSet

Lists all ProcedureCodeSet for the given procedureCode

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
procedureCode
required
string

Procedure Code

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

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.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/procedure-codes/{procedureCode}/sets
Request samples
Response samples
No sample

Get ProcedureCodeSet

Gets ProcedureCodeSet

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
procedureCode
required
string

Procedure Code

codeSet
required
string

Code Set

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/procedure-codes/{procedureCode}/sets/{codeSet}
Request samples
Response samples
No sample

Update ProcedureCodeSet

Updates a specific ProcedureCodeSet.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
procedureCode
required
string

Procedure Code

codeSet
required
string

Code Set

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
procedure_Code
required
string [ 1 .. 8 ] characters
code_Set
required
string [ 1 .. 6 ] characters
description
string or null <= 64 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

put/procedure-codes/{procedureCode}/sets/{codeSet}
Request samples
{
  • "procedure_Code": "string",
  • "code_Set": "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 ProcedureCodeSet

Deletes an ProcedureCodeSet

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
procedureCode
required
string

Procedure Code

codeSet
required
string

Code Set

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/procedure-codes/{procedureCode}/sets/{codeSet}
Request samples

Create or Update Batch ProcedureCodeSet

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

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
procedureCode
required
string

Procedure Code

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
procedure_Code
required
string [ 1 .. 8 ] characters
code_Set
required
string [ 1 .. 6 ] characters
description
string or null <= 64 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
207

Success

401

Unauthorized

put/procedure-codes/{procedureCode}/sets-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}