Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

2.) Successful Return Body

...

Set Patient

·       Method: POST

·       Endpoint: https://localhost:8090/NoahWebIntegrationGUIStart /noah4/setpatient

·       Request Format: JSON

·       Response Format: JSON

·       Introduced in Noah version: 4.16

...

Headers:

  • Content-Type: application/json

Body:

Code Block
languagejson
{
  "patientGuid": "550e8400-e29b-41d4-a716-446655440000",
  "options": {
    "StartGui": true,
    "ShowAllPatients": false,
    "SelectDetailsView": true
  }
}
  • patientGuid (string, nullable):

    • When null, no changes are made to the current active patient.

    • When null and StartGui is true, the Noah ES Client starts without a specific patient selected.

    • When non-null, the patient with the matching GUID is set as the active patient in the Noah Business System.

    • When non-null and StartGui is false, the Noah ES Client does not start, but the specified patient is set as active.

  • options (object, optional):

    • StartGui (boolean, nullable):

      • When true, starts the Noah ES Client GUI.

      • When null, no changes are made to the current GUI state.

      • When false, the GUI is not started.

    • ShowAllPatients (boolean, nullable):

      • When false, the Noah ES Client does not display patients in the patient list.

      • When null, no changes are made to the current patient list state.

      • When true, patients in the list are displayed.

    • SelectDetailsView (boolean, nullable):

      • When true, the patient list collapses in the Noah ES Client.

      • When null, no changes are made to the current state of the patient list view.

      • A value of false is not utilized and has no effect.

Response Format
PatientGuid (string): The GUID of the active patient in the Noah ES Client.

Example Response (patient guid exists):
{
  "PatientGuid": "550e8400-e29b-41d4-a716-446655440000"
}

Example Response (patient guid does NOT exist):
{
  "PatientGuid": null
}

Detecting Noah ES Client patient selection changes

...