Skip to content

S
swagger
Commit 67bf7f45 by Edwin Ferreira
Options

Update medicamentos-afiliado.json se agrega pedidos

parent 11687b91
Showing with 836 additions and 133 deletions
apigee/medicamentos-afiliado.json
...@@ -43,6 +43,10 @@ ...@@ -43,6 +43,10 @@
{ {
"name": "coom-medicamentos-afiliados", "name": "coom-medicamentos-afiliados",
"description": "Validación de pacientes de Coomeva" "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": { "paths": {
...@@ -272,180 +276,824 @@ ...@@ -272,180 +276,824 @@
} }
} }
} }
}, },
"400": { "400": {
"description": "Estado inválido" "description": "Estado inválido"
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v1/medicamentos/domicilio/cobertura": {
"get": {
"tags": [
"quick-medicamentos-domicilios"
],
"summary": "Solicitud de cobertura",
"description": "Permite validar si Quick tiene cobertura en una dirección y ciudad.",
"operationId": "solicitudCobertuta",
"parameters": [
{
"name": "ciudad",
"in": "query",
"description": "Ciudad para consultar cobertura.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "direccion",
"in": "query",
"description": "Dirección para consultar cobertura.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-usuario",
"in": "header",
"description": "Objeto con usuario y clave en base64 Ej = Basic <i>Base64(usuario:clave)</i>.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/generalQuick"
}
}
}
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/v1/medicamentos/domicilio": {
"post": {
"tags": [
"quick-medicamentos-domicilios"
],
"summary": "Crear guia",
"description": "Se crea servicio en la plataforma SmarQuick para el control y gestion del domicilio.",
"operationId": "crearGuia",
"requestBody": {
"$ref": "#/components/requestBodies/crearGuiaRequestBody"
},
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/generalQuick"
}
}
}
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
},
"get": {
"tags": [
"quick-medicamentos-domicilios"
],
"summary": "Consultar guia",
"description": "Permite consultar guia a partir del numero de guia. Consulta contra SmartQuick.",
"operationId": "consultarGuia",
"parameters": [
{
"name": "numeroGuia",
"in": "query",
"description": "Numero de guia.",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"resultado"
],
"properties": {
"resultado": {
"type": "array",
"xml": {
"name": "resultado"
},
"items": {
"$ref": "#/components/schemas/resultadoQuick"
}
},
"consultarGuia": {
"type": "array",
"items": {
"$ref": "#/components/schemas/consultarGuia"
}
}
}
}
}
}
}
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
}
]
}
},
"/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": {
"description": "Encontrar más información en EnterpriseArchitect",
"url": "http://172.16.95.36/wiki/index.php/Enterprise_Architect"
},
"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"
}
}
}
} }
}, },
"security": [ "eps": {
{ "type": "object",
"apigee_auth": [ "description": "Objeto EPS",
"write:apigee", "properties": {
"read:apigee" "id": {
] "type": "string",
"description": "Número único de identificación de la EPS"
}
} }
]
} }
},
"/v1/medicamentos/domicilio/cobertura": {
"get": {
"tags": [
"quick-medicamentos-domicilios"
],
"summary": "Solicitud de cobertura",
"description": "Permite validar si Quick tiene cobertura en una dirección y ciudad.",
"operationId": "solicitudCobertuta",
"parameters": [
{
"name": "ciudad",
"in": "query",
"description": "Ciudad para consultar cobertura.",
"required": true,
"schema": {
"type": "string"
} }
}, },
{ "horario": {
"name": "direccion", "type": "object",
"in": "query", "description": "Nombre de la ciudad",
"description": "Dirección para consultar cobertura.", "properties": {
"required": true, "id": {
"schema": { "type": "string",
"type": "string" "description": "Número único de identificación del rango horario"
}
} }
}, },
{ "comentario": {
"name": "x-usuario", "type": "string",
"in": "header", "description": "Comentario del pedido"
"description": "Objeto con usuario y clave en base64 Ej = Basic <i>Base64(usuario:clave)</i>.", },
"required": true, "usuarioCreacion": {
"schema": { "type": "string",
"type": "string" "description": "Usuario de creación"
} }
} }
], },
"responses": { "archivo": {
"200": { "type": "array",
"description": "Operación exitosa", "description": "Lista de archivos",
"content": { "items": {
"application/json": { "properties": {
"schema": { "ruta": {
"$ref": "#/components/schemas/generalQuick" "type": "string",
"description": "Ruta del archivo"
}
} }
} }
} }
} }
}, },
"security": [ "qualifyOrderSchemasRequestBody": {
{ "type": "object",
"apigee_auth": [ "description": "Información del request de cancelar pedido",
"write:apigee", "properties": {
"read:apigee" "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"
} }
]
} }
}, },
"/v1/medicamentos/domicilio": { "cancelOrderSchemasRequestBody": {
"post": { "type": "object",
"tags": [ "description": "Información del request de cancelar pedido",
"quick-medicamentos-domicilios" "properties": {
], "accion": {
"summary": "Crear guia", "type": "string",
"description": "Se crea servicio en la plataforma SmarQuick para el control y gestion del domicilio.", "description": "Acción para realizar"
"operationId": "crearGuia",
"requestBody": {
"$ref": "#/components/requestBodies/crearGuiaRequestBody"
}, },
"responses": { "codigo": {
"200": { "type": "string",
"description": "Operación exitosa", "description": "Código"
"content": { },
"application/json": { "usuarioActual": {
"schema": { "type": "string",
"$ref": "#/components/schemas/generalQuick" "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"
} }
} }
} }
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
} }
]
},
"get": {
"tags": [
"quick-medicamentos-domicilios"
],
"summary": "Consultar guia",
"description": "Permite consultar guia a partir del numero de guia. Consulta contra SmartQuick.",
"operationId": "consultarGuia",
"parameters": [
{
"name": "numeroGuia",
"in": "query",
"description": "Numero de guia.",
"required": true,
"schema": {
"type": "number"
} }
} }
], },
"responses": { "createAddressByPatientSchemas": {
"200": {
"description": "Operación exitosa",
"content": {
"application/json": {
"schema": {
"type": "object", "type": "object",
"required": [ "description": "Información de crear direcciones por paciente",
"resultado"
],
"properties": { "properties": {
"resultado": { "paciente": {
"type": "array", "type": "object",
"xml": { "description": "Objeto paciente",
"name": "resultado" "properties": {
"id": {
"type": "string",
"description": "Número único de identificación del paciente"
}, },
"items": { "documento": {
"$ref": "#/components/schemas/resultadoQuick" "type": "object",
} "description": "Objeto documento",
"properties": {
"tipo": {
"type": "string",
"description": "Tipo de identificación"
}, },
"consultarGuia": { "numero": {
"type": "array", "type": "string",
"items": { "description": "Número de identificación"
"$ref": "#/components/schemas/consultarGuia"
} }
} }
},
"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"
} }
} }
} }
} }
} }
},
"security": [
{
"apigee_auth": [
"write:apigee",
"read:apigee"
]
} }
]
} }
} }
}, },
"externalDocs": {
"description": "Encontrar más información en EnterpriseArchitect",
"url": "http://172.16.95.36/wiki/index.php/Enterprise_Architect"
},
"components": {
"schemas": {
"resultadoQuick": { "resultadoQuick": {
"description": "Objeto de resultado específico para la plataforma SmarQuick", "description": "Objeto de resultado específico para la plataforma SmarQuick",
"type": "object", "type": "object",
...@@ -1436,6 +2084,61 @@ ...@@ -1436,6 +2084,61 @@
}, },
"description": "Crear cita sin orden", "description": "Crear cita sin orden",
"required": true "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": { "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