TOTVS - RESTFul API

GET

{apiVersion}/accreditations

Description

Acreditacoes do prestador

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
healthprovidercode	string	optional
locationcode	string	optional

GET

{apiVersion}/appealValid

Description

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
protocol	string	optional
formnumber	string	optional
healthprovidercode	string	optional

GET

{apiVersion}/authorizationBatch/{batchCode}

Description

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
batchcode	string	optional

GET

{apiVersion}/authorizations/{idHealthIns}

Description

Retorna os dados do atendimento de um beneficiario

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
authorizationtype	string	optional
action	string	optional
healthprovidercode	string	optional
locationcode	string	optional
showdeniedproc	boolean	optional
_pathparam	Undefined	Undefined
idhealthins	string	optional

GET

{apiVersion}/batchesAuthorization

Description

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
healthprovidercode	string	optional
protocol	string	optional

GET

{apiVersion}/beneficiaryElegibility

Description

Find beneficiary by CPF or CARD NUMBER

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
cardnumberorcpf	string	optional
authorizationtype	string	optional
healthprovidercode	string	optional

GET

{apiVersion}/cbos

Description

CBOS de um prestador

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
page	string	optional
pagesize	string	optional
locationcode	string	optional
healthproviderid	string	optional
filter	string	optional

GET

{apiVersion}/authorizations/{idHealthIns}/clinicalAttachments

Description

Retorna os anexos clinicos de uma guia

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
page	string	optional
pagesize	string	optional
expand	string	optional
_pathparam	Undefined	Undefined
idhealthins	string	optional

GET

{apiVersion}/clinicalStaff

Description

Retorna Corpo Clinico

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
healthprovidercode	string	optional
locationcode	string	optional
specialtycode	string	optional
pagesize	string	optional
page	string	optional

GET

{apiVersion}/competenceProtocols

Description

Retorna os dados da competencia do prestador

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
healthprovidercode	string	optional
sequential	string	optional
month	string	optional
year	string	optional
page	string	optional
pagesize	string	optional

GET

{apiVersion}/executions/{idHealthIns}

Description

Lista execuções de tratamento seriado

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
idhealthins	string	optional

GET

{apiVersion}/glossedAppeal

Description

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
healthprovidercode	string	optional
page	string	optional
pagesize	string	optional
fields	string	optional
expand	string	optional
order	string	optional
protocol	string	optional
formnumber	string	optional
initialperiod	string	optional
finalperiod	string	optional
appealprotocol	string	optional
status	string	optional

GET

{apiVersion}/healthProviders/{healthProviderCode}

Description

Dados de um prestador

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
healthprovidercode	string	optional

GET

{apiVersion}/healthProviders/{healthProviderCode}/healthProviderSpecialities

Description

Especialidades de um prestador

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
page	string	optional
pagesize	string	optional
attendancelocation	string	optional
_pathparam	Undefined	Undefined
healthprovidercode	string	optional

GET

{apiVersion}/authorizations/{idHealthIns}/initialSituation

Description

Retorna as prorrogacoes de uma guia

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
page	string	optional
pagesize	string	optional
expand	string	optional
_pathparam	Undefined	Undefined
idhealthins	string	optional

GET

{apiVersion}/itemAppeal

Description

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
healthprovidercode	string	optional
sequential	string	optional
page	string	optional
pagesize	string	optional
fields	string	optional
expand	string	optional
order	string	optional
status	string	optional

GET

{apiVersion}/knowledgeBank

Description

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
attachmentskey	string	optional
filename	string	optional

GET

{apiVersion}/patientHealthcareFacility

Description

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
healthprovidercode	string	optional
codrda	string	optional

GET

{apiVersion}/paymentCalendar

Description

Retorna o periodo do calendario de pagamento

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

GET

{apiVersion}/procedures

Description

Pesquisa de procedimentos para execucao

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
action	string	optional
filter	string	optional
tablecode	string	optional
procedureid	string	optional
customwhere	string	optional
page	string	optional
pagesize	string	optional
healthprovidercode	string	optional

GET

{apiVersion}/procedures/{procedureId}

Description

Pesquisa de procedimentos para execucao

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
procedureid	string	optional

GET

{apiVersion}/professionals/{professionalCode}/cbos

Description

CBOS de um profissional

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
page	string	optional
pagesize	string	optional
filter	string	optional
_pathparam	Undefined	Undefined
professionalcode	string	optional

GET

{apiVersion}/professionals

Description

Busca profissionais de saude

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
healthproviderid	string	optional
idonhealthinsurer	string	optional
stateabbreviation	string	optional
professionalcouncil	string	optional
professionalcouncilnumber	string	optional
officialrecord	string	optional
professionaltype	string	optional
healthprovidertype	string	optional
expand	string	optional
fields	string	optional
name	string	optional
page	string	optional
pagesize	string	optional
action	string	optional
filterclinicalstaffrequest	boolean	optional
filterclinicalstaffexecution	boolean	optional
isodonto	boolean	optional

GET

{apiVersion}/professionals/{professionalCode}/professionalSpecialities

Description

Especialidades de um profissional

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
page	string	optional
pagesize	string	optional
_pathparam	Undefined	Undefined
professionalcode	string	optional

GET

{apiVersion}/healthProviders

Description

Dados de um prestador

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
healthproviderid	string	optional
page	string	optional
pagesize	string	optional

GET

{version}/beneficiaries/{subscriberId}/block

Description

Retorna solicitação de protocolo de bloqueio do beneficiários

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
subscriberid	string	optional

GET

{apiVersion}/procedures/{procedureId}/teethRegions/{teethRegionId}/surfaces

Description

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
expand	string	optional
fields	string	optional
_pathparam	Undefined	Undefined
procedureid	string	optional
teethregionid	string	optional

GET

{apiVersion}/procedures/{procedureId}/teethRegions/

Description

Pesquisa de procedimentos para execucao

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
expand	string	optional
fields	string	optional
_pathparam	Undefined	Undefined
procedureid	string	optional

GET

{apiVersion}/authorizations/{idHealthIns}/treatmentExtensions

Description

Retorna as prorrogacoes de uma guia

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
page	string	optional
pagesize	string	optional
expand	string	optional
_pathparam	Undefined	Undefined
idhealthins	string	optional

GET

{apiVersion}/userUsage

Description

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
page	string	optional
pagesize	string	optional
fields	string	optional
expand	string	optional
order	string	optional
initialperiod	string	optional
finalperiod	string	optional
subscriberid	string	optional
procedurecode	string	optional
executiondate	string	optional
healthprovidercode	string	optional
healthproviderdocument	string	optional
cid	string	optional
procedurename	string	optional
healthprovidername	string	optional
quantity	string	optional
toothregion	string	optional
face	string	optional

POST

{apiVersion}/apoInfo

Description

Retorna os status dos fontes passados no body

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

POST

{apiVersion}/authorizations

Description

Verifica se pode realizar o reenvio de uma Solic TISS online no HAT

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
resendbatch	boolean	optional
action	string	optional

POST

{apiVersion}/benefPortalPassRec

Description

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

POST

{apiVersion}/clinicalStaff

Description

Adiciona um profissional em um corpo clinico

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

POST

{apiVersion}/BenefFirstAccess

Description

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

POST

{apiVersion}/glossedAppeal

Description

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

POST

{apiVersion}/knowledgeBank

Description

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

POST

{apiVersion}/pegTransfer

Description

Realiza a transferencias de guias para PEGs de faturamento

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

POST

{apiVersion}/postAuditXml

Description

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

POST

{apiVersion}/professionals

Description

Cadastra profissional de Saude

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

POST

{apiVersion}/procedureAuthorization

Description

Authorization of procedure

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
procedureid	string	optional

POST

{version}/beneficiaries/{subscriberId}/block

Description

Solicita protocolo de bloqueio dos beneficiários pela RN 402

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
subscriberid	string	optional

POST

{apiVersion}/tokenBenef/{subscriberId}

Description

Retorna o token de atendimento de um beneficiario

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
subscriberid	string	optional

PUT

{apiVersion}/authorizationBatch

Description

Alteração do campo correspondente ao lote do HAT de uma guia

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
batchcode	string	optional
action	string	optional
idonhealthinsurer	string	optional

PUT

{apiVersion}/batchNotes/{protocol}

Description

Alteração do campo de notas de um lote

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
protocol	string	optional

PUT

{apiVersion}/clinicalStaff/{id}/block

Description

Bloqueia um profissional do corpo clinico

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

PUT

{apiVersion}/hospitalizationDate/{authorizationId}

Description

Informar data de internação/alta

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
authorizationid	string	optional

PUT

{apiVersion}/knowledgeBank/{attachmentsKey}

Description

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

PUT

{apiVersion}/competenceProtocols/{sequential}

Description

Altera o status de uma competencia do prestador

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
sequential	string	optional

TOTVS - RESTFul API

Service: /totvshealthplans/

Métodos

GET {apiVersion}/accreditations

Description

GET {apiVersion}/appealValid

Description

GET {apiVersion}/authorizationBatch/{batchCode}

Description

GET {apiVersion}/authorizations/{idHealthIns}

Description

GET {apiVersion}/batchesAuthorization

Description

GET {apiVersion}/beneficiaryElegibility

Description

GET {apiVersion}/cbos

Description

GET {apiVersion}/authorizations/{idHealthIns}/clinicalAttachments

Description

GET {apiVersion}/clinicalStaff

Description

GET {apiVersion}/competenceProtocols

Description

GET {apiVersion}/executions/{idHealthIns}

Description

GET {apiVersion}/glossedAppeal

Description

GET {apiVersion}/healthProviders/{healthProviderCode}

Description

GET {apiVersion}/healthProviders/{healthProviderCode}/healthProviderSpecialities

Description

GET {apiVersion}/authorizations/{idHealthIns}/initialSituation

Description

GET {apiVersion}/itemAppeal

Description

GET {apiVersion}/knowledgeBank

Description

GET {apiVersion}/patientHealthcareFacility

Description

GET {apiVersion}/paymentCalendar

Description

GET {apiVersion}/procedures

Description

GET {apiVersion}/procedures/{procedureId}

Description

GET {apiVersion}/professionals/{professionalCode}/cbos

Description

GET {apiVersion}/professionals

Description

GET {apiVersion}/professionals/{professionalCode}/professionalSpecialities

Description

GET {apiVersion}/healthProviders

Description

GET {version}/beneficiaries/{subscriberId}/block

Description

GET {apiVersion}/procedures/{procedureId}/teethRegions/{teethRegionId}/surfaces

Description

GET {apiVersion}/procedures/{procedureId}/teethRegions/

Description

GET {apiVersion}/authorizations/{idHealthIns}/treatmentExtensions

Description

GET {apiVersion}/userUsage

Description

POST {apiVersion}/apoInfo

Description

POST {apiVersion}/authorizations

Description

POST {apiVersion}/benefPortalPassRec

Description

POST {apiVersion}/clinicalStaff

Description

POST {apiVersion}/BenefFirstAccess

Description

POST {apiVersion}/glossedAppeal

Description

POST {apiVersion}/knowledgeBank

Description

POST {apiVersion}/pegTransfer

Description

POST {apiVersion}/postAuditXml

GET

{apiVersion}/accreditations

GET

{apiVersion}/appealValid

GET

{apiVersion}/authorizationBatch/{batchCode}

GET

{apiVersion}/authorizations/{idHealthIns}

GET

{apiVersion}/batchesAuthorization

GET

{apiVersion}/beneficiaryElegibility

GET

{apiVersion}/cbos

GET

{apiVersion}/authorizations/{idHealthIns}/clinicalAttachments

GET

{apiVersion}/clinicalStaff

GET

{apiVersion}/competenceProtocols

GET

{apiVersion}/executions/{idHealthIns}

GET

{apiVersion}/glossedAppeal

GET

{apiVersion}/healthProviders/{healthProviderCode}

GET

{apiVersion}/healthProviders/{healthProviderCode}/healthProviderSpecialities

GET

{apiVersion}/authorizations/{idHealthIns}/initialSituation

GET

{apiVersion}/itemAppeal

GET

{apiVersion}/knowledgeBank

GET

{apiVersion}/patientHealthcareFacility

GET

{apiVersion}/paymentCalendar

GET

{apiVersion}/procedures

GET

{apiVersion}/procedures/{procedureId}

GET

{apiVersion}/professionals/{professionalCode}/cbos

GET

{apiVersion}/professionals

GET

{apiVersion}/professionals/{professionalCode}/professionalSpecialities

GET

{apiVersion}/healthProviders

GET

{version}/beneficiaries/{subscriberId}/block

GET

{apiVersion}/procedures/{procedureId}/teethRegions/{teethRegionId}/surfaces

GET

{apiVersion}/procedures/{procedureId}/teethRegions/

GET

{apiVersion}/authorizations/{idHealthIns}/treatmentExtensions

GET

{apiVersion}/userUsage

POST

{apiVersion}/apoInfo

POST

{apiVersion}/authorizations

POST

{apiVersion}/benefPortalPassRec

POST

{apiVersion}/clinicalStaff

POST

{apiVersion}/BenefFirstAccess

POST

{apiVersion}/glossedAppeal

POST

{apiVersion}/knowledgeBank

POST

{apiVersion}/pegTransfer

POST

{apiVersion}/postAuditXml

POST

{apiVersion}/professionals

POST

{apiVersion}/procedureAuthorization

POST

{version}/beneficiaries/{subscriberId}/block

POST

{apiVersion}/tokenBenef/{subscriberId}

PUT

{apiVersion}/authorizationBatch

PUT

{apiVersion}/batchNotes/{protocol}

PUT

{apiVersion}/clinicalStaff/{id}/block

PUT

{apiVersion}/hospitalizationDate/{authorizationId}

PUT

{apiVersion}/knowledgeBank/{attachmentsKey}

PUT

{apiVersion}/competenceProtocols/{sequential}