Skip to main content
Response models define the structure of data received from the HL7 connectivity providers. These DTOs contain operation results, patient information, and transaction details.
All response classes use @JsonIgnoreProperties(ignoreUnknown = true) to ignore unexpected fields from the API.

​
Authentication Responses

​
LoginResponse

Authentication response containing the session token and provider information. Package: com.hl7client.model.dto.response.auth
​
token
String
required
JWT authentication token for subsequent API requests
​
exp
String
required
Token expiration timestamp
​
modelEspecifico
Prestador
required
Provider-specific information and permissions

​
Example

LoginResponse response = authService.login(loginRequest);
String token = response.getToken();
Prestador provider = response.getModelEspecifico();
System.out.println("Logged in as: " + provider.getRazonSocialPrestador());

​
Prestador

Provider information included in the login response. Package: com.hl7client.model.dto.response.auth
​
emailPrestador
String
Provider’s email address
​
cuitPrestador
String
Provider’s CUIT (tax identification number)
​
apellidoPrestador
String
Provider’s last name
​
nombrePrestador
String
Provider’s first name
​
razonSocialPrestador
String
Provider’s business name
​
habilitaADP
String
ADP (Autorizaciones de Prestaciones) enablement flag
​
idPrestador
Integer
Provider’s internal identifier
​
idUsuario
Integer
User’s internal identifier
​
codPrestador
Integer
Provider’s code
​
admin
Boolean
Whether the user has administrator privileges

​
HL7 Operation Responses

​
ElegibilidadResponse

Eligibility verification response containing patient coverage and benefit information. Package: com.hl7client.model.dto.response.hl7

​
Patient Information

​
apeNom
String
Patient’s full name (last name, first name)
​
pmi
String
Patient Medical Identifier
​
edad
Integer
Patient’s age
​
sexo
String
Patient’s biological sex
​
sexoAuto
String
Self-declared sex
​
generoAuto
String
Self-declared gender

​
Coverage Information

​
planCodi
String
Plan code
​
gravado
String
Tax status indicator
​
leyimp
String
Tax law applicable

​
Transaction Information

​
transac
String
Transaction identifier
​
transacAlta
String
Transaction creation timestamp

​
Rejection/Error Information

​
rechaCabecera
Integer
Header rejection code (0 if approved)
​
rechaCabeDeno
String
Header rejection description
​
icdDeno
String
ICD diagnosis description

​
Example

Hl7Result<ElegibilidadResponse> result = hl7Service.checkElegibilidad(request);

if (result.isOk()) {
    ElegibilidadResponse response = result.getData().get();
    if (response.getRechaCabecera() == 0) {
        System.out.println("Patient: " + response.getApeNom());
        System.out.println("Plan: " + response.getPlanCodi());
    } else {
        System.out.println("Rejected: " + response.getRechaCabeDeno());
    }
}

​
RegistracionResponse

Service registration response containing transaction results and item-level details. Package: com.hl7client.model.dto.response.hl7
​
cabecera
RegistracionCabecera
required
Header information with patient and transaction data
​
detalle
RegistracionDetalle[]
Array of detail items (may be null if no items were processed)
The detalle array often comes as null when there are no item-level rejections or observations.

​
RegistracionCabecera

Header information from a registration response. Package: com.hl7client.model.dto.response.hl7

​
Transaction Information

​
transac
Long
Transaction identifier assigned by the provider
​
transacAlta
String
Transaction creation timestamp
​
autoriz
Integer
Authorization number (if approved)

​
Rejection/Status Information

​
rechaCabecera
Integer
Header rejection code (0 if approved)
​
rechaCabeDeno
String
Header rejection description

​
Patient Information

​
apeNom
String
Patient’s full name
​
pmi
String
Patient Medical Identifier
​
edad
Integer
Patient’s age
​
sexo
String
Patient’s biological sex
​
sexoAuto
String
Self-declared sex
​
generoAuto
String
Self-declared gender

​
Coverage Information

​
planCodi
String
Plan code
​
gravado
String
Tax status indicator
​
leyimp
String
Tax law applicable

​
Additional Information

​
icdDeno
String
ICD diagnosis description
​
nomPrestad
String
Provider name
​
sucursal
String
Branch/office information

​
RegistracionDetalle

Detail-level item information from a registration response. Package: com.hl7client.model.dto.response.hl7
​
transac
Long
Transaction identifier
​
recha
Integer
Item rejection code (0 if approved)
​
denoItem
String
Item description or rejection message

​
Example

RegistracionResponse response = result.getData().get();
RegistracionCabecera cabecera = response.getCabecera();

if (cabecera.getRechaCabecera() == 0) {
    System.out.println("Approved! Auth: " + cabecera.getAutoriz());
    
    if (response.getDetalle() != null) {
        for (RegistracionDetalle item : response.getDetalle()) {
            if (item.getRecha() != 0) {
                System.out.println("Item rejected: " + item.getDenoItem());
            }
        }
    }
} else {
    System.out.println("Rejected: " + cabecera.getRechaCabeDeno());
}

​
CancelacionResponse

Cancellation response containing the result of a service cancellation request. Package: com.hl7client.model.dto.response.hl7
​
cabecera
CancelacionCabecera
required
Header information with cancellation result
​
detalle
CancelacionDetalle[]
Array of detail items showing per-item cancellation results

​
CancelacionCabecera

Header information from a cancellation response. Package: com.hl7client.model.dto.response.hl7

​
Transaction Information

​
transac
Long
Transaction identifier
​
transacAlta
String
Transaction creation timestamp

​
Rejection/Status Information

​
rechaCabecera
Integer
Header rejection code (0 if cancellation was successful)
​
rechaCabeDeno
String
Header rejection description

​
Patient Information

​
apeNom
String
Patient’s full name
​
pmi
String
Patient Medical Identifier
​
edad
Integer
Patient’s age
​
sexo
String
Patient’s biological sex

​
Coverage Information

​
planCodi
String
Plan code
​
gravado
String
Tax status indicator
​
leyimp
String
Tax law applicable

​
CancelacionDetalle

Detail-level item information from a cancellation response. Package: com.hl7client.model.dto.response.hl7
​
transac
Long
Transaction identifier
​
recha
Integer
Item rejection code (0 if cancellation was successful)
​
denoItem
String
Item description or cancellation rejection message

​
Example

CancelacionResponse response = result.getData().get();
CancelacionCabecera cabecera = response.getCabecera();

if (cabecera.getRechaCabecera() == 0) {
    System.out.println("Cancellation successful");
} else {
    System.out.println("Cancellation rejected: " + cabecera.getRechaCabeDeno());
}

if (response.getDetalle() != null) {
    for (CancelacionDetalle item : response.getDetalle()) {
        System.out.println("Item: " + item.getDenoItem() + 
                         " - Status: " + (item.getRecha() == 0 ? "OK" : "Rejected"));
    }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us