Histórico da Página

...

Informações

title	Nomenclatura das APIs

Para nome composto, as APIs utilizam o padrão camelCasee 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

...

Painel

titleColor	Orange
borderStyle	solid
title	ContinuousMedications - Retorna os medicamentos de uso contínuo

Retorna os medicamentos de uso contínuo do beneficiário

/totvsHealthPlans/refundSetup/v1/continuousMedications

GET

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
subscriber-id subscriberId (query)	string	Matricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO) (obtido através da API Beneficiaries - v1.000 (Family Contract))	*required
prescription-code prescriptionCode (query)	string	Filtro de medicamentos pelo código da receita no sistema
prescription-status prescriptionStatus (query)	string	Filtro de medicamentos pelo status da receita, sendo: 0 - Solicitado (Portal) 1 - Protocolado 2 - Em Analise 3 - Deferido 4 - Indeferido 5 - Deferido Parcialmente 6 - Pendente Inf. beneficiário A - Solicitação não concluída pode ser enviado mais de um status. Exemplo: 0,1,2,3
medication-code medicationCode (query)	string	Filtro de medicamentos pelo código
expiration-date expirationDate (query)	string	Filtro de medicamentos pela validade, sendo: 1 - Medicamentos dentro da validade 2 - Medicamentos fora da validade
page (query)	string	Valor numérico (maior que zero) representando a página solicitada
pageSize (query)	string	Valor numérico (maior que zero) representando o total de registros retornados na consulta
order (query)	string	Lista de campos para ordenação, separada por virgula (,).
fields (query)	string	Lista com o nome das propriedades JSON que serão retornadas.
filter (query)	string	Filtros seguindo o padrão ODATA

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

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

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	numeric (integer)	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de medicamentos
items.prescription-statusprescriptionStatus	string	Status da receita do medicamento: 0 - Solicitado (Portal) 1 - Protocolado 2 - Em Analise 3 - Deferido 4 - Indeferido 5 - Deferido Parcialmente 6 - Pendente Inf. beneficiário A - Solicitação não concluída	B4F_STATUS	*required
items.prescription-codeprescriptionCode	string	Código da receita do medicamento	B7D_CODREC	*required
items.initial-medication-dateinitialMedicationSate	string (date)	Data inicial da validade do medicamento	B7D_DTVINI	*required
items.final-medication-datefinaMmedicationDate	string (date)	Data final da validade do medicamento	B7D_DTFVAL	*required
items.medication-codemedicationCode	string	Código do medicamento	B7D_CODMED	*required
items.medication-descriptionmedicationDescription	string	Descrição do medicamento	BR8_DESCRI	*required
items.unit-measureunitMeasure	string	Unidade de consumo do medicamento	B7D_UNICON
items.quantity-authorizedquantityAuthorized	numeric (integer)	Quantidade autorizada do medicamento	B7D_QTDAUT
items.quantity-executedquantityExecuted	numeric (integer)	Quantidade utilizada (executada) do medicamento	B7D_QTDEXE
items.state-abbreviationstateAbbreviation	string	Estado do conselho regional do profissional da receita	B4F_ESTSOL	*required
items.professional-councilprofessionalCouncil	string	Sigla do conselho regional do profissional da receita	B4F_SIGLA	*required
items.professional-council_numberprofessionalCouncilNumber	string	Numero do conselho regional do profissional da receita	B4F_REGSOL	*required
items.professional-nameprofessionalName	string	Nome do profissional da receita	BB0_NOME	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "prescription-statusprescriptionStatus": "3",
            "prescription-codeprescriptionCode": "41750520230419000001",
            "initial-medication-dateinitialMedicationDate": "2023-01-01",
            "final-medication-datefinalMedicationDate": "2023-01-01",
            "medication-codemedicationCode": "0490269497",
            "medication-descriptionmedicationDescription": "AAS ADULTO 500 MG COM CT BL AL PLAS INC X 20",
            "unit-measureunitMeasure": "",
            "quantity-authorizedquantityAuthorized": 9999,
            "quantity-executedquantityExecuted": 0,
            "state-abbreviationstateAbbreviation": "SP",
            "professional-councilprofessionalCouncil": "CRM",
            "professional-council_numberprofessionalCouncilNumber": "1244477111",
            "professional-nameprofessionalName": "FRANCISCO"
        },
        {
            "prescription-statusprescriptionStatus": "1",
            "prescription-codeprescriptionCode": "41750520230619000001",
            "initial-medication-dateinitialMedicationDate": "2023-04-03",
            "final-medication-datefinalMedicationDate": "2023-04-03",
            "medication-codemedicationCode": "0490173961",
            "medication-descriptionmedicationDescription": "DRAMIN 100 MG COM CT BL AL PLAS INC X 20",
            "unit-measureunitMeasure": "",
            "quantity-authorizedquantityAuthorized": 0,
            "quantity-executedquantityExecuted": 0,
            "state-abbreviationstateAbbreviation": "SP",
            "professional-councilprofessionalCouncil": "CRM",
            "professional-council_numberprofessionalCouncilNumber": "334456",
            "professional-nameprofessionalName": "VINICIUS"
        }
    ],
    "hasNext": true,
    "remainingRecords": 3
}

Aviso

Expandir

title	(406) - Parâmetros obrigatórios

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": "E001",
    "message": "Existem chaves obrigatórias que não foram informadas.",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001-406",
            "message": "Chave subscriber-idsubscriberId obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave subscriber-id."
        }
    ]
}

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": "E001",
    "message": "Beneficiário não encontrado",
    "detailedMessage": "Não foi possível retornar os dados do beneficiário através da matrícula informada."
}

...

Painel

titleColor	Orange
borderStyle	solid
title	Refunds - Retorna os protocolos de reembolso do medicamento

Retorna protocolos de reembolso vinculado ao medicamento de uso contínuo.

/totvsHealthPlans/refundSetup/v1/continuousMedications/refunds

GET

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
prescription-code prescriptionCode (query)	string	Código da receita do medicamento	*required
medication-code medicationCode (query)	string	Filtro de medicamentos pelo código
page (query)	string	Valor numérico (maior que zero) representando a página solicitada
pageSize (query)	string	Valor numérico (maior que zero) representando o total de registros retornados na consulta
order (query)	string	Lista de campos para ordenação, separada por virgula (,).
fields (query)	string	Lista com o nome das propriedades JSON que serão retornadas.
filter (query)	string	Filtros seguindo o padrão ODATA

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

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

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	numeric (integer)	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de protocolos do medicamento
items.prescription-codeprescriptionCode	string	Código da receita do medicamento	B1N_CODREC	*required
items.medication-codemedicationCode	string	Código do medicamento	B1N_CODPRO	*required
items.medication-descriptionmedicationDescription	string	Descrição do medicamento	BR8_DESCRI	*required
items.protocol	string	Numero do protocolo de reembolso	B1N_PROTOC	*required
items.status	string	Status do protocolo de reembolso, sendo: 0 = Solicitado (Portal) 1 = Protocolado 2 = Em analise 3 = Deferido 4 = Indeferido 5 = Em digitação 6 = Lib. financeiro 7 = Não lib. financeiro 8 = Glosado 9 = Auditoria A = Solicitação não concluída B = Aguardando informação do Beneficiário C = Aprovado Parcialmente D = Cancelado E = Reembolso Revertido	BOW_STATUS	*required
items.request-daterequestDate	string (date)	Data de solicitação do reembolso	BOW_DTDIGI	*required
items.quantity-requestedquantityRequested	numeric (integer)	Quantidade no reembolso	B1N_QTDMED	*required
items.repayment-daterepaymentDate	string (date)	Data de pagamento do reembolso	BOW_DATPAG

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{{
    "items": [
        {
            "prescription-code": "41750520230419000001",
            "medication-code": "0490173961",
            "medication-description": "DRAMIN 100 MG COM CT BL AL PLAS INC X 20",
            "protocol": "41750520230525000002",
            "status": "A",
            "request-date": "2023-05-25",
            "quantity-requested": 1,
            "repayment-date": "2023-05-24"
        },
        {
            "prescription-code": "41750520230419000001",
            "medication-code": "0490173961",
            "medication-description": "DRAMIN 100 MG COM CT BL AL PLAS INC X 20",
            "protocol": "41750520230529000001",
            "status": "A",
            "request-date": "2023-05-29",
            "quantity-requested": 1,
            "repayment-date": "2023-04-24"
        },"items": [
        {
            "prescription-codeprescriptionCode": "41750520230419000001",
            "medication-codemedicationCode": "0490173961",
            "medication-descriptionmedicationDescription": "DRAMIN 100 MG COM CT BL AL PLAS INC X 20",
            "protocol": "4175052023060100002241750520230525000002",
            "status": "A",
            "request-daterequestDate": "2023-0605-0125",
            "quantity-requestedquantityRequested": 1,
            "repayment-daterepaymentDate": "2023-05-3024"
        },
        {
            "prescription-codeprescriptionCode": "41750520230419000001",
            "medication-codemedicationCode": "0490173961",
            "medication-descriptionmedicationDescription": "DRAMIN 100 MG COM CT BL AL PLAS INC X 20",
            "protocol": "4175052023060100002541750520230529000001",
            "status": "A",
            "request-daterequestDate": "2023-0605-0129",
            "quantity-requestedquantityRequested": 1,
            "repayment-daterepaymentDate": "2023-0504-3024"
        }
    ],
    "hasNext": true,
    "remainingRecords": 30
}

Aviso

Expandir

title	(406) - Parâmetros obrigatórios

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": "E001",
    "message": "Existem chaves obrigatórias que não foram informadas.",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001-406",
            "message": "Chave prescription-codeprescriptionCode obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave prescription-code."
        }
    ]
}

Aviso

Expandir

title	(404) - Receita 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": "E001",
    "message": "Receita Não Encontrada",
    "detailedMessage": "Não foi possível retornar os dados da receita através do código da receita informada."
}

...

Árvore de páginas

Versões comparadas

Versão antiga 10

Nova versão 11

Chave

02. EXEMPLO DE UTILIZAÇÃO