Histórico da Página

...

Visão Geral
Exemplo de utilização
Tela api continuousMedications
1. Outras Ações / Ações relacionadas
Tela api continuousMedications
1. Principais Campos e Parâmetros
Tabelas utilizadas

...

Painel

titleColor	Orange
borderStyle	solid
title	ContinuousMedications - Inclusão de medicamentos de uso contínuo

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

/totvsHealthPlans/refundSetup/v1/continuousMedications

POST

Nota

Expandir

title	Parameters

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

Expandir

title	Request

healthInsurerCode	string	Código da operadora de saúde no sistema	BB0_CODOPE	*required
subscriberId	string	Matricula do beneficiário (obtido através da API Beneficiaries - v1.000 (Family Contract))	B4F_MATRIC	*required
professionalCouncil	string	Sigla do conselho regional do profissional de saúde da receita (obtido através da api /totvsHealthPlans/attendanceNetwork/v1/regionalCouncils)	B4F_SIGLA	*required
professionalCouncilNumber	string	Numero do conselho regional do profissional de saúde da receita	B4F_REGSOL	*required
stateAbbreviation	string	Estado do conselho regional do profissional de saúde da receita	B4F_ESTSOL	*required
professionalName	string	Nome do profissional de saúde da receita (obtido através da API Professionals - v1.000 (Attendance Network))	BB0_NOME	*required
prescriptionDate	string (date)	Data da receita	B4F_DATINI	*required
medications	array	Medicamentos de uso contínuo		*required
medications.tableCode	string	Código da tabela do medicamento (obtido através da api /totvsHealthPlans/procedure/v1/medications)	B7D_CODPAD	*required
medications.medicationCode	string	Código do medicamento (obtido através da api /totvsHealthPlans/procedure/v1/medications)	B7D_CODMED	*required
attachments	array	Anexos dos medicamentos		*required
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" : "2023-04-03",
	"professionalCouncilNumber" : "334456",
	"medications" : [
        {
            "tableCode" : "04",
            "medicationCode" : "0490173961"
        }
	],
    "attachments" : [
        {
            "href" : "https://www.totvs.com/wp-content/uploads/2021/04/totvs-shared.png?teste"
        }
    ]
}

Dica

Expandir

title	(201) - Operação realizada com sucesso

prescriptionCode	string	Código da receita no sistema	B4F_CODREC	*required
status	string	Status da receita dos medicamentos	B4F_STATUS	*required
prescriptionDescription	string	Descrição da receita	B4F_DESCRI	*required
subscriberId	string	Matricula do beneficiário	B4F_MATRIC	*required
subscriberName	string	Nome do beneficiário	BA1_NOMUSR	*required
registrationDate	string (date)

B4F_

Data de cadastro da receita do medicamento	B4F_DTCAD	*required
professionalCouncil	string	Sigla do conselho regional do profissional da receita	B4F_SIGLA	*required
stateAbbreviation	string	Estado do conselho regional do profissional da receita	B4F_ESTSOL	*required
professionalCouncilNumber	string	Numero do conselho regional do profissional da receita	B4F_REGSOL	*required
professionalName	string	Nome do profissional da receita	BB0_NOME	*required
startValidityDate	string (date)

B4F

Data inicial de validade da receita	B4F_DATINI	*required
endValidityDate	string (date)	Data final de validade da receita	B4F_DATFIN	*required
medications	array	Medicamentos de contínuo da receita		*required
medications.tableCode	string	Código da tabela do medicamento	B7D_CODPAD	*required
medications.medicationCode	string	Código do medicamento	B7D_CODMED	*required
medications.medicationDescription	string	Descrição do medicamento	BR8_DESCRI	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "prescriptionCode": "41750520230619000003",
    "status": "1",
    "prescriptionDescription": "Receita Nº 41750520230619000003.",
    "subscriberId": "00011008000027010",
    "subscriberName": "HERNANDES ALVES DA SILVA",
    "registrationDate": "2023-06-19",
    "professionalCouncil": "CRM",
    "stateAbbreviation": "SP",
    "professionalCouncilNumber": "334457",
    "professionalName": "VINICIUS",
    "startValidityDate": "2023-04-03",
    "endValidityDate": "2023-04-03",
    "medications": [
        {
            "tableCode": "04",
            "medicationCode": "0490173961",
            "medicationDescription": "DRAMIN 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: >>\"healthInsurerCodeprofessionalCouncil\" : \"0001CRM\",\r\n    \t\"subscriberIdstateAbbreviation\" : \"00011008000027010SP\",\r\n    \"refundReceiptsprofessionalName\" : [\r\n        {"VINICIUS\",\r\n            \"unreferencedNetworkIdentifierprescriptionDate\" : \"770777330001592023-04-03\",\r\n            \t\"unreferencedNetworkNameprofessionalCouncilNumber\" : \"JOSE334457\",\r\n\t\"medications\" : [\r\n          \"stateAbbreviation\" : \"SP\",\{\r\n            \"cityCodetableCode\" : \"350010504\",\r\n            \"documentCodemedicationCode\" : \"030490173961\",\r\n        }\r\n\t],\r\n    \"documentNumberattachments\" : [\"000001235\",r\n        {\r\n            \"documentDatehref\" : \"2023-06-07\",https://www.totvs.com/wp-content/uploads/2021/04/totvs-shared.png?teste\"\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}<<"
}]\r\n}<<"
}

Aviso

Expandir

title	(406) - Campos 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": "E002",
    "message": "Os campos do json no body estão inválidos",

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 doVerifique a lista de erros no campo statusdetails devepara ser: 0;1"mais detalhes.",
        },"details": [
        {
            "code": "E002BE002D-406",
            "message": "Campo healthInsurerCode obrigatórioTipo inválido para o campo professionalCouncilNumber",
            "detailedMessage": "Não foi informado valorO valor do campo professionalCouncilNumber deve ser do campotipo healthInsurerCode(C)."
        },
        {
            "code": "E002EE002A-406",
            "message": "Tamanho inválido paraCampo attachments não informado",
            "detailedMessage": "Não foi informado o campo healthInsurerCodeattachments.",
            "detailedMessage": "O valor do campo healthInsurerCode deve ter o tamanho 4."
        },
        {
            }
    ]
}

Aviso

Expandir

title	(404) - Operadora não encontrada

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

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E002E-406E003",
    "message": "Operadora de Saúde não encontrada",
    "messagedetailedMessage": "Tamanho inválido paraNão foi encontrada nenhum operadora de saúde com o campocódigo subscriberId0099",
            "detailedMessage": "O valor do campo subscriberId deve ter o tamanho 17."
        },
        {
            "code": "E002B-406",
   
}

Aviso

Expandir

title	(404) - Beneficiário não encontrado

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

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E004         "message": "Campo refundReceipts obrigatório",
    "message": "Beneficiário não  encontrado",
    "detailedMessage": "Não foi informadoencontrado valornenhum dobeneficiário campo refundReceipts."
        }
    ]
com a matricula 00011008000027012"
}

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": "E003E005",
    "message": "DadosErro inválidosao paraincluir realizarreceita ade solicitaçãomedicamentos de reembolsouso continuo.",
    "detailedMessage": "Verifique osa detalheslista dosde erros nopara campomais detailsdetalhes",
    "details": [
        {
            "code": "E004AE005-4041",
            "message": "Operadora de saúde não encontradaNão existe registro relacionado a chave informada no alias BR8, ordenação 1.",
            "detailedMessage": "Não foi encontrada nenhuma operadora "Id do campo de saúde com o código 0099 no cadastro (BA0)erro: B7D_CODMED; Id do erro: REGNOIS"
        },
        {
            "code": "E004BE005-4041",
            "message": "Beneficiário solicitante não encontradoErro ao realizar download do arquivo.",
            "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000027012 no cadastro (BA1)"detailedMessage": "Status code: 404; Erro: Not Found\r\n; Url: https://www.totvs.com/wp-content/uploads/2022/04/totvs-shared.png?teste"
        }
    ]
}

03. TELA API CONTINUOUSMEDICATIONS

...

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão 4

Chave

03. TELA API CONTINUOUSMEDICATIONS