getSpecialtyGroups

Retrieves a list of profession/specialty sets keyed on specialty group.

Request

GET /rest/refdata/specialty-groups

Parameters

None.

Response

200 OK

[
  {
    "specialtyGroup": "Endocrinology/Diabetes",
    "professionSpecialties": [
      {
        "profession": {
          "professionId": 1,
          "professionName": "Doctor",
          "displaySpecialty": false,
          "displayCondition": false
        },
        "specialties": [
          {
            "specialtyId": 10,
            "specialtyName": "Endocrinology"
          }
        ]
      }
    ]
  }
]

Field	Type	Description
specialtyGroup	string	Name of the specialty group
professionSpecialties	array	Array of profession/specialty pairings
professionSpecialties[].profession	object	Profession details
professionSpecialties[].profession.professionId	integer	Profession ID
professionSpecialties[].profession.professionName	string	Profession name
professionSpecialties[].profession.displaySpecialty	boolean	Whether to display specialty in UI
professionSpecialties[].profession.displayCondition	boolean	Whether to display condition in UI
professionSpecialties[].specialties	array	List of specialties in this group

Errors

Exception	Cause
WSRefDataServiceException	Service error while fetching specialty groups