getXUserProfileFieldMetadata

Retrieves a list of extended user profile fields given a valid profession ID (user type). The response contains all available fields as well as those fields that can be grouped as a profile group (e.g. "Treatment" may contain one or more fields that relate to a treatment).

Request

GET /rest/refdata/extended-user-profile-metadata

Query Parameters

Parameter	Type	Required	Description
professionId	integer	Yes	Profession/user type ID (e.g. 9 = Patient)

Example

GET /rest/refdata/extended-user-profile-metadata?professionId=9

Response

200 OK

{
  "professionId": 9,
  "allProfileFields": [
    {
      "profileFieldId": 1,
      "statusCode": "A",
      "dataType": "ForeignKey",
      "profileFieldName": "Condition"
    }
  ],
  "profileGroups": []
}

Field	Type	Description
professionId	integer	The profession ID these fields apply to
allProfileFields	array	All available extended profile fields
allProfileFields[].profileFieldId	integer	Primary key of the profile field
allProfileFields[].statusCode	string	A = active
allProfileFields[].dataType	string	Data type (e.g. ForeignKey, String, Integer)
allProfileFields[].profileFieldName	string	Display name of the field
profileGroups	array	Logical groups of profile fields

Errors

Exception	Cause
WSRefDataServiceException	Service error while fetching profile field metadata