api-docs v5.45.0

API Docs

Medical_Encounter

Medical Encounter - Post

Back to top

Create a medical encounter

POST /medical-encounters

Headers

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
facility string

facility id
invoice boolean optional

invoice id
patient string

patient id
type string Allowed values: inpatient,outpatient,er
preceding string optional

the preceding encounter (for continuations)
precedingParent string optional

the preceding encounter (for continuations)
doctors string[] optional

attending doctor id
tags string[] optional
queueNumber number optional

the encounter's queue number for the whole encounter
RCSNo string optional
insuranceApprovalCode string optional
encounterType string optional Allowed values: new,follow-up
services object[] optional

services to be consumed
services.service string

service id
services.consumable number
services.consumed number
pendingQueues object[] optional
pendingQueues.queue string
pendingQueues.meta object
pendingQueues.trail string
pendingQueues.weight number
pendingQueues.queues string[]
finishedAt number optional
finishedBy string optional
isForFollowup boolean optional

flag is this encounter flow is not yet end
pePerformed boolean optional

flag if PE is performed during this encounter
hasAPEReport boolean optional
APEReportTemplate string optional
APEReportFinalizedAt number optional
APEReportDoneAt number optional
APEReportClassifiedAt number optional
peContract string optional

string reference to insurance-contract the performed PE should be associated under
peContractInsurer string optional

string reference to insurance-contract the performed PE insurer should be associated under

Examples

Example usage:

curl "https://yourdomain.com/medical-encounters" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "facility": "facility-id",
    "patient": "patient-id",
    "type": "inpatient"
  }'

Parameters examples

json - Request-Example

{
  "facility": "facility-id",
  "patient": "patient-id",
  "type": "inpatient"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
facility string
invoice string
patient string
type string

inpatient, outpatient, er
preceding string
precedingParent string
doctors string[]
tags string[]
queueNumber number
RCSNo string
insuranceApprovalCode string
encounterType string

new, follow-up
services object[]
services.service string

service id
services.consumable number
services.consumed number
pendingQueues object[]
pendingQueues.queue string
pendingQueues.meta object
pendingQueues.trail string
pendingQueues.weight number
pendingQueues.queues string[]
finishedAt number
finishedBy string
isForFollowup boolean
pePerformed boolean
hasAPEReport boolean
APEReportTemplate string
APEReportFinalizedAt number
APEReportDoneAt number
APEReportClassifiedAt number
peContract string
peContractInsurer string
isPatientNew boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "encounter-1-id",
  "encounterType": "new"
}

Medical Encounter - Delete

Back to top

Delete a specific medical encounter. Can only delete if patient has no active queue.

DELETE /medical-encounters/:id

Headers

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
id string

id of encounter

Examples

Example usage:

curl "https://yourdomain.com/medical-encounters/<medical-encounter-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
facility string
invoice string
patient string
type string

inpatient, outpatient, er
preceding string
precedingParent string
doctors string[]
tags string[]
queueNumber number
RCSNo string
insuranceApprovalCode string
encounterType string

new, follow-up
services object[]
services.service string

service id
services.consumable number
services.consumed number
pendingQueues object[]
pendingQueues.queue string
pendingQueues.meta object
pendingQueues.trail string
pendingQueues.weight number
pendingQueues.queues string[]
finishedAt number
finishedBy string
isForFollowup boolean
pePerformed boolean
hasAPEReport boolean
APEReportTemplate string
APEReportFinalizedAt number
APEReportDoneAt number
APEReportClassifiedAt number
peContract string
peContractInsurer string
isPatientNew boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "encounter-1-id",
  "encounterType": "new"
}

Medical Encounter - Find

Back to top

Fetch the list of medical encounters

GET /medical-encounters

Headers

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/medical-encounters" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalEncounters object[]

array of medicalEncounter
medicalEncounters.id string
medicalEncounters.createdAt number
medicalEncounters.createdBy string
medicalEncounters.facility string
medicalEncounters.invoice string
medicalEncounters.patient string
medicalEncounters.type string

inpatient, outpatient, er
medicalEncounters.preceding string
medicalEncounters.precedingParent string
medicalEncounters.doctors string[]
medicalEncounters.tags string[]
medicalEncounters.queueNumber number
medicalEncounters.RCSNo string
medicalEncounters.insuranceApprovalCode string
medicalEncounters.encounterType string

new, follow-up
medicalEncounters.services object[]
medicalEncounters.services.service string

service id
medicalEncounters.services.consumable number
medicalEncounters.services.consumed number
medicalEncounters.pendingQueues object[]
medicalEncounters.pendingQueues.queue string
medicalEncounters.pendingQueues.meta object
medicalEncounters.pendingQueues.trail string
medicalEncounters.pendingQueues.weight number
medicalEncounters.pendingQueues.queues string[]
medicalEncounters.finishedAt number
medicalEncounters.finishedBy string
medicalEncounters.isForFollowup boolean
medicalEncounters.pePerformed boolean
medicalEncounters.hasAPEReport boolean
medicalEncounters.APEReportTemplate string
medicalEncounters.APEReportFinalizedAt number
medicalEncounters.APEReportDoneAt number
medicalEncounters.APEReportClassifiedAt number
medicalEncounters.peContract string
medicalEncounters.peContractInsurer string
medicalEncounters.isPatientNew boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "encounter-1-id",
    "encounterType": "new"
  },
  {
    "id": "encounter-2-id",
    "encounterType": "follow-up"
  }
]

Medical Encounter - Get

Back to top

Get a specific medical encounter

GET /medical-encounters/:id

Headers

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
id string

id of encounter

Examples

Example usage:

curl "https://yourdomain.com/medical-encounters/<medical-encounter-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
facility string
invoice string
patient string
type string

inpatient, outpatient, er
preceding string
precedingParent string
doctors string[]
tags string[]
queueNumber number
RCSNo string
insuranceApprovalCode string
encounterType string

new, follow-up
services object[]
services.service string

service id
services.consumable number
services.consumed number
pendingQueues object[]
pendingQueues.queue string
pendingQueues.meta object
pendingQueues.trail string
pendingQueues.weight number
pendingQueues.queues string[]
finishedAt number
finishedBy string
isForFollowup boolean
pePerformed boolean
hasAPEReport boolean
APEReportTemplate string
APEReportFinalizedAt number
APEReportDoneAt number
APEReportClassifiedAt number
peContract string
peContractInsurer string
isPatientNew boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "encounter-1-id",
  "encounterType": "new"
}

Medical Encounter - Patch

Back to top

Update a medical encounter

PATCH /medical-encounters/:id

Headers

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
invoice boolean optional

invoice id
precedingParent string optional

the preceding encounter (for continuations)
doctors string[] optional

attending doctor id
tags string[] optional
RCSNo string optional
insuranceApprovalCode string optional
encounterType string optional Allowed values: new,follow-up
services object[] optional

services to be consumed
services.service string

service id
services.consumable number
services.consumed number
pendingQueues object[] optional
pendingQueues.queue string
pendingQueues.meta object
pendingQueues.trail string
pendingQueues.weight number
pendingQueues.queues string[]
finishedAt number optional
finishedBy string optional
isForFollowup boolean optional

flag is this encounter flow is not yet end
pePerformed boolean optional

flag if PE is performed during this encounter
hasAPEReport boolean optional
APEReportTemplate string optional
APEReportFinalizedAt number optional
APEReportDoneAt number optional
APEReportClassifiedAt number optional
peContract string optional

string reference to insurance-contract the performed PE should be associated under
peContractInsurer string optional

string reference to insurance-contract the performed PE insurer should be associated under

Examples

Example usage:

curl "https://yourdomain.com/medical-encounters/<medical-encounter-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "createdAt": 1234567890,
    "APEReportFinalizedAt": 1234567890,
    "APEReportDoneAt": 1234567890
  }'

Parameters examples

json - Request-Example

{
  "createdAt": 1234567890,
  "APEReportFinalizedAt": 1234567890,
  "APEReportDoneAt": 1234567890
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
facility string
invoice string
patient string
type string

inpatient, outpatient, er
preceding string
precedingParent string
doctors string[]
tags string[]
queueNumber number
RCSNo string
insuranceApprovalCode string
encounterType string

new, follow-up
services object[]
services.service string

service id
services.consumable number
services.consumed number
pendingQueues object[]
pendingQueues.queue string
pendingQueues.meta object
pendingQueues.trail string
pendingQueues.weight number
pendingQueues.queues string[]
finishedAt number
finishedBy string
isForFollowup boolean
pePerformed boolean
hasAPEReport boolean
APEReportTemplate string
APEReportFinalizedAt number
APEReportDoneAt number
APEReportClassifiedAt number
peContract string
peContractInsurer string
isPatientNew boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "encounter-1-id",
  "encounterType": "new"
}

results matching ""

    No results matching ""