Skip to main content
Request models define the structure of data sent to the HL7 connectivity providers. These DTOs are used for authentication and HL7 operations.

​
Authentication Requests

​
LoginRequest

Authentication request containing user credentials and device information. Package: com.hl7client.model.dto.request.auth
​
apiKey
String
required
API key for authentication with the HL7 connectivity provider
​
email
String
required
User’s email address
​
password
String
required
User’s password
​
device
DeviceRequest
required
Device information for the authentication request

​
Example

DeviceRequest device = new DeviceRequest(
    "messaging-id-123",
    "device-id-456",
    "My Desktop"
);

LoginRequest request = new LoginRequest(
    "your-api-key",
    "[email protected]",
    "password123",
    device
);

​
DeviceRequest

Device information included in authentication requests. Package: com.hl7client.model.dto.request.auth
​
messagingid
String
required
Messaging identifier for push notifications
​
deviceid
String
required
Unique device identifier
​
devicename
String
required
Human-readable device name
​
bloqueado
boolean
Whether the device is blocked (always false in constructor)
​
recordar
boolean
Whether to remember the device (always false in constructor)

​
HL7 Operation Requests

​
ElegibilidadRequest

Eligibility verification request to check patient coverage and benefits. Package: com.hl7client.model.dto.request.hl7 Serialization: Fields with null values are excluded from JSON output (@JsonInclude(JsonInclude.Include.NON_NULL))

​
Operation Data

​
modo
String
Operation mode (max length: 1)
​
creden
String
Credential/card number (max length: 19)
​
alta
String
Registration timestamp in ISO format: yyyy-MM-dd'T'HH:mm:ss
​
fecdif
String
Differential date in format: yyyy-MM-dd
​
manual
Manual
Manual processing indicator (enum value)

​
Technical Data

​
ticketExt
Integer
External ticket number
​
termId
String
Terminal identifier
​
interNro
Integer
Internal number

​
Provider Data

​
cuit
String
Provider’s CUIT (tax identification number)
​
oriMatri
String
Origin of provider registration/license

​
Previous Result

​
autoriz
Integer
Authorization number from previous operation
​
rechaExt
Integer
External rejection code from previous operation

​
RegistracionRequest

Service registration request for submitting healthcare services and procedures. Package: com.hl7client.model.dto.request.hl7 Serialization: Fields with null values are excluded from JSON output

​
Operation Data

​
modo
String
Operation mode (max length: 1)
​
creden
String
Credential/card number (max length: 23)
​
tipo
Integer
Transaction type (tinyint)
​
alta
String
Registration timestamp (datetime)
​
fecdif
String
Differential date (max length: 10)
​
manual
Manual
Manual processing indicator
​
consulta
Manual
Consultation indicator

​
Technical Data

​
ticketExt
Integer
External ticket number
​
termId
String
Terminal identifier (max length: 20)
​
interNro
Integer
Internal number

​
Provider Data

​
cuit
String
Provider’s CUIT (max length: 40)
​
oriMatri
String
Origin of provider registration (max length: 10)

​
Previous Result

​
autoriz
Integer
Authorization number from previous operation
​
rechaExt
Integer
External rejection code (smallint)

​
HL7 Extended Fields

​
icd
String
ICD diagnosis code (max length: 6)
​
param1
String
Free parameter 1 (max length: 255)
​
param2
String
Free parameter 2 (max length: 255)
​
param3
String
Free parameter 3 (max length: 255)
​
tipoEfector
String
Type of effector/provider (max length: 4)
​
idEfector
String
Effector identifier (max length: 11)
​
tipoPrescr
String
Type of prescriber (max length: 4)
​
idPrescr
String
Prescriber identifier (max length: 11)
​
msgId
String
Message identifier (max length: 20)
​
ackacept
String
Acknowledgment acceptance code (max length: 2)
​
ackackapl
String
Acknowledgment application code (max length: 2)
​
tipoMensaje
String
Message type (max length: 1)
​
powerBuilder
Boolean
PowerBuilder client flag

​
CancelacionRequest

Cancellation request for reversing previously registered services. Package: com.hl7client.model.dto.request.hl7 Serialization: Fields with null values are excluded from JSON output

​
Operation Data

​
modo
String
Operation mode (typically “N”)
​
creden
Long
Credential/card number
​
tipo
Integer
Transaction type
​
alta
String
Registration timestamp (can be empty)
​
manual
Manual
Manual processing indicator (nullable)

​
Cancellation Data

​
ticketExt
Integer
External ticket number
​
cancelCab
Integer
Cancellation header identifier (nullable)
​
cancelModo
String
Cancellation mode (typically “N”)
​
errorExt
Integer
External error code (nullable)

​
Technical Data

​
termId
String
Terminal identifier
​
interNro
Integer
Internal number

​
Provider Data

​
cuit
Long
Provider’s CUIT

​
Free Parameters

​
param1
String
Free parameter 1
​
param2
String
Free parameter 2

​
Enumerations

​
Manual

Indicates the processing mode for HL7 operations. Package: com.hl7client.model.dto.request.hl7 Values:
​
MANUAL
String
Manual processing mode (value: “0”)
​
CAPITADOR
String
Capitation mode (value: “C”)
​
COMSULTA
String
Consultation mode (value: “L”)
The enum values are serialized to their string representations using @JsonValue.

​
Example

ElegibilidadRequest request = new ElegibilidadRequest();
request.setManual(Manual.MANUAL);
// Serializes as: {"manual": "0"}

Build docs developers (and LLMs) love

Get started for freeTalk to us