API docs by Redocly

MiPaciente - Telemonitoreo (1.0.0)

Download OpenAPI specification:Download

MiPaciente API-GW endpoints

Client

Client API.

Find all admissions for a given person

Notes:

  • This endpoint returns an array with all the admissions of a person, including the health program and the assigned gateway information. If there is no associated health program, and no gateway assigned, these values will be null.
Authorizations:
BasicAuth
path Parameters
personId
required
string <uuid>
Example: 609a003f-a364-4cfe-98cb-8b0505c081c2
query Parameters
organizationId
required
string <uuid>
Example: organizationId=9e366ad4-1cd3-42ed-8564-25f3725e94ba

Responses

Response samples

Content type
application/json
{
  • "problem": null,
  • "ok": true,
  • "status": 200,
  • "data": [
    ]
}

Find a Admission by Id

This endpoint returns one admission, including the health program and the assigned gateway information. If there is no associated health program, and no gateway assigned, these values will be null.

Authorizations:
BasicAuth
path Parameters
admissionId
required
string <uuid>
Example: 609a003f-a364-4cfe-98cb-8b0505c081c2

Responses

Response samples

Content type
application/json
{
  • "problem": null,
  • "ok": true,
  • "status": 200,
  • "data": {
    }
}

Finish an admission

This endpoint finish the admission and unbinds the gateway that was assigned.

Authorizations:
BasicAuth
path Parameters
admissionId
required
string <uuid>
Example: 000b83dd-64ff-4212-921e-f9299e86ad49
Request Body schema: application/json
reasonClinicalDischarge
required
string

Responses

Request samples

Content type
application/json
{
  • "reasonClinicalDischarge": "Razones por las que el paciente finalizó su participación en el programa."
}

Response samples

Content type
application/json
{
  • "problem": null,
  • "ok": true,
  • "status": 200,
  • "data": {
    }
}

Find observations by admissionId

Authorizations:
BasicAuth
path Parameters
admissionId
required
string <uuid>
Example: 609a003f-a364-4cfe-98cb-8b0505c081c2

Responses

Response samples

Content type
application/json
{
  • "problem": null,
  • "ok": true,
  • "status": 200,
  • "data": [
    ]
}

Assign organization's gateways to an admission

Authorizations:
BasicAuth
path Parameters
admissionId
required
string <uuid>
Example: 609a003f-a364-4cfe-98cb-8b0505c081c2
Request Body schema: application/json

An array of organizationGatewayId

arrays

Responses

Request samples

Content type
application/json

An array of organizationGatewayId

[
  • "c0f889ab-e466-4be9-a88e-d291ea344381",
  • "c0f889ab-e466-4be9-a88e-d291ea344382",
  • "c0f889ab-e466-4be9-a88e-d291ea344383"
]

Response samples

Content type
application/json
{
  • "problem": null,
  • "ok": true,
  • "status": 200,
  • "data": {
    }
}

Unassign an organization's gateway from an admission

If isFailing: true, a returnReason must be sent. If isFailing: false, returnReason must not be sent.

Authorizations:
BasicAuth
path Parameters
admissionId
required
string <uuid>
Example: 609a003f-a364-4cfe-98cb-8b0505c081c2
organizationGatewayId
required
string <uuid>
Example: 5aab7ee5-b530-4547-845f-b37ec68e3689
Request Body schema: application/json
isFailing
boolean
returnReason
string

Responses

Request samples

Content type
application/json
{
  • "isFailing": true,
  • "returnReason": "Descripción de la falla por la que se desvincula el gateway"
}

Response samples

Content type
application/json
{
  • "problem": null,
  • "ok": true,
  • "status": 200,
  • "data": {
    }
}

Assign gateway to organization

Authorizations:
BasicAuth
path Parameters
organizationId
required
string <uuid>
Example: 609a003f-a364-4cfe-98cb-8b0505c081c2
gatewayId
required
string <uuid>
Example: 5aab7ee5-b530-4547-845f-b37ec68e3689

Responses

Response samples

Content type
application/json
{
  • "problem": null,
  • "ok": true,
  • "status": 200,
  • "data": {
    }
}

Unassign gateway from organization

If the gateway is assign to an active admission this action is not allowed.

Authorizations:
BasicAuth
path Parameters
organizationId
required
string <uuid>
Example: 609a003f-a364-4cfe-98cb-8b0505c081c2
gatewayId
required
string <uuid>
Example: 5aab7ee5-b530-4547-845f-b37ec68e3689

Responses

Response samples

Content type
application/json
{
  • "problem": null,
  • "ok": true,
  • "status": 200,
  • "data": {
    }
}

Add new patient/person/admission

Add new patient/person/admission or patient/admission if the person already exists.

Authorizations:
BasicAuth
query Parameters
organizationId
required
string <uuid>
Example: organizationId=609a003f-a364-4cfe-98cb-8b0505c081c2
Request Body schema: application/json
One of
healthInsuranceEntityId
string <uuid>
privateHealthInsuranceId
string <uuid>
occupationCodeId
string <uuid>
Array of objects (newAdmission)
required
object (newPerson)

Responses

Request samples

Content type
application/json
Example
{
  • "healthInsuranceEntityId": "c1a2190d-3635-4301-979f-bcb980661c5d",
  • "privateHealthInsuranceId": "c1a2190d-3635-4301-979f-bcb980661c5d",
  • "occupationCodeId": "c1a2190d-3635-4301-979f-bcb980661c5d",
  • "admissions": [
    ],
  • "person": {
    }
}

Response samples

Content type
application/json
{
  • "problem": null,
  • "ok": true,
  • "status": 200,
  • "data": [
    ]
}

Generate patients report

Note: This endpoint return a json with all patients of the organization, their admissions and associated gateways.

Authorizations:
BasicAuth
query Parameters
organizationId
required
string <uuid>
Example: organizationId=9e366ad4-1cd3-42ed-8564-25f3725e94ba

Responses

Response samples

Content type
application/json
{
  • "problem": null,
  • "ok": true,
  • "status": 200,
  • "data": [
    ]
}

Generate report with patients, admissions and observations

Note: This endpoint return a json with all patients of the organization, their admissions and observations.

Authorizations:
BasicAuth
query Parameters
startDate
required
string <date-time>
Example: startDate=2022-02-08T05:00:18.573Z

Initial date of the report. This date corresponds to the admission's start date.

finalDate
required
string <date-time>
Example: finalDate=2022-07-08T05:00:18.573Z

Final date of the report.

organizationId
required
string <uuid>
Example: organizationId=9e366ad4-1cd3-42ed-8564-25f3725e94ba

Responses

Response samples

Content type
application/json
{
  • "problem": null,
  • "ok": true,
  • "status": 200,
  • "data": {
    }
}