diff --git a/apigee/salud-eps.json b/apigee/salud-eps.json index dac0eeb..a7bf8a5 100644 --- a/apigee/salud-eps.json +++ b/apigee/salud-eps.json @@ -6,12 +6,12 @@ "url": "https://colsubsidio-test.apigee.net/api" }, { - "description": "Producción", + "description": "Producci—n", "url": "https://colsubsidio-prod.apigee.net/api" } ], "info": { - "description": "Información de los servicios del producto EPS salud.", + "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", @@ -30,7 +30,7 @@ }, { "name": "cols-salud-cita", - "description": "Administración de citas" + "description": "Administraci—n de citas" }, { "name": "cols-salud-eps", @@ -56,7 +56,7 @@ "cols-salud-afiliado" ], "summary": "Validador afiliado", - "description": "Obtener información de los afiliados de salud", + "description": "Obtener informaci—n de los afiliados de salud", "operationId": "validadorAfiliadoSalud", "parameters": [ { @@ -71,7 +71,7 @@ { "name": "numId", "in": "query", - "description": "Número de identificación", + "description": "Nœmero de identificaci—n", "required": true, "schema": { "type": "string" @@ -80,7 +80,7 @@ { "name": "asociado", "in": "query", - "description": "Es un asociado o no
1 - Sí
0 - No", + "description": "Es un asociado o no
1 - S’
0 - No", "required": true, "schema": { "type": "string" @@ -89,7 +89,7 @@ { "name": "cesan", "in": "query", - "description": "Empresa en la que tiene la cesantías", + "description": "Empresa en la que tiene la cesant’as", "required": false, "schema": { "type": "string" @@ -98,7 +98,7 @@ ], "responses": { "200": { - "description": "Operación exitosa", + "description": "Operaci—n exitosa", "content": { "application/json": { "schema": { @@ -108,7 +108,7 @@ } }, "400": { - "description": "Estado inválido" + "description": "Estado inv‡lido" } }, "security": [ @@ -127,11 +127,11 @@ "cols-salud-cita" ], "summary": "Actualizar cita sin orden", - "description": "Realizar actualización de una cita", + "description": "Realizar actualizaci—n de una cita", "operationId": "actualizarCita", "responses": { "200": { - "description": "Operación exitosa", + "description": "Operaci—n exitosa", "content": { "application/json": { "schema": { @@ -141,7 +141,7 @@ } }, "400": { - "description": "Estado inválido" + "description": "Estado inv‡lido" } }, "security": [ @@ -165,7 +165,7 @@ "operationId": "borrarCita", "responses": { "200": { - "description": "Operación exitosa", + "description": "Operaci—n exitosa", "content": { "application/json": { "schema": { @@ -175,7 +175,7 @@ } }, "400": { - "description": "Estado inválido" + "description": "Estado inv‡lido" } }, "security": [ @@ -195,7 +195,7 @@ "cols-salud-cita" ], "summary": "Cita horario", - "description": "Obtener información cita horario", + "description": "Obtener informaci—n cita horario", "operationId": "citaHorario", "parameters": [ { @@ -246,7 +246,7 @@ { "name": "planificacion", "in": "query", - "description": "Planificación", + "description": "Planificaci—n", "required": false, "schema": { "type": "string" @@ -264,7 +264,7 @@ ], "responses": { "200": { - "description": "Operación exitosa", + "description": "Operaci—n exitosa", "content": { "application/json": { "schema": { @@ -274,7 +274,7 @@ } }, "400": { - "description": "Estado inválido" + "description": "Estado inv‡lido" } }, "security": [ @@ -295,17 +295,17 @@ "operationId": "reservarCitaSinOrden", "responses": { "200": { - "description": "Operación exitosa", + "description": "Operaci—n exitosa", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/reservarCitaResponse" + "$ref": "#/components/schemas/reservarCitaSinOrdenResponse" } } } }, "400": { - "description": "Estado inválido" + "description": "Estado inv‡lido" } }, "security": [ @@ -317,7 +317,7 @@ } ], "requestBody": { - "$ref": "#/components/requestBodies/reservaCitaRequestBody" + "$ref": "#/components/requestBodies/reservaCitaSinOrdenRequestBody" } } }, @@ -327,13 +327,13 @@ "cols-salud-cita" ], "summary": "Consultar cita", - "description": "Obtener información 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", + "description": "El campo solo es de relleno, para evitar problemas de duplicado en la documentaci—n de Swaager", "required": true, "schema": { "type": "string" @@ -342,7 +342,7 @@ { "name": "tipoId", "in": "query", - "description": "Tipo identificación", + "description": "Tipo identificaci—n", "required": true, "schema": { "type": "string" @@ -351,7 +351,7 @@ { "name": "numId", "in": "query", - "description": "Número identificación", + "description": "Nœmero identificaci—n", "required": true, "schema": { "type": "number" @@ -360,7 +360,7 @@ ], "responses": { "200": { - "description": "Operación exitosa", + "description": "Operaci—n exitosa", "content": { "application/json": { "schema": { @@ -370,7 +370,7 @@ } }, "400": { - "description": "Estado inválido" + "description": "Estado inv‡lido" } }, "security": [ @@ -389,13 +389,13 @@ "cols-salud-cita" ], "summary": "Disponibilidad citas", - "description": "Obtener información 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", + "description": "El campo solo es de relleno, para evitar problemas de duplicado en la documentaci—n de Swaager", "required": true, "schema": { "type": "string" @@ -413,7 +413,7 @@ { "name": "medico", "in": "query", - "description": "Médico", + "description": "MŽdico", "required": false, "schema": { "type": "string" @@ -422,7 +422,7 @@ { "name": "ipsadscripcion", "in": "query", - "description": "IPS adscripción", + "description": "IPS adscripci—n", "required": false, "schema": { "type": "string" @@ -440,7 +440,7 @@ { "name": "planificacion", "in": "query", - "description": "Planificación", + "description": "Planificaci—n", "required": false, "schema": { "type": "string" @@ -467,7 +467,7 @@ ], "responses": { "200": { - "description": "Operación exitosa", + "description": "Operaci—n exitosa", "content": { "application/json": { "schema": { @@ -477,7 +477,87 @@ } }, "400": { - "description": "Estado inválido" + "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": [ @@ -500,7 +580,7 @@ "operationId": "crearCitaConOrden", "responses": { "200": { - "description": "Operación exitosa", + "description": "Operaci—n exitosa", "content": { "application/json": { "schema": { @@ -510,7 +590,7 @@ } }, "400": { - "description": "Estado inválido" + "description": "Estado inv‡lido" } }, "security": [ @@ -536,7 +616,7 @@ "operationId": "reservarCitaConOrden", "responses": { "200": { - "description": "Operación exitosa", + "description": "Operaci—n exitosa", "content": { "application/json": { "schema": { @@ -546,7 +626,7 @@ } }, "400": { - "description": "Estado inválido" + "description": "Estado inv‡lido" } }, "security": [ @@ -562,13 +642,49 @@ } } }, - "/v2/pacientes/convenio": { + "/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.", + "description": "Servicio de consulta de convenio, buscando por tipo de identificaci—n y nœmero de identificaci—n.", "operationId": "consultaConvenio", "parameters": [ { @@ -583,7 +699,7 @@ { "name": "numId", "in": "query", - "description": "Número de identificación", + "description": "Nœmero de identificaci—n", "required": true, "schema": { "type": "number" @@ -592,7 +708,7 @@ ], "responses": { "200": { - "description": "Operación exitosa", + "description": "Operaci—n exitosa", "content": { "application/json": { "schema": { @@ -602,7 +718,7 @@ } }, "400": { - "description": "Estado inválido" + "description": "Estado inv‡lido" } }, "security": [ @@ -621,7 +737,7 @@ "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.", + "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": [ { @@ -636,7 +752,7 @@ { "name": "documento", "in": "query", - "description": "Número de identificación.
Ejemplo:
1052411109", + "description": "Nœmero de identificaci—n.
Ejemplo:
1052411109", "required": true, "schema": { "type": "string" @@ -645,7 +761,7 @@ ], "responses": { "200": { - "description": "Operación exitosa", + "description": "Operaci—n exitosa", "content": { "application/json": { "schema": { @@ -655,7 +771,7 @@ } }, "400": { - "description": "Estado inválido" + "description": "Estado inv‡lido" } }, "security": [ @@ -673,8 +789,8 @@ "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.", + "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": [ { @@ -689,7 +805,7 @@ { "name": "numId", "in": "query", - "description": "Número de identificación", + "description": "Nœmero de identificaci—n", "required": true, "schema": { "type": "string" @@ -698,16 +814,16 @@ { "name": "codigoEsp", "in": "query", - "description": "Código que indica el código de la especialidad
150", + "description": "C—digo que indica el c—digo de la especialidad
150", "required": true, "schema": { "type": "number" } - }, + } ], "responses": { "200": { - "description": "Operación exitosa", + "description": "Operaci—n exitosa", "content": { "application/json": { "schema": { @@ -717,7 +833,7 @@ } }, "400": { - "description": "Estado inválido" + "description": "Estado inv‡lido" } }, "security": [ @@ -735,14 +851,14 @@ "tags": [ "cols-salud-paciente" ], - "summary": "Obtener cita por especialidad", + "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.", + "description": "Campo que indica el convenio el cual est‡ asociado el paciente.", "required": true, "schema": { "type": "string" @@ -766,10 +882,10 @@ "type": "number" } }, - { + { "name": "sexo", "in": "query", - "description": "Define el género del paciente
Ejemplo:
M F", + "description": "Define el gŽnero del paciente
Ejemplo:
M F", "required": true, "schema": { "type": "string" @@ -778,7 +894,7 @@ ], "responses": { "200": { - "description": "Operación exitosa", + "description": "Operaci—n exitosa", "content": { "application/json": { "schema": { @@ -788,7 +904,7 @@ } }, "400": { - "description": "Estado inválido" + "description": "Estado inv‡lido" } }, "security": [ @@ -806,11 +922,11 @@ "tags": [ "cols-salud-paciente" ], - "summary": "Obtener cita por especialidad", + "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", @@ -822,7 +938,7 @@ { "name": "numId", "in": "query", - "description": "Número de identificación", + "description": "Nœmero de identificaci—n", "required": true, "schema": { "type": "number" @@ -831,7 +947,7 @@ ], "responses": { "200": { - "description": "Operación exitosa", + "description": "Operaci—n exitosa", "content": { "application/json": { "schema": { @@ -841,7 +957,7 @@ } }, "400": { - "description": "Estado inválido" + "description": "Estado inv‡lido" } }, "security": [ @@ -853,243 +969,999 @@ } ] } - } - }, - "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" + }, + "/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" + } }, - "descripcion": { - "type": "string", - "description": "Descripción del resultado" + { + "name": "numId", + "in": "query", + "description": "Nœmero de identificaci—n", + "required": true, + "schema": { + "type": "number" + } } - }, - "xml": { - "name": "resultado" - } - }, - "documento": { - "type": "object", - "properties": { - "tipo": { - "type": "string", - "description": "Tipo de documento" + ], + "responses": { + "200": { + "description": "Operaci—n exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/detallePacienteResponse" + } + } + } }, - "numero": { - "type": "string", - "description": "Número de identificación del documento" + "400": { + "description": "Estado inv‡lido" } }, - "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" + "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" + } + } + } }, - "segundoApellido": { - "type": "string", - "description": "Segundo apellido" + "400": { + "description": "Estado inv‡lido" } }, - "xml": { - "name": "nombre" - } - }, - "categoria": { - "type": "object", - "properties": { - "codigo": { - "type": "string", - "description": "Código de la categoría" + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] } - }, - "xml": { - "name": "categoria" + ], + "requestBody": { + "$ref": "#/components/requestBodies/pacienteProvisionalRequestBody" } - }, - "tipo": { - "type": "object", - "properties": { + } + }, + "/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 del tipo" + "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." } - }, - "xml": { - "name": "tipo" } }, - "estado": { + "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": "Código del estado" + "description": "Paciente" } - }, - "xml": { - "name": "estado" } }, - "convenio": { + "genero": { "type": "object", "properties": { "codigo": { "type": "string", - "description": "Código del convenio" + "description": "Representa el codigo de género" }, - "estado": { + "descripcion": { "type": "string", - "description": "Estado del convenio" + "description": "representa la descripción" + } + } + }, + "pais": { + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "Especifica el id del país" }, "nombre": { "type": "string", - "description": "Nombre del convenio" + "description": "Especifica el nombre del país" + } + } + }, + "departamento": { + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "Especifica el id del departamento" }, - "clase": { + "nombre": { "type": "string", - "description": "Clase del convenio" + "description": "Especifica el nombre del departamento" } - }, - "xml": { - "name": "convenio" } }, - "eps": { + "ciudad": { "type": "object", "properties": { - "documento": { - "$ref": "#/components/schemas/documento" + "id": { + "type": "number", + "description": "Especifica el id de la ciudad" }, "nombre": { "type": "string", - "description": "Nombre de la EPS" + "description": "Especifica el nombre de la ciudad" + } + } + }, + "localidad": { + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "Especifica el id de la localidad" }, - "convenio": { - "$ref": "#/components/schemas/convenio" + "nombre": { + "type": "string", + "description": "Especifica el nombre de la localidad" } - }, - "xml": { - "name": "eps" } }, - "ips": { + "coordenadasGeograficas": { "type": "object", "properties": { - "codigo": { + "latitud": { "type": "string", - "description": "Codigo", + "description": "Latitud" }, - "nombre": { + "longitud": { "type": "string", - "description": "Fecha de comprobación" + "description": "Longitud" } - }, - "xml": { - "name": "ips" } }, - "prestador": { + "direccion": { "type": "object", "properties": { - "codigo": { + "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 de la especialidad" + "description": "c—digo postal corespondiente" }, - "nombre": { + "direccionPrincipal": { "type": "string", - "description": "Descripción de la especialidad" + "description": "direccion principal del paciente" }, - "apellidos": { + "direccionSecundaria": { "type": "string", - "description": "Indicativo de la cita prioritaria" + "description": "dirección secundaria" } - }, - "xml": { - "name": "prestador" } }, - "especialidad": { + "centroMedico": { "type": "object", "properties": { "codigo": { - "type": "number", - "description": "código de la especialidad" + "type": "string", + "description": "Nombre del centro médico" }, "descripcion": { "type": "string", - "description": "Descripción de la especialidad" - }, - "citaPrioritaria": { - "type": "number", - "description": "Indicativo de la cita prioritaria" + "description": "Descripción del centro médico" } - }, - "xml": { - "name": "especialidad" } }, - "afiliado": { + "prestacion": { "type": "object", "properties": { - "fechaComprobacion": { + "codigo": { "type": "string", - "description": "Fecha de comprobación", - "format": "date-time" + "description": "código de la prestación" }, - "documento": { - "$ref": "#/components/schemas/documento" + "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" }, - "nombre": { - "$ref": "#/components/schemas/nombre" + "convenio": { + "$ref": "#/components/schemas/convenio" }, - "categoria": { - "$ref": "#/components/schemas/categoria" + "especialidad": { + "$ref": "#/components/schemas/especialidad" }, - "tipo": { - "$ref": "#/components/schemas/tipo" + "centroMedico": { + "$ref": "#/components/schemas/centroMedico" }, - "estado": { - "$ref": "#/components/schemas/estado" + "prestador": { + "$ref": "#/components/schemas/prestador" }, - "semanasCotizadas": { - "type": "integer", - "description": "Semanas cotizadas" + "consultorio": { + "type": "string", + "description": "Nombre del consultorio" }, - "convenio": { - "$ref": "#/components/schemas/convenio" + "prestacion": { + "$ref": "#/components/schemas/prestacion" }, - "eps": { - "$ref": "#/components/schemas/eps" + "numeroOrden": { + "type": "number", + "description": "Número de la orden" + }, + "documentoContable": { + "type": "string", + "description": "Define del documento contable" } - }, - "xml": { - "name": "afiliado" } }, - "cita": { + "crearCitaSinOrdenR": { + "type": "object", + "required": [ + "cita" + ], + "properties": { + "cita": { + "$ref": "#/components/schemas/crearCitaSinOrdenResp" + } + } + }, + "crearCitaSinOrdenResp": { "type": "object", "required": [ "idReserva" @@ -1097,142 +1969,32 @@ "properties": { "idReserva": { "type": "string", - "description": "Número de la reserva" + "description": "Id reserva" }, - "desistir": { + "valor": { "type": "string", - "description": "Si se desiste de asistir a la cita" - } - } - }, - "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", - "required": [ - "codigo" - ], - "properties": { - "codigo": { - "type": "number", - "description": "Paciente" + "description": "Valor de la cita" } } }, - "actualizarSinOrden": { + "crearCitaSinOrdenResponse": { "type": "object", "required": [ - "cita" + "resultado", + "creacionSinOrden" ], "properties": { - "cita": { - "$ref": "#/components/schemas/cita" + "resultado": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + }, + "creacionSinOrden": { + "$ref": "#/components/schemas/crearCitaSinOrdenR" } } }, @@ -1264,26 +2026,57 @@ "prestador", "paciente", "tipoPlanificacion", - "unidadTratamiento", + "unidadTratamiento" ], "properties": { + "cita": { + "$ref": "#/components/schemas/reservarSinOrdencita" + }, "prestador": { - "$ref": "#/components/schemas/prestador" + "$ref": "#/components/schemas/reservaSinOrdenprestador" }, "paciente": { - "$ref": "#/components/schemas/paciente" + "$ref": "#/components/schemas/reservaSinOrdenpaciente" }, "tipoPlanificacion": { "type": "string", - "description": "Tipo planificación" + "description": "Tipo planificaci—n" }, "unidadTratamiento": { "type": "string", - "description": "Unidad de tratamiento" + "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" }, - "eps": { + "idOrden": { "type": "string", - "description": "EPS" + "description": "Numero de orden" } } }, @@ -1305,7 +2098,23 @@ "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": { @@ -1318,7 +2127,7 @@ "tipoPlanificacionId", "ordenId", "unidadPlanificada", - "numeroPrestacion", + "numeroPrestacion" ], "properties": { "fechaHora": { @@ -1343,7 +2152,7 @@ }, "tipoPlanificacionId": { "type": "string", - "description": "Id tipo planificación" + "description": "Id tipo planificaci—n" }, "ordenId": { "type": "number", @@ -1355,8 +2164,8 @@ }, "numeroPrestacion": { "type": "string", - "description": "Número prestación" - }, + "description": "Nœmero prestaci—n" + } } }, "actualizarCitaRequest": { @@ -1392,7 +2201,7 @@ } } }, - "reservaCitaRequest": { + "reservaCitaSinOrdenRequest": { "type": "object", "required": [ "resultados" @@ -1414,6 +2223,17 @@ } } }, + "borrarCitaConOrdenRequest": { + "type": "object", + "required": [ + "resultados" + ], + "properties": { + "borrarConOrden": { + "$ref": "#/components/schemas/borrarConOrden" + } + } + }, "crearCitaRequest": { "type": "object", "required": [ @@ -1425,6 +2245,55 @@ } } }, + "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": [ @@ -1445,6 +2314,26 @@ } } }, + "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": [ @@ -1496,6 +2385,47 @@ } } }, + "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": [ @@ -1530,6 +2460,23 @@ } } }, + "reservarCitaSinOrdenResponse": { + "type": "object", + "required": [ + "resultados" + ], + "properties": { + "resultados": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + } + } + }, "disponibilidadCitasResponse": { "type": "object", "required": [ @@ -1584,7 +2531,7 @@ } } }, - "especialidadPorPacienteResponse": { + "especialidadPorPacienteResponse": { "type": "object", "required": [ "resultados" @@ -1604,7 +2551,7 @@ } } }, - "consultaOrdenesResponse": { + "consultaOrdenesResponse": { "type": "object", "required": [ "resultados" @@ -1620,14 +2567,13 @@ } }, "ordenesClinicas": { - "type":"array", - "items":{ - "$ref": "#/components/schemas/ordenesClinicas" + "type": "array", + "items": { + "$ref": "#/components/schemas/ordenesClinicas" } } } }, - "medicoTratanteResponse": { "type": "object", "required": [ @@ -1645,19 +2591,18 @@ }, "prestador": { "type": "array", - "items":{ - "$ref": "#/components/schemas/prestador" + "items": { + "$ref": "#/components/schemas/prestador" } } } }, - "convenioPacienteResponse": { - "type": "object", - "required": [ + "type": "object", + "required": [ "resultados" - ], - "properties": { + ], + "properties": { "resultados": { "type": "array", "xml": { @@ -1670,7 +2615,90 @@ "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": { @@ -1682,7 +2710,18 @@ } } }, - "description": "Información de la cita a actualizar", + "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": { @@ -1693,7 +2732,7 @@ } } }, - "description": "Información de la cita a actualizar", + "description": "Informaci—n de la cita a actualizar", "required": true }, "reservarCitaRequestBody": { @@ -1704,14 +2743,25 @@ } } }, - "description": "Información de la cita", + "description": "Informaci—n de la cita", "required": true }, - "reservaCitaRequestBody": { + "borrarCitaConOrdenRequestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/reservaCitaRequest" + "$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" } } }, @@ -1739,6 +2789,17 @@ }, "description": "Reservar cita sin orden", "required": true + }, + "pacienteProvisionalRequestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/crearPacienteProvisionalRequest" + } + } + }, + "description": "Actualizar paciente", + "required": true } }, "securitySchemes": { @@ -1756,4 +2817,4 @@ } } } -} +} \ No newline at end of file