Convert a canonical patient event into an HL7 v2.x ADT message

curl -X POST /api/v1/canonical/patient/to-hl7 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "event_type": "PATIENT_REGISTERED",
  "event_timestamp": "2026-07-31T10:12:24Z",
  "event_id": 65,
  "patient": {
    "patient_identity": {
      "patient_id": 32410364,
      "is_relative": false,
      "lab_patient_id": "",
      "patient_type": "I",
      "designation": "",
      "national_health_id": "",
      "passport_number": "",
      "national_identity_number": "",
      "aadhar_number": "",
      "pan_number": "",
      "ssn_number": ""
    },
    "patient_name": {
      "full_name": "Saurabh Testing",
      "first_name": "Saurabh",
      "middle_name": "",
      "last_name": "Testing"
    },
    "demographics": {
      "gender": "Male",
      "date_of_birth": "2009-05-01",
      "age": 17,
      "age_in_days": 6300,
      "nationality": "",
      "ethnicity": "",
      "race": ""
    },
    "contact_information": {
      "mobile_number": "",
      "alternate_contact": "",
      "country_code": "91",
      "email": "",
      "alternate_email": ""
    },
    "address_information": {
      "address": "",
      "area": "",
      "area_of_residence": "",
      "landmark": "",
      "city": "",
      "state": "",
      "pincode": ""
    },
    "clinical_information": {
      "clinical_history": "",
      "clinical_history_index": "",
      "diseases": "",
      "allergies": "",
      "height": "",
      "weight": "",
      "doctor_code": "",
      "ward_number": ""
    },
    "insurance_information": {
      "insurance_number": "",
      "medical_scheme_code": "",
      "medical_schemes_code_id": "",
      "sponsorship": "",
      "debtor_id": "",
      "recent_insurances": []
    },
    "system_information": {
      "option_code": "",
      "worker_code": ""
    },
    "audit_information": {
      "user_registration_date": "2026-07-30T06:21:02Z",
      "last_updated_time": "2026-07-31T10:11:54Z",
      "created_by": "",
      "updated_by": ""
    },
    "guarantor_information": {}
  },
  "organization_details": {
    "org_id": 219935,
    "org_full_name": "prepaid qty",
    "org_email": "",
    "org_code": "acho8V",
    "org_type": "",
    "org_address": ""
  },
  "referral_details": {
    "referral_npi": "",
    "referral_email": "-",
    "referred_name": "SELFA2",
    "referral_source": ""
  },
  "laboratory_information": {
    "lab_id": 3871,
    "lab_name": "CrelioHealth Demo Center",
    "lab_timezone": "America/New_York",
    "lab_user_id": "",
    "lab_user": "",
    "source": ""
  },
  "rule_templates": [],
  "integration_configs": {
    "id": 5384,
    "vendor_master": 8,
    "protocol": "HL7",
    "configuration_data": {
      "category": "ADT",
      "actionType": "A31 - Patient Update",
      "connection_type": "TCP/IP",
      "version": "2.5",
      "configurations": {},
      "segments": [
        "MSH",
        "EVN",
        "PV1",
        "PID",
        "GT1",
        "IN1"
      ],
      "labDetails": {
        "name": "",
        "cliaNumber": "",
        "address": ""
      },
      "reportSettings": {
        "templateName": "",
        "reportSettingId": 13384,
        "templateText": "",
        "header": false,
        "footer": false,
        "sendBillPdfBase64": false,
        "docSignNoPageBreak": false,
        "isDbTemplate": false
      },
      "emailSettings": {
        "enabled": false,
        "to": "",
        "cc": ""
      }
    },
    "name": "ADT - Patient Update (TCP)",
    "host": "hl7.example.com",
    "port": 2575,
    "organization_ids": [],
    "is_active": true,
    "action_type": 65
  }
}'

{
  "version": "string",
  "segment_count": 1,
  "hl7_message": "string",
  "segments": [
    "string"
  ],
  "rules_applied": [
    {
      "rule_id": 1,
      "rule_name": "string",
      "action": "string",
      "applied": true,
      "detail": "string",
      "skipped_by_condition": false,
      "errored": false
    }
  ]
}

Convert a canonical :class:PatientEvent into an HL7 v2.x ADT message.

Runs the full build pipeline minus delivery: build the ADT segments, apply the configuration flags, render the message, then apply the event’s rule_templates (as HL7 rules). The payload is the same canonical structure accepted by /patient/validate, including integration_configs which drives the HL7 version and which optional segments to emit.

Returns the HL7 message as both a \r-joined string and a list of segments (reflecting any rule-driven changes), plus the per-rule log.

Convert a canonical :class:`PatientEvent` into an HL7 v2.x ADT message. Runs the full build pipeline minus delivery: build the ADT segments, apply the configuration flags, render the message, then apply the event's ``rule_templates`` (as HL7 rules). The payload is the same canonical structure accepted by ``/patient/validate``, including ``integration_configs`` which drives the HL7 version and which optional segments to emit. Returns the HL7 message as both a ``\r``-joined string and a list of segments (reflecting any rule-driven changes), plus the per-rule log.

Authentication

AuthorizationBearer

Static shared-secret token for internal service-to-service calls.

Request

This endpoint expects an object.

event_typeenumRequired

Type of patient lifecycle event

event_timestampdatetimeRequired

UTC timestamp when the event occurred (ISO 8601)

event_idintegerRequired

Unique monotonic event identifier

patientobjectRequired

Full patient record

organization_detailsobject or nullOptional

Organisation context (absent when the event has no org)

referral_detailsobject or nullOptional

Referral source context (absent when there is no referral)

laboratory_informationobject or nullOptional

Laboratory context (absent when not supplied)

rule_templateslist of objectsOptional

Rule templates attached to the event (applied downstream)

integration_configsobject or nullOptional

Integration configuration used to build the outbound message

integration_payloadmap from strings to any or nullOptional

Transport/logging metadata (log_id, lab_id, callback context). Not part of the canonical event; forwarded to the delivery layer so the Fusion worker receives full context / the Mirth receiver gets LABID/LOGID segments.

Response

Successful Response

versionstring

HL7 version of the rendered message, e.g. '2.5'

segment_countinteger

Number of segments in the message

hl7_messagestring

Rendered HL7 message (‘\r’-joined)

segmentslist of strings

The message split into segments

rules_appliedlist of objectsOptional

Per-rule execution log

Errors

422

Unprocessable Entity Error