Realiza a inclusão de novos medicamentos de uso contínuo para o beneficiário. | /totvsHealthPlans/refundSetup/v1/continuousMedications | |
| Nota |
|---|
| Expandir |
|---|
| | Authorization (header) | | Cabeçalho usado para autorização das requisições (Bearer token) | *required | Content-Type (header) | | 'application/json' é o formato do conteúdo | *required |
|
|
| Dica |
|---|
| Expandir |
|---|
| | 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 RegionalCouncils - v1.000 (Attendance Network)) | 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 API Medications - v1.000 (Procedure)) | B7D_CODPAD | *required | | medications.medicationCode | string | Código do medicamento (obtido através da api /totvsHealthPlans/procedure/v1/medications API Medications - v1.000 (Procedure)) | 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, 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
| 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) | 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) | 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: >>\"professionalCouncil\" : \"CRM\",\r\n \"stateAbbreviation\" : \"SP\",\r\n \"professionalName\" : \"VINICIUS\",\r\n \"prescriptionDate\" : \"2023-04-03\",\r\n\t\"professionalCouncilNumber\" : \"334457\",\r\n\t\"medications\" : [\r\n {\r\n \"tableCode\" : \"04\",\r\n \"medicationCode\" : \"0490173961\"\r\n }\r\n\t],\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}<<"
} |
|
|
| 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",
"detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
"details": [
{
"code": "E002D-406",
"message": "Tipo inválido para o campo professionalCouncilNumber",
"detailedMessage": "O valor do campo professionalCouncilNumber deve ser do tipo (C)."
},
{
"code": "E002A-406",
"message": "Campo attachments não informado",
"detailedMessage": "Não foi informado o campo attachments."
}
]
} |
|
|
| 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": "E003",
"message": "Operadora de Saúde não encontrada",
"detailedMessage": "Não foi encontrada nenhum operadora de saúde com o código 0099"
} |
|
|
| 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": "Beneficiário não encontrado",
"detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000027012"
} |
|
|
| Aviso |
|---|
| Expandir |
|---|
| title | (400) - Dados 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": "E005",
"message": "Erro ao incluir receita de medicamentos de uso continuo.",
"detailedMessage": "Verifique a lista de erros para mais detalhes",
"details": [
{
"code": "E005-1",
"message": "Não existe registro relacionado a chave informada no alias BR8, ordenação 1.",
"detailedMessage": "Id do campo de erro: B7D_CODMED; Id do erro: REGNOIS"
},
{
"code": "E005-1",
"message": "Erro ao realizar download do arquivo.",
"detailedMessage": "Status code: 404; Erro: Not Found\r\n; Url: https://www.totvs.com/wp-content/uploads/2022/04/totvs-shared.png?teste"
}
]
} |
|
|
|