DH Patient & Visit SOAP API Specifications

DH Patient & Visit SOAP API Specifications

Endpoints

http://[dialoghealth-server]/dialoghealth-source-api/soap/DataShare

http://[dialoghealth-server]/dh-integration/soap/DataShare

Target namespace: https://www.dialoghealth.com/

getReturnCodeStr

POST /GetReturnCodeStr

Parameters
Body Parameter

Name

Description

Required

Default

Pattern

Body

GetReturnCodeStr

X

-

-

Return Type

GetReturnCodeStrResponse

Content Type

  • application/xml

Responses

 

 

Table 1. http response codes

Code

Message

Datatype

200

Successfully retrieved the response

GetReturnCodeStrResponse

insertPatientInfo

POST /InsertPatientInfo

Parameters
Body Parameter

Name

Description

Required

Default

Pattern

Body

InsertPatientInfo

X

-

-

Return Type

InsertPatientInfoResponse

Content Type

  • application/xml

Responses

 

 

Table 2. http response codes

Code

Message

Datatype

200

Successfully retrieved the response

InsertPatientInfoResponse

Samples
Sample request Body
1<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:hel="http://helloarcher.com"> 2 <soap:Header/> 3 <soap:Body> 4 <hel:InsertPatientInfo> 5 <hel:Password>pswd</hel:Password> 6 <hel:doc> 7<Header Application="SourcePlusConnect" BUID="3" CreateDateTime="20111007113542" VendorAppName="VendorName" FacilityName="UI NAME OF a NEEDED CONSOLE" 8 FacilityAcronym="TASC"> 9 <PatientData> 10 <Patient Accountnumber="This is a PatientID_1" LastName="SOAP Last" FirstName="Name" MI="" DOB="19801212" SSN="121212121" Sex="F" MaritialStatus="" 11 RaceCode="" Nationality="" HomePhone="6846816816" WorkPhone="${yourNumber}" WorkPhoneExtn="" CellPhone="${yourNumber}" Email=""> 12 <Addresses> 13 <Address AddressType="M" AddressLine1="${yourValue}" AddressLine2="${yourValue}" City="${yourValue}" State="${yourValue}" ZipCode="123456" 14 ZipPlus4="" Country="" EmployerName="" Occupation="" /> 15 </Addresses> 16 <PatientVisit> 17 <VisitInformation VisitNumber="${yourNumber}" CaseNumber="${yourNumber}" Status="N" TypeOfVisit="" ApptStatus="Pending" ScheduledDate="20111007" 18 ScheduledTime="09:45:00:0" ScheduledEndDate="20111007" ScheduledEndTime="10:00:00:0" Duration="" DurationUnits="" Anesthesia="" Room=".OR #2" 19 RoomType="OR" OthPhysID="" OthPhysLastName="" OthPhysFirstName="" RefPhysID="" RefPhysLastName="" RefPhysFirstName="" /> 20 <PatientProcedures> 21 <ProcedureInformation PhysicianID="${yourValue}" PhysicianLastName="${yourValue}" PhysicianFirstName="${yourValue}" PhysCredentials="" 22 ProcedureSequence="1" ProcedureCode="${yourNumber}" 23 ProcedureDescription="3D RENDERING WITH INTERPRETATION AND REPORTING OF COMPUTED TOMOGRAPHY, MAGNETIC 24RESONANCE IMAGING, ULTRASOUND, OR OTHER TOMOGRAPHIC MODALITY; REQUIRING IMAGE POSTPROCESSING ON AN 25INDEPENDENT WORKSTATION" 26 ICDCode_1="789.32" ICDdescription_1="ABDOMINAL OR PELVIC SWELLING, MASS, OR 27LUMP, LEFT UPPER QUADRANT" ICDCode_2="" ICDdescription_2="" 28 ICDCode_3="" ICDdescription_3="" /> 29 </PatientProcedures> 30 <PatientEquipment> 31 <EquipmentInformation EquipmentID="" EquipmentDescription="" /> 32 </PatientEquipment> 33 <PatientGuarantor> 34 <GuarantorInformation GuarantorNumber="242" GuarantorLastName="${yourValue}" GuarantorFirstName="${yourValue}" GuarantorMIName="" 35 GuarantorDOB="19801212" GuarantorSSN="121212121" GuarantorSex="F" RelationToPatient="" GuarantorAddress1="45 Hollywood Blvd" 36 GuarantorAddress2="111" GuarantorCity="CHARLESTON" GuarantorState="WV" GuarantorZipcode="123456" GuarantorHomePhone="6846816816" 37 GuarantorWorkPhone="2059694698" GuarantorWorkPhoneExtn="" GuarantorEmpName="" GuarantorEmpID="" /> 38 <GuarantorInformation GuarantorNumber="242" GuarantorLastName="Abdul" GuarantorFirstName="Paula" GuarantorMIName="" 39 GuarantorDOB="19801212" GuarantorSSN="${yourNumber}" GuarantorSex="F" RelationToPatient="" GuarantorAddress1="45 Hollywood Blvd" 40 GuarantorAddress2="111" GuarantorCity="CHARLESTON" GuarantorState="WV" GuarantorZipcode="${yourNumber}" GuarantorHomePhone="6846816816" 41 GuarantorWorkPhone="${yourNumber}" GuarantorWorkPhoneExtn="" GuarantorEmpName="" GuarantorEmpID="" /> 42 </PatientGuarantor> 43 <PatientInsurances> 44 <InsuranceInformation InsuranceID="${yourValue}" InsuranceName="${yourValue}" InsuranceRole="${yourValue}" 45 InsuranceOfficeName="${yourValue}" InsuranceType="${yourValue}" AssignOfBenefits="Yes" Address1="${yourValue}" Address2="" City="West Haven" 46 State="CT" ZipCode="${yourNumber}" InsPhone="8001234567" InsuredLastName="${yourValue}" InsuredFirstName="${yourValue}" InsuredMiName="" InsuredDOB="19801212" 47 InsuredSSN="${yourNumber}" InsuredSex="F" RelationToInsured="Self" InsuredAddress1="45 48Hollywood Blvd" InsuredAddress2="111" InsuredCity="CHARLESTON" 49 InsuredState="WV" InsuredZip="25304" InsGroupName="" InsGroupNum="" PreAuthNum="" InsRep="" VerifyByCode="" VerifyByLastName="" 50 VerifyByFirstName="" VerifyByMIName="" VerifyDateTime="" CoPayment="" Deposit="" policyDeductable="" InsuredEmplName="" InsuredEmplID="" 51 InsuredEmplIDNumber="168798413" PlanEffectiveDate="" PlanExpirationDate="" InsuredEmplAddress1="" InsuredEmplAddress2="" 52 InsuredEmplCity="" InsuredEmplState="" InsuredEmplZipCode="" InsuredEmplStatus="" /> 53 </PatientInsurances> 54 </PatientVisit> 55 </Patient> 56 </PatientData> 57</Header> 58 </hel:doc> 59 </hel:InsertPatientInfo> 60 </soap:Body> 61</soap:Envelope>

Models

GetReturnCodeStr

Field Name

Required

Type

Format

GetReturnCodeStr

X

TnsGetReturnCodeStr

-

GetReturnCodeStrResponse

Field Name

Required

Type

Format

GetReturnCodeStrResponse

X

TnsGetReturnCodeStrResponse

-

InsertPatientInfo

Field Name

Required

Type

Format

InsertPatientInfo

X

TnsInsertPatientInfo

-

InsertPatientInfoResponse

Field Name

Required

Type

Format

InsertPatientInfoResponse

X

InsertPatientInfoResponse

-

TnsAddress

Field Name

Required

Type

Description

Format

city

-

String

City

-

state

-

String

State

-

zip

-

String

Zip

-

street

-

String

Street

-

TnsAddresses

Field Name

Required

Type

Description

Format

address

X

List of [tns_address]

Patient’s addresses

-

TnsAnesthesiologist

Field Name

Required

Type

Description

Format

name

-

String

Anesthesiologist’s name

-

msisdn

-

String

Anesthesiologist phone number

-

TnsGetReturnCodeStr

Field Name

Required

Type

Description

Format

Password

X

String

User’s password

-

thecode

X

Integer

-

int32

TnsGetReturnCodeStrResponse

Field Name

Required

Type

Description

Format

GetReturnCodeStrResult

-

String

 

-

TnsInsertPatientInfo

Field Name

Required

Type

Description

Format

Password

-

String

Password

 

doc

-

Object

 

 

TnsInsertPatientInfoResponse

Field Name

Required

Type

Description

Format

return

X

Integer

 

int32

TnsPatient

Field Name

Required

Type

Description

Format

id

-

String

Patient’s ID

-

firstName

-

String

First name

-

lastName

-

String

Last name

-

dob

-

date

Date of birth

date

msisdn

-

String

Phone number

-

additionalPhone

-

String

Additional phone

-

insuranceProvider

-

String

Insurance provider

-

addresses

X

TnsAddresses

List of addresses

 

patientVisits

X

TnsPatientVisits

List of patient’s visits

-

TnsPatientVisit

Field Name

Required

Type

Description

Format

id

-

String

Visit ID

-

name

-

String

Visit name

-

date

-

Date

Visit date

date-time

arrivalTime

-

Date

Visit arrival time

date-time

location

-

String

Visit location

-

status

-

String

Visit status

-

note

-

String

Visit note

-

physician

X

TnsPhysician

Physician assigned

-

anesthesiologist

X

TnsAnesthesiologist

Anesthesiologist assigned

-

TnsPatientVisits

Field Name

Required

Type

patientVisit

X

List of TnsPatientVisit

TnsPatients

Field Name

Required

Type

patient

X

List of TnsPatient

TnsPhysician

Field Name

Required

Type

Description

Format

name

-

String

Physician’s name

-

msisdn

-

String

Physician’s phone number

-

TnsProtocallImport

Field Name

Required

Type

patients

X

TnsPatients


    • Related Articles

    • DH Patient and Appointment REST XML API

      Access HTTP Basic Authentication basic Endpoints https://[dialoghealth-server]/dh-integration/rest/ Import Patients' data POST /import/protocall/authbase/{CONSOLE-CODE} Content Type application/xml; charset=utf-8 Parameters Request Body - XML ...

    • DH Persons-Events-Subscription Status Rest API

      Description API allows importing of person and event data immediately to the Dialog Health platform as well as the ability to manage subscription status. Please note: API use is restricted to 250 requests per hour. Access HTTP Basic Authentication ...

    • DH Trigger SMS API

      Introduction Trigger is a message to one particular person which can be set up for a client and sent on demand as API call. The trigger works only for known patients/employees, who are already registered in Dialog Health database. Triggers can be ...

    • DH Message Results Writeback API

      DH Message Results Writeback API Access · HTTP Basic Authentication basic Endpoints https://[dialoghealth-server]/dialoghealth-writeback-api/ ApiController responses GET /api/responses/{consoleCode}/{startTimestamp}/{endTimestamp} Parameters Path ...

    • Introduction to Data Integrations - Patients

      About Dialog Health's PROTOCALL™ and Our Use of Data PROTOCALL™ is a cloud-based Patient + Caregiver Engagement Platform which leverages the mobile phone to improve outcomes. Dialog Health’s mobile messaging enables two-way communication between your ...