Get Allergy

GET {{baseUrl}}/api/v2/ReferenceData?resourceType=allergy&searchString=fish

Overview:

This API takes an input parameter resourceType that has value 'allergy', and returns allergy-related data from systems like Athena and SNOMED. Based on the input, the API provides a paginated response containing details of allergens, including their names, IDs, and standardized codes.

Example Responses:

  • Athena: Returns basic allergy details, such as allergen names and IDs (e.g., Fish Containing Products).

  • SNOMED: Provides standardized allergy codes and relationships between allergy concepts (e.g., Allergy to seafood and Allergy to fish), along with SNOMED-CT identifiers.

Use Cases:

  • Populating AllergyIntolerance Resources: This API can be used to retrieve relevant allergy data, including SNOMED codes or specific allergen names, for creating or updating AllergyIntolerance resources in healthcare systems.

  • Standardizing Allergy Information: The API helps standardize allergen information using SNOMED codes, ensuring that the allergy data used across healthcare systems is consistent and compliant with clinical standards.

  • Clinical Decision Support and Documentation: Clinicians and healthcare applications can use this API to document and manage patient allergies accurately, retrieving the correct codes and names for use in EHRs or decision-support systems.

Request Params

KeyDatatypeRequiredDescription
resourceTypestring(Required) The type of resource to search for
searchStringstring(Required) The search string to use

HEADERS

KeyDatatypeRequiredDescription
x-source-idstring(Required) The source ID to use
Acceptstring

RESPONSES

status: OK

{"context":{"system":"\u003cstring\u003e","category":"\u003cstring\u003e"},"data":{"pagination":{"count":"\u003cinteger\u003e"},"result":[{"allergyid":"\u003cinteger\u003e","allergy":"\u003cstring\u003e","allergenid":"\u003cinteger\u003e","allergenname":"\u003cstring\u003e"},{"allergyid":"\u003cinteger\u003e","allergy":"\u003cstring\u003e","allergenid":"\u003cinteger\u003e","allergenname":"\u003cstring\u003e"}]}}