DH Patient and Appointment REST XML API

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 structure

Name

Type

Required

protocallImport

protocallImport

X

Samples
Sample curl command to send request
1$ curl --location --request POST 'https://{dialoghealth-server}/dh-integration/rest/import/protocall/authbase/WEBMAG6745' \ 2--header 'Content-Type: application/xml' \ 3--header 'Authorization: Basic {credentials}' \ 4--data-raw '{xml-request-body}'
Sample request Body
1<?xml version="1.0" encoding="UTF-8"?> 2<protocallImport> 3 <patients> 4 <patient id="PatientId" 5 firstName="FirstName" 6 lastName="LastName" 7 dob="08/21/1984" 8 msisdn="13143435555" 9 additionalPhone="" 10 insuranceProvider="insurance provider 1"> 11 <addresses> 12 <address city="City" state="State" zip="33323" street="123 Main Street"/> 13 <address city="City" state="State" zip="33321" street="121 Main Street"/> 14 </addresses> 15 <patientVisits> 16 <patientVisit id="Appointment Id" 17 name="Appointment Name" 18 date="12/22/2012 9:00 AM" 19 arrivalTime="8:00 AM" 20 location="appointment location" 21 status="Completed" 22 note="appointmentNote"> 23 <physician name="Physitian name" msisdn="13143435552"/> 24 <anesthesiologist name="" msisdn=""/> 25 </patientVisit> 26 <patientVisit name="Appointment Name2" 27 date="12/22/2012 9:00 AM" 28 arrivalTime="8:00 AM" 29 location="appointment location" 30 status="Cancelled"> 31 <physician name="Physitian name2"/> 32 </patientVisit> 33 </patientVisits> 34 </patient> 35 <patient firstName="FirstName" 36 lastName="LastName" 37 dob="1984-08-21" 38 msisdn="12143435551" 39 insuranceProvider="insurance prov 2"> 40 <addresses> 41 <address city="City" state="State" zip="33323" street="street" /> 42 </addresses> 43 </patient> 44 </patients> 45</protocallImport>

Models

protocallImport

Elem Name

Required

Type

Description

Format

patients

X

List of patient

Patients to be imported

-

patient

Attribute

Required

Type

Description

Format

id

-

String

Patient ID

-

firstName

-

String

First name

-

lastName

-

String

Last name

-

dob

-

String

Date of birth

-

msisdn

-

String

Mobile phone number

-

additionalPhone

-

String

Additional phone

-

Element

Required

Type

Description

Format

misc1

-

String

Miscellaneous field for a patient

-

misc2

-

String

Miscellaneous field for a patient

-

misc3

-

String

Miscellaneous field for a patient

-

misc4

-

String

Miscellaneous field for a patient

-

misc5

-

String

Miscellaneous field for a patient

-

addresses

-

List of address

Addresses of the patient

-

patientVisits

-

List of patientVisit

Visits of the patient

-

address

Attribute

Required

Type

Description

city

-

String

City

state

-

String

State

zip

-

String

ZIP

street

-

String

Street

patientVisit

Atttribute

Required

Type

Description

Format

id

-

String

Unique identifier of the visit

-

name

-

String

Visit name

-

date

-

String

Visit date

MM/dd/yyyy hh:mm a

arrivalTime

-

String

Visit arrival time

hh:mm a

location

-

String

Event location

-

status

-

String

Visit status

Enum: CANCELED, COMPLETED, RESCHEDULED, DISCHARGED, SCHEDULED, NO_SHOW

note

-

String

Visit note

-

Element

Required

Type

Description

Format

misc1

-

String

Miscellaneous field for a visit

-

misc2

-

String

Miscellaneous field for a visit

-

misc3

-

String

Miscellaneous field for a visit

-

misc4

-

String

Miscellaneous field for a visit

-

misc5

-

String

Miscellaneous field for a visit

-

physician

-

physician

Provider

-


physician

Attribute

Required

Type

Description

name

-

String

Provider name

msisdn

-

String

Provider phone number


    • Related Articles

    • 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/ DataShareSoapBinding getReturnCodeStr POST /GetReturnCodeStr ...

    • 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 Person and Appointment Misc Fields update REST API

      Access HTTP Basic Authentication basic Endpoints https://[dialoghealth-server]/dialoghealth-simpleadmit-api/ MetricsController scrape GET /metrics Parameters - Return Type String Content Type application/json Responses Code Message Datatype 200 - ...

    • 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 Introduction The Dialog Health Message Results Writeback API allows external systems to retrieve detailed information about outbound and inbound SMS communications sent through Dialog Health. This API is designed to ...