Comparação de Páginas

Tópicos:

Índice

1- URL base API

Ambientes	URL
Produção	https://admin.mosia.chat/api

2- Endpoint

Endpoint

Método

Descrição

/prontuario/carregarProntuarioPublico?protocolo=<protocolo_chamado>

GET

Método responsável por retornar formulários dinâmicos do prontuário do paciente, incluindo referência e contra-referência.

Obs: Prescrições não são retornadas neste endpoint, necessário consultar o endpoint de chamado (https://mobilesaudejira.atlassian.net/l/cp/VWHepMJj ).

3- Autenticação (Headers)

Key	Value	Descrição
Authorization	<TOKEN_API_MOSIA>	Token de autenticação pode ser encontrado na página de configuração de integração com CRM no painel administrativo.

Para obter o TOKEN_API_MOSIA relacionado ao CRM. siga os passos:

Acesse a administração do MOSIA, em admin.mosia.chat
No menu principal, acesse "Ajustes Gerais" e habilite o CRM;
Indique uma URL de CALLBACK e salve as mudanças.
Um token será exibido. Este é o token que será utilizado nas integrações destas APIs.

4- Body Response

4.1- Objeto “raiz” do retorno

Propriedade	Tipo	Descrição
status	Boolean	Indica sucesso ou falha do request
data	Array	Contém um objeto com os registros de prontuário (Formulários, referência e contra-referência)
critica	Array	Pode retornar mensagens de erro. Este dado pode ser obtido no campo msg da raízraiz
timestamp	Timestamp	Timestamp do retorno
msg	String	Mensagem de retorno de sucesso ou falha

4.2- Objeto “data” do retorno

Propriedade	Tipo	Descrição
id_modelo_prontuario	Int	Id do modelo de prontuário. O Um modelo de prontuário é responsável por reunir um conjunto de formulários. Para cada atendente/Médico é possível vincular apenas 1 Modelo de prontuário. Sendo assim, o array “data” pode ter apenas 1 objeto.
registros	Array	Retorna objetos com os registros de prontuário (Formulários , referência e contra-referênciadinâmicos)
encaminhamento	Object	Retorna os objetos de referência e contra-referência

4.3- Objeto “registro” do array “registros“ do retorno

Propriedade

Tipo

Descrição

section_id

String

Id da seção de prontuário.

Informações
Utilizamos a seção de prontuário para vincular os formulários criados no FormBuilder e retorná-los para o painel do Atendente/Médico.

section

String

Nome da seção de prontuário visível para o Atendente/Médico.

data

Object

Retorna um conjunto de dados (campos) dinâmicos, que podem ser cadastrados no FormBuilder de acordo com cada necessidade/padrão do cliente.

Exemplo de campo do tipo texto:

Bloco de código

language	json

"queixa-principal-": "Exemplo de queixa principal",

Exemplo de campo do tipo radio-buttombutton:

Bloco de código

language	json

"diabetes": {
  "label": "Sim",
  "value": "S"
}

4.4- Objeto “encaminhamento” do array “data“ do retorno

Propriedade	Tipo	Descrição
referencias	Array	Retorna um ou mais objetos de referências criadas.
contra_referencia	Object	Retorna um objeto de contra-referência.

4.5- Objeto “referencia” do array “referencias“ do retorno

Propriedade	Tipo	Descrição
id_prontuario_referencia	String	Id do encaminhamento (referência).
id_prontuario_paciente	String	Id do prontuário do paciente
id_agenda	String	id da agenda do cliente
data_agenda	String	Data da agenda
hora_agenda	String	Hora da agenda
data_referencia	String	Data da criaçao da referência
id_unico_beneficiario	String	Chave única do beneficiário
nome_paciente	String	Nome do paciente
id_medico	String	Id do médico
protocolo	String	Protocolo do atendimento
id_especialidade	String	Id especialidade
nome_especialidade	String	Nome da Especialidade
codigo_cid	String	Código CID da especialidade
nome_cid	String	Nome CID da especialidade
tipo_consulta	String	Tipo da consulta (“0“ = Teleconsulta / “2” = Presencial)
data_validade	String	Data de validade da referência
historico_objetivo	String	Descrição do histórico e/ou objetivos
concluido	String	Indica se a referência foi concluída (“0“ = Não / “1” = Sim)
data_conclusao	String	Data de conclusão da referência

4.6- Objeto “contra_referencia” do objeto “encaminhamento“ do retorno

Propriedade	Tipo	Descrição
id_prontuario_contra_referencia	String	Id da contra-referência.
id_prontuario_referencia	String	Id do encaminhamento (referência).
id_agenda	String	id da agenda do cliente
data_agenda	String	Data da agenda
hora_agenda	String	Hora da agenda
id_medico	String	Id do médico
nome_medico	String	Nome do médico
protocolo	String	Protocolo do atendimento
data_contra_referencia	String	Data da criaçao da contra-referência
analise_clinica	String	Descrição da análise clínica
sugestao_cuidado	String	Decrição de sugestão e cuidado

5- Exemplo de retorno com sucesso (200)

Bloco de código

language	json

{
  "status": true,
  "data": [
    {
      "id_modelo_prontuario": 30,
      "registros": [
        {
          "section_id": "39",
          "section": "Anminese",
          "data": {
            "queixa-principal-": "Exemplo de queixa principal",
            "problemas-renais-": "Exemplo de problemas renais",
            "problemas-articulares-ou-reumatismo-": "",
            "problemas-cardiacos-": "Descrevendo problemas cardíacos",
            "problemas-respiratorios-": "",
            "problemas-gastricos-": "",
            "alergias-": "",
            "hepatite-": {
              "label": "Não",
              "value": "N"
            },
            "gravidez-": {
              "label": "Não",
              "value": "N"
            },
            "diabetes-": {
              "label": "Sim",
              "value": "S"
            },
            "problemas-de-cicatrizacao-": {
              "label": "Sim",
              "value": "S"
            }
          }
        },
        {
          "section_id": "40",
          "section": "Exames Físicos",
          "data": {
            "altura-": "1.76",
            "peso-": "89",
            "frequencia-cardiaca-": "",
            "pressao-arterial-sistolica-": "",
            "pressao-arterial-diastolica-": ""
          }
        },
        {
          "section_id": "41",
          "section": "Hipótese diagnóstica",
          "data": {}
        }
      ],
      "encaminhamento": {
        "referencias": [
          {
            "id_prontuario_referencia": "58876",
            "id_prontuario_paciente": "328170",
            "id_agenda": "12411570500000120230",
            "data_agenda": "2023-03-01",
            "hora_agenda": "10:00:00",
            "data_referencia": "2023-03-01",
            "id_unico_beneficiario": "rafael@mobilesaude.com.br",
            "nome_paciente": "Rafael Simão AG: 1001010",
            "id_medico": "124115705",
            "nome_medico": "Rafael S. 2 - Geneticista",
            "protocolo": "120230301000001",
            "id_especialidade": "201115",
            "nome_especialidade": "Geneticista",
            "codigo_cid": "A010",
            "nome_cid": "Febre tifóide",
            "tipo_consulta": "0",
            "data_validade": null,
            "historico_objetivo": "Descrição de histórico e/ou objetivos",
            "concluido": "1",
            "data_conclusao": "2023-03-01"
          }
        ],
        "contra_referencia": {
          "id_prontuario_contra_referencia": "8084",
          "id_prontuario_referencia": "58876",
          "id_agenda": "AEAE00000120230301",
          "data_agenda": "2023-03-01",
          "hora_agenda": "10:00:00",
          "id_medico": "AEAE",
          "nome_medico": "Rafael S. 1",
          "protocolo": "120230301000002",
          "data_contra_referencia": "2023-03-01",
          "analise_clinica": "Descrevendo análise.",
          "sugestao_cuidado": "Descrevendo sugestões e cuidados."
        }
      }
    }
  ],
  "critica": [
    null
  ],
  "timestamp": "2023-03-01T12:02:02+00:00",
  "msg": "Sucesso"
}

6- Exemplo de retorno com falha (STATUS_CODE)

Informações
Neste caso podemos ter casos de status_code igual a 200, e “status” do body response igual a “false“.

Bloco de código

language	json

{
    "status": false,
    "data": [],
    "critica": [
        null
    ],
    "timestamp": "2023-03-01T12:04:02+00:00",
    "msg": "Acesso não autorizado"
}

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

1- URL base API

2- Endpoint

3- Autenticação (Headers)

4- Body Response

4.1- Objeto “raiz” do retorno

4.2- Objeto “data” do retorno

4.3- Objeto “registro” do array “registros“ do retorno

4.4- Objeto “encaminhamento” do array “data“ do retorno

4.5- Objeto “referencia” do array “referencias“ do retorno

4.6- Objeto “contra_referencia” do objeto “encaminhamento“ do retorno

5- Exemplo de retorno com sucesso (200)

6- Exemplo de retorno com falha (STATUS_CODE)