getIdentifiers

Retrieves a list of identifiers supported by the system for both users and contacts. Typically used for HCP (Healthcare Professional) IDs such as AHPRA, RACGP, etc. These usually differ per country or country/profession combination.

Request

GET /rest/refdata/identifiers

Query Parameters

Parameter	Type	Required	Description
countryCode	string	Yes	ISO country code to look up identifiers for
professionId	integer	No	Profession ID (from getProfessions) to further filter identifiers

Examples

GET /rest/refdata/identifiers?countryCode=AU
GET /rest/refdata/identifiers?countryCode=AU&professionId=1

Response

200 OK

[
  {
    "identifierId": 1,
    "identifierName": "AHPRA",
    "identifierDesc": "Australian Health Practitioner Regulation Agency",
    "identifierFormatDesc": "e.g. XYZ0123456789",
    "identifierFormatRegex": "^([a-zA-Z]{3})([\\d]{10})$",
    "countryCode": "AU",
    "professionId": 1,
    "used": true
  }
]

Field	Type	Description
identifierId	integer	Primary key of the identifier
identifierName	string	Short name (e.g. AHPRA)
identifierDesc	string	Full description
identifierFormatDesc	string	Human-readable format hint
identifierFormatRegex	string	Regex pattern for client-side validation
countryCode	string	ISO country code this identifier applies to
professionId	integer	Profession ID this identifier applies to
used	boolean	Whether this identifier is actively used

Errors

Exception	Cause
WSRefDataServiceException	Service error while fetching identifiers

Version

GET /rest/refdata/identifiers/version

{ "version": 1 }