CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
    1. ContinuousMedications - Inclusão de medicamentos de uso contínuo
  3. Tela api continuousMedications
    1. Outras Ações / Ações relacionadas
  4. Tela api continuousMedications
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


01. VISÃO GERAL

API para a entidade continuousMedications (Medicamentos de uso contínuo) do produto TOTVS Saúde Planos Linha Protheus.

Clique aqui para detalhes sobre como habilitar o serviço de APIs


API para obtenção do token de acesso às API’s REST no Protheus

De posse então do access_token obtido na api token, basta fazer a requisição à API desejada incluindo no cabeçalho o parâmetro Authorization com o valor Bearer mais o token de acesso.

Para nome composto, as APIs utilizam o padrão camelCase e quando a houver paginação será utilizado o padrão tudo minúsculo separado por hífen para os campos dentro do array items


02. EXEMPLO DE UTILIZAÇÃO

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

/totvsHealthPlans/refundSetup/v1/continuousMedications

POST

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
healthInsurerCodestringCódigo da operadora de saúde no sistemaBB0_CODOPE*required
subscriberIdstring

Matricula do beneficiário

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

B4F_MATRIC*required
professionalCouncilstring

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

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

B4F_SIGLA*required
professionalCouncilNumberstring

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

B4F_REGSOL*required
stateAbbreviationstring

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

B4F_ESTSOL*required
professionalNamestring

Nome do profissional de saúde da receita

(obtido através da API Professionals - v1.000 (Attendance Network))

BB0_NOME*required
prescriptionDatestring (date)Data da receitaB4F_DATINI*required
medicationsarrayMedicamentos de uso contínuo
*required
medications.tableCodestring

Código da tabela do medicamento

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

B7D_CODPAD*required
medications.medicationCodestring

Código do medicamento

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

B7D_CODMED*required
attachmentsarrayAnexos dos medicamentos
*required
attachments.hrefstringUrl do arquivo para que seja realizado o download
*required
{
	"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"
        }
    ]
}
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
{
    "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"
        }
    ]
}
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.
{
    "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}<<"
}
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.
{
    "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."
        }
    ]
}
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
{
    "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)"
        }
    ]
}

03. TELA API CONTINUOUSMEDICATIONS

Outras Ações / Ações relacionadas

AçãoDescrição
Inclua a ação Inclua a descrição relacionada
Inclua a ação Inclua a descrição relacionada
Inclua a ação Inclua a descrição relacionada

04. TELA API CONTINUOUSMEDICATIONS

Principais Campos e Parâmetros

CampoDescrição
Inclua o campo Inclua a descrição relacionada
Inclua o campo Inclua a descrição relacionada
Inclua o campo Inclua a descrição relacionada



05. TABELAS UTILIZADAS