Allergen

A substance that, upon exposure to an individual, may cause a harmful or undesirable physiological response.

Best practices is to utilize this endpoint to find codings to feed the Allergy Intolerance Create/Update. These substances come directly from our integration with FDB.

Endpoints

get
/Allergen/{id}
 get
/Allergen
get
/Allergen/{id}

Allergen read

Read an Allergen resource.

Path Parameters

id required
string
The unique identifier for the Allergen

Response Payload Attributes

resourceType
string

The FHIR Resource name.

id
string

The identifier of the Allergen.

text
json

Text summary of the Allergen, for human interpretation.

Click to view child attributes
status

All allergens returned from this endpoint will show a status of generated since this resource is generated from FDB.

div

Limited xhtml content that contains the human readable text of the Allergen.

code
json

Code that identifies the allergen

In Canvas we will return two different codings: one from FDB and one RxNorm

Click to view child attributes
coding
array[json]

Identifies where the definition of the code comes from.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://www.nlm.nih.gov/research/umls/rxnorm
  • http://snomed.info/sct
  • http://www.fdbhealth.com/
code
string

The code of the allergen

display
string

The display name of the coding

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

An Allergen Search requires either a code or _text search parameter to perform.
_text
string

Performs a case insensitive partial search on the narrative of the Allergen.

code
string

System url and code that identifies the allergen formatted like
system_url|code.

Search Values Supported:
  • http://www.nlm.nih.gov/research/umls/rxnorm|code
  • http://snomed.info/sct|code

Response Payload Attributes

resourceType
string

The FHIR Resource name.

type
string

This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .

total
integer

The number of resources that match the search parameter.

link
array[json]

Attributes relevant to pagination, see our Pagination page for more detail.

Click to view child attributes
relation
enum [self|first|next|last]

The relation of the page search

url

The search url for the specific relation

entry
array[json]

The results bundle that lists out each object returned in the search

Click to view child attributes
resource
json

The attributes specific to the resource type, see the Attributes section below

Attributes

resourceType
string

The FHIR Resource name.

id
string

The identifier of the Allergen.

text
json

Text summary of the Allergen, for human interpretation.

Click to view child attributes
status

All allergens returned from this endpoint will show a status of generated since this resource is generated from FDB.

div

Limited xhtml content that contains the human readable text of the Allergen.

code
json

Code that identifies the allergen

In Canvas we will return two different codings: one from FDB and one RxNorm

Click to view child attributes
coding
array[json]

Identifies where the definition of the code comes from.

Click to view child attributes
system
string

The system url of the coding.

Value Options Supported:
  • http://www.nlm.nih.gov/research/umls/rxnorm
  • http://snomed.info/sct
  • http://www.fdbhealth.com/
code
string

The code of the allergen

display
string

The display name of the coding

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"
      }
    }
  ]
}