Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Painel
titleColorOrange
borderStylesolid
titleContinuousMedications - Inclusão de medicamentos de uso contínuo

Realiza a inclusão de novos medicamentos de uso contínuo para o beneficiário.

/totvsHealthPlans/attendancerefundSetup/v1/refundscontinuousMedications

POST

Nota
Expandir
titleParameters
Authorization (header)

string

Cabeçalho usado para autorização das requisições (Bearer token)*required

Content-Type (header)

string

'application/json' é o formato do conteúdo*required
Dica
*required
Expandir
titleRequest
statusstring

Define o status final do protocolo, sendo:

  • 1 - Protocolado
  • 0 - Solicitação não concluída 
solicitante do protocoloBOWUSUARIrefundReceipts
healthInsurerCodestringCódigo da operadora de saúde no sistemaBOWBB0_OPEMOVCODOPE*required
subscriberIdstring

Matricula do beneficiário

(obtido através da API Beneficiaries - v1.000 (Family Contract))

B4F_MATRIC*required
professionalCouncilarrayComprovantes de reembolso*requiredstring

Sigla do conselho regional do profissional de saúde da receita

(obtido através da api /totvsHealthPlans/attendanceNetwork/v1/regionalCouncils)

B4F_SIGLArefundReceipts.unreferencedNetworkIdentifierstringCPF/CNPJ do prestador de serviçoB1N_PRCNPJ*required
refundReceipts.unreferencedNetworkNameprofessionalCouncilNumberstring

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.stateAbbreviationstring

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.cityCodeprofessionalNamestring

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.documentCodeprescriptionDatestring (date)Data da receitaB4F_DATINI*required
medicationsarrayMedicamentos de uso contínuo
*required
medications.tableCodestring

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.documentNumbermedicationCodestringNumero do documentoB1N_NUMDOCrefundReceipts.documentDatestring (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.expensesattachmentsarrayDespesas do comprovante de reembolsoAnexos dos medicamentos
*required
refundReceiptsattachments.expenses.subscriberIdhrefstring

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.procedureClassstring

Código do tipo de despesa utilizado

(obtido através da api totvsHealthPlans/procedure/v1/classes)

B1N_TIPSER*required
refundReceipts.expenses.tableCodestring

Código da tabela da despesa

(obtido através da api /totvsHealthPlans/procedure/v1/classes/{classId}/procedures)

B1N_CODPAD*required
refundReceipts.expenses.procedureCodestring

Código da despesa

(obtido através da api /totvsHealthPlans/procedure/v1/classes/{classId}/procedures)

B1N_CODPRO*required
refundReceipts.expenses.continuousUsestring

Quando a despesa for medicamento, informa se é de uso contínuo, sendo:

  • 0 - Não
  • 1 - Sim
B1N_USOCON*required
refundReceipts.expenses.prescriptionCodestring

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.expenseAmountnumber (double)Valor total da despesaB1N_VLRTOT*required
refundReceipts.expenses.quantitynumber (integer)Quantidade de despesaB1N_QTDPRO*required
refundReceipts.expenses.executionDatestring (date)Data de execução da despesaB1N_DATPRO*required

refundReceipts.attachments

array

Anexos do comprovante

Obrigatório quando for informado o status igual a 1 - Protocolado

refundReceipts.attachments.hrefstringUrl do arquivo para que seja realizado o download*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
	"healthInsurerCode" : "0001",
	"subscriberId" : "00011008000027010",
	"professionalCouncil" : "CRM",
    "stateAbbreviation" : "SP",
    "professionalName" : "VINICIUS",
    "prescriptionDate
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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
prescriptionCodestring
B4F_CODREC*required
statusstring
B4F_STATUS
prescriptionDescriptionstring
B4F_DESCRI
subscriberIdstring
B4F_MATRIC
subscriberNamestring
BA1_NOMUSR
registrationDatestring (date)
B4F_DTCAD
professionalCouncilstring
B4F_SIGLA
stateAbbreviationstring
B4F_ESTSOL
professionalCouncilNumberstring
B4F_REGSOL
professionalNamestring
BB0_NOME
startValidityDatestring (date)
B4F_DATINI
endValidityDatestring (date)
B4F_DATFIN
medicationsarray


medications.tableCodestring
B7D_CODPAD
medications.medicationCodestring
B7D_CODMED
medications.medicationDescriptionstring
BR8_DESCRI
Dica
*required
Expandir
title(201) - Operação realizada com sucesso
protocolstringNumero do protocolo gerado para o reembolsoBOW_PROTOC*required
statusstring

Status do protocolo:

  • 0 - Solicitação não concluída
  • 1 - Protocolado
BOW_STATUS*required
requestDatestring (date)Data de solicitaçãoBOW_DTDIGI*required
presentedAmountnumeric (double)Valor apresentadoBOW_VLRAPR*required
refundedAmountnumeric (double)Valor reembolsadoBOW_VLRREEpaymentDatestring (date)Data de pagamento do reembolsoBOW_PGMTO
beneficiaryNamestring

Nome do beneficiário solicitante

BOW_NOMUSR*required
linksarray

links relacionados ao recurso refunds (Padrão HATEOAS):

  • rel: expenses (Despesas do protocolo)
  • rel: attachments (Anexos do protocolo)

Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "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)"
        }
    ]
}

...