diff --git a/apigee/salud-eps.json b/apigee/salud-eps.json index cfb6fc1..dac0eeb 100644 --- a/apigee/salud-eps.json +++ b/apigee/salud-eps.json @@ -126,7 +126,7 @@ "tags": [ "cols-salud-cita" ], - "summary": "Actualizar cita", + "summary": "Actualizar cita sin orden", "description": "Realizar actualización de una cita", "operationId": "actualizarCita", "responses": { @@ -321,7 +321,7 @@ } } }, - "/v2/salud/citas{a}": { + "/v2/salud/citas{adendo}": { "get": { "tags": [ "cols-salud-cita" @@ -330,10 +330,10 @@ "description": "Obtener información cita", "operationId": "consultarCita", "parameters": [ - { - "name": "a", + { + "name": "adendo", "in": "path", - "description": "El campo solo es de prueba, para evitar problemas de duplicado", + "description": "El campo solo es de relleno, para evitar problemas de duplicado en la documentación de Swaager", "required": true, "schema": { "type": "string" @@ -383,7 +383,7 @@ ] } }, - "/v2/salud/citas{b}": { + "/v2/salud/citas{adicion}": { "get": { "tags": [ "cols-salud-cita" @@ -392,10 +392,10 @@ "description": "Obtener información disponibilidad citas", "operationId": "disponibilidadCitas", "parameters": [ - { - "name": "b", + { + "name": "adicion", "in": "path", - "description": "El campo solo es de prueba, para evitar problemas de duplicado", + "description": "El campo solo es de relleno, para evitar problemas de duplicado en la documentación de Swaager", "required": true, "schema": { "type": "string" @@ -447,18 +447,382 @@ } }, { - "name": "ips", + "name": "ips", + "in": "query", + "description": "IPS", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "paciente", + "in": "query", + "description": "Paciente", + "required": true, + "schema": { + "type": "number" + } + } + ], + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/disponibilidadCitasResponse" + } + } + } + }, + "400": { + "description": "Estado inválido" + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ] + } + }, + "/v2/salud/citas/crearconorden": { + "post": { + "tags": [ + "cols-salud-cita" + ], + "summary": "Cita con orden", + "description": "Crear cita con orden", + "operationId": "crearCitaConOrden", + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/crearCitaResponse" + } + } + } + }, + "400": { + "description": "Estado inválido" + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/crearCitaRequestBody" + } + } + }, + "/v2/salud/citas/reservaconorden": { + "post": { + "tags": [ + "cols-salud-cita" + ], + "summary": "Reservar con orden", + "description": "Reservar cita con orden", + "operationId": "reservarCitaConOrden", + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/reservarCitaResponse" + } + } + } + }, + "400": { + "description": "Estado inválido" + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/reservarCitaConOrdenRequestBody" + } + } + }, + "/v2/pacientes/convenio": { + "get": { + "tags": [ + "cols-salud-paciente" + ], + "summary": "Consulta de convenio", + "description":"Servicio de consulta de convenio, buscando por tipo de identificación y número de identificación.", + "operationId": "consultaConvenio", + "parameters": [ + { + "name": "tipoId", + "in": "query", + "description": "Tipo de identificacion.
CC - Cedula
NIT - NIT", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "numId", + "in": "query", + "description": "Número de identificación", + "required": true, + "schema": { + "type": "number" + } + } + ], + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/convenioPacienteResponse" + } + } + } + }, + "400": { + "description": "Estado inválido" + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ] + } + }, + "/v2/salud/pacientes/grupofamiliar": { + "get": { + "tags": [ + "cols-salud-paciente" + ], + "summary": "Obtener grupo familiar", + "description": "Servcio que permite consultar los datos asociados al grupo familiar de un afiliado, dado un tipo y número de documento.", + "operationId": "consultaGrupoFamiliar", + "parameters": [ + { + "name": "tipoDoc", + "in": "query", + "description": "Tipo de identificacion.
Ejemplo:
CC - Cedula
NIT - NIT", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "documento", + "in": "query", + "description": "Número de identificación.
Ejemplo:
1052411109", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/consultaGrupoFamiliarResponse" + } + } + } + }, + "400": { + "description": "Estado inválido" + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ] + } + }, + "/v2/salud/pacientes/medicotratante": { + "get": { + "tags": [ + "cols-salud-paciente" + ], + "summary": "Obtener médico tratante de un afiliado", + "description": "Api que permite consultar el medico tratante de un afiliado dato un tipo y número de identificación.", + "operationId": "medicoContratante", + "parameters": [ + { + "name": "tipoId", + "in": "query", + "description": "Tipo de identificacion.
CC - Cedula
NIT - NIT", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "numId", + "in": "query", + "description": "Número de identificación", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "codigoEsp", + "in": "query", + "description": "Código que indica el código de la especialidad
150", + "required": true, + "schema": { + "type": "number" + } + }, + ], + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/medicoTratanteResponse" + } + } + } + }, + "400": { + "description": "Estado inválido" + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ] + } + }, + "/v2/salud/pacientes/citasporespecialidades": { + "get": { + "tags": [ + "cols-salud-paciente" + ], + "summary": "Obtener cita por especialidad", + "description": "Servicio que permite obtener citas por especialidad de un paciente.", + "operationId": "citaBusquedaPorEspecialidad", + "parameters": [ + { + "name": "convenio", + "in": "query", + "description": "Campo que indica el convenio el cual está asociado el paciente.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pacienteId", + "in": "query", + "description": "Identificador del paciente.
Ejemplo
10009", + "required": true, + "schema": { + "type": "number" + } + }, + { + "name": "edad", + "in": "query", + "description": "Indica la edad del paciente.
Ejemplo:
19", + "required": true, + "schema": { + "type": "number" + } + }, + { + "name": "sexo", + "in": "query", + "description": "Define el género del paciente
Ejemplo:
M F", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/especialidadPorPacienteResponse" + } + } + } + }, + "400": { + "description": "Estado inválido" + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ] + } + }, + "/v2/salud/pacientes/ordenesclinicas": { + "get": { + "tags": [ + "cols-salud-paciente" + ], + "summary": "Obtener cita por especialidad", + "description": "Servicio que permite obtener citas por especialidad de un paciente.", + "operationId": "consultaOrdenesClinicas", + "parameters": [ + { + "name": "tipoId", "in": "query", - "description": "IPS", - "required": false, + "description": "Tipo de identificacion.
CC - Cedula
NIT - NIT", + "required": true, "schema": { "type": "string" } }, { - "name": "paciente", + "name": "numId", "in": "query", - "description": "Paciente", + "description": "Número de identificación", "required": true, "schema": { "type": "number" @@ -471,7 +835,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/disponibilidadCitasResponse" + "$ref": "#/components/schemas/consultaOrdenesResponse" } } } @@ -631,6 +995,62 @@ "name": "eps" } }, + "ips": { + "type": "object", + "properties": { + "codigo": { + "type": "string", + "description": "Codigo", + }, + "nombre": { + "type": "string", + "description": "Fecha de comprobación" + } + }, + "xml": { + "name": "ips" + } + }, + "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": { @@ -685,18 +1105,114 @@ } } }, - "prestador": { - "type": "object", - "required": [ - "codigo" - ], - "properties": { - "codigo": { - "type": "number", - "description": "Prestador" - } - } - }, + "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": [ @@ -748,7 +1264,7 @@ "prestador", "paciente", "tipoPlanificacion", - "unidadTratamiento" + "unidadTratamiento", ], "properties": { "prestador": { @@ -771,6 +1287,78 @@ } } }, + "crearCitaConOrden": { + "type": "object", + "required": [ + "ordenId", + "citaId" + ], + "properties": { + "ordenId": { + "type": "number", + "description": "Id de orden" + }, + "citaId": { + "type": "number", + "description": "Id de cita" + }, + "citaDesistir": { + "type": "string", + "description": "Desistir de la cita" + }, + } + }, + "reservaConOrden": { + "type": "object", + "required": [ + "fechaHora", + "especialidadId", + "prestadorId", + "pacienteId", + "tipoPlanificacionId", + "ordenId", + "unidadPlanificada", + "numeroPrestacion", + ], + "properties": { + "fechaHora": { + "type": "string", + "description": "Fecha reserva" + }, + "especialidadId": { + "type": "number", + "description": "Especialidad" + }, + "prestadorId": { + "type": "number", + "description": "Id Prestador" + }, + "pacienteId": { + "type": "number", + "description": "Id paciente" + }, + "epsParticular": { + "type": "string", + "description": "Eps particular" + }, + "tipoPlanificacionId": { + "type": "string", + "description": "Id tipo planificación" + }, + "ordenId": { + "type": "number", + "description": "Id orden" + }, + "unidadPlanificada": { + "type": "string", + "description": "Unidad planificada" + }, + "numeroPrestacion": { + "type": "string", + "description": "Número prestación" + }, + } + }, "actualizarCitaRequest": { "type": "object", "required": [ @@ -815,6 +1403,28 @@ } } }, + "reservaCitaConOrdenRequest": { + "type": "object", + "required": [ + "resultados" + ], + "properties": { + "reservaSinOrden": { + "$ref": "#/components/schemas/reservaConOrden" + } + } + }, + "crearCitaRequest": { + "type": "object", + "required": [ + "resultados" + ], + "properties": { + "crearCitaConOrden": { + "$ref": "#/components/schemas/crearCitaConOrden" + } + } + }, "validadorAfiliadoSaludResponse": { "type": "object", "required": [ @@ -936,6 +1546,131 @@ } } } + }, + "crearCitaResponse": { + "type": "object", + "required": [ + "resultado" + ], + "properties": { + "resultado": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + } + } + }, + "consultaGrupoFamiliarResponse": { + "type": "object", + "required": [ + "resultados" + ], + "properties": { + "resultados": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + }, + "grupoFamiliar": { + "$ref": "#/components/schemas/afiliadoGrupo" + } + } + }, + "especialidadPorPacienteResponse": { + "type": "object", + "required": [ + "resultados" + ], + "properties": { + "resultados": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + }, + "especialidad": { + "$ref": "#/components/schemas/especialidad" + } + } + }, + "consultaOrdenesResponse": { + "type": "object", + "required": [ + "resultados" + ], + "properties": { + "resultados": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + }, + "ordenesClinicas": { + "type":"array", + "items":{ + "$ref": "#/components/schemas/ordenesClinicas" + } + } + } + }, + + "medicoTratanteResponse": { + "type": "object", + "required": [ + "resultados" + ], + "properties": { + "resultados": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + }, + "prestador": { + "type": "array", + "items":{ + "$ref": "#/components/schemas/prestador" + } + } + } + }, + + "convenioPacienteResponse": { + "type": "object", + "required": [ + "resultados" + ], + "properties": { + "resultados": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + }, + "Convenio": { + "$ref": "#/components/schemas/afiliacion" + } + } } }, "requestBodies": { @@ -982,6 +1717,28 @@ }, "description": "Reservar cita sin orden", "required": true + }, + "reservarCitaConOrdenRequestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/reservaCitaConOrdenRequest" + } + } + }, + "description": "Reservar cita sin orden", + "required": true + }, + "crearCitaRequestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/crearCitaRequest" + } + } + }, + "description": "Reservar cita sin orden", + "required": true } }, "securitySchemes": { @@ -999,4 +1756,4 @@ } } } -} \ No newline at end of file +}