Allergen
A substance that, upon exposure to an individual, may cause a harmful or undesirable physiological response.
Endpoints
Attributes
id
string
The identifier of the Allergen
text
json
Text summary of the Allergen, for human interpretation
code
json
Code that identifies the allergen
get
/Allergen/{id}
Allergen read
Read an Allergen resource.
Path Parameters
id required
string
The unique identifier for the Allergen
Responses
200 OK
Request was successful.
Errors
401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
404 Not Found
The requested resource was not found.
get
/Allergen
Allergen search
Search for Allergyen resources.
Query Parameters
_text
string
Search on the narrative of the Allergen
code
string
Code that identifies the allergen
Responses
200 OK
Request was successful.
Errors
400 Bad Request
The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
curl --request GET \ --url 'https://fumage-example.canvasmedical.com/Allergen/<id>' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json'
import requests url = "https://fumage-example.canvasmedical.com/Allergen/<id>" headers = { "accept": "application/json", "Authorization": "Bearer <token>" } response = requests.get(url, headers=headers) print(response.text)
{ "resourceType": "Allergen", "id": "fdb-6-2754", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>minocycline HCl</p><p>6979</p>\"</div>" }, "code": { "coding": [ { "system": "http://www.fdbhealth.com/", "code": "6-2754", "display": "minocycline HCl" }, { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "6979" } ] } }
{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "unknown", "details": { "text": "Authentication failed" } } ] }
{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "text": "Authorization failed" } } ] }
{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "not-found", "details": { "text": "Unknown Allergen resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'" } } ] }
curl --request GET \ --url 'https://fumage-example.canvasmedical.com/Allergen?code=http://www.nlm.nih.gov/research/umls/rxnorm|6979' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json'
import requests url = "https://fumage-example.canvasmedical.com/Allergen?code=http://www.nlm.nih.gov/research/umls/rxnorm|6979" headers = { "accept": "application/json", "Authorization": "Bearer <token>" } response = requests.get(url, headers=headers) print(response.text)
{ "resourceType": "Bundle", "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "/Allergen?code=http%3A%2F%2Fwww.nlm.nih.gov%2Fresearch%2Fumls%2Frxnorm%7C6979&_count=10&_offset=0" }, { "relation": "first", "url": "/Allergen?code=http%3A%2F%2Fwww.nlm.nih.gov%2Fresearch%2Fumls%2Frxnorm%7C6979&_count=10&_offset=0" }, { "relation": "last", "url": "/Allergen?code=http%3A%2F%2Fwww.nlm.nih.gov%2Fresearch%2Fumls%2Frxnorm%7C6979&_count=10&_offset=0" } ], "entry": [ { "resource": { "resourceType": "Allergen", "id": "fdb-6-2754", "text": { "status": "generated", "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>minocycline HCl</p><p>6979</p>\"</div>" }, "code": { "coding": [ { "system": "http://www.fdbhealth.com/", "code": "6-2754", "display": "minocycline HCl" }, { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "6979" } ] } } } ] }
{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "text": "Bad request" } } ] }
{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "unknown", "details": { "text": "Authentication failed" } } ] }
{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "text": "Authorization failed" } } ] }