HHhhaexchange
Internal

Get generic references

Returns generic references from HHA GenericReferences table by CompanyID (ProviderId/VendorId) and ReferenceType. Client ID and API key are required for authentication and to determine the correct HHA database environment. Returns all active reference records matching the specified CompanyID and ReferenceType.

get/v1/internal/generic-references

Request

  • Base URL
    https://api.hhaexchange.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.hhaexchange.com/v1/internal/generic-references
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.hhaexchange.com/v1/fhir/auth/token scopes: read

Query parameters

ClientIdstring required

Client ID (mandatory)

XApiKeystring required

API key (mandatory)

ProviderIdinteger required

Provider ID / Vendor ID (CompanyID) (mandatory)

ReferenceTypestring required

Reference type (e.g., 'EmergencyContactRelationship') (mandatory)

Response

Successful Response

CompanyIDinteger required
ReferenceTypestring required

Changes

No recorded changes to this operation across all 3 revisions of this API.