Skip to content

S
swagger
Commit b7cb9ac6 by robert.barrazaga@colsubsidio.com
Options

Update salud-eps.json

parent a51a7432
Showing with 783 additions and 26 deletions
apigee/salud-eps.json
...@@ -126,7 +126,7 @@ ...@@ -126,7 +126,7 @@
"tags": [ "tags": [
"cols-salud-cita" "cols-salud-cita"
], ],
"summary": "Actualizar cita", "summary": "Actualizar cita sin orden",
"description": "Realizar actualización de una cita", "description": "Realizar actualización de una cita",
"operationId": "actualizarCita", "operationId": "actualizarCita",
"responses": { "responses": {
...@@ -321,7 +321,7 @@ ...@@ -321,7 +321,7 @@
} }
} }
}, },
"/v2/salud/citas{a}": { "/v2/salud/citas{adendo}": {
"get": { "get": {
"tags": [ "tags": [
"cols-salud-cita" "cols-salud-cita"
...@@ -331,9 +331,9 @@ ...@@ -331,9 +331,9 @@
"operationId": "consultarCita", "operationId": "consultarCita",
"parameters": [ "parameters": [
{ {
"name": "a", "name": "adendo",
"in": "path", "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, "required": true,
"schema": { "schema": {
"type": "string" "type": "string"
...@@ -383,7 +383,7 @@ ...@@ -383,7 +383,7 @@
] ]
} }
}, },
"/v2/salud/citas{b}": { "/v2/salud/citas{adicion}": {
"get": { "get": {
"tags": [ "tags": [
"cols-salud-cita" "cols-salud-cita"
...@@ -393,9 +393,9 @@ ...@@ -393,9 +393,9 @@
"operationId": "disponibilidadCitas", "operationId": "disponibilidadCitas",
"parameters": [ "parameters": [
{ {
"name": "b", "name": "adicion",
"in": "path", "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, "required": true,
"schema": { "schema": {
"type": "string" "type": "string"
...@@ -489,6 +489,370 @@ ...@@ -489,6 +489,370 @@
} }
] ]
} }
},
"/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.<br>CC - Cedula<br>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.<br/><strong>Ejemplo</strong>:<br/>CC - Cedula<br>NIT - NIT",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documento",
"in": "query",
"description": "Número de identificación.<br/><strong>Ejemplo:</strong><br/>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.<br>CC - Cedula<br>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<br/>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.<br/>Ejemplo<br/>10009",
"required": true,
"schema": {
"type": "number"
}
},
{
"name": "edad",
"in": "query",
"description": "Indica la edad del paciente.<br/><strong>Ejemplo:</strong><br/>19",
"required": true,
"schema": {
"type": "number"
}
},
{
"name": "sexo",
"in": "query",
"description": "Define el género del paciente<br/><strong>Ejemplo:</strong><br/>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": "Tipo de identificacion.<br>CC - Cedula<br>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/consultaOrdenesResponse"
}
}
}
},
"400": {
"description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
} }
}, },
"externalDocs": { "externalDocs": {
...@@ -598,37 +962,93 @@ ...@@ -598,37 +962,93 @@
}, },
"estado": { "estado": {
"type": "string", "type": "string",
"description": "Estado del convenio" "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": "Fecha de comprobación"
}
},
"xml": {
"name": "ips"
}
},
"prestador": {
"type": "object",
"properties": {
"codigo": {
"type": "string",
"description": "código de la especialidad"
}, },
"nombre": { "nombre": {
"type": "string", "type": "string",
"description": "Nombre del convenio" "description": "Descripción de la especialidad"
}, },
"clase": { "apellidos": {
"type": "string", "type": "string",
"description": "Clase del convenio" "description": "Indicativo de la cita prioritaria"
} }
}, },
"xml": { "xml": {
"name": "convenio" "name": "prestador"
} }
}, },
"eps": { "especialidad": {
"type": "object", "type": "object",
"properties": { "properties": {
"documento": { "codigo": {
"$ref": "#/components/schemas/documento" "type": "number",
"description": "código de la especialidad"
}, },
"nombre": { "descripcion": {
"type": "string", "type": "string",
"description": "Nombre de la EPS" "description": "Descripción de la especialidad"
}, },
"convenio": { "citaPrioritaria": {
"$ref": "#/components/schemas/convenio" "type": "number",
"description": "Indicativo de la cita prioritaria"
} }
}, },
"xml": { "xml": {
"name": "eps" "name": "especialidad"
} }
}, },
"afiliado": { "afiliado": {
...@@ -685,15 +1105,111 @@ ...@@ -685,15 +1105,111 @@
} }
} }
}, },
"prestador": { "afiliacion": {
"type": "object", "type": "object",
"required": [
"codigo"
],
"properties": { "properties": {
"codigo": { "codigo": {
"type": "number", "type": "number",
"description": "Prestador" "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"
} }
} }
}, },
...@@ -748,7 +1264,7 @@ ...@@ -748,7 +1264,7 @@
"prestador", "prestador",
"paciente", "paciente",
"tipoPlanificacion", "tipoPlanificacion",
"unidadTratamiento" "unidadTratamiento",
], ],
"properties": { "properties": {
"prestador": { "prestador": {
...@@ -771,6 +1287,78 @@ ...@@ -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": { "actualizarCitaRequest": {
"type": "object", "type": "object",
"required": [ "required": [
...@@ -815,6 +1403,28 @@ ...@@ -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": { "validadorAfiliadoSaludResponse": {
"type": "object", "type": "object",
"required": [ "required": [
...@@ -936,6 +1546,131 @@ ...@@ -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": { "requestBodies": {
...@@ -982,6 +1717,28 @@ ...@@ -982,6 +1717,28 @@
}, },
"description": "Reservar cita sin orden", "description": "Reservar cita sin orden",
"required": true "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": { "securitySchemes": {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment