Realiza a inclusão de novos medicamentos de uso contínuo para o beneficiário. /totvsHealthPlans/attendancerefundSetup/v1/refundscontinuousMedications | |
Nota |
---|
Expandir |
---|
| Authorization (header) | | Cabeçalho usado para autorização das requisições (Bearer token) | *required | Content-Type (header) | | 'application/json' é o formato do conteúdo | *required |
|
|
Dica |
---|
Expandir |
---|
| status | string | Define o status final do protocolo, sendo: - 1 - Protocolado
- 0 - Solicitação não concluída
| *required | healthInsurerCode | string | Código da operadora de saúde no sistema | BOWBB0_OPEMOVCODOPE | *required | subscriberId | string | Matricula do beneficiário | solicitante do protocolo(obtido através da API Beneficiaries - v1.000 (Family Contract)) | BOWB4F_ | USUARIMATRIC | *required | refundReceipts professionalCouncil | array | Comprovantes de reembolso | *required | string | Sigla do conselho regional do profissional de saúde da receita (obtido através da api /totvsHealthPlans/attendanceNetwork/v1/regionalCouncils) | B4F_SIGLA | refundReceipts.unreferencedNetworkIdentifier | string | CPF/CNPJ do prestador de serviço | B1N_PRCNPJ | *required | refundReceipts.unreferencedNetworkNameprofessionalCouncilNumber | string | Nome do prestador de serviço (obtido através da api /totvsHealthPlans/attendanceNetwork/v1/unreferencedNetworks) | Numero do conselho regional do profissional de saúde da receita | B4F_REGSOLB1N_PRNOME | *required | refundReceipts.stateAbbreviation | string | Estado do prestador (obtido através da api /totvsHealthPlans/attendanceNetwork/v1/unreferencedNetworks) do conselho regional do profissional de saúde da receita | B4F_ESTSOLB1N_EST | *required | refundReceipts.cityCodeprofessionalName | string | Código do Município do prestadorNome do profissional de saúde da receita (obtido através da API Cities Professionals - v1.000 (Locality) ou api /totvsHealthPlans/attendanceNetwork/v1/unreferencedNetworksAttendance Network)) | B1NBB0_CODMUNNOME | *required | refundReceipts.documentCodeprescriptionDate | string (date) | Data da receita | B4F_DATINI | *required | medications | array | Medicamentos de uso contínuo |
| *required | medications.tableCode | string | Código da tabela do medicamentoCódigo do tipo de comprovante (obtido através da API Documents - v1.000 (Refund Setup))api /totvsHealthPlans/procedure/v1/medications) | B7D_CODPADB1N_TIPDOC (BBS_COD) | *required | refundReceiptsmedications.documentNumbermedicationCode | string | Numero do documento | B1N_NUMDOC | refundReceipts.documentDate | string (date) | Data de emissão do documento | Código do medicamento (obtido através da api /totvsHealthPlans/procedure/v1/medications) | B7D_CODMEDB1N_DATDOC | *required | refundReceipts.expensesattachments | array | Despesas do comprovante de reembolsoAnexos dos medicamentos |
| *required | refundReceiptsattachments.expenses.subscriberIdhref | string | Matricula do beneficiário da despesa (obtido através da API Beneficiaries - v1.000 (Family Contract)) | B1N_MATRICUrl do arquivo para que seja realizado o download |
| *required | refundReceipts.expenses.procedureClass | string | Código do tipo de despesa utilizado (obtido através da api totvsHealthPlans/procedure/v1/classes) | B1N_TIPSER | *required | refundReceipts.expenses.tableCode | string | Código da tabela da despesa (obtido através da api /totvsHealthPlans/procedure/v1/classes/{classId}/procedures) | B1N_CODPAD | *required | refundReceipts.expenses.procedureCode | string | Código da despesa (obtido através da api /totvsHealthPlans/procedure/v1/classes/{classId}/procedures) | B1N_CODPRO | *required | refundReceipts.expenses.continuousUse | string | Quando a despesa for medicamento, informa se é de uso contínuo, sendo: | B1N_USOCON | *required | refundReceipts.expenses.prescriptionCode | string | Código da receita do medicamento de uso continuo (obtivo através da api /totvsHealthPlans/refundSetup/v1/continuousMedications) Obrigatório quando continuousUse for igual a 1 | B1N_CODREC | refundReceipts.expenses.expenseAmount | number (double) | Valor total da despesa | B1N_VLRTOT | *required | refundReceipts.expenses.quantity | number (integer) | Quantidade de despesa | B1N_QTDPRO | *required | refundReceipts.expenses.executionDate | string (date) | Data de execução da despesa | B1N_DATPRO | *required | refundReceipts.attachments | array | Anexos do comprovante Obrigatório quando for informado o status igual a 1 - Protocolado | refundReceipts.attachments.href | string | Url do arquivo para que seja realizado o download | *required |
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"healthInsurerCode" : "0001",
"subscriberId" : "00011008000027010",
"professionalCouncil" : "CRM",
"stateAbbreviation" : "SP",
"professionalName" : "VINICIUS",
"prescriptionDate | Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"status" : "1",
"healthInsurerCode" : "0001",
"subscriberId" : "00011008000027010",
"refundReceipts" : [
{
"unreferencedNetworkIdentifier" : "77077733000159",
"unreferencedNetworkName" : "JOSE",
"stateAbbreviation" : "SP",
"cityCode" : "3500105",
"documentCode" : "03",
"documentNumber" : "000001235",
"documentDate" : "2023-06-07",
"expenses" : [
{
"subscriberId" : "00011008000027010",
"procedureClass" : "000005",
"tableCode" : "04",
"procedureCode": "0490173961",
"continuousUse" : "1",
"prescriptionCode" : "41750520230419000001",
"expenseAmount": 250,
"quantity" : 1,
"executionDate" : "2023-0604-0703"
,
"professionalCouncilNumber" : "334456",
"medications" : [
{
}
"tableCode" : ]"04",
"attachmentsmedicationCode" : ["0490173961"
}
],
"attachments" : {[
{
"href" : "https://www.totvs.com/wp-content/uploads/2021/04/totvs-shared.png?teste"
}
]/2021/04/totvs-shared.png?teste"
}
]
}} |
|
|
Dica |
---|
Expandir |
---|
title | (201) - Operação realizada com sucesso |
---|
| prescriptionCode | string |
| B4F_CODREC | *required | status | string |
| B4F_STATUS |
| prescriptionDescription | string |
| B4F_DESCRI |
| subscriberId | string |
| B4F_MATRIC |
| subscriberName | string |
| BA1_NOMUSR |
| registrationDate | string (date) |
| B4F_DTCAD |
| professionalCouncil | string |
| B4F_SIGLA |
| stateAbbreviation | string |
| B4F_ESTSOL |
| professionalCouncilNumber | string |
| B4F_REGSOL |
| professionalName | string |
| BB0_NOME |
| startValidityDate | string (date) |
| B4F_DATINI |
| endValidityDate | string (date) |
| B4F_DATFIN |
| medications | array |
|
|
| medications.tableCode | string |
| B7D_CODPAD |
| medications.medicationCode | string |
| B7D_CODMED |
| medications.medicationDescription | string |
| BR8_DESCRI |
|
| Dica |
---|
Expandir |
---|
title | (201) - Operação realizada com sucesso |
---|
| protocol | string | Numero do protocolo gerado para o reembolso | BOW_PROTOC | *required | status | string | Status do protocolo: - 0 - Solicitação não concluída
- 1 - Protocolado
| BOW_STATUS | *required | requestDate | string (date) | Data de solicitação | BOW_DTDIGI | *required | presentedAmount | numeric (double) | Valor apresentado | BOW_VLRAPR | *required | refundedAmount | numeric (double) | Valor reembolsado | BOW_VLRREE | paymentDate | string (date) | Data de pagamento do reembolso | BOW_PGMTO | beneficiaryName | string | Nome do beneficiário solicitante | BOW_NOMUSR | *required | links | array | links relacionados ao recurso refunds (Padrão HATEOAS): - rel: expenses (Despesas do protocolo)
- rel: attachments (Anexos do protocolo)
| *required Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"protocolprescriptionCode": "4175052023060700000341750520230619000003",
"status": "1",
"requestDateprescriptionDescription": "2023-06-07Receita Nº 41750520230619000003.",
"presentedAmountsubscriberId": 250"00011008000027010",
"refundedAmountsubscriberName": 0,
"HERNANDES ALVES "paymentDate": "DA SILVA",
"beneficiaryNameregistrationDate": "HERNANDES ALVES DA SILVA2023-06-19",
"linksprofessionalCouncil": [
"CRM",
{"stateAbbreviation": "SP",
"professionalCouncilNumber": "334457",
"relprofessionalName": "expensesVINICIUS",
"startValidityDate": "2023-04-03",
"hrefendValidityDate": "/totvsHealthPlans/attendance/v1/refunds/41750520230607000003/expenses""2023-04-03",
"medications": [
},
{
{"tableCode": "04",
"relmedicationCode": "attachments0490173961",
"hrefmedicationDescription": "/totvsHealthPlans/attendance/v1/refunds/41750520230607000003/attachmentsDRAMIN 100 MG COM CT BL AL PLAS INC X 20"
}
]
} |
|
|
Aviso |
---|
Expandir |
---|
title | (406) - Json do body invalido |
---|
| code | string | Código identificador do erro. | *required | message | string | Literal no idioma da requisição descrevendo o erro para o usuário. | *required | detailedMessage | string | Mensagem técnica e mais detalhada do erro. | *required | details | array | Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal. |
|
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"code": "E001",
"message": "JSON inválido",
"detailedMessage": "Json Error: >>\"healthInsurerCode\" : \"0001\",\r\n\t\"subscriberId\" : \"00011008000027010\",\r\n \"refundReceipts\" : [\r\n {\r\n \"unreferencedNetworkIdentifier\" : \"77077733000159\",\r\n \"unreferencedNetworkName\" : \"JOSE\",\r\n \"stateAbbreviation\" : \"SP\",\r\n \"cityCode\" : \"3500105\",\r\n \"documentCode\" : \"03\",\r\n \"documentNumber\" : \"000001235\",\r\n \"documentDate\" : \"2023-06-07\",\r\n \"expenses\" : [\r\n {\r\n \"subscriberId\" : \"00011008000027010\",\r\n \"procedureClass\" : \"000005\",\r\n \"tableCode\" : \"04\",\r\n \"procedureCode\": \"0490173961\",\r\n \"continuousUse\" : \"1\",\r\n \"prescriptionCode\" : \"41750520230419000001\",\r\n \"expenseAmount\": 250,\r\n \"quantity\" : 1,\r\n \"executionDate\" : \"2023-06-07\"\t\t\r\n }\r\n ],\r\n \"attachments\" : [\r\n {\r\n \"href\" : \"https://www.totvs.com/wp-content/uploads/2021/04/totvs-shared.png?teste\"\r\n }\r\n ]\r\n }\r\n ]\r\n}<<"
} |
|
|
Aviso |
---|
Expandir |
---|
title | (406) - Campos do body inválidos |
---|
| code | string | Código identificador do erro. | *required | message | string | Literal no idioma da requisição descrevendo o erro para o usuário. | *required | detailedMessage | string | Mensagem técnica e mais detalhada do erro. | *required | details | array | Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal. |
|
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"code": "E002",
"message": "Os campos do json no body estão inválidos",
"detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
"details": [
{
"code": "E002D-406",
"message": "Tipo inválido para o campo status",
"detailedMessage": "O valor do campo status deve ser do tipo (C)."
},
{
"code": "E002F-406",
"message": "Valor inválido para o campo status",
"detailedMessage": "O valor do campo status deve ser: 0;1"
},
{
"code": "E002B-406",
"message": "Campo healthInsurerCode obrigatório",
"detailedMessage": "Não foi informado valor do campo healthInsurerCode."
},
{
"code": "E002E-406",
"message": "Tamanho inválido para o campo healthInsurerCode",
"detailedMessage": "O valor do campo healthInsurerCode deve ter o tamanho 4."
},
{
"code": "E002E-406",
"message": "Tamanho inválido para o campo subscriberId",
"detailedMessage": "O valor do campo subscriberId deve ter o tamanho 17."
},
{
"code": "E002B-406",
"message": "Campo refundReceipts obrigatório",
"detailedMessage": "Não foi informado valor do campo refundReceipts."
}
]
} |
|
|
Aviso |
---|
Expandir |
---|
title | (400) - Dados do reembolso inválidos |
---|
| code | string | Código identificador do erro. | *required | message | string | Literal no idioma da requisição descrevendo o erro para o usuário. | *required | detailedMessage | string | Mensagem técnica e mais detalhada do erro. | *required | details | array | Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal. | *required |
Bloco de código |
---|
language | c# |
---|
theme | Emacs |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| {
"code": "E003",
"message": "Dados inválidos para realizar a solicitação de reembolso",
"detailedMessage": "Verifique os detalhes dos erros no campo details",
"details": [
{
"code": "E004A-404",
"message": "Operadora de saúde não encontrada",
"detailedMessage": "Não foi encontrada nenhuma operadora de saúde com o código 0099 no cadastro (BA0)"
},
{
"code": "E004B-404",
"message": "Beneficiário solicitante não encontrado",
"detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000027012 no cadastro (BA1)"
}
]
} |
|
|
|