{
"openapi": "3.0.0",
"servers": [
{
"description": "Calidad",
"url": "https://colsubsidio-test.apigee.net/api"
},
{
"description": "Producción",
"url": "https://colsubsidio-prod.apigee.net/api"
}
],
"info": {
"description": "Información de los servicios del producto EPS salud.",
"version": "2.0.0",
"title": "EPS Salud",
"termsOfService": "http://172.16.95.36/wiki/index.php/T%C3%A9rminos_de_servicio_Swagger",
"contact": {
"email": "operacionesti@colsubsidio.com"
},
"license": {
"name": "Colsubsidio",
"url": "http://172.16.95.36/wiki/index.php/T%C3%A9rminos_de_servicio_Swagger"
}
},
"tags": [
{
"name": "cols-salud-afiliado",
"description": "Afiliados de salud"
},
{
"name": "cols-salud-cita",
"description": "Administración de citas"
},
{
"name": "cols-salud-eps",
"description": "EPSs"
},
{
"name": "cols-salud-ips",
"description": "IPSs"
},
{
"name": "cols-salud-multa",
"description": "Manejo de multas de las citas en salud"
},
{
"name": "cols-salud-paciente",
"description": "Pacientes de salud"
}
],
"paths": {
"/v2/salud/afiliados": {
"get": {
"tags": [
"cols-salud-afiliado"
],
"summary": "Validador afiliado",
"description": "Obtener información de los afiliados de salud",
"operationId": "validadorAfiliadoSalud",
"parameters": [
{
"name": "tipoId",
"in": "query",
"description": "Tipo de identificacion.
CC - Cedula
NIT - NIT",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numId",
"in": "query",
"description": "Número de identificación",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "asociado",
"in": "query",
"description": "Es un asociado o no
1 - Sí
0 - No",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "cesan",
"in": "query",
"description": "Empresa en la que tiene la cesantías",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/validadorAfiliadoSaludResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v2/salud/citas": {
"put": {
"tags": [
"cols-salud-cita"
],
"summary": "Actualizar cita sin orden",
"description": "Realizar actualización de una cita",
"operationId": "actualizarCita",
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/actualizarCitaResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
],
"requestBody": {
"$ref": "#/components/requestBodies/actualizarCitaRequestBody"
}
},
"delete": {
"tags": [
"cols-salud-cita"
],
"summary": "Borrar cita sin orden",
"description": "Realizar el borrado de una cita sin orden",
"operationId": "borrarCita",
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/borrarCitaResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
],
"requestBody": {
"$ref": "#/components/requestBodies/borrarCitaRequestBody"
}
},
"get": {
"tags": [
"cols-salud-cita"
],
"summary": "Cita horario",
"description": "Obtener información cita horario",
"operationId": "citaHorario",
"parameters": [
{
"name": "fechasolicitud",
"in": "query",
"description": "Fecha solicitud",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "especialidad",
"in": "query",
"description": "Especialidad",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "medico",
"in": "query",
"description": "Medico",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ips",
"in": "query",
"description": "IPS cita",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "jornada",
"in": "query",
"description": "Jornada cita",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "planificacion",
"in": "query",
"description": "Planificación",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "paciente",
"in": "query",
"description": "IPS cita",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/citaHorarioResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
},
"post": {
"tags": [
"cols-salud-cita"
],
"summary": "Reservar cita sin orden",
"description": "Reservar cita sin orden",
"operationId": "reservarCitaSinOrden",
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/reservarCitaSinOrdenResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
],
"requestBody": {
"$ref": "#/components/requestBodies/reservaCitaSinOrdenRequestBody"
}
}
},
"/v2/salud/citas{adendo}": {
"get": {
"tags": [
"cols-salud-cita"
],
"summary": "Consultar cita",
"description": "Obtener información cita",
"operationId": "consultarCita",
"parameters": [
{
"name": "adendo",
"in": "path",
"description": "El campo solo es de relleno, para evitar problemas de duplicado en la documentación de Swaager",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tipoId",
"in": "query",
"description": "Tipo identificación",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numId",
"in": "query",
"description": "Número identificación",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/consultarCitaResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v2/salud/citas{adicion}": {
"get": {
"tags": [
"cols-salud-cita"
],
"summary": "Disponibilidad citas",
"description": "Obtener información disponibilidad citas",
"operationId": "disponibilidadCitas",
"parameters": [
{
"name": "adicion",
"in": "path",
"description": "El campo solo es de relleno, para evitar problemas de duplicado en la documentación de Swaager",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "especialidad",
"in": "query",
"description": "Especialidad",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "medico",
"in": "query",
"description": "Médico",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ipsadscripcion",
"in": "query",
"description": "IPS adscripción",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "jornada",
"in": "query",
"description": "Jornada",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "planificacion",
"in": "query",
"description": "Planificación",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ips",
"in": "query",
"description": "IPS",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "paciente",
"in": "query",
"description": "Paciente",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/disponibilidadCitasResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v2/salud/citas{agregacion}": {
"get": {
"tags": [
"cols-salud-cita"
],
"summary": "Disponibilidad citas",
"description": "Obtener información disponibilidad citas",
"operationId": "busquedaCitaPorMedico",
"parameters": [
{
"name": "agregacion",
"in": "path",
"description": "El campo solo es de relleno, para evitar problemas de duplicado en la documentación de Swaager",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "prestadorId",
"in": "query",
"description": "Id del prestador",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "especialidadId",
"in": "query",
"description": "Id especialidad",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "fechaSolicitud",
"in": "query",
"description": "Fecha solicitud",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "jornada",
"in": "query",
"description": "Jornada",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/busquedaCitaPorMedicoResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v2/salud/citas/crearconorden": {
"post": {
"tags": [
"cols-salud-cita"
],
"summary": "Cita con orden",
"description": "Crear cita con orden",
"operationId": "crearCitaConOrden",
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/crearCitaResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
],
"requestBody": {
"$ref": "#/components/requestBodies/crearCitaRequestBody"
}
}
},
"/v2/salud/citas/reservaconorden": {
"post": {
"tags": [
"cols-salud-cita"
],
"summary": "Reservar con orden",
"description": "Reservar cita con orden",
"operationId": "reservarCitaConOrden",
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/reservarCitaResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
],
"requestBody": {
"$ref": "#/components/requestBodies/reservarCitaConOrdenRequestBody"
}
}
},
"/v2/salud/citas/crearsinorden": {
"post": {
"tags": [
"cols-salud-cita"
],
"summary": "Crear cita sin orden",
"description": "Crear cita sin orden",
"operationId": "crearCitaSinOrden",
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/crearCitaSinOrdenResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
],
"requestBody": {
"$ref": "#/components/requestBodies/crearCitaSinOrdenRequestBody"
}
}
},
"/v2/pacientes/convenio": {
"get": {
"tags": [
"cols-salud-paciente"
],
"summary": "Consulta de convenio",
"description": "Servicio de consulta de convenio, buscando por tipo de identificación y número de identificación.",
"operationId": "consultaConvenio",
"parameters": [
{
"name": "tipoId",
"in": "query",
"description": "Tipo de identificacion.
CC - Cedula
NIT - NIT",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numId",
"in": "query",
"description": "Número de identificación",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/convenioPacienteResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v2/salud/pacientes/grupofamiliar": {
"get": {
"tags": [
"cols-salud-paciente"
],
"summary": "Obtener grupo familiar",
"description": "Servcio que permite consultar los datos asociados al grupo familiar de un afiliado, dado un tipo y número de documento.",
"operationId": "consultaGrupoFamiliar",
"parameters": [
{
"name": "tipoDoc",
"in": "query",
"description": "Tipo de identificacion.
Ejemplo:
CC - Cedula
NIT - NIT",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documento",
"in": "query",
"description": "Número de identificación.
Ejemplo:
1052411109",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/consultaGrupoFamiliarResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v2/salud/pacientes/medicotratante": {
"get": {
"tags": [
"cols-salud-paciente"
],
"summary": "Obtener médico tratante de un afiliado",
"description": "Api que permite consultar el medico tratante de un afiliado dato un tipo y número de identificación.",
"operationId": "medicoContratante",
"parameters": [
{
"name": "tipoId",
"in": "query",
"description": "Tipo de identificacion.
CC - Cedula
NIT - NIT",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numId",
"in": "query",
"description": "Número de identificación",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "codigoEsp",
"in": "query",
"description": "Código que indica el código de la especialidad
150",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/medicoTratanteResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v2/salud/pacientes/citasporespecialidades": {
"get": {
"tags": [
"cols-salud-paciente"
],
"summary": "Obtener cita por especialidad",
"description": "Servicio que permite obtener citas por especialidad de un paciente.",
"operationId": "citaBusquedaPorEspecialidad",
"parameters": [
{
"name": "convenio",
"in": "query",
"description": "Campo que indica el convenio el cual está asociado el paciente.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "pacienteId",
"in": "query",
"description": "Identificador del paciente.
Ejemplo
10009",
"required": true,
"schema": {
"type": "number"
}
},
{
"name": "edad",
"in": "query",
"description": "Indica la edad del paciente.
Ejemplo:
19",
"required": true,
"schema": {
"type": "number"
}
},
{
"name": "sexo",
"in": "query",
"description": "Define el género del paciente
Ejemplo:
M F",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/especialidadPorPacienteResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v2/salud/pacientes/ordenesclinicas": {
"get": {
"tags": [
"cols-salud-paciente"
],
"summary": "Obtener cita por especialidad",
"description": "Servicio que permite obtener citas por especialidad de un paciente.",
"operationId": "consultaOrdenesClinicas",
"parameters": [
{
"name": "tipoId",
"in": "query",
"description": "Tipo de identificacion.
CC - Cedula
NIT - NIT",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numId",
"in": "query",
"description": "Número de identificación",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/consultaOrdenesResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v2/salud/pacientes/detalle": {
"get": {
"tags": [
"cols-salud-paciente"
],
"summary": "Información completa del paciente",
"description": "Servicio que dado la identificación de un paciente devuelve la información del mismo en la plataforma de salud: dirección, teléfono, nombre completos.",
"operationId": "getDetallePaciente",
"parameters": [
{
"name": "tipoId",
"in": "query",
"description": "Tipo de identificación.
CC - Cedula
NIT - NIT",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numId",
"in": "query",
"description": "Número de identificación",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/detallePacienteResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v2/salud/pacientes": {
"post": {
"tags": [
"cols-salud-paciente"
],
"summary": "Actualizar paciente",
"description": "Servicio para realizar actualización de datos de un paciente.",
"operationId": "crearPacienteProvisional",
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resultado"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
],
"requestBody": {
"$ref": "#/components/requestBodies/pacienteProvisionalRequestBody"
}
}
},
"/v2/salud/multas": {
"get": {
"tags": [
"cols-salud-multa"
],
"summary": "Consultas multas",
"description": "Servicio que permite consultar las multas de un paciente dado un tipo y número de documento.",
"operationId": "consultaMultas",
"parameters": [
{
"name": "tipoId",
"in": "query",
"description": "Tipo de identificacion.
Ejemplo:
CC - Cedula
NIT - NIT",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numId",
"in": "query",
"description": "Número de identificación.
Ejemplo:
1052411109",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/consultaMultasResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v2/salud/ips": {
"get": {
"tags": [
"cols-salud-ips"
],
"summary": "Consultas ips adscritas",
"description": "Permite consultar las IPS adscritas de un afiliado por un tipo y número de identificación.",
"operationId": "consultaIpsInscrita",
"parameters": [
{
"name": "tipoId",
"in": "query",
"description": "Tipo de identificacion.
Ejemplo:
CC - Cedula
NIT - NIT",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numId",
"in": "query",
"description": "Número de identificación.
Ejemplo:
1052411109",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/consultaIpsAdscritaResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v2/salud/ips{idEsp}": {
"get": {
"tags": [
"cols-salud-ips"
],
"summary": "Consultas ips por Id de la especilidad",
"description": "Permite consultar las IPS por Especialidad",
"operationId": "consultaIps",
"parameters": [
{
"name": "idEsp",
"in": "path",
"description": "El campo solo es de relleno, para evitar problemas de duplicado en la documentación de Swaager",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/consultaIpsAdscritaResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v2/salud/citas/borrarconorden": {
"delete": {
"tags": [
"cols-salud-cita"
],
"summary": "Borrar cita con orden",
"description": "Realizar el borrado de una cita con orden",
"operationId": "citaBorradoConOrden",
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/borrarCitaConOrdenResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
],
"requestBody": {
"$ref": "#/components/requestBodies/borrarCitaConOrdenRequestBody"
}
}
},
"/v1/salud/eps": {
"get": {
"tags": [
"cols-salud-eps"
],
"summary": "Consultar eps",
"description": "Obtener información de las eps",
"operationId": "consultaEps",
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/consultarEpsResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
}
},
"externalDocs": {
"description": "Encontrar más información en EnterpriseArchitect",
"url": "http://172.16.95.36/wiki/index.php/Enterprise_Architect"
},
"components": {
"schemas": {
"resultado": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Código del resultado"
},
"descripcion": {
"type": "string",
"description": "Descripción del resultado"
}
},
"xml": {
"name": "resultado"
}
},
"documento": {
"type": "object",
"properties": {
"tipo": {
"type": "string",
"description": "Tipo de documento"
},
"numero": {
"type": "string",
"description": "Número de identificación del documento"
}
},
"xml": {
"name": "documento"
}
},
"nombre": {
"type": "object",
"properties": {
"primero": {
"type": "string",
"description": "Primer nombre"
},
"segundo": {
"type": "string",
"description": "Segundo nombre"
},
"primerApellido": {
"type": "string",
"description": "Primer apellido"
},
"segundoApellido": {
"type": "string",
"description": "Segundo apellido"
}
},
"xml": {
"name": "nombre"
}
},
"categoria": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Código de la categoría"
}
},
"xml": {
"name": "categoria"
}
},
"tipo": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Código del tipo"
}
},
"xml": {
"name": "tipo"
}
},
"estado": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Código del estado"
}
},
"xml": {
"name": "estado"
}
},
"convenio": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Código del convenio"
},
"estado": {
"type": "string",
"description": "Estado del convenio"
},
"nombre": {
"type": "string",
"description": "Nombre del convenio"
},
"clase": {
"type": "string",
"description": "Clase del convenio"
}
},
"xml": {
"name": "convenio"
}
},
"eps": {
"type": "object",
"properties": {
"documento": {
"$ref": "#/components/schemas/documento"
},
"nombre": {
"type": "string",
"description": "Nombre de la EPS"
},
"convenio": {
"$ref": "#/components/schemas/convenio"
}
},
"xml": {
"name": "eps"
}
},
"ips": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Codigo"
},
"nombre": {
"type": "string",
"description": "Nombre ips"
}
},
"xml": {
"name": "ips"
}
},
"reservaSinOrdenprestador": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "código de la especialidad"
}
},
"xml": {
"name": "prestador"
}
},
"prestador": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "código de la especialidad"
},
"nombre": {
"type": "string",
"description": "Descripción de la especialidad"
},
"apellidos": {
"type": "string",
"description": "Indicativo de la cita prioritaria"
}
},
"xml": {
"name": "prestador"
}
},
"especialidad": {
"type": "object",
"properties": {
"codigo": {
"type": "number",
"description": "código de la especialidad"
},
"descripcion": {
"type": "string",
"description": "Descripción de la especialidad"
},
"citaPrioritaria": {
"type": "number",
"description": "Indicativo de la cita prioritaria"
}
},
"xml": {
"name": "especialidad"
}
},
"afiliado": {
"type": "object",
"properties": {
"fechaComprobacion": {
"type": "string",
"description": "Fecha de comprobación",
"format": "date-time"
},
"documento": {
"$ref": "#/components/schemas/documento"
},
"nombre": {
"$ref": "#/components/schemas/nombre"
},
"categoria": {
"$ref": "#/components/schemas/categoria"
},
"tipo": {
"$ref": "#/components/schemas/tipo"
},
"estado": {
"$ref": "#/components/schemas/estado"
},
"semanasCotizadas": {
"type": "integer",
"description": "Semanas cotizadas"
},
"convenio": {
"$ref": "#/components/schemas/convenio"
},
"eps": {
"$ref": "#/components/schemas/eps"
}
},
"xml": {
"name": "afiliado"
}
},
"cita": {
"type": "object",
"properties": {
"fechaHora": {
"type": "string",
"description": "Fecha de la cita"
},
"centroMedico": {
"$ref": "#/components/schemas/centroMedico"
},
"convenio": {
"$ref": "#/components/schemas/convenio"
},
"prestador": {
"$ref": "#/components/schemas/especialidad"
},
"estado": {
"$ref": "#/components/schemas/estado"
},
"consultorio": {
"type": "string",
"description": "Nombre del consultorio"
},
"idReserva": {
"type": "number",
"description": "id de la Reversa"
},
"valor": {
"type": "number",
"description": "valor de la cita"
},
"numeroOrden": {
"type": "number",
"description": "Número de la orden"
},
"documentoContable": {
"type": "number",
"description": "Documento contable"
}
}
},
"reservarSinOrdencita": {
"type": "object",
"required": [
"fechaHora"
],
"properties": {
"fechaHora": {
"type": "string",
"description": "Fecha de la reserva"
}
}
},
"busquedaCitaPorMedicoCita": {
"type": "object",
"required": [
"prestador"
],
"properties": {
"prestador": {
"$ref": "#/components/schemas/prestador"
},
"especialidad": {
"$ref": "#/components/schemas/especialidad"
},
"ips": {
"$ref": "#/components/schemas/ips"
},
"tipoPlanificacion": {
"type": "string",
"description": "Tipo de planificación"
},
"unidadTratamiento": {
"type": "string",
"description": "Unidad de tratamiento"
},
"fechaHora": {
"type": "string",
"description": "Fecha"
}
}
},
"afiliacion": {
"type": "object",
"properties": {
"codigo": {
"type": "number",
"description": "Código de afiliación"
}
}
},
"ordenesClinicas": {
"type": "object",
"properties": {
"unidadOrgId": {
"type": "string",
"description": "Identificacion de la unidad"
},
"fechaGenOrd": {
"type": "string",
"description": "Fecha Generación de orden"
},
"numeroOrden": {
"type": "number",
"description": "Fecha Generación de orden"
},
"prestacionId": {
"type": "string",
"description": "Campo que inidica el identificador de prestación."
},
"descripcionPrestacion": {
"type": "string",
"description": "Indica la descripción de la prestación."
},
"cantidadPrestacion": {
"type": "number",
"description": "Campo donde se establece la cantidad de la prestación."
},
"estado": {
"type": "string",
"description": "Indica el estado de la orden."
},
"codigoEspecialidad": {
"type": "number",
"description": "Indica el codigo de especialidad."
},
"descripcionEspecialidad ": {
"type": "number",
"description": "Campo que indica la descripción de la especialidad."
},
"medicoId": {
"type": "number",
"description": "Campo que indica el id del médico."
},
"pacienteId": {
"type": "number",
"description": "Identificador del paciente."
},
"AutorizacionId": {
"type": "string",
"description": "Identificador de autorización."
}
}
},
"afiliadoGrupo": {
"type": "object",
"properties": {
"tipo": {
"type": "string",
"description": "Tipo de usuario"
},
"tipoIdentificacion": {
"type": "string",
"description": "Tipo de identificación"
},
"numeroIdentificacion": {
"type": "string",
"description": "Número identificación"
},
"nombre": {
"type": "string",
"description": "NombreUsuario"
},
"parentesco": {
"type": "string",
"description": "Parentesco"
},
"fechaNacimiento": {
"type": "string",
"description": "Fecha de nacimiento"
},
"sexo": {
"type": "string",
"description": "Sexo"
},
"estado": {
"type": "string",
"description": "estado"
},
"tipoIdentificacionCotizante": {
"type": "string",
"description": "estado"
},
"numeroIdentificacionCotizante": {
"type": "string",
"description": "estado"
}
}
},
"paciente": {
"type": "object",
"properties": {
"documento": {
"$ref": "#/components/schemas/documento"
},
"tratamiento": {
"type": "string",
"description": "Tratamiento formal al paciente"
},
"nombre": {
"$ref": "#/components/schemas/nombre"
},
"categoria": {
"$ref": "#/components/schemas/categoria"
},
"ips": {
"$ref": "#/components/schemas/ips"
},
"eps": {
"$ref": "#/components/schemas/eps"
},
"preferencial": {
"type": "boolean"
},
"fechaNacimiento": {
"type": "string"
},
"genero": {
"$ref": "#/components/schemas/genero"
},
"telefono": {
"type": "string"
},
"correoElectronico": {
"type": "string"
},
"direccion": {
"$ref": "#/components/schemas/direccion"
}
}
},
"reservaSinOrdenpaciente": {
"type": "object",
"required": [
"codigo"
],
"properties": {
"codigo": {
"type": "string",
"description": "Paciente"
}
}
},
"genero": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Representa el codigo de género"
},
"descripcion": {
"type": "string",
"description": "representa la descripción"
}
}
},
"pais": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Especifica el id del país"
},
"nombre": {
"type": "string",
"description": "Especifica el nombre del país"
}
}
},
"departamento": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Especifica el id del departamento"
},
"nombre": {
"type": "string",
"description": "Especifica el nombre del departamento"
}
}
},
"ciudad": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Especifica el id de la ciudad"
},
"nombre": {
"type": "string",
"description": "Especifica el nombre de la ciudad"
}
}
},
"localidad": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Especifica el id de la localidad"
},
"nombre": {
"type": "string",
"description": "Especifica el nombre de la localidad"
}
}
},
"coordenadasGeograficas": {
"type": "object",
"properties": {
"latitud": {
"type": "string",
"description": "Latitud"
},
"longitud": {
"type": "string",
"description": "Longitud"
}
}
},
"direccion": {
"type": "object",
"properties": {
"pais": {
"$ref": "#/components/schemas/pais"
},
"departamento": {
"$ref": "#/components/schemas/departamento"
},
"ciudad": {
"$ref": "#/components/schemas/ciudad"
},
"localidad": {
"$ref": "#/components/schemas/localidad"
},
"coordenadasGeograficas": {
"$ref": "#/components/schemas/coordenadasGeograficas"
},
"codigoPostal": {
"type": "string",
"description": "código postal corespondiente"
},
"direccionPrincipal": {
"type": "string",
"description": "direccion principal del paciente"
},
"direccionSecundaria": {
"type": "string",
"description": "dirección secundaria"
}
}
},
"centroMedico": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Nombre del centro médico"
},
"descripcion": {
"type": "string",
"description": "Descripción del centro médico"
}
}
},
"prestacion": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "código de la prestación"
},
"descripcion": {
"type": "string",
"description": "Descripción de la prestación"
}
}
},
"actualizarSinOrden": {
"type": "object",
"required": [
"cita"
],
"properties": {
"cita": {
"$ref": "#/components/schemas/cita"
}
}
},
"multa": {
"type": "object",
"properties": {
"cita": {
"$ref": "#/components/schemas/cita"
},
"convenio": {
"$ref": "#/components/schemas/convenio"
},
"especialidad": {
"$ref": "#/components/schemas/especialidad"
},
"centroMedico": {
"$ref": "#/components/schemas/centroMedico"
},
"prestador": {
"$ref": "#/components/schemas/prestador"
},
"consultorio": {
"type": "string",
"description": "Nombre del consultorio"
},
"prestacion": {
"$ref": "#/components/schemas/prestacion"
},
"numeroOrden": {
"type": "number",
"description": "Número de la orden"
},
"documentoContable": {
"type": "string",
"description": "Define del documento contable"
}
}
},
"crearCitaSinOrdenR": {
"type": "object",
"required": [
"cita"
],
"properties": {
"cita": {
"$ref": "#/components/schemas/crearCitaSinOrdenResp"
}
}
},
"crearCitaSinOrdenResp": {
"type": "object",
"required": [
"idReserva"
],
"properties": {
"idReserva": {
"type": "string",
"description": "Id reserva"
},
"valor": {
"type": "string",
"description": "Valor de la cita"
}
}
},
"crearCitaSinOrdenResponse": {
"type": "object",
"required": [
"resultado",
"creacionSinOrden"
],
"properties": {
"resultado": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"creacionSinOrden": {
"$ref": "#/components/schemas/crearCitaSinOrdenR"
}
}
},
"borrarSinOrden": {
"type": "object",
"required": [
"cita"
],
"properties": {
"cita": {
"$ref": "#/components/schemas/cita"
}
}
},
"reservarSinOrden": {
"type": "object",
"required": [
"cita"
],
"properties": {
"cita": {
"$ref": "#/components/schemas/cita"
}
}
},
"reservaSinOrden": {
"type": "object",
"required": [
"prestador",
"paciente",
"tipoPlanificacion",
"unidadTratamiento"
],
"properties": {
"cita": {
"$ref": "#/components/schemas/reservarSinOrdencita"
},
"prestador": {
"$ref": "#/components/schemas/reservaSinOrdenprestador"
},
"paciente": {
"$ref": "#/components/schemas/reservaSinOrdenpaciente"
},
"tipoPlanificacion": {
"type": "string",
"description": "Tipo planificación"
},
"unidadTratamiento": {
"type": "string",
"description": "Unidad de tratamiento"
},
"eps": {
"type": "string",
"description": "EPS"
}
}
},
"borrarConOrden": {
"type": "object",
"required": [
"cita"
],
"properties": {
"cita": {
"$ref": "#/components/schemas/borrarCitaConOrdencita"
}
}
},
"borrarCitaConOrdencita": {
"type": "object",
"required": [
"idReserva",
"idOrden"
],
"properties": {
"idReserva": {
"type": "string",
"description": "Número de la reserva"
},
"idOrden": {
"type": "string",
"description": "Numero de orden"
}
}
},
"crearCitaConOrden": {
"type": "object",
"required": [
"ordenId",
"citaId"
],
"properties": {
"ordenId": {
"type": "number",
"description": "Id de orden"
},
"citaId": {
"type": "number",
"description": "Id de cita"
},
"citaDesistir": {
"type": "string",
"description": "Desistir de la cita"
}
}
},
"epsResultado": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id de la EPS"
},
"nombre": {
"type": "string",
"description": "Nombre de la EPS"
}
},
"xml": {
"name": "eps"
}
},
"reservaConOrden": {
"type": "object",
"required": [
"fechaHora",
"especialidadId",
"prestadorId",
"pacienteId",
"tipoPlanificacionId",
"ordenId",
"unidadPlanificada",
"numeroPrestacion"
],
"properties": {
"fechaHora": {
"type": "string",
"description": "Fecha reserva"
},
"especialidadId": {
"type": "number",
"description": "Especialidad"
},
"prestadorId": {
"type": "number",
"description": "Id Prestador"
},
"pacienteId": {
"type": "number",
"description": "Id paciente"
},
"epsParticular": {
"type": "string",
"description": "Eps particular"
},
"tipoPlanificacionId": {
"type": "string",
"description": "Id tipo planificación"
},
"ordenId": {
"type": "number",
"description": "Id orden"
},
"unidadPlanificada": {
"type": "string",
"description": "Unidad planificada"
},
"numeroPrestacion": {
"type": "string",
"description": "Número prestación"
}
}
},
"actualizarCitaRequest": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"actualizarSinOrden": {
"$ref": "#/components/schemas/actualizarSinOrden"
}
}
},
"borrarCitaRequest": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"borrarSinOrden": {
"$ref": "#/components/schemas/borrarSinOrden"
}
}
},
"reservarCitaRequest": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"reservarSinOrden": {
"$ref": "#/components/schemas/reservarSinOrden"
}
}
},
"reservaCitaSinOrdenRequest": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"reservaSinOrden": {
"$ref": "#/components/schemas/reservaSinOrden"
}
}
},
"reservaCitaConOrdenRequest": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"reservaSinOrden": {
"$ref": "#/components/schemas/reservaConOrden"
}
}
},
"borrarCitaConOrdenRequest": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"borrarConOrden": {
"$ref": "#/components/schemas/borrarConOrden"
}
}
},
"crearCitaRequest": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"crearCitaConOrden": {
"$ref": "#/components/schemas/crearCitaConOrden"
}
}
},
"crearPacienteProvisionalRequest": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"Provisional": {
"$ref": "#/components/schemas/paciente"
}
}
},
"crearCitaSinOrdenRequest": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"crearCitaSinOrden": {
"$ref": "#/components/schemas/crearCitaSinOrden"
}
}
},
"crearCitaSinOrden": {
"type": "object",
"required": [
"cita"
],
"properties": {
"cita": {
"$ref": "#/components/schemas/crearCitaSinOrdenCita"
}
}
},
"crearCitaSinOrdenCita": {
"type": "object",
"required": [
"idReserva"
],
"properties": {
"idReserva": {
"type": "string",
"description": "Id de la reserva"
},
"desistir": {
"type": "string",
"description": "Desistir de la cita"
}
}
},
"validadorAfiliadoSaludResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"afiliado": {
"$ref": "#/components/schemas/afiliado"
}
}
},
"consultarEpsResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"eps": {
"$ref": "#/components/schemas/epsResultado"
}
}
},
"actualizarCitaResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
}
}
},
"borrarCitaResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
}
}
},
"citaHorarioResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
}
}
},
"borrarCitaConOrdenResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
}
}
},
"busquedaCitaPorMedicoResponse": {
"type": "object",
"required": [
"resultados",
"cita"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"cita": {
"type": "array",
"items": {
"$ref": "#/components/schemas/busquedaCitaPorMedicoCita"
}
}
}
},
"consultarCitaResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
}
}
},
"reservarCitaResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
}
}
},
"reservarCitaSinOrdenResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
}
}
},
"disponibilidadCitasResponse": {
"type": "object",
"required": [
"resultado"
],
"properties": {
"resultado": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
}
}
},
"crearCitaResponse": {
"type": "object",
"required": [
"resultado"
],
"properties": {
"resultado": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
}
}
},
"consultaGrupoFamiliarResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"grupoFamiliar": {
"$ref": "#/components/schemas/afiliadoGrupo"
}
}
},
"especialidadPorPacienteResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"especialidad": {
"$ref": "#/components/schemas/especialidad"
}
}
},
"consultaOrdenesResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"ordenesClinicas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ordenesClinicas"
}
}
}
},
"medicoTratanteResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"prestador": {
"type": "array",
"items": {
"$ref": "#/components/schemas/prestador"
}
}
}
},
"convenioPacienteResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"Convenio": {
"$ref": "#/components/schemas/afiliacion"
}
}
},
"detallePacienteResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"paciente": {
"$ref": "#/components/schemas/paciente"
}
}
},
"crearPacienteResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
}
}
},
"consultaMultasResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"Multa": {
"type": "array",
"items": {
"$ref": "#/components/schemas/multa"
}
}
}
},
"consultaIpsAdscritaResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"ips": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ips"
}
}
}
}
},
"requestBodies": {
"actualizarCitaRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/actualizarCitaRequest"
}
}
},
"description": "Información de la cita a actualizar",
"required": true
},
"crearCitaSinOrdenRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/crearCitaSinOrdenRequest"
}
}
},
"description": "Crear cita sin orden",
"required": true
},
"borrarCitaRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/borrarCitaRequest"
}
}
},
"description": "Información de la cita a actualizar",
"required": true
},
"reservarCitaRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/reservarCitaRequest"
}
}
},
"description": "Información de la cita",
"required": true
},
"borrarCitaConOrdenRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/borrarCitaConOrdenRequest"
}
}
},
"description": "Información de la cita a borrar con orden",
"required": true
},
"reservaCitaSinOrdenRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/reservaCitaSinOrdenRequest"
}
}
},
"description": "Reservar cita sin orden",
"required": true
},
"reservarCitaConOrdenRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/reservaCitaConOrdenRequest"
}
}
},
"description": "Reservar cita sin orden",
"required": true
},
"crearCitaRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/crearCitaRequest"
}
}
},
"description": "Reservar cita sin orden",
"required": true
},
"pacienteProvisionalRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/crearPacienteProvisionalRequest"
}
}
},
"description": "Actualizar paciente",
"required": true
}
},
"securitySchemes": {
"apigee_auth": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://colsubsidio-test.apigee.net/oauth/client_credential/accesstoken?grant_type=client_credentials",
"scopes": {
"write:apigee": "Permisos de escritura",
"read:apigee": "Permisos de lectura"
}
}
}
}
}
}
}