Histórico da Página

...

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
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
prescriptionCode (query)	string	Filtro de medicamentos pelo código da receita no sistema
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
medicationCode (query)	string	Filtro de medicamentos pelo código
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.prescriptionStatusprescription_status	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.prescriptionCodeprescription_Code	string	Código da receita do medicamento	B7D_CODREC	*required
items.initialMedicationSateinitial_medication_date	string (date)	Data inicial da validade do medicamento	B7D_DTVINI	*required
items.finaMmedicationDatefinal_medication_date	string (date)	Data final da validade do medicamento	B7D_DTFVAL	*required
items.medicationCodemedication_code	string	Código do medicamento	B7D_CODMED	*required
items.medicationDescriptionmedication_description	string	Descrição do medicamento	BR8_DESCRI	*required
items.unitMeasureunit_measure	string	Unidade de consumo do medicamento	B7D_UNICON
items.quantityAuthorizedquantity_authorized	numeric (integer)	Quantidade autorizada do medicamento	B7D_QTDAUT
items.quantityExecutedquantity_executed	numeric (integer)	Quantidade utilizada (executada) do medicamento	B7D_QTDEXE
items.stateAbbreviationstate_abbreviation	string	Estado do conselho regional do profissional da receita	B4F_ESTSOL	*required
items.professionalCouncilprofessional_council	string	Sigla do conselho regional do profissional da receita	B4F_SIGLA	*required
items.professionalCouncilNumberprofessional_council_number	string	Numero do conselho regional do profissional da receita	B4F_REGSOL	*required
items.professionalNameprofessional_name	string	Nome do profissional da receita	BB0_NOME	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "prescriptionStatusprescription_status": "3",
            "prescriptionCodeprescription_code": "41750520230419000001",
            "initialMedicationDateinitial_medication_date": "2023-01-01",
            "finalMedicationDatefinal_medication_date": "2023-01-01",
            "medicationCodemedication_code": "0490269497",
            "medicationDescriptionmedication_description": "AAS ADULTO 500 MG COM CT BL AL PLAS INC X 20",
            "unitMeasureunit_measure": "",
            "quantityAuthorizedquantity_authorized": 9999,
            "quantityExecutedquantity_executed": 0,
            "stateAbbreviationstate_abbreviation": "SP",
            "professionalCouncilprofessional_council": "CRM",
            "professionalCouncilNumberprofessional_council_number": "1244477111",
            "professionalNameprofessional_name": "FRANCISCO"
        },
        {
            "prescriptionStatusprescription_status": "1",
            "prescriptionCodeprescription_code": "41750520230619000001",
            "initialMedicationDateinitial_medication_date": "2023-04-03",
            "finalMedicationDatefinal_medication_date": "2023-04-03",
            "medicationCodemedication_code": "0490173961",
            "medicationDescriptionmedication_description": "DRAMIN 100 MG COM CT BL AL PLAS INC X 20",
            "unitMeasureunit_measure": "",
            "quantityAuthorizedquantity_authorized": 0,
            "quantityExecutedquantity_executed": 0,
            "stateAbbreviationstate_abbreviation": "SP",
            "professionalCouncilprofessional_council": "CRM",
            "professionalCouncilNumberprofessional_council_number": "334456",
            "professionalNameprofessional_name": "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 subscriberId 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."
}

...

Árvore de páginas

Versões comparadas

Versão antiga 11

Nova versão 12

Chave