{
"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",
"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/reservarCitaResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
],
"requestBody": {
"$ref": "#/components/requestBodies/reservaCitaRequestBody"
}
}
},
"/v2/salud/citas{a}": {
"get": {
"tags": [
"cols-salud-cita"
],
"summary": "Consultar cita",
"description": "Obtener información cita",
"operationId": "consultarCita",
"parameters": [
{
"name": "a",
"in": "path",
"description": "El campo solo es de prueba, para evitar problemas de duplicado",
"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{b}": {
"get": {
"tags": [
"cols-salud-cita"
],
"summary": "Disponibilidad citas",
"description": "Obtener información disponibilidad citas",
"operationId": "disponibilidadCitas",
"parameters": [
{
"name": "b",
"in": "path",
"description": "El campo solo es de prueba, para evitar problemas de duplicado",
"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"
]
}
]
}
}
},
"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"
}
},
"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",
"required": [
"idReserva"
],
"properties": {
"idReserva": {
"type": "string",
"description": "Número de la reserva"
},
"desistir": {
"type": "string",
"description": "Si se desiste de asistir a la cita"
}
}
},
"prestador": {
"type": "object",
"required": [
"codigo"
],
"properties": {
"codigo": {
"type": "number",
"description": "Prestador"
}
}
},
"paciente": {
"type": "object",
"required": [
"codigo"
],
"properties": {
"codigo": {
"type": "number",
"description": "Paciente"
}
}
},
"actualizarSinOrden": {
"type": "object",
"required": [
"cita"
],
"properties": {
"cita": {
"$ref": "#/components/schemas/cita"
}
}
},
"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": {
"prestador": {
"$ref": "#/components/schemas/prestador"
},
"paciente": {
"$ref": "#/components/schemas/paciente"
},
"tipoPlanificacion": {
"type": "string",
"description": "Tipo planificación"
},
"unidadTratamiento": {
"type": "string",
"description": "Unidad de tratamiento"
},
"eps": {
"type": "string",
"description": "EPS"
}
}
},
"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"
}
}
},
"reservaCitaRequest": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"reservaSinOrden": {
"$ref": "#/components/schemas/reservaSinOrden"
}
}
},
"validadorAfiliadoSaludResponse": {
"type": "object",
"required": [
"resultados"
],
"properties": {
"resultados": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"afiliado": {
"$ref": "#/components/schemas/afiliado"
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"disponibilidadCitasResponse": {
"type": "object",
"required": [
"resultado"
],
"properties": {
"resultado": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
}
}
}
},
"requestBodies": {
"actualizarCitaRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/actualizarCitaRequest"
}
}
},
"description": "Información de la cita a actualizar",
"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
},
"reservaCitaRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/reservaCitaRequest"
}
}
},
"description": "Reservar cita sin orden",
"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"
}
}
}
}
}
}
}