healthcare
allergy

Retrieve an allergy

Changed on
get/healthcare/{connection_id}/allergy/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/healthcare/{connection_id}/allergy/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Allergy

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for the allergy/intolerance

created_atstring date-time

When the allergy record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

When the allergy record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

patient_idstring

The patient who has the allergy

encounter_idstring

The encounter in which the allergy was recorded

practitioner_idstring

The practitioner who recorded or asserted the allergy

namestring

Human-readable name of the substance

status'ACTIVE' | 'INACTIVE' | 'RESOLVED' | 'OTHER'

Clinical status of the allergy

type'FOOD' | 'MEDICATION' | 'ENVIRONMENT' | 'BIOLOGIC' | 'OTHER'

Category of the substance

criticality'LOW' | 'HIGH' | 'UNABLE_TO_ASSESS' | 'OTHER'

Potential severity of future reactions

onset_atstring date-time

When the allergy was first identified (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

recorded_atstring date-time

When the allergy was recorded (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

notesstring

Free-text notes about the allergy

rawobject

Raw data from integration

Changes