api-docs v5.116.0

API Docs

Table of contents

Ward_Occupant

Ward Occupant - Delete

Back to top

Delete a specific ward occupant

DELETE /ward-occupants/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/ward-occupants/<ward-occupant-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp

Default value: currentTime
createdBy string

account uid
facility string
encounter string
room string
bed string

bed id
provider string

doc uid
occupiedAt number

timestamp

Default value: currentTime
occupiedBy string

account uid
dischargedAt number

timestamp
dischargedBy string

account uid

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Ward Occupant - Find

Back to top

Get list of ward occupants

GET /ward-occupants

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/ward-occupants" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
wardOccupants object[]

array of wardOccupant
wardOccupants.id string
wardOccupants.createdAt number

timestamp

Default value: currentTime
wardOccupants.createdBy string

account uid
wardOccupants.facility string
wardOccupants.encounter string
wardOccupants.room string
wardOccupants.bed string

bed id
wardOccupants.provider string

doc uid
wardOccupants.occupiedAt number

timestamp

Default value: currentTime
wardOccupants.occupiedBy string

account uid
wardOccupants.dischargedAt number

timestamp
wardOccupants.dischargedBy string

account uid

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "id-1",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  },
  {
    "id": "id-2",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  }
]

Ward Occupant - Get

Back to top

Get a specific ward occupant

GET /ward-occupants/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/ward-occupants/<ward-occupant-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp

Default value: currentTime
createdBy string

account uid
facility string
encounter string
room string
bed string

bed id
provider string

doc uid
occupiedAt number

timestamp

Default value: currentTime
occupiedBy string

account uid
dischargedAt number

timestamp
dischargedBy string

account uid

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Ward Occupant - Patch

Back to top

Update ward occupant

PATCH /ward-occupants/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
provider string

operators
discharge boolean

operators

Examples

Example usage:

curl "https://yourdomain.com/ward-occupants/<ward-occupant-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "discharge": true
  }'

Parameters examples

json - Request-Example

{
  "discharge": true
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp

Default value: currentTime
createdBy string

account uid
facility string
encounter string
room string
bed string

bed id
provider string

doc uid
occupiedAt number

timestamp

Default value: currentTime
occupiedBy string

account uid
dischargedAt number

timestamp
dischargedBy string

account uid

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Ward Occupant - Post

Back to top

Create ward occupant

POST /ward-occupants

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
createdAt number optional

timestamp

Default value: currentTime
encounter string
bed string

bed id
provider string optional

doc uid
occupiedAt number optional

timestamp

Default value: currentTime
occupiedBy string

account uid

Examples

Example usage:

curl "https://yourdomain.com/ward-occupants" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "encounter": "encounter-id",
    "bed": "bed-id",
    "occupiedBy": "some-uid"
  }'

Parameters examples

json - Request-Example

{
  "encounter": "encounter-id",
  "bed": "bed-id",
  "occupiedBy": "some-uid"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp

Default value: currentTime
createdBy string

account uid
facility string
encounter string
room string
bed string

bed id
provider string

doc uid
occupiedAt number

timestamp

Default value: currentTime
occupiedBy string

account uid
dischargedAt number

timestamp
dischargedBy string

account uid

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

results matching ""

    No results matching ""