HIPAA Relationships

Create HIPAARelationship

Creates a new HIPAARelationship

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

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

Code identifying the HIPAA family relationship

description
string or null <= 512 characters

Description of the HIPAA family relationship

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/hipaa-relationships
Request samples
{
  • "hipaA_Code": "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 HIPAARelationship

Lists all HIPAARelationship given a specific

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/hipaa-relationships
Request samples 
Response samples 
No sample
Get HIPAARelationship
Gets HIPAARelationship


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
hIPAACode
required
string
HIPAA Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/hipaa-relationships/{hIPAACode}
Request samples 
Response samples 
No sample
Update HIPAARelationship
Updates a specific HIPAARelationship.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
hIPAACode
required
string
HIPAA Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
hipaA_Code
required
string  [ 1 .. 8 ] characters 
Code identifying the HIPAA family relationship


 
description
string or null  <= 512 characters 
Description of the HIPAA family relationship


 
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/hipaa-relationships/{hIPAACode}
Request samples 
{
  • "hipaA_Code": "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 HIPAARelationship
Deletes an HIPAARelationship


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
hIPAACode
required
string
HIPAA Code


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/hipaa-relationships/{hIPAACode}
Request samples 
Create or Update Batch HIPAARelationship
Create or Update multiple HIPAARelationship 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 
hipaA_Code
required
string  [ 1 .. 8 ] characters 
Code identifying the HIPAA family relationship


 
description
string or null  <= 512 characters 
Description of the HIPAA family relationship


 
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/hipaa-relationships-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}