API Buscar Profissionais Responsáveis - Lista profissionais responsaveis

Só são suportadas integrações no padrão REST.

Introdução

Método de listagem de atividades do programa de APS

Método "aps/profissionaisResponsaveis"

Este método é obrigatório;
Atente-se aos critérios de preenchimento;
Atente-se as mensagens de retorno para cada HTTPS Status Code;

Endpoint

Endpoint	Método	Header Content-Type	Descrição

Endpoint	Método	Header Content-Type	Descrição
exemplo.com / aps/profissionaisResponsaveis Atenção O endpoint obrigatoriamente deve terminar com “/aps/profissionaisResponsaveis	POST	application/json

Parâmetros de entrada

Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.

Serão enviados no BODY os seguintes parâmetros:

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro	Obrigatório	Tipo	Descrição
chaveUnica	M	String	Chave de identificação do usuário retornada no login
integracao	OP	Objeto	Nó integração retornado no login do usuário
beneficiario	M	Objeto	Beneficiario selecionado para agendamento da consulta
idPrograma	OP	Number	ID do programa cadastrado pela PREVIVA	Exemplo: Programa de atenção primaria a saúde
idGrupo	OP	Number	ID do grupo cadastrado pela PREVIVA	Exemplo: Programa de nutrição
idSubgrupo	OP	Number	ID do subgrupo cadastrado pela PREVIVA	Exemplo: Nivel intermediario

{
    "chaveUnica":"String",
    "integracao":{ Objeto },
    "beneficiario":{ Objeto }
    "idPrograma:": Number,
    "idGrupo:": Number,
    "idSubgrupo:": Number,
}

Objeto beneficiario

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição
chaveUnica	M	String	Chave de identificação do paciente
numeroContrato	M	String	Número do contrato do paciente
integracao	OP	Objeto	Nó integração retornado no login do usuário

{
    "beneficiario":{
      "chaveUnica":"String",
      "numeroContrato":"String",
      "integracao":{ Objeto }
}

Exemplo request

{
  "chaveUnica": "101012",
  "integracao": {
    "cpf": "123456789123",
    "numero_cartao": "9288701",
  },
  "beneficiario": {
    "chaveUnica": "101012", //geralmente é o cpf
    "numeroContrato": "616161",
    "integracao": {
        "cpf": "123456789123", 
        "numero_cartao": "9288701",
      },
  },
  "idPrograma":123,
  "idGrupo":123,
  "idSubgrupo":123,
}

Descrição dos objetos e atributos de retorno - Sucesso

Está indicado abaixo a estrutura de retorno do método. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.

Objeto principal

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
profissionais	M	Array de objetos do tipo "profissional"

Objeto “profissional"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
codigoProfissional	M	Numer	Codigo identificador do profissional cadastrada no Previva
nome	M	String	Nome
tratamento	OP	Objeto do tipo item	Define o tratamento a ser utilizado: Sr Sra. …
foto	OP	String	URL do arquivo
sexo	OP	Objeto do tipo item
tipoPessoa	OP	Objeto do tipo item	Identifica o tipo de pessoa: Fisica Juridica
tipoProfissional	OP	Objeto do tipo item	Identifica o tipo de profissional: Enfermeiro Medico
vinculo	OP	Objeto do tipo item	Identifica o tipo de vinculo: cooperado …
contato	OP	Objeto do tipo “contato"
dadosConselho	OP	Objeto do tipo “dadosConselho"
programa	M	Objeto do tipo programa
horarioAtendimento	OP	Array de objetos do tipo “horario"	Data na qual a atividade foi realizada	Formato esperado: `YYYY-MM-DD HH:mm:ss`
profissionalResponsavel	M	Boolean	Indica que se o medico é um responsável pelo paciente

Objeto “contato"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo
telefone	OP	String
telefoneCelular	OP	String
email	OP	String
whatsapp	OP	String

Objeto “item"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
codigo	M	Numer	Codigo identificador do item
descricao	M	String	Descrição do item

Objeto "dadosConselho"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição
numero	M	Numer	numero do conselho
uf	M	String	uf do conselho
tipoConselho	M	Objeto do tipo “tipoConselho"

Objeto "tipoConselho"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição
codigo	M	String	Codigo do tipo de conselho
descricao	M	String	Descrição do tipo de conselho
sigla	M	String	Sigla do conselho

Objeto "programa"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição
codigo	M	Numer	Codigo identificador do porgrama
titulo	M	String	Titulo do programa
descricao	OP	String	Descrição do programa
icone	OP	String	Icone do programa
grupos	OP	Array de objetos do tipo "grupo"

Objeto "grupo"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição
codigo	M	Numer	Codigo identificador do grupo
titulo	M	String	Titulo do grupo
descricao	OP	String	Descrição do grupo
icone	OP	String	Icone do grupo
subgrupo	OP	Objeto do tipo subgrupo

Objeto "subgrupo"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição
codigo	M	Numer	Codigo identificador do subgrupo
titulo	M	String	Titulo do subgrupo
descricao	OP	String	Descrição do subgrupo
icone	OP	String	Icone do subgrupo

Objeto "horarioAtendimento"

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Regra de preenchimento
diaSemana	M	Objeto o tipo "item"	Enum de dias da semana
horaInicio	M	String
horaFim	OP	String

Mosia Omnichannel Parceiros