Osana Api (1.0.0)
Download OpenAPI specification:Download
get appointment
Authorizations:
bearerAuth
query Parameters
page | string Example: page=0 |
limit | string Example: limit=10 |
patientId required | string Example: patientId=7b49680d-f9ae-47f4-a642-59516f3bd002 |
dateFrom | string Example: dateFrom=2023-03-01 |
appointmentStatus | string |
sortDirection | string Enum: "ASC" "DESC" Example: sortDirection=ASC |
Responses
create appointment
Authorizations:
bearerAuth
Request Body schema: application/json
patientId | string |
practitionersIds | Array of strings |
hcsId | string |
appointmentDate | string |
appointmentStart | string |
minutesDuration | string |
patientCoverageId | string |
copay | number |
authorization | boolean |
appointmentId | string |
locationId | string |
Responses
Request samples
- Payload
Content type
application/json
{- "patientId": "b3b1d5b0-0975-435f-898a-ee69dd3633aa",
- "practitionersIds": [
- "2caf07c2-b874-47e7-a465-57be943eb747"
], - "hcsId": "PG_9590",
- "appointmentDate": "2023-02-03",
- "appointmentStart": "08:30",
- "minutesDuration": "30",
- "patientCoverageId": "bbfb4fc0-77b0-41de-9f2a-1323462d8db1",
- "copay": 1350,
- "authorization": true,
- "appointmentId": "2898198",
- "locationId": "cdb887bc-0df9-4b69-93c4-9894d31febd7"
}
Create coverage
Authorizations:
bearerAuth
Request Body schema: application/json
credentialNumber | string |
beneficiaryId | string |
insurancePlanId | string |
Responses
Request samples
- Payload
Content type
application/json
{- "credentialNumber": 191231280,
- "beneficiaryId": "37707687-73f7-4d38-b53b-e82c2164e428",
- "insurancePlanId": "11157eb2-6c22-4df6-8fac-7bc2d6b82340"
}
Response samples
- 201
- 404
- 409
- 422
- 500
Content type
application/json
{- "status": "string",
- "model": {
- "id": "string"
}
}
Edit coverage
Authorizations:
bearerAuth
path Parameters
coverageId required | string Example: 3208a231-3b26-4ef8-b4eb-9ede9bce9947 |
Request Body schema: application/json
credentialNumber | string |
insurancePlanId | string |
Responses
Request samples
- Payload
Content type
application/json
{- "credentialNumber": 191231280,
- "insurancePlanId": "11157eb2-6c22-4df6-8fac-7bc2d6b82340"
}
Response samples
- 200
- 404
- 422
- 500
Content type
application/json
{- "status": "string",
- "model": {
- "id": "string"
}
}
get healthCareService
Authorizations:
bearerAuth
query Parameters
search | string Example: search=cardiologia |
type | string Enum: "CONSULTA" "PRACTICA" |
page | string Example: page=0 |
limit | string Example: limit=10 |
hcsId | string Example: hcsId=PGG_24 |
patientCoverageId required | string Example: patientCoverageId=bbfb4fc0-77b0-41de-9f2a-1323462d8db1 |
patientId required | string Example: patientId=7b49680d-f9ae-47f4-a642-59516f3bd002 |
Responses
Get frequent HCS
Authorizations:
bearerAuth
query Parameters
search | string Example: search=cardiologia |
page | string Example: page=0 |
limit | string Example: limit=10 |
patientCoverageId required | string Example: patientCoverageId=bbfb4fc0-77b0-41de-9f2a-1323462d8db1 |
patientId required | string Example: patientId=7b49680d-f9ae-47f4-a642-59516f3bd002 |
Responses
Get frequent HCS
Authorizations:
bearerAuth
query Parameters
search | string Example: search=cardiologia |
page | string Example: page=0 |
limit | string Example: limit=10 |
patientCoverageId required | string Example: patientCoverageId=bbfb4fc0-77b0-41de-9f2a-1323462d8db1 |
patientId required | string Example: patientId=7b49680d-f9ae-47f4-a642-59516f3bd002 |
type | string Enum: "CONSULTA" "PRACTICA" |
Responses
Endpoint to get insurance carriers
Authorizations:
bearerAuth
query Parameters
search | string |
page | string Example: page=0 |
limit | string Example: limit=10 |
sortProperty | string Example: sortProperty=name |
sortDirection | string Enum: "ASC" "DESC" Example: sortDirection=ASC |
Responses
Response samples
- 200
- 422
- 500
Content type
application/json
{- "data": [
- {
- "id": "string",
- "name": "string"
}
], - "pagination": {
- "totalPages": 0,
- "totalElements": 0,
- "page": 0,
- "limit": 0,
- "numberOfElements": 0
}
}
Endpoint to get insurance carriers
Authorizations:
bearerAuth
query Parameters
ownerId | string |
search | string |
page | string Example: page=0 |
limit | string Example: limit=10 |
sortProperty | string Example: sortProperty=name |
sortDirection | string Enum: "ASC" "DESC" Example: sortDirection=ASC |
Responses
Response samples
- 200
- 422
- 500
Content type
application/json
{- "data": [
- {
- "id": "string",
- "name": "string"
}
], - "pagination": {
- "totalPages": 0,
- "totalElements": 0,
- "page": 0,
- "limit": 0,
- "numberOfElements": 0
}
}
endpoint to get available slots
Authorizations:
bearerAuth
query Parameters
page | string Example: page=0 |
limit | string Example: limit=10 |
Request Body schema: application/json
hcsId | string |
practitionerId | string |
modalityVirtual | boolean |
object | |
appointmentRequired | boolean |
locationId | string |
patientCoverageId | string |
patientId | string |
Responses
Request samples
- Payload
Content type
application/json
{- "hcsId": "PG_9587",
- "practitionerId": null,
- "modalityVirtual": null,
- "dateConfig": {
- "dateFrom": "2023-03-01",
- "dateTo": "2023-04-01",
- "daysOfWeek": [
- "MONDAY",
- "TUESDAY",
- "WEDNESDAY"
], - "hourFrom": "10:00",
- "hourTo": "18:00"
}, - "appointmentRequired": true,
- "locationId": null,
- "patientCoverageId": "bbfb4fc0-77b0-41de-9f2a-1323462d8db1",
- "patientId": "7b49680d-f9ae-47f4-a642-59516f3bd002"
}