PreAppointmentDocumentResponse

Support document resource returned in successful responses

statusstring

Current status of the document (PENDING = placeholder awaiting upload, RECEIVED = file uploaded)

Possible values: [PENDING, RECEIVED]

Example: RECEIVED

pre_appointment_charge_idstring<uuid>

Identifier of the associated charge, if any

Example: 550e8400-e29b-41d4-a716-446655440001

support_file_namestring

Human-readable name of the support type, from the provider's document catalog. Null when the code has no catalog entry; consumers should fall back to supportFileCode.

Example: Guia médica

created_atstring<date-time>

Timestamp when the document record was created

Example: 2026-07-06T16:45:23.123-05:00

requiredboolean

Indicates whether this document is mandatory for the associated procedure

Example: true

original_file_namestring

Original file name provided by the client

Example: cpf-123.pdf

download_urlstring

Presigned URL to download the document; null if the document has no file yet

Example: https://osigu-rcm.s3.amazonaws.com/pre-attendance/...

support_file_codestring

Code identifying the type of support document

Example: CPF

sourcestring

Source of the document (HIS_INBOUND = from external HIS system, MANUAL = uploaded manually)

Possible values: [HIS_INBOUND, MANUAL]

Example: MANUAL

ai_validation_errorsstring

Raw AI validation detail as stored by the validation service; null when the document was never analysed or was approved. Forwarded verbatim (the consumer parses it), so the DVS contract can evolve without changing this API.

Example: {"aiAnalysisTypeApplied":"GUIA_TISS_INTERNACAO","errors":[{"field":"48 - Código na Operadora/CNPJ","value":null,"reason":"Falta assinatura do Beneficiário ou Responsável","subreason":null,"reasonKey":"SIGNATURE_NOT_PROVIDED","precisionPercentage":null}]}

ai_validation_precision_percentagenumber<double>

Overall confidence of the AI analysis, as a percentage

Example: 87.5

file_sizeinteger<int64>

File size in bytes

Example: 102400

provider_product_codestring

Provider product code of the associated charge, if any

Example: PROD-001

idstring<uuid>

Unique identifier (UUID) of the document record

Example: 550e8400-e29b-41d4-a716-446655440000

mime_typestring

Detected MIME type of the uploaded file

Example: application/pdf

ai_validation_statusstring

AI-based validation status of the document content

Possible values: [APPROVED, REJECTED, PENDING, NOT_APPLICABLE, ERROR]

Example: PENDING