AllergyIntolerance

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-allergyintolerance.html

Endpoints

post
/AllergyIntolerance
 get
/AllergyIntolerance/{id}
 put
/AllergyIntolerance/{id}
 get
/AllergyIntolerance

Attributes

id
string

The identifier of the AllergyIntolerance

clinicalStatus
json

The clinical status of the allergy or intolerance

Supported codes for create interactions are: active, inactive

verificationStatus
json

Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product)

Supported codes for create interactions are: confirmed, entered-in-error

type
string

Identification of the underlying physiological mechanism for the reaction risk

Supported codes for create interactions are: allergy, intolerance

code
json

Code that identifies the allergy or intolerance

Supported codings for create interactions are obtained from the Allergen search endpoint.

patient
json

Who the sensitivity is for

encounter
json

Encounter when the allergy or intolerance was asserted

Canvas does not currently support concurrent creation of resources on the same encounter. Please avoid issuing concurrent requests that reference the same encounter to this endpoint, or to any other endpoints that reference encounters. It is OK to issue concurrent requests to these endpoints as long as the requests reference different encounters.

onsetDateTime
date

When allergy or intolerance was identified

recordedDate
datetime

Date first version of the resource instance was recorded

recorder
json

Who recorded the sensitivity

lastOccurrence
date

Date of last known occurrence of a reaction

note
array[json]

Additional text not captured in other fields

reaction
array[json]

Adverse Reaction Events linked to exposure to substance

Supported severity codes for create interactions are: mild, moderate, severe

post
/AllergyIntolerance

AllergyIntolerance create

Create an AllergyIntolerance resource.

Exactly one FDB coding is required in the code field. FDB codings can be obtained from the Allergen search endpoint. The Allergen resource is a custom Canvas FHIR resource.

If encounter is provided, the AllergyIntolerance will be added to the existing encounter (note). If it is not provided, a new data import note will be created.

Attributes

id
string

The identifier of the AllergyIntolerance

clinicalStatus
json

The clinical status of the allergy or intolerance

Supported codes for create interactions are: active, inactive

verificationStatus
json

Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product)

Supported codes for create interactions are: confirmed, entered-in-error

type
string

Identification of the underlying physiological mechanism for the reaction risk

Supported codes for create interactions are: allergy, intolerance

code
json

Code that identifies the allergy or intolerance

Supported codings for create interactions are obtained from the Allergen search endpoint.

patient
json

Who the sensitivity is for

encounter
json

Encounter when the allergy or intolerance was asserted

Canvas does not currently support concurrent creation of resources on the same encounter. Please avoid issuing concurrent requests that reference the same encounter to this endpoint, or to any other endpoints that reference encounters. It is OK to issue concurrent requests to these endpoints as long as the requests reference different encounters.

onsetDateTime
date

When allergy or intolerance was identified

recordedDate
datetime

Date first version of the resource instance was recorded

recorder
json

Who recorded the sensitivity

lastOccurrence
date

Date of last known occurrence of a reaction

note
array[json]

Additional text not captured in other fields

reaction
array[json]

Adverse Reaction Events linked to exposure to substance

Supported severity codes for create interactions are: mild, moderate, severe

Responses

201 Created
The server has successfully processed the request, the new resource has been created and is now ready for interaction.

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.
405 Method Not Allowed
The request performs an operation that is either not supported or allowed.
422 Unprocessable Entity
The request cannot be processed due to semantic issues or conflicts with the database state.
get
/AllergyIntolerance/{id}

AllergyIntolerance read

Read an AllergyIntolerance resource.

Path Parameters

id required
string
The unique identifier for the AllergyIntolerance

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.
put
/AllergyIntolerance/{id}

AllergyIntolerance update

Update an AllergyIntolerance resource.

The only type of AllergyIntolerance update interaction that is supported by Canvas is to mark an existing AllergyIntolerance as entered-in-error. No changes to other fields will be processed.

Attributes

id
string

The identifier of the AllergyIntolerance

clinicalStatus
json

The clinical status of the allergy or intolerance

Supported codes for create interactions are: active, inactive

verificationStatus
json

Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product)

Supported codes for create interactions are: confirmed, entered-in-error

type
string

Identification of the underlying physiological mechanism for the reaction risk

Supported codes for create interactions are: allergy, intolerance

code
json

Code that identifies the allergy or intolerance

Supported codings for create interactions are obtained from the Allergen search endpoint.

patient
json

Who the sensitivity is for

encounter
json

Encounter when the allergy or intolerance was asserted

Canvas does not currently support concurrent creation of resources on the same encounter. Please avoid issuing concurrent requests that reference the same encounter to this endpoint, or to any other endpoints that reference encounters. It is OK to issue concurrent requests to these endpoints as long as the requests reference different encounters.

onsetDateTime
date

When allergy or intolerance was identified

recordedDate
datetime

Date first version of the resource instance was recorded

recorder
json

Who recorded the sensitivity

lastOccurrence
date

Date of last known occurrence of a reaction

note
array[json]

Additional text not captured in other fields

reaction
array[json]

Adverse Reaction Events linked to exposure to substance

Supported severity codes for create interactions are: mild, moderate, severe

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.
404 Not Found
The requested resource was not found.
405 Method Not Allowed
The request performs an operation that is either not supported or allowed.
412 Precondition Failed
The request depends on a precondition that has not been met.
422 Unprocessable Entity
The request cannot be processed due to semantic issues or conflicts with the database state.
get
/AllergyIntolerance

AllergyIntolerance search

Search for AllergyIntolerance resources.

Query Parameters

_id
string

The identifier of the AllergyIntolerance

patient
string

Who the sensitivity is for

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 POST \
     --url 'https://fumage-example.canvasmedical.com/AllergyIntolerance' \
     --header 'Authorization: Bearer <token>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
    "resourceType": "AllergyIntolerance",
    "clinicalStatus": {
        "coding": [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                "code": "active",
                "display": "Active"
            }
        ],
        "text": "Active"
    },
    "verificationStatus": {
        "coding": [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                "code": "confirmed",
                "display": "Confirmed"
            }
        ],
        "text": "Confirmed"
    },
    "type": "allergy",
    "code": {
        "coding": [
            {
                "system": "http://www.fdbhealth.com/",
                "code": "2-15588",
                "display": "Allergy Medicine"
            }
        ],
        "text": "Allergy Medicine"
    },
    "patient": {
        "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
    },
    "encounter": {
        "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
    },
    "onsetDateTime": "2023-06-15",
    "recorder": {
        "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
    },
    "lastOccurrence": "2023-06-17",
    "note": [
        {
            "text": "AllergyIntolerance note"
        }
    ],
    "reaction": [
        {
            "manifestation": [
                {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                            "code": "unknown",
                            "display": "Unknown"
                        }
                    ],
                    "text": "Unknown"
                }
            ],
            "severity": "moderate"
        }
    ]
}'

  • import requests

url = "https://fumage-example.canvasmedical.com/AllergyIntolerance"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer <token>",
    "content-type": "application/json"
}

payload = {
    "resourceType": "AllergyIntolerance",
    "clinicalStatus": {
        "coding": [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                "code": "active",
                "display": "Active"
            }
        ],
        "text": "Active"
    },
    "verificationStatus": {
        "coding": [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                "code": "confirmed",
                "display": "Confirmed"
            }
        ],
        "text": "Confirmed"
    },
    "type": "allergy",
    "code": {
        "coding": [
            {
                "system": "http://www.fdbhealth.com/",
                "code": "2-15588",
                "display": "Allergy Medicine"
            }
        ],
        "text": "Allergy Medicine"
    },
    "patient": {
        "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
    },
    "encounter": {
        "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
    },
    "onsetDateTime": "2023-06-15",
    "recorder": {
        "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
    },
    "lastOccurrence": "2023-06-17",
    "note": [
        {
            "text": "AllergyIntolerance note"
        }
    ],
    "reaction": [
        {
            "manifestation": [
                {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                            "code": "unknown",
                            "display": "Unknown"
                        }
                    ],
                    "text": "Unknown"
                }
            ],
            "severity": "moderate"
        }
    ]
}
response = requests.post(url, json=payload, headers=headers)

print(response.text)

  • null

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

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "not-supported",
      "details": {
        "text": "Operation is not supported"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "business-rule",
      "details": {
        "text": "Unprocessable entity"
      }
    }
  ]
}

  • curl --request GET \
     --url 'https://fumage-example.canvasmedical.com/AllergyIntolerance/<id>' \
     --header 'Authorization: Bearer <token>' \
     --header 'accept: application/json'

  • import requests

url = "https://fumage-example.canvasmedical.com/AllergyIntolerance/<id>"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

  • {
    "resourceType": "AllergyIntolerance",
    "id": "3340c331-d446-4700-9c23-7959bd393f26",
    "clinicalStatus": {
        "coding": [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                "code": "active",
                "display": "Active"
            }
        ],
        "text": "Active"
    },
    "verificationStatus": {
        "coding": [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                "code": "confirmed",
                "display": "Confirmed"
            }
        ],
        "text": "Confirmed"
    },
    "type": "allergy",
    "code": {
        "coding": [
            {
                "system": "http://www.fdbhealth.com/",
                "code": "2-15588",
                "display": "Allergy Medicine"
            }
        ],
        "text": "Allergy Medicine"
    },
    "patient": {
        "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
    },
    "encounter": {
        "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
    },
    "onsetDateTime": "2023-06-15",
    "recorder": {
        "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
    },
    "lastOccurrence": "2023-06-17",
    "note": [
        {
            "text": "AllergyIntolerance note"
        }
    ],
    "reaction": [
        {
            "manifestation": [
                {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                            "code": "unknown",
                            "display": "Unknown"
                        }
                    ],
                    "text": "Unknown"
                }
            ],
            "severity": "moderate"
        }
    ]
}

  • {
  "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 AllergyIntolerance resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
      }
    }
  ]
}

  • curl --request PUT \
     --url 'https://fumage-example.canvasmedical.com/AllergyIntolerance/<id>' \
     --header 'Authorization: Bearer <token>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
    "resourceType": "AllergyIntolerance",
    "clinicalStatus": {
        "coding": [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                "code": "active",
                "display": "Active"
            }
        ],
        "text": "Active"
    },
    "verificationStatus": {
        "coding": [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                "code": "entered-in-error",
                "display": "Entered in Error"
            }
        ],
        "text": "Confirmed"
    },
    "type": "allergy",
    "code": {
        "coding": [
            {
                "system": "http://www.fdbhealth.com/",
                "code": "2-15588",
                "display": "Allergy Medicine"
            }
        ],
        "text": "Allergy Medicine"
    },
    "patient": {
        "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
    },
    "encounter": {
        "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
    },
    "onsetDateTime": "2023-06-15",
    "recorder": {
        "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
    },
    "lastOccurrence": "2023-06-17",
    "note": [
        {
            "text": "AllergyIntolerance note"
        }
    ],
    "reaction": [
        {
            "manifestation": [
                {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                            "code": "unknown",
                            "display": "Unknown"
                        }
                    ],
                    "text": "Unknown"
                }
            ],
            "severity": "moderate"
        }
    ]
}'

  • import requests

url = "https://fumage-example.canvasmedical.com/AllergyIntolerance/<id>"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer <token>",
    "content-type": "application/json"
}

payload = {
    "resourceType": "AllergyIntolerance",
    "clinicalStatus": {
        "coding": [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                "code": "active",
                "display": "Active"
            }
        ],
        "text": "Active"
    },
    "verificationStatus": {
        "coding": [
            {
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                "code": "entered-in-error",
                "display": "Entered in Error"
            }
        ],
        "text": "Confirmed"
    },
    "type": "allergy",
    "code": {
        "coding": [
            {
                "system": "http://www.fdbhealth.com/",
                "code": "2-15588",
                "display": "Allergy Medicine"
            }
        ],
        "text": "Allergy Medicine"
    },
    "patient": {
        "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
    },
    "encounter": {
        "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
    },
    "onsetDateTime": "2023-06-15",
    "recorder": {
        "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
    },
    "lastOccurrence": "2023-06-17",
    "note": [
        {
            "text": "AllergyIntolerance note"
        }
    ],
    "reaction": [
        {
            "manifestation": [
                {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                            "code": "unknown",
                            "display": "Unknown"
                        }
                    ],
                    "text": "Unknown"
                }
            ],
            "severity": "moderate"
        }
    ]
}
response = requests.put(url, json=payload, headers=headers)

print(response.text)

  • null

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

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "not-found",
      "details": {
        "text": "Unknown AllergyIntolerance resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "not-supported",
      "details": {
        "text": "Operation is not supported"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "conflict",
      "details": {
        "text": "Resource updated since If-Unmodified-Since date"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "business-rule",
      "details": {
        "text": "Unprocessable entity"
      }
    }
  ]
}

  • curl --request GET \
     --url 'https://fumage-example.canvasmedical.com/AllergyIntolerance?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0' \
     --header 'Authorization: Bearer <token>' \
     --header 'accept: application/json'

  • import requests

url = "https://fumage-example.canvasmedical.com/AllergyIntolerance?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0"

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": "/AllergyIntolerance?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
        },
        {
            "relation": "first",
            "url": "/AllergyIntolerance?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
        },
        {
            "relation": "last",
            "url": "/AllergyIntolerance?patient=Patient%2Fb8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
        }
    ],
    "entry": [
        {
            "resource": {
                "resourceType": "AllergyIntolerance",
                "id": "3340c331-d446-4700-9c23-7959bd393f26",
                "clinicalStatus": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                            "code": "active",
                            "display": "Active"
                        }
                    ],
                    "text": "Active"
                },
                "verificationStatus": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                            "code": "confirmed",
                            "display": "Confirmed"
                        }
                    ],
                    "text": "Confirmed"
                },
                "type": "allergy",
                "code": {
                    "coding": [
                        {
                            "system": "http://www.fdbhealth.com/",
                            "code": "2-15588",
                            "display": "Allergy Medicine"
                        }
                    ],
                    "text": "Allergy Medicine"
                },
                "patient": {
                    "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"
                },
                "encounter": {
                    "reference": "Encounter/eae3c8a5-a129-4960-9715-fc26da30eccc"
                },
                "onsetDateTime": "2023-06-15",
                "recorder": {
                    "reference": "Practitioner/76428138e7644ce6b7eb426fdbbf2f39"
                },
                "lastOccurrence": "2023-06-17",
                "note": [
                    {
                        "text": "AllergyIntolerance note"
                    }
                ],
                "reaction": [
                    {
                        "manifestation": [
                            {
                                "coding": [
                                    {
                                        "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                                        "code": "unknown",
                                        "display": "Unknown"
                                    }
                                ],
                                "text": "Unknown"
                            }
                        ],
                        "severity": "moderate"
                    }
                ]
            }
        }
    ]
}

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