In FHIR STU3 standard, AllergyIntolerance resource is representing risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
In this RESTful API, this resource is utilized to describe medication allergies in CCDS.
A AllergyIntolerance is acting as a record of a clinical assessment of an allergy or intolerance; a propensity, or a potential risk to an individual, to have an adverse reaction on future exposure to the specified substance, or class of substance..
Required or some important fields and parameters would be given in the following tables. Operations and parameters of this resource would also be listed.
Resource Element Fields
| Name | Description | Type |
|---|---|---|
| identifier | The identifier for this resource | Identifier |
| clicnicalStatus | The clinical status of the resource | code (AllergyIntoleranceClinicalStatus) |
| verificationStatus | The verification status of the resource | code (AllergyIntoleranceVerificationStatus) |
| type | The type of the allergy or the intolerance | code (AllergyIntoleranceType) |
| category | The category of the allergy or the intolerance | code (AllergyIntoleranceCategory) |
| criticality | The criticality of the allergy or the intolerance | code (AllergyIntoleranceCriticality) |
| code | Code that identifies the allergy or intolerance | CodeableConcept (AllergyIntolerance Substance/Product, Condition and Negation Codes) |
| patient | The subject for the allergy or intolerance | References (Patient) |
| onset | When allergy or intolerance was identified |
onsetDateTime: dateTime onsetAge: Age onsetPeriod: Period onsetRange: Range onsetString: string |
| assertedDate | Date record was believed accurate | dateTime |
Get Medication Allergies by Patient
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/AllergyIntolerance?patient={id}
Example:
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/AllergyIntolerance?patient=608
Search Medication Allergies With Specific Date
For this resource, users are able to search using parameters like date, patient, and category etc. Important searching parameters would be listed in the following table.
| Parameter Name | Description | Type | Required |
|---|---|---|---|
| _id | The Id of the certain resource | string | False |
| identifier | The unique identifier for medications | string | False |
| onset | Query date/time or interval when the allergy or intolerance was identified | dateTime | False |
| date | Date record was believed accurate | dateTime | False |
| patient | The Id representing the specific patient | integer | True (If the query is concerning a specific patient) |
| category | The category of this medication allergy | string | False |
| code | Identify the medication allergy | string | False |
This following request format indicates how to get medications on a specific date, using parameter onset.
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/AllergyIntolerance?patient={id}&onset={dateTime}
Example:
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/AllergyIntolerance?patient=608&onset=1980-05-10
Search Allergy Intolerance With a Date Range
The request format would be like:
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/AllergyIntolerance?patient={id}&onset=>={dateTime}&onset=<{dateTime (later than previous dateTime)}
Example:
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/AllergyIntolerance?patient=608&onset=>=1979-05-10&onset=<1980-12-31
{
"resourceType": "Bundle",
"id": "2b5b5def-20b1-4d8b-b6ce-34a6b7470a31",
"meta": {
"lastUpdated": "2017-12-22T09:21:44.122-06:00"
},
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "https://evalfhir.directmdemail.com/fhir/baseDstu3/AllergyIntolerance?onset=%3E%3D1979-05-10&onset=%3C1980-12-31&patient=608"
}
],
"entry": [
{
"fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/AllergyIntolerance/611",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "611",
"meta": {
"versionId": "1",
"lastUpdated": "2017-12-22T09:08:24.000-06:00"
},
"clinicalStatus": "active",
"criticality": "high",
"patient": {
"reference": "Patient/608"
},
"onsetPeriod": {
"start": "1980-05-10T11:00:00-04:00"
},
"reaction": [
{
"substance": {
"coding": [
{
"system": "RxNorm",
"code": "7980",
"display": "Penicillin G"
}
]
},
"manifestation": [
{
"coding": [
{
"system": "SNOMED-CT",
"code": "247472004",
"display": "Hives"
}
]
}
],
"onset": "1980-05-10T11:00:00-04:00"
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/AllergyIntolerance/612",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "612",
"meta": {
"versionId": "1",
"lastUpdated": "2017-12-22T09:08:24.000-06:00"
},
"clinicalStatus": "active",
"criticality": "high",
"patient": {
"reference": "Patient/608"
},
"onsetPeriod": {
"start": "1980-05-10T11:00:00-04:00"
},
"reaction": [
{
"substance": {
"coding": [
{
"system": "RxNorm",
"code": "733",
"display": "Ampicillin"
}
]
},
"manifestation": [
{
"coding": [
{
"system": "SNOMED-CT",
"code": "247472004",
"display": "Hives"
}
]
}
],
"onset": "1980-05-10T11:00:00-04:00"
}
]
},
"search": {
"mode": "match"
}
}
]
}