{
"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 Medicamentos Afiliado.",
"version": "2.0.0",
"title": "Medicamentos Afiliado",
"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-medicamentos-validacion",
"description": "Validacion de pacientes"
}
],
"paths": {
"/v1/medicamentos/validaciones/{eps}": {
"get": {
"tags": [
"cols-medicamentos-validacion"
],
"summary": "Validar paciente",
"description": "Obtener informacion de los pacientes",
"operationId": "validadorDerechoMedicamentos",
"parameters": [
{
"name": "eps",
"in": "path",
"description": "Nombre EPSs.
neps - Nueva EPS",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tipoId",
"in": "query",
"description": "Tipo de identificacion.
1. CE - Cédula de extranjería
2. TI - Tarjeta de identidad
3. CC - Cédula de ciudadanía
4. NIT - NIT
5. RC - Registro civil de nacimiento
6. PS - Pasaporte
7. ME - Menor de edad
8. NU - NUIP
9. AS - Adulto sin identificación
10. CD - Carné diplomático
11. CN - Recién nacido vivo
12. SC - Salvoconducto
13. PE - Permiso especial",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "numId",
"in": "query",
"description": "Número de documento de identificación del afiliado a consultar.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/validadorDerechoMedicamentosResponse"
}
}
}
},
"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"
},
"completo": {
"type": "string",
"description": "Nombre Completo"
}
},
"xml": {
"name": "nombre"
}
},
"categoria": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Código de la categoría"
},
"sigla": {
"type": "string",
"description": "Sigla de la categoría"
}
},
"xml": {
"name": "categoria"
}
},
"sede": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Codigo de la sede"
},
"nombre": {
"type": "string",
"description": "Nombre de la sede"
}
},
"xml": {
"name": "ips"
}
},
"ips": {
"type": "object",
"properties": {
"sede": {
"$ref": "#/components/schemas/ciudad"
},
"codigo": {
"type": "string",
"description": "Codigo de ips"
},
"nombre": {
"type": "string",
"description": "Nombre de ips"
}
},
"xml": {
"name": "ips"
}
},
"tipo": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Codigo del tipo paciente"
},
"descripcion": {
"type": "string",
"description": "Descripcion del tipo paciente"
}
},
"xml": {
"name": "ips"
}
},
"estado": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Codigo del estado"
},
"descripcion": {
"type": "string",
"description": "Descripcion del estado"
}
},
"xml": {
"name": "estado"
}
},
"convenio": {
"type": "object",
"properties": {
"nombre": {
"type": "string",
"description": "Nombre"
}
},
"xml": {
"name": "convenio"
}
},
"exento": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Descripcion de exento"
},
"tipo": {
"type": "string",
"description": "Tipo de exento"
}
},
"xml": {
"name": "exento"
}
},
"genero": {
"type": "object",
"properties": {
"descripcion": {
"type": "string",
"description": "Descripcion del genero -M -F"
}
},
"xml": {
"name": "genero"
}
},
"nacimiento": {
"type": "object",
"properties": {
"fecha": {
"type": "string",
"description": "Fecha de nacimiento"
}
},
"xml": {
"name": "nacimiento"
}
},
"ciudad": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Codigo de ciudad"
},
"nombre": {
"type": "string",
"description": "Nombre de ciudad"
}
},
"xml": {
"name": "ciudad"
}
},
"departamento": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Codigo de departamento"
},
"nombre": {
"type": "string",
"description": "Nombre de departamento"
}
},
"xml": {
"name": "departamento"
}
},
"municipio": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Codigo de municipio"
},
"nombre": {
"type": "string",
"description": "Nombre de municipio"
}
},
"xml": {
"name": "municipio"
}
},
"direccion": {
"type": "object",
"properties": {
"direccionPrincipal": {
"type": "string",
"description": "Fecha de nacimiento"
},
"ciudad": {
"$ref": "#/components/schemas/ciudad"
},
"departamento": {
"$ref": "#/components/schemas/departamento"
},
"municipio": {
"$ref": "#/components/schemas/municipio"
}
},
"xml": {
"name": "direccion"
}
},
"vigencia": {
"type": "object",
"properties": {
"inicio": {
"type": "string",
"description": "Fecha de inicio de vigencia"
},
"fin": {
"type": "string",
"description": "Fecha de fin de vigencia"
}
},
"xml": {
"name": "vigencia"
}
},
"nombrePrestador": {
"type": "object",
"properties": {
"completo": {
"type": "string",
"description": "Nombre del medico"
}
},
"xml": {
"name": "nombrePrestador"
}
},
"ipsPrestador": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Codigo Ips prestadora"
},
"nombre": {
"type": "string",
"description": "Nombre Ips prestadora"
}
},
"xml": {
"name": "ipsPrestador"
}
},
"desicion": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Codigo de desicion"
},
"descripcion": {
"type": "string",
"description": "Descripcion de desicion"
}
},
"xml": {
"name": "desicion"
}
},
"cobertura": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "Codigo de cobertura"
},
"descripcion": {
"type": "string",
"description": "Descripcion de cobertura"
}
},
"xml": {
"name": "cobertura"
}
},
"prestador": {
"type": "object",
"properties": {
"nombre": {
"$ref": "#/components/schemas/nombrePrestador"
},
"ips": {
"$ref": "#/components/schemas/ipsPrestador"
},
"desicion": {
"$ref": "#/components/schemas/desicion"
},
"cobertura": {
"$ref": "#/components/schemas/cobertura"
},
"codigo": {
"type": "string",
"description": "código de la especialidad"
}
},
"xml": {
"name": "prestador"
}
},
"paciente": {
"type": "object",
"properties": {
"nombre": {
"$ref": "#/components/schemas/nombre"
},
"documento": {
"$ref": "#/components/schemas/documento"
},
"categoria": {
"$ref": "#/components/schemas/categoria"
},
"exento": {
"$ref": "#/components/schemas/exento"
},
"genero": {
"$ref": "#/components/schemas/genero"
},
"nacimiento": {
"$ref": "#/components/schemas/nacimiento"
},
"direccion": {
"$ref": "#/components/schemas/direccion"
},
"vigencia": {
"$ref": "#/components/schemas/vigencia"
},
"ips": {
"$ref": "#/components/schemas/ips"
},
"estado": {
"$ref": "#/components/schemas/estado"
},
"tipo": {
"$ref": "#/components/schemas/tipo"
},
"edad": {
"type": "string",
"description": "edad del paciente"
},
"codigo": {
"type": "string",
"description": "Codigo del paciente"
},
"telefono": {
"type": "string",
"description": "Telefono del paciente"
},
"celular": {
"type": "string",
"description": "Celular del paciente"
},
"email": {
"type": "string",
"description": "Email del paciente"
},
"regimen": {
"type": "string",
"description": "Eegimen del paciente"
},
"semanasCotizadas": {
"type": "string",
"description": "Semanas cotizadas del paciente"
},
"convenio": {
"type": "string",
"description": "Convenio del paciente"
},
"fechaAntifuedad": {
"type": "string",
"description": "Fecha de antifuedad del paciente"
},
"preferencial": {
"type": "string",
"description": "Preferencial del paciente"
}
}
},
"empresa": {
"type": "object",
"properties": {
"documento": {
"$ref": "#/components/schemas/documento"
},
"nombre": {
"type": "string",
"description": "Nombre de la empresa"
}
}
},
"parentesco": {
"type": "object",
"properties": {
"tipo": {
"type": "string",
"description": "Tipo de parentesco"
},
"documento": {
"$ref": "#/components/schemas/documento"
}
}
},
"plan": {
"type": "object",
"properties": {
"descripcion": {
"type": "string",
"description": "Descripcion del plan"
},
"codigo": {
"type": "string",
"description": "Codigo del plan"
},
"nombre": {
"type": "string",
"description": "Nombre del plan"
}
}
},
"contrato": {
"type": "object",
"properties": {
"numero": {
"type": "string",
"description": "Numero de contrato"
},
"perioricidad": {
"type": "string",
"description": "Perioricidad del contrato"
},
"medioPago": {
"type": "string",
"description": "Tipo de parentesco"
},
"plan": {
"$ref": "#/components/schemas/plan"
}
}
},
"comprobacion": {
"type": "object",
"properties": {
"numero": {
"type": "string",
"description": "Numero de comprobacion"
},
"fecha": {
"type": "string",
"description": "fecha de comprobacion"
}
}
},
"eps": {
"type": "object",
"properties": {
"documento": {
"$ref": "#/components/schemas/documento"
},
"nombre": {
"type": "string",
"description": "Nombre Eps"
}
}
},
"obtenerPaciente": {
"type": "object",
"properties": {
"paciente": {
"$ref": "#/components/schemas/paciente"
},
"prestador": {
"$ref": "#/components/schemas/prestador"
},
"empresa": {
"$ref": "#/components/schemas/empresa"
},
"parentesco": {
"$ref": "#/components/schemas/parentesco"
},
"contrato": {
"$ref": "#/components/schemas/contrato"
},
"comprobacion": {
"$ref": "#/components/schemas/comprobacion"
},
"eps": {
"$ref": "#/components/schemas/eps"
},
"derechoServicio": {
"type": "string",
"description": "Derecho de servicio"
}
}
},
"validadorDerechoMedicamentosResponse": {
"type": "object",
"required": [
"resultado"
],
"properties": {
"resultado": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"obtenerPaciente": {
"type": "array",
"items": {
"$ref": "#/components/schemas/obtenerPaciente"
}
}
}
}
},
"requestBodies": {},
"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"
}
}
}
}
}
}
}