{ "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": "neps-medicamentos-afiliados", "description": "Validacion de pacientes de Nueva EPS" }, { "name": "quick-medicamentos-domicilios", "description": "Servicio de gestión de domicilio de medicamentos" }, { "name": "sura-medicamentos-afiliados", "description": "Validación de pacientes de Sura" }, { "name": "fami-medicamentos-afiliados", "description": "Validación de pacientes de Famisanar En construccion" }, { "name": "coom-medicamentos-afiliados", "description": "Validación de pacientes de Coomeva En construccion" } ], "paths": { "/v1/medicamentos/afiliados/neps/consulta": { "get": { "tags": [ "neps-medicamentos-afiliados" ], "summary": "Validar paciente", "description": "Obtener informacion de los pacientes para la aseguradora NEPS", "operationId": "validadorDerechoMedicamentosNEPS", "parameters": [ { "name": "tipoId", "in": "query", "description": "
Nueva EPS
Tipo de identificación Descripción
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/validadorDerechoMedicamentosNEPSResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v1/medicamentos/afiliados/sura/consulta": { "get": { "tags": [ "sura-medicamentos-afiliados" ], "summary": "Validar paciente de Sura", "description": "Obtener informacion de los pacientes para la aseguradora NEPS", "operationId": "validadorDerechoMedicamentosSura", "parameters": [ { "name": "tipoId", "in": "query", "description": "
Sura
Tipo de identificación Descripción
C Cédula
N NIT
E Cédula de extranjería
P
R Registro civil de nacimiento
", "required": true, "schema": { "type": "string", "enum":[C,N,E,P,R] } }, { "name": "numId", "in": "query", "description": "Número de documento de identificación del afiliado a consultar.", "required": true, "schema": { "type": "string" } }, { "name": "codigoProducto", "in": "query", "description": "
Código de productos
Código Nombre
<vacío> Todos los productos
06 PAC – Plan complementario
03 Medicina prepagada
15 Póliza de salud
", "required": false, "schema": { "type": "string", "enum":['06','03','15'] } }, { "name": "amparos", "in": "query", "description": "Consulta los amparos del asegurado en cada contrato.", "required": false, "schema": { "type": "boolean" } }, { "name": "emi", "in": "query", "description": "Valida el derecho a EMI del asegurado en cada contrato", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validadorDerechoMedicamentosSuraResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v1/medicamentos/afiliados/fami/consulta": { "get": { "tags": [ "fami-medicamentos-afiliados" ], "summary": "Validar paciente de Famisanar", "description": "Obtener informacion de los pacientes para la aseguradora Famisanar", "operationId": "validadorDerechoMedicamentosFamisanar", "parameters": [ { "name": "tipoId", "in": "query", "description": "Tipo de documento de identificacion, ejemplo: CC", "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/validadorDerechoMedicamentosFamisanarResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v1/medicamentos/afiliados/coom/consulta": { "get": { "tags": [ "coom-medicamentos-afiliados" ], "summary": "Validar paciente de Coomeva", "description": "Obtener informacion de los pacientes para la aseguradora Coomeva", "operationId": "validadorDerechoMedicamentosCoomeva", "parameters": [ { "name": "tipoId", "in": "query", "description": "Tipo de documento de identificacion, ejemplo: CC", "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/validadorDerechoMedicamentosCoomevaResponse" } } } }, "400": { "description": "Estado inválido" } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v1/medicamentos/domicilio/cobertura": { "get": { "tags": [ "quick-medicamentos-domicilios" ], "summary": "Solicitud de cobertura", "description": "Permite validar si Quick tiene cobertura en una dirección y ciudad.", "operationId": "solicitudCobertuta", "parameters": [ { "name": "ciudad", "in": "query", "description": "Ciudad para consultar cobertura.", "required": true, "schema": { "type": "string" } }, { "name": "direccion", "in": "query", "description": "Dirección para consultar cobertura.", "required": true, "schema": { "type": "string" } }, { "name": "x-usuario", "in": "header", "description": "Objeto con usuario y clave en base64 Ej = Basic Base64(usuario:clave).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generalQuick" } } } } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] } }, "/v1/medicamentos/domicilio": { "post": { "tags": [ "quick-medicamentos-domicilios" ], "summary": "Crear guia", "description": "Se crea servicio en la plataforma SmarQuick para el control y gestion del domicilio.", "operationId": "crearGuia", "requestBody": { "$ref": "#/components/requestBodies/crearGuiaRequestBody" }, "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generalQuick" } } } } }, "security": [ { "apigee_auth": [ "write:apigee", "read:apigee" ] } ] }, "get": { "tags": [ "quick-medicamentos-domicilios" ], "summary": "Consultar guia", "description": "Permite consultar guia a partir del numero de guia. Consulta contra SmartQuick.", "operationId": "consultarGuia", "parameters": [ { "name": "numeroGuia", "in": "query", "description": "Numero de guia.", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "Operación exitosa", "content": { "application/json": { "schema": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultadoQuick" } }, "consultarGuia": { "type": "array", "items": { "$ref": "#/components/schemas/consultarGuia" } } } } } } } }, "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": { "resultadoQuick": { "description": "Objeto de resultado específico para la plataforma SmarQuick", "type": "object", "properties": { "codigo": { "type": "string", "description": "Código del resultado" }, "descripcion": { "type": "string", "description": "Descripción del resultado" }, "valorTotal": { "type": "number", "description": "Valor total" }, "direccion": { "type": "string", "description": "Dirección no encontrada" } }, "required": [ "valorTotal codigo descripcion" ] }, "generalQuick": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultadoQuick" } } } }, "crearGuiaRequest": { "type": "object", "properties": { "informacionPersonal": { "type": "object", "description": "Código del resultado", "properties": { "nombre": { "$ref": "#/components/schemas/nombreRequestQuick" }, "documento": { "$ref": "#/components/schemas/documentoRequestQuick" }, "residencia": { "$ref": "#/components/schemas/residenciaRequestQuick" } } }, "envio": { "type": "object", "properties": { "guia": { "$ref": "#/components/schemas/guia" }, "entrega": { "$ref": "#/components/schemas/entrega" }, "pago": { "$ref": "#/components/schemas/pago" }, "observacion": { "type": "string" }, "negocio": { "type": "string" }, "usuario": { "type": "string" } } } } }, "nombreRequestQuick": { "type": "object", "description": "Informacion del nombre del receptor", "properties": { "completo": { "type": "string", "description": "Nombre completo de recptor" } } }, "documentoRequestQuick": { "type": "object", "description": "Informacion del documento del receptor", "properties": { "numero": { "type": "number", "description": "Numero de identificacion del receptor" } } }, "residenciaRequestQuick": { "type": "object", "description": "Informacion de residencia del receptor", "properties": { "ciudad": { "type": "object", "description": "Informacion de la ciudad del recptor", "properties": { "nombre": { "type": "string", "description": "Nombre de la ciudad de envio" } } }, "direccion": { "type": "object", "description": "Informacion de la direccion", "properties": { "direccionPrincipal": { "type": "string", "description": "Direccion del receptor" } } }, "telefono": { "type": "number", "description": "Telefono del receptor" } } }, "consultarGuia": { "type": "object", "properties": { "direccion": { "$ref": "#/components/schemas/direccion" }, "envio": { "type": "object", "description": "Informacion del envio", "properties": { "guia": { "type": "object", "description": "Informacion de guia", "properties": { "numero": { "type": "string", "description": "Numero de guia del envio" }, "imei": { "type": "string", "description": "Numero identificacion del envio" }, "fechaCreacion": { "type": "string", "description": "Fecha de creacion de la guia" } } }, "fechaRecibido": { "type": "string", "description": "Fecha de recibido del envio" }, "fechaLlegada": { "type": "string", "description": "Fecha de llegada del transporte" }, "fechaCierre": { "type": "string", "description": "Fecha de cierre del envio" }, "estado": { "type": "string", "description": "Estado del envio" }, "novedad": { "type": "string", "description": "Novedad del envio" } } }, "informacionPersonal": { "type": "object", "description": "Informacion del conductor", "properties": { "nombre": { "type": "string", "description": "Nombre del transportista" }, "foto": { "type": "string", "description": "Foto del transportista" } } } } }, "guia": { "type": "object", "description": "Informacion de la guia", "properties": { "numero": { "type": "number", "description": "Numero de guia del envio" } } }, "entrega": { "type": "object", "description": "Informacion de la entrega", "properties": { "fecha": { "type": "string", "description": "Fecha de entrega del envio" }, "hora": { "type": "string", "description": "Hora de entrega del envio" } } }, "pago": { "type": "object", "description": "Informacion del pago", "properties": { "forma": { "type": "string", "description": "Forma de pago del receptor" }, "valor": { "type": "string", "description": "Valor a pagar por el receptor" }, "cuentaVenta": { "type": "string", "description": "Por cual plataforma compro el recptor" } } }, "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/sede" }, "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" } }, "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", "format":"date-time" } }, "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": "Dirección principal" }, "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" } }, "decision": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Codigo de decisión" }, "descripcion": { "type": "string", "description": "Descripcion de decisión" } }, "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" }, "decision": { "$ref": "#/components/schemas/decision" }, "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" }, "fechaAntiguedad": { "type": "string", "description": "Fecha de antigedad 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" }, "fechaContinuidad": { "type": "string", "description": "Fecha de continuidad", "format":"date-time" }, "plan": { "$ref": "#/components/schemas/plan" }, "ramo": { "$ref": "#/components/schemas/ramo" }, "servicio": { "$ref": "#/components/schemas/servicio" }, "estado": { "$ref": "#/components/schemas/estado" }, "asesor": { "$ref": "#/components/schemas/asesor" }, "vigencia": { "$ref": "#/components/schemas/vigencia" }, "anexo": { "type": "array", "xml": { "name": "contrato" }, "items": { "$ref": "#/components/schemas/anexo" } }, "afiliado": { "$ref": "#/components/schemas/afiliado" }, "amparo": { "type": "string", "description": "Información del amparo" } } }, "afiliado": { "type": "object", "properties": { "nombre": { "$ref": "#/components/schemas/nombre" }, "documento": { "$ref": "#/components/schemas/documento" } } }, "anexo": { "type": "object", "properties": { "tipo": { "type":"string", "description":"Tipo de anexo" }, "estado": { "type":"boolean", "description":"Estado del anexo" } } }, "asesor": { "type": "object", "properties": { "nombre": { "$ref": "#/components/schemas/nombre" } } }, "ramo": { "type": "object", "properties": { "codigo": { "type":"string", "description":"Código del ramo" }, "tipo": { "type":"string", "description":"Tipo del ramo" } } }, "servicio": { "type": "object", "properties": { "codigo": { "type":"string", "description":"Código del servicio" }, "nombre": { "type":"string", "description":"Nombre del servicio" } } }, "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": { "type": "array", "xml": { "name": "contrato" }, "items": { "$ref": "#/components/schemas/contrato" } }, "comprobacion": { "$ref": "#/components/schemas/comprobacion" }, "eps": { "$ref": "#/components/schemas/eps" } } }, "validadorDerechoMedicamentosNEPSResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "obtenerPaciente": { "type": "array", "items": { "$ref": "#/components/schemas/obtenerPaciente" } } } }, "validadorDerechoMedicamentosSuraResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "obtenerPaciente": { "type": "array", "items": { "$ref": "#/components/schemas/obtenerPaciente" } } } }, "validadorDerechoMedicamentosFamisanarResponse": { "type": "object", "required": [ "resultado" ], "properties": { "resultado": { "type": "array", "xml": { "name": "resultado" }, "items": { "$ref": "#/components/schemas/resultado" } }, "obtenerPaciente": { "type": "array", "items": { "$ref": "#/components/schemas/obtenerPaciente" } } } }, "validadorDerechoMedicamentosCoomevaResponse": { "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": { "crearGuiaRequestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/crearGuiaRequest" } } }, "description": "Crear 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" } } } } } } }