{
"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": {
"get": {
"tags": [
"cols-salud-cita"
],
"summary": "Consultar cita por identificación",
"description": "Obtener información cita",
"operationId": "consultarCita",
"parameters": [
{
"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"
]
}
]
},
"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"
}
},
"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/horario": {
"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": "Id del paciente",
"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"
]
}
]
}
},
"/v2/salud/citas/disponibilidad": {
"get": {
"tags": [
"cols-salud-cita"
],
"summary": "Disponibilidad citas",
"description": "Obtener información disponibilidad citas",
"operationId": "disponibilidadCitas",
"parameters": [
{
"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/prestador": {
"get": {
"tags": [
"cols-salud-cita"
],
"summary": "Disponibilidad citas",
"description": "Obtener información disponibilidad citas",
"operationId": "busquedaCitaPorMedico",
"parameters": [
{
"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/salud/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": {
"get": {
"tags": [
"cols-salud-paciente"
],
"summary": "Consulta de datos del paciente",
"description": "Servicio de consulta de datos de paciente, buscando por tipo de identificación y número de identificación.",
"operationId": "getDatosPacientePorDocumento",
"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/getDatosPacientePorDocumentoResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
},
"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"
}
}
},
"/v2/salud/citas/condicionamiento": {
"get": {
"tags": [
"cols-salud-cita"
],
"summary": "Consulta de condicionamiento de citas.",
"description": "Obtener informacion de condicionamiento de especialidad en citas.",
"operationId": "obtenerCondicionamientoCita",
"parameters": [
{
"name": "pacienteId",
"in": "query",
"description": "Numero de identificacion del paciente.",
"required": true,
"schema": {
"type": "number"
}
},
{
"name": "convenio",
"in": "query",
"description": "Numero de convenio.",
"required": true,
"schema": {
"type": "number"
}
},
{
"name": "edad",
"in": "query",
"description": "Edad del paciente.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "genero",
"in": "query",
"description": "Envio de genero del paciente.
Genero | Descripcion |
---|---|
M | Masculino |
F | Femenino |