Criação de um novo item de cobrança

Esta chamada permite que prestadores de serviços de saúde, como hospitais, clínicas ou outras instituições, registrem cobranças vinculadas a atendimentos específicos realizados. Uma cobrança refere-se a um item associado ao atendimento do paciente, podendo incluir serviços médicos prestados, exames realizados, procedimentos executados ou materiais consumidos durante o cuidado. Cada cobrança criada será diretamente vinculada ao atendimento correspondente, garantindo rastreabilidade e integridade das informações para fins de faturamento e controle operacional.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Este campo representa o identificador único do item de cobrança no sistema. Ele deve ser gerado pelo sistema de gestão hospitalar (HIS) utilizado pela instituição, garantindo que seja único dentro do sistema para cada conta. Esse identificador será associado diretamente à linha de cobrança na conta do paciente e será utilizado para ações de atualização e exclusão de itens de cobrança no processo de integração entre o sistema de gestão hospitalar e o RCM. A ausência de unicidade ou inconsistências neste código pode comprometer a integridade das operações de manutenção e processamento de cobranças.

string
required

Este campo deve conter o código do atendimento concatenado com o código da conta, separados por um hífen (-). O formato padronizado garante a vinculação exata entre o atendimento e suas respectivas contas, especialmente em casos de internação, onde um único atendimento pode estar associado a várias contas. Regras de Apresentação O código do atendimento e o código da conta devem estar concatenados e separados por um hífen. Cada combinação deve ser representada separadamente. Exemplo Prático Paciente Maria esteve internada no período de 01/01/2025 a 15/01/2025. O atendimento foi identificado pelo código 123456, e as contas geradas durante a internação foram 789 e 91011. Nesse caso, as combinações devem ser apresentadas como: 123456-789 e 123456-91011

string

Representa o diagnóstico inicial que motivou o atendimento na unidade de saúde. Deve ser informado de forma clara e objetiva, descrevendo o motivo pelo qual o paciente procurou a instituição, incluindo sintomas ou condições relevantes. Por exemplo: "Internação hospitalar devido a forte dor abdominal" ou "Atendimento ambulatorial por febre alta e tosse persistente".

string
Defaults to UUIF

Identificador único da empresa prestadora de serviços ou do cliente responsável por gerar a cobrança. Este campo deve conter a descrição que identifica a organização no sistema, garantindo a rastreabilidade e associação correta das cobranças aos respectivos prestadores ou clientes.

string

Identificador único da empresa prestadora de serviços ou do cliente responsável por gerar a cobrança. Este campo deve conter o código ou chave que identifica a organização no sistema, garantindo a rastreabilidade e associação correta das cobranças aos respectivos prestadores ou clientes. Pelo menos um destes campos deve vir: provedor_branch_id provedor_branch_code

string
Defaults to UUID

Identificador do serviço ao qual a cobrança será vinculada. No sistema, este campo representa o tipo de atendimento prestado, como, por exemplo, atendimento ambulatorial, internação eletiva ou outros serviços realizados. É obrigatório fornecer pelo menos um dos seguintes campos para identificar o tipo de serviço: service_type_id, service_type_code ou service_type. Esses identificadores garantem que a cobrança seja corretamente associada ao tipo de atendimento correspondente.

string

Especifica o código que identifica o serviço ao qual a cobrança será vinculada. Esse campo é essencial para associar a cobrança ao tipo de atendimento realizado, como, por exemplo, atendimento ambulatorial ou internação eletiva. Para garantir a correta identificação, é necessário informar pelo menos um dos seguintes campos: service_type_id, service_type_code ou service_type.

string

Especifica o nome do serviço ao qual a cobrança será vinculada. Este campo é utilizado para descrever o tipo de atendimento prestado, como, por exemplo, "Atendimento Ambulatorial" ou "Internação Eletiva". Para assegurar a identificação correta do serviço, é obrigatório informar pelo menos um dos seguintes campos: service_type_id, service_type_code ou service_type.

boolean

Define se a cobrança deve ser associada à organização da conta final. Caso o valor não seja explicitamente informado, o sistema atribuirá o valor padrão True. Esse campo é utilizado para identificar os itens que serão apresentados e cobrados da operadora de saúde, garantindo que todos os elementos relevantes sejam incluídos na conta final.

date-time
Defaults to 2023-07-14T16:00:47.000Z

Data e hora de quando a cobrança foi criada, pode ter valor em data passada, mas não com valor futuro.

string
required

Este campo representa o código do convênio que identifica a relação entre o cliente (hospital ou instituição de saúde) e a fonte pagadora (operadora de saúde). Trata-se de um código referenciado que vincula o hospital à fonte pagadora responsável pelo pagamento.

string
required

Este campo representa o identificador único do paciente no sistema. Ele é usado para vincular todas as informações e interações associadas ao paciente de forma consistente e precisa.

string

Este campo armazena o nome completo do paciente. Ele é utilizado para identificação e conferência de informações no sistema.

string
enum

Este campo especifica o tipo de documento utilizado para identificar o paciente. Ele deve indicar, em texto, qual documento foi apresentado para vinculação ao atendimento. Regras de Uso O tipo de documento deve ser registrado de forma clara e padronizada. Valores permitidos: Carteirinha – Para atendimentos vinculados a operadoras de saúde que exigem o número da carteirinha do convênio. CPF – Para pacientes onde o CPF é aceito como documento de identificação. RG – Para pacientes identificados com o Registro Geral (documento de identidade). Passaporte – Para pacientes estrangeiros sem CPF ou RG. Exemplo Prático Carteirinha – Operadora de saúde exige este documento. CPF – Documento utilizado em atendimentos sem exigência de carteirinha. RG – Documento de identificação pessoal para residentes no Brasil. Passaporte – Identificação para pacientes estrangeiros.

Allowed:
string

Este campo armazena o número do documento utilizado para identificar o paciente, seja a carteirinha do convênio ou outro documento oficial.

double

Este campo representa a quantidade do item cobrado, indicando o número de unidades, serviços ou procedimentos realizados no atendimento/conta.

string
required

Esse campo corresponde ao código de apresentação do item de cobrança

string
required

Esse campo corresponde a descrição do item cobrança Exemplo Prático Foi realizado um lançamento de Seringa Preechida 10ml com o código 6789 na conta da paciente Maria no dia 01/01/2025. A descrição é : Seringa Preechida 10ml

double
required

Esse campo corresponde ao valor unitário do item de cobrança Exemplo Prático Foi realizado um lançamento de duas Seringas Preechidas 10ml com o código 6789 na conta da paciente Maria no dia 01/01/2025, com o valor Unitário de R$ 1,00 . O valor unitário é 1,00

string

Esse campo corresponde ao valor total dos itens de cobrança Exemplo Prático Foi realizado um lançamento de duas Seringas Preechidas 10ml com o código 6789 na conta da paciente Maria no dia 01/01/2025, com o valor Unitário de R$ 1,00 . O valor total é de 2,00

string
required

Moeda de cobrança. Por exemplo: COP, GTQ, USD, MXN, BRL Exemplo Prático R$ 2,00

string

Identificador do exame de diagnóstico Este é o mapeamento do número do estudo no onbase

string

Esse campo apresenta o código de diagnóstico na CID-10 Exemplo Prático: Dor localizada no abdome superior (R10.1). O código é R10.1

string

Esse campo apresenta a descrição do código de diagnóstico na CID-10 Exemplo Prático: Dor localizada no abdome superior (R10.1). A descrição é Dor localizada no abdome superior

boolean

Esse campo indica se a cobrança foi criada manualmente, ou seja através da interface web

string

Este campo deve conter o código que identifica a especialidade médica relacionada ao atendimento ou procedimento realizado.

string

Este campo deve conter a descrição textual da especialidade médica associada ao atendimento ou procedimento realizado. Texto descritivo, por exemplo: Clínica Geral Cardiologia Pediatria

string

Indica a senha de autorização fornecida pela operadora de saúde para cada conta médica do atendimento.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json