Skip to content

S
swagger
Commit 67bf7f45 by Edwin Ferreira
Options

Update medicamentos-afiliado.json se agrega pedidos

parent 11687b91
Showing with 703 additions and 0 deletions
apigee/medicamentos-afiliado.json
......@@ -43,6 +43,10 @@
{
"name": "coom-medicamentos-afiliados",
"description": "Validación de pacientes de Coomeva"
},
{
"name": "cols-medicamentos-pedidos",
"description": "Servicio encargado de gestionar cada uno de los departamentos y ciudades que participan en el proyecto de Medicamentos. Estos servicios permiten ver un listado de cada uno de los departamentos y a su vez las ciudades que tienen asociadas."
}
],
"paths": {
......@@ -438,6 +442,272 @@
}
]
}
},
"/v1/medicamentos/pedidos/formula": {
"post": {
"tags": [
"cols-medicamentos-pedidos"
],
"summary": "Crear pedido con fórmula electrónica",
"description": "Permite crear pedido con fórmula electrónica.",
"operationId": "crearOrdenConFormulaElectronica",
"requestBody": {
"$ref": "#/components/requestBodies/createOrderWithElectronicFormulaRequestBody"
},
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resultadoPedido"
}
}
}
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v1/medicamentos/pedidos": {
"post": {
"tags": [
"cols-medicamentos-pedidos"
],
"summary": "Crear pedido sin fórmula electrónica",
"description": "Permite crear pedido sin fórmula electrónica.",
"operationId": "createOrderWithoutElectronicFormula",
"requestBody": {
"$ref": "#/components/requestBodies/createOrderWithoutElectronicFormulaRequestBody"
},
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/resultadoPedido"
}
}
}
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v1/medicamentos/pedidos/calificar": {
"post": {
"tags": [
"cols-medicamentos-pedidos"
],
"summary": "Calificar pedidos",
"description": "Permite calificar pedidos.",
"operationId": "qualifyOrder",
"requestBody": {
"$ref": "#/components/requestBodies/qualifyOrderRequestBody"
},
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resultado": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
}
}
}
}
}
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v1/medicamentos/pedidos/cancelar": {
"post": {
"tags": [
"cols-medicamentos-pedidos"
],
"summary": "Cancelar pedidos",
"description": "Permite cancelar pedidos.",
"operationId": "cancelOrder",
"requestBody": {
"$ref": "#/components/requestBodies/cancelOrderRequestBody"
},
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resultado": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
}
}
}
}
}
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v1/medicamentos/pedidos/direccion": {
"post": {
"tags": [
"cols-medicamentos-pedidos"
],
"summary": "Crear direcciones por paciente.",
"description": "Permite crear direcciones por paciente.",
"operationId": "createAddressByPatient",
"requestBody": {
"$ref": "#/components/requestBodies/createAddressByPatientRequestBody"
},
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resultado": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultadoDireccionPedido"
}
}
}
}
}
}
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
},
"get": {
"tags": [
"cols-medicamentos-pedidos"
],
"summary": "Obtener dirección por paciente",
"description": "Permite obtener dirección por paciente.",
"operationId": "getAddressByPatient",
"parameters": [
{
"name": "tipoId",
"in": "query",
"description": "Tipo de identificación del paciente",
"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": {
"type": "object",
"required": [
"resultado"
],
"properties": {
"resultado": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultado"
}
},
"obtenerDireccionPaciente": {
"type": "array",
"items": {
"$ref": "#/components/schemas/createAddressByPatientSchemas"
}
}
}
}
}
}
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
}
},
"externalDocs": {
......@@ -446,6 +716,384 @@
},
"components": {
"schemas": {
"resultadoPedido": {
"description": "Objeto de resultado específico para la plataforma SmarQuick",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Identificador"
},
"codigo": {
"type": "string",
"description": "Código del resultado"
},
"descripcion": {
"type": "string",
"description": "Descripción del resultado"
}
}
},
"resultadoDireccionPedido": {
"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"
},
"direccionId": {
"type": "string",
"description": "Número único de identificación de la dirección"
}
},
"required": [
"valorTotal codigo descripcion"
]
},
"createOrderWithElectronicFormulaSchemasRequestBody": {
"type": "object",
"description": "Información del request de crear orden con fórmula electrónica",
"properties": {
"pedido": {
"type": "object",
"description": "Informacion del pedido",
"properties": {
"paciente": {
"type": "object",
"description": "Objeto paciente",
"properties": {
"documento": {
"type": "object",
"description": "Objeto documento",
"properties": {
"tipo": {
"type": "string",
"description": "Tipo de identificación"
},
"numero": {
"type": "string",
"description": "Número de identificación"
}
}
},
"direccion": {
"type": "object",
"description": "Objeto direccion",
"properties": {
"id": {
"type": "string",
"description": "Número único de identificación de la dirección"
},
"ciudad": {
"type": "object",
"description": "Nombre de la ciudad",
"properties": {
"id": {
"type": "string",
"description": "Número único de identificación de la ciudad"
}
}
}
}
},
"eps": {
"type": "object",
"description": "Objeto EPS",
"properties": {
"id": {
"type": "string",
"description": "Número único de identificación de la EPS"
}
}
}
}
},
"formula": {
"type": "array",
"description": "Listado de objeto formula",
"items": {
"properties": {
"numero": {
"type": "string",
"description": "Numero de la formula"
},
"tratamiento": {
"type": "array",
"description": "Listado de objeto Items Formula",
"items": {
"properties": {
"producto": {
"type": "object",
"description": "Listado de objeto producto",
"properties": {
"codigo": {
"type": "string",
"description": "Código del elemento de la fórmula"
},
"descripcion": {
"type": "string",
"description": "Nombre del elemento de la fórmula"
}
}
},
"cantidad": {
"type": "string",
"description": "Calificación"
}
}
}
}
}
}
},
"horario": {
"type": "object",
"description": "Nombre de la ciudad",
"properties": {
"id": {
"type": "string",
"description": "Número único de identificación del rango horario"
}
}
},
"comentario": {
"type": "string",
"description": "Comentario del pedido"
},
"usuarioCreacion": {
"type": "string",
"description": "Usuario de creación"
}
}
}
}
},
"createOrderWithoutElectronicFormulaSchemasRequestBody": {
"type": "object",
"description": "Información del request de crear orden sin fórmula electrónica",
"properties": {
"pedido": {
"type": "object",
"description": "Informacion del pedido",
"properties": {
"paciente": {
"type": "object",
"description": "Objeto paciente",
"properties": {
"documento": {
"type": "object",
"description": "Objeto documento",
"properties": {
"tipo": {
"type": "string",
"description": "Tipo de identificación"
},
"numero": {
"type": "string",
"description": "Número de identificación"
}
}
},
"direccion": {
"type": "object",
"description": "Objeto direccion",
"properties": {
"id": {
"type": "string",
"description": "Número único de identificación de la dirección"
},
"ciudad": {
"type": "object",
"description": "Nombre de la ciudad",
"properties": {
"id": {
"type": "string",
"description": "Número único de identificación de la ciudad"
}
}
}
}
},
"eps": {
"type": "object",
"description": "Objeto EPS",
"properties": {
"id": {
"type": "string",
"description": "Número único de identificación de la EPS"
}
}
}
}
},
"horario": {
"type": "object",
"description": "Nombre de la ciudad",
"properties": {
"id": {
"type": "string",
"description": "Número único de identificación del rango horario"
}
}
},
"comentario": {
"type": "string",
"description": "Comentario del pedido"
},
"usuarioCreacion": {
"type": "string",
"description": "Usuario de creación"
}
}
},
"archivo": {
"type": "array",
"description": "Lista de archivos",
"items": {
"properties": {
"ruta": {
"type": "string",
"description": "Ruta del archivo"
}
}
}
}
}
},
"qualifyOrderSchemasRequestBody": {
"type": "object",
"description": "Información del request de cancelar pedido",
"properties": {
"accion": {
"type": "string",
"description": "Acción para realizar"
},
"codigo": {
"type": "string",
"description": "Código"
},
"calificacion": {
"type": "string",
"description": "Calificación"
},
"comentario": {
"type": "string",
"description": "Comentario referente a la calificación"
},
"usuarioActual": {
"type": "string",
"description": "Usuario actual"
}
}
},
"cancelOrderSchemasRequestBody": {
"type": "object",
"description": "Información del request de cancelar pedido",
"properties": {
"accion": {
"type": "string",
"description": "Acción para realizar"
},
"codigo": {
"type": "string",
"description": "Código"
},
"usuarioActual": {
"type": "string",
"description": "Usuario actual"
}
}
},
"createAddressByPatientSchemasRequestBody": {
"type": "object",
"description": "Información de crear direcciones por paciente",
"properties": {
"direccion": {
"type": "object",
"description": "Objeto direccion",
"properties": {
"direccionPrincipal": {
"type": "string",
"description": "Dirección del paciente"
},
"ciudad": {
"type": "object",
"description": "Objeto de la ciudad",
"properties": {
"id": {
"type": "string",
"description": "Número único de identificación de la ciudad"
}
}
}
}
}
}
},
"createAddressByPatientSchemas": {
"type": "object",
"description": "Información de crear direcciones por paciente",
"properties": {
"paciente": {
"type": "object",
"description": "Objeto paciente",
"properties": {
"id": {
"type": "string",
"description": "Número único de identificación del paciente"
},
"documento": {
"type": "object",
"description": "Objeto documento",
"properties": {
"tipo": {
"type": "string",
"description": "Tipo de identificación"
},
"numero": {
"type": "string",
"description": "Número de identificación"
}
}
},
"direccion": {
"type": "object",
"description": "Objeto direccion",
"properties": {
"id": {
"type": "string",
"description": "Número único de identificación de la dirección"
},
"direccionPrincipal": {
"type": "string",
"description": "Dirección del paciente"
},
"comentario": {
"type": "string",
"description": "Comentarios referentes a la dirección"
},
"ciudad": {
"type": "object",
"description": "Nombre de la ciudad",
"properties": {
"id": {
"type": "string",
"description": "Número único de identificación de la ciudad"
}
}
}
}
}
}
}
}
},
"resultadoQuick": {
"description": "Objeto de resultado específico para la plataforma SmarQuick",
"type": "object",
......@@ -1436,6 +2084,61 @@
},
"description": "Crear cita sin orden",
"required": true
},
"createOrderWithElectronicFormulaRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createOrderWithElectronicFormulaSchemasRequestBody"
}
}
},
"description": "Información del request de crear pedido con fórmula electrónica",
"required": true
},
"createOrderWithoutElectronicFormulaRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createOrderWithoutElectronicFormulaSchemasRequestBody"
}
}
},
"description": "Información del request de crear pedido sin fórmula electrónica",
"required": true
},
"qualifyOrderRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/qualifyOrderSchemasRequestBody"
}
}
},
"description": "Información del request de crear pedido",
"required": true
},
"cancelOrderRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cancelOrderSchemasRequestBody"
}
}
},
"description": "Información del request de cancelar pedido",
"required": true
},
"createAddressByPatientRequestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createAddressByPatientSchemasRequestBody"
}
}
},
"description": "Información de crear direcciones por paciente",
"required": true
}
},
"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