DH Person and Appointment Misc Fields update REST API

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

-

String

Samples
Sample curl command to send request
1$ curl --location --request GET 'https://[dialoghealth-server]/dialoghealth-simpleadmit-api/metrics'
Sample response body (text)
1jvm_buffer_count{id="mapped",} 0.0 2jvm_buffer_count{id="direct",} 150.0 3jvm_buffer_count{id="mapped - 'non-volatile memory'",} 0.0

SimpleAdmitApi

update

PUT /appt-misc

Parameters
Body Parameter

Name

Description

Required

Default

Pattern

UpdateRequest

UpdateRequest

X

-

-

Return Type

ApiResponseString

Content Type

  • application/json

Responses

Code

Message

Datatype

200

-

ApiResponseString

400

-

ErrorResponse

Samples
Sample curl command to send request
1$ curl --location --request PUT 'https://[dialoghealth-server]/dialoghealth-simpleadmit-api/appt-misc' \ 2--header 'Authorization: Basic {credentials}' \ 3--header 'Content-Type: application/json' \ 4--header 'Cookie: JSESSIONID=4D4BB3ABB26A07598169BBF4FF6CB510; session_id=1278034009.1.1922121152.547952640' \ 5--data-raw '{request-body-json}'
Sample request body (json)
1{ 2 "consoleCode": "WEBMAG6745", 3 "appointmentData": { 4 "apptId": "3redfvdfe4f44g45g", 5 "misc1": null, 6 "misc2": "misc2", 7 "misc3": "misc3", 8 "misc4": "misc4", 9 "misc5": "misc5" 10 }, 11 "patientData": { 12 "patientId": "Qyujyuj", 13 "misc1": "misc1", 14 "misc2": null, 15 "misc3": null, 16 "misc4": null, 17 "misc5": null 18 } 19}
Sample response body (json)
1{ 2 "requestId": "5f207097-1afa-4708-b48a-abad0aea69cc", 3 "response": "success" 4}

Models

ApiResponseString

Field Name

Type

Description

Format

requestId

String

Unique identifier of the request

-

response

String

Response

-

AppointmentData

Field Name

Required

Type

Description

Format

apptId

X

String

Appointment ID - must exist and must match patientId too

-

misc1

-

String

Miscellaneous field for an appointment - does not update when not set

-

misc2

-

String

Miscellaneous field for an appointment - does not update when not set

-

misc3

-

String

Miscellaneous field for an appointment - does not update when not set

-

misc4

-

String

Miscellaneous field for an appointment - does not update when not set

-

misc5

-

String

Miscellaneous field for an appointment - does not update when not set

-

PatientData

Field Name

Required

Type

Description

Format

Field Name

Required

Type

Description

Format

patientId

X

String

Patient’s ID to be matched (required)

-

misc1

-

String

Miscellaneous field for a patient - does not update when not set

-

misc2

-

String

Miscellaneous field for a patient - does not update when not set

-

misc3

-

String

Miscellaneous field for a patient - does not update when not set

-

misc4

-

String

Miscellaneous field for a patient - does not update when not set

-

misc5

-

String

Miscellaneous field for a patient - does not update when not set

-

UpdateRequest

Field Name

Required

Type

Description

Format

consoleCode

X

String

Console code user has access to

SIDJUL8079

appointmentData

-

AppointmentData

Appointment information

-

patientData

X

PatientData

Patient information

-

ErrorResponse

Field Name

Type

Description

Format

message

String

Error response message

-


    • 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 ...

    • CSV Template for Adding Participants, Appointments and 10 Misc Fields (32)

      How to Fill Out the 32-Column CSV File This file is our most inclusive file type which holds participant, appointment, and appointment miscellaneous data. The 32-Column CSV file is what Dialog Health utilizes to transfer your data to our platform. ...

    • CSV Template for Adding Multiple Locations, Participants, Appointments and 10 Misc Fields (33)

      Navigating the 33-Column CSV File: A Beginner's Guide The 33-Column CSV file serves as a medium through which Dialog Health can transfer your data to our platform. This file is exclusively designated for adding participant data, and appointment/event ...

    • 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 ...