HL7 ADT Data Transformation Documentation

HL7 ADT Data Transformation

Transform HL7 ADT messages into the full HL7 Message in JSON. Our transformation works both ways, allowing you to also transform JSON into an accurate HL7 ADT message.

Our current supported HL7 version: 2.5.1

Need help with some of our documentation? Feel free to contact our support team, and one of our support team members will be happy to assist you.

HL7 ADT Message to JSON API Request

Transform any HL7 ADT message into JSON while having all of the data transformed into the JSON format.

post https://api-hl7.splinxtechnologies.com/v1/hl7-transformation/2-5-1/hl7-to-json

Request headers

Authentication

To make REST API calls, make sure to include your account's email and password in a Base64 encrypted format in the Basic authentication scheme. The value is <Account-Email> and <Account-Password>

LicenseId

Sample request

HL7 ADT_A02 Message Copy

MSH|^~\&|||||19880705||ADT^A02^ADT_A02|83457831|D^A|2.5.1|||||USA
EVN|20030705|20030706|01
PID|1||22^^ISO^^AND^^^^X-Ray impression&W4&&&&&&An x-ray impression||Smith&&Billson&&Smith^Billson^^^^^U^P^^^^19880705^20990705||19780705|M|||||||||||||||Chicago|N|||||||||19880705
PD1|O~U||Sample Organization^L^^^^^^FACILITY1&1.2.3.4.5.6.7&ISO^P|||||||||Y|19880704
PV1|1|E|||||Smith&&Billson&&Smith^Billson^^^^^^^U^^NPI^^^^^^G|||||||||||||H03^19880705|||||||||||||||||Hospital^19880705||||||||19880705

Sample response

JSON Copy

{
  "seg_01_MSH_R": {
    "seq_01_FieldSeparator_R": "|",
    "seq_02_EncodingCharacter_R": "^~\\&",
    "seq_03_SendingApplication_O_TBL0361": {},
    "seq_04_SendingFacility_O_TBL0362": {},
    "seq_05_ReceivingApplication_O_TBL0361": {},
    "seq_06_ReceivingFacility_O_TBL0362": {},
    "seq_07_DateTimeOfMessage_R": {
      "seq_01_Time_R": {
        "seq_01_DateTime": "19880705"
      },
      "seq_02_DegreeOfPrecision_B_TBL0529": ""
    },
    "seq_08_Security_O": "",
    "seq_09_MessageType_R": {
      "seq_01_MessageCode_R_TBL0076": "ADT",
      "seq_02_TriggerEvent_R_TBL0003": "A02",
      "seq_03_MessageStructure_R_TBL0354": "ADT_A02"
    },
    "seq_10_MessageControlID_R": "83457831",
    "seq_11_ProcessingID_R": {
      "seq_01_ProcessingID_O_TBL0103": "D",
      "seq_02_ProcessingMode_O_TBL0207": "A"
    },
    "seq_12_VersionID_R": {
      "seq_01_VersionID_O_TBL0104": "2.5.1",
      "seq_02_InternationalizationCode_O_TBL0399": {},
      "seq_03_InternationalVersionID_O": {}
    },
    "seq_13_SequenceNumber_O": "",
    "seq_14_ContinuationPointer_O": "",
    "seq_15_AcceptAcknowledgmentType_O_TBL0155": "",
    "seq_16_ApplicationAcknowledgmentType_O_TBL0155": "",
    "seq_17_CountryCode_O_TBL0399": "USA",
    "seq_18_CharacterSet_O_TBL0211": [],
    "seq_19_PrincipalLanguageOfMessage_O": {},
    "seq_20_AlternateCharacterSetHandlingSchema_O_TBL0356": "",
    "seq_21_MessageProfileIdentifier_O": []
  },
  "seg_02_SFT_O": [],
  "seg_03_EVN_R": {
    "seq_01_EventTypeCode_B_TBL0003": "",
    "seq_02_RecordedDateTime_R": {
      "seq_01_Time_R": {
        "seq_01_DateTime": "20030705"
      },
      "seq_02_DegreeOfPrecision_B_TBL0529": ""
    },
    "seq_03_DateTimePlannedEvent_O": {
      "seq_01_Time_R": {
        "seq_01_DateTime": "20030706"
      },
      "seq_02_DegreeOfPrecision_B_TBL0529": ""
    },
    "seq_04_EventReasonCode_O_TBL0062": "01",
    "seq_05_OperatorID_O_TBL0188": [],
    "seq_06_EventOccurred_O": {},
    "seq_07_EventFacility_O": {}
  },
  "seg_04_PID_R": {
    "seq_01_SetID_O": "1",
    "seq_02_PatientID_B": [],
    "seq_03_PatientIdentifierList_R": [
      {
        "seq_01_IDNumber_R": "22",
        "seq_02_CheckDigit_O ": "1.2.3.4.5.6.7",
        "seq_03_CheckDigitScheme_O_TBL0061": "ISO",
        "seq_04_AssigningAuthority_O_TBL0363": "",
        "seq_05_IdentifierTypeCode_O_TBL0203": "AND",
        "seq_06_AssigningFacility_O": "",
        "seq_07_EffectiveDate_O": "",
        "seq_08_ExpirationDate_O": "",
        "seq_09_AssigningJurisdiction_O": {
          "seq_01_Identifier_O ": "475734952",
          "seq_02_Text_O": "X-Ray impression",
          "seq_03_NameOfCodingSystem_O_TBL0396": "W4",
          "seq_04_AlternateIdentifier_O": "",
          "seq_05_AlternateText_O": "",
          "seq_06_NameOfAlternateCodingSystem_O_TBL0396": "",
          "seq_07_CodingSystemVersionID_O": "",
          "seq_08_AlternateCodingSystemVersionID_O": "",
          "seq_09_OriginalText_O": "An x-ray impression"
        },
        "seq_10_AssigningAgencyOrDepartment_O": ""
      }
    ],
    "seq_04_AlternatePatientID_B": [],
    "seq_05_PatientName_R": [
      {
        "seq_01_FamilyName_O": {
          "seq_01_Surname_R": "Smith",
          "seq_02_OwnSurnamePrefix_O": "",
          "seq_03_OwnSurname_O": "Billson",
          "seq_04_SurnamePrefixFromPartnerSpouse_O": "",
          "seq_05_SurnameFromPartnerSpouse_O": "Smith"
        },
        "seq_02_GivenName_O": "Billson",
        "seq_03_SecondAndFurtherGivenNamesOrInitialsThereof_O": "",
        "seq_04_Suffix_O": "",
        "seq_05_Prefix_O": "",
        "seq_06_Degree_B_TBL0360": "",
        "seq_07_NameTypeCode_O_TBL0200": "U",
        "seq_08_NameRepresentationCode_O_TBL0465": "P",
        "seq_09_NameContext_O_TBL0448": {},
        "seq_10_NameValidityRange_B": {},
        "seq_11_NameAssemblyOrder_O_TBL0444": "",
        "seq_12_EffectiveDate_O": {
          "seq_01_Time_R": {
            "seq_01_DateTime": "19880705"
          },
          "seq_02_DegreeOfPrecision_B_TBL0529": ""
        },
        "seq_13_ExpirationDate_O": {
          "seq_01_Time_R": {
            "seq_01_DateTime": "20990705"
          },
          "seq_02_DegreeOfPrecision_B_TBL0529": ""
        },
        "seq_14_ProfessionalSuffix_O": ""
      }
    ],
    "seq_06_MothersMaidenName_O": [],
    "seq_07_DateTimeOfBirth_O": {
      "seq_01_Time_R": {
        "seq_01_DateTime": "19780705"
      },
      "seq_02_DegreeOfPrecision_B_TBL0529": ""
    },
    "seq_08_AdministrativeSex_O_TBL0001": "M",
    "seq_09_PatientAlias_B": [],
    "seq_10_Race_O_TBL0005": [],
    "seq_11_PatientAddress_O": [],
    "seq_12_CountyCode_B_TBL0289": "",
    "seq_13_PhoneNumberHome_O": [],
    "seq_14_PhoneNumberBusiness_O": [],
    "seq_15_PrimaryLanguage_O_TBL0296": {},
    "seq_16_MaritalStatus_O_TBL0002": {},
    "seq_17_Religion_O_TBL0006": {},
    "seq_18_PatientAccountNumber_O": {},
    "seq_19_SSNNumberPatient_B": "",
    "seq_20_DriversLicenseNumberPatient_B": {},
    "seq_21_MothersIdentifier_O": [],
    "seq_22_EthnicGroup_O_TBL0189": [],
    "seq_23_BirthPlace_O": "Chicago",
    "seq_24_MultipleBirthIndicator_O_TBL0136": "N",
    "seq_25_BirthOrder_O": "",
    "seq_26_Citizenship_O_TBL0171": [],
    "seq_27_VeteransMilitaryStatus_O_TBL0172": {},
    "seq_28_Nationality_B_TBL0212": {},
    "seq_29_PatientDeathDateAndTime_O": {},
    "seq_30_PatientDeathIndicator_O_TBL0136": "",
    "seq_31_IdentityUnknownIndicator_O_TBL136": "",
    "seq_32_IdentityReliabilityCode_O_TBL0445": [],
    "seq_33_LastUpdateDateTime_O": {
      "seq_01_Time_R": {
        "seq_01_DateTime": "19880705"
      },
      "seq_02_DegreeOfPrecision_B_TBL0529": ""
    },
    "seq_34_LastUpdateFacility_O": {},
    "seq_35_SpeciesCode_C_TBL0446": {},
    "seq_36_BreedCode_C_TBL0447": {},
    "seq_37_Strain_O": "",
    "seq_38_ProductionClassCode_O_TBL0429": [],
    "seq_39_TribalCitizenship_O_TBL0171": []
  },
  "seg_05_PD1_O": {
    "seq_01_LivingDependency_O_TBL0223": [
      "O",
      "U"
    ],
    "seq_02_LivingArrangement_O_TBL0220": "",
    "seq_03_PatientPrimaryFacility_O": [
      {
        "seq_01_OrganizationName_O": "Sample Organization",
        "seq_02_OrganizationNameTypeCode_O_TBL0204": "L",
        "seq_03_IDNumber_B": "",
        "seq_04_CheckDigit_O": "",
        "seq_05_CheckDigitScheme_O_TBL0061": "",
        "seq_06_AssigningAuthority_O_TBL0363": {},
        "": "seq_07_IdentifierTypeCode_O_TBL0203",
        "seq_08_AssigningFacility_O": {
          "seq_01_NamespaceID_O_TBL0300": "FACILITY1",
          "seq_02_UniversalID_C": "1.2.3.4.5.6.7",
          "seq_03_UniversalIDType_C_TBL0301": "ISO"
        },
        "seq_09_NameRepresentationCode_O_TBL0465": "P",
        "seq_10_OrganizationIdentifier_O": ""
      }
    ],
    "seq_04_PatientPrimaryCareProviderNameAndIDNo_B": [],
    "seq_05_StudentIndicator_O_TBL0231": "",
    "seq_06_Handicap_O_TBL0295": "",
    "seq_07_LivingWillCode_O_TBL0315": "",
    "seq_08_OrganDonor_Code_O_TBL0316": "",
    "seq_09_SeperateBill_O_TBL0136": "",
    "seq_10_DuplicatePatient_O": [],
    "seq_11_PublicityCode_O_TBL0215": {},
    "seq_12_ProtectionIndicator_O_TBL0136": "Y",
    "seq_13_ProtectionIndicatorEffectiveDate_O": {
      "seq_01_Date": "19880704"
    },
    "seq_14_PlaceOfWorship_O": [],
    "seq_15_AdvanceDirectiveCode_O_TBL0435": [],
    "seq_16_ImmunizationRegistryStatus_O_TBL0441": "",
    "seq_17_ImmunizationRegistryStatusEffectiveDate_O": {},
    "seq_18_PublicityCodeEffectiveDate_O": {},
    "seq_19_MilitaryBranch_O_TBL0140": "",
    "seq_20_MilitaryRankGrade_O_TBL0141": "",
    "seq_21_MilitaryStatus_O_TBL0142": ""
  },
  "seq_06_ROL_O": [],
  "seg_07_PV1_R": {
    "seq_01_SetID_O": "1",
    "seq_02_PatientClass_R_TBL0004": "E",
    "seq_03_AssignedPatientLocation_O": {},
    "seq_04_AdmissionType_O_TBL0007": "",
    "seq_05_PreadmitNumber_O": {},
    "seq_06_PriorPatientLocation_O": {},
    "seq_07_AttendingDoctor_O_TBL0010": [
      {
        "seq_01_IDNumber_O": "",
        "seq_02_FamilyName_O": {
          "seq_01_Surname_R": "Smith",
          "seq_02_OwnSurnamePrefix_O": "",
          "seq_03_OwnSurname_O": "Billson",
          "seq_04_SurnamePrefixFromPartnerSpouse_O": "",
          "seq_05_SurnameFromPartnerSpouse_O": "Smith"
        },
        "seq_03_GivenName_O": "Billson",
        "seq_04_SecondAndFurtherGivenNamesOrInitialsThereof_O": "",
        "seq_05_Suffix_O": "",
        "seq_06_Prefix_O": "",
        "seq_07_Degree_B_TBL0360": "",
        "seq_08_SourceTable_O_TBL0297": "",
        "seq_09_AssigningAuthority_O_TBL0363": {},
        "seq_10_NameTypeCode_O_TBL0200": "U",
        "seq_11_IdentifierCheckDigit_O": "",
        "seq_12_CheckDigitScheme_C_TBL0061": "NPI",
        "seq_13_IdentifierTypeCode_O_TBL0203": "",
        "seq_14_AssigningFacility_O": {},
        "seq_15_NameRepresentationCode_O_TBL0465": "",
        "seq_16_NameContext_O_TBL0448": {},
        "seq_17_NameValidityRange_B": {},
        "seq_18_NameAssemblyOrder_O_TBL0444": "G",
        "seq_19_EffectiveDate_O": {},
        "seq_20_ExpirationDate_O": {},
        "seq_21_ProfessionalSuffix_O": "",
        "seq_22_AssigningJurisdiction_O": {},
        "seq_23_AssigningAgencyOrDepartment_O": {}
      }
    ],
    "seq_08_ReferringDoctor_O_TBL0010": [],
    "seq_09_ConsultingDoctor_B_TBL0010": [],
    "seq_10_HospitalService_O_TBL0069": "",
    "seq_11_TemporaryLocation_O": {},
    "seq_12_PreadmitTestIndicator_O_TBL0087": "",
    "seq_13_ReAdmissionIndicator_O_TBL0092": "",
    "seq_14_AdmitSource_O_TBL0023": "",
    "seq_15_AmbulatoryStatus_O_TBL0009": [],
    "seq_16_VIPIndicator_O_TBL0099": "",
    "seq_17_AdmittingDoctor_O_TBL0010": [],
    "seq_18_PatientType_O_TBL0018": "",
    "seq_19_VisitNumber_O": {},
    "seq_20_FinancialClass_O_TBL0064": [
      {
        "seq_01_FinancialClassCode_R_TBL0064": "H03",
        "seq_02_EffectiveDate_O": {
          "seq_01_Time_R": {
            "seq_01_DateTime": "19880705"
          },
          "seq_02_DegreeOfPrecision_B_TBL0529": ""
        }
      }
    ],
    "seq_21_ChargePriceIndicator_O_TBL0032": "",
    "seq_22_CourtesyCode_O_TBL0045": "",
    "seq_23_CreditRating_O_TBL0046": "",
    "seq_24_ContractCode_O_TBL0044": [],
    "seq_25_ContractEffectiveDate_O": [],
    "seq_26_ContractAmount_O": [],
    "seq_27_ContractPeriod_O": [],
    "seq_28_InterestCode_O_TBL0073": "",
    "seq_29_TransferToBadDebtCode_O_TBL0110": "",
    "seq_30_TransferToBadDebtDate_O": {},
    "seq_31_BadDebtAgencyCode_O_TBL0021": "",
    "seq_32_BadDebtTransferAmount_O": "",
    "seq_33_BadDebtRecoveryAmount_O": "",
    "seq_34_DeleteAccountIndicator_O_TBL0111": "",
    "seq_35_DeleteAccountDate_O": {},
    "seq_36_DischargeDisposition_O_TBL0112": "",
    "seq_37_DischargedToLocation_O_TBL0113": {
      "seq_01_DischargeLocation_R_TBL0113": "Hospital",
      "seq_02_EffectiveDate_O": {
        "seq_01_Time_R": {
          "seq_01_DateTime": "19880705"
        },
        "seq_02_DegreeOfPrecision_B_TBL0529": ""
      }
    },
    "seq_38_DietType_O_TBL0114": {},
    "seq_39_ServicingFacility_O_TBL0115": "",
    "seq_40_BedStatus_O_TBL0116": "",
    "seq_41_AccountStatus_O_TBL0117": "",
    "seq_42_PendingLocation_O": {},
    "seq_43_PriorTemporaryLocation_O": {},
    "seq_44_AdmitDateTime_O": {},
    "seq_45_DischargeDateTime_O": [
      {
        "seq_01_Time_R": {
          "seq_01_DateTime": "19880705"
        }
      }
    ],
    "seq_02_DegreeOfPrecision_B_TBL0529": ""
  },
  "seq_46_CurrentPatientBalance_O": "",
  "seq_47_TotalCharges_O": "",
  "seq_48_TotalAdjustments_O": "",
  "seq_49_TotalPayments_O": "12",
  "seq_50_AlternateVisitID_O_TBL0203": {},
  "seq_51_VisitIndicator_O_TBL0326": "",
  "seq_52_OtherHealthcareProvider_B_TBL0010": [],
  "seg_08_PV2_O": {},
  "seg_09_ROL_O": [],
  "seg_10_DB1_O": [],
  "seg_11_OBX_O": [],
  "seg_12_PDA_O": {}
}

JSON to HL7 ADT Message API Request

Transform the JSON format of an HL7 message into an properly formatted HL7 ADT Message.

post https://api-hl7.splinxtechnologies.com/v1/hl7-transformation/2-5-1/json-to-hl7