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
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
The identifier of the AllergyIntolerance
Canvas supports a note identifier extension on this resource for create, read, update, and search interactions. The note identifier can be used with the Canvas Note API.
Important: For create interactions, Canvas recommends sending the note identifier extension or the Encounter reference, but not both. If both are supplied, they must both refer to the same note.
The url
for the extension is: http://schemas.canvasmedical.com/fhir/extensions/note-id
The valueId
contains the note identifier.
See the request and response examples for more information.
The clinical status of the allergy or intolerance
Supported codes for create interactions are: active, inactive
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
Identification of the underlying physiological mechanism for the reaction risk
Supported codes for create interactions are: allergy, intolerance
Code that identifies the allergy or intolerance
Supported codings for create interactions are obtained from the Allergen search endpoint.
Who the sensitivity is for
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.
When allergy or intolerance was identified
Date first version of the resource instance was recorded
Who recorded the sensitivity
Date of last known occurrence of a reaction
Additional text not captured in other fields
Adverse Reaction Events linked to exposure to substance
Supported severity codes for create interactions are: mild, moderate, severe
Responses
Canvas returns the created resource's id as a UUID within the
location
header and a null
response body.Errors
AllergyIntolerance read
Read an AllergyIntolerance resource.
Path Parameters
Response Payload Attributes
The identifier of the AllergyIntolerance
Canvas supports a note identifier extension on this resource for create, read, update, and search interactions. The note identifier can be used with the Canvas Note API.
Important: For create interactions, Canvas recommends sending the note identifier extension or the Encounter reference, but not both. If both are supplied, they must both refer to the same note.
The url
for the extension is: http://schemas.canvasmedical.com/fhir/extensions/note-id
The valueId
contains the note identifier.
See the request and response examples for more information.
The clinical status of the allergy or intolerance
Supported codes for create interactions are: active, inactive
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
Identification of the underlying physiological mechanism for the reaction risk
Supported codes for create interactions are: allergy, intolerance
Code that identifies the allergy or intolerance
Supported codings for create interactions are obtained from the Allergen search endpoint.
Who the sensitivity is for
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.
When allergy or intolerance was identified
Date first version of the resource instance was recorded
Who recorded the sensitivity
Date of last known occurrence of a reaction
Additional text not captured in other fields
Adverse Reaction Events linked to exposure to substance
Supported severity codes for create interactions are: mild, moderate, severe
Responses
Errors
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
The identifier of the AllergyIntolerance
Canvas supports a note identifier extension on this resource for create, read, update, and search interactions. The note identifier can be used with the Canvas Note API.
Important: For create interactions, Canvas recommends sending the note identifier extension or the Encounter reference, but not both. If both are supplied, they must both refer to the same note.
The url
for the extension is: http://schemas.canvasmedical.com/fhir/extensions/note-id
The valueId
contains the note identifier.
See the request and response examples for more information.
The clinical status of the allergy or intolerance
Supported codes for create interactions are: active, inactive
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
Identification of the underlying physiological mechanism for the reaction risk
Supported codes for create interactions are: allergy, intolerance
Code that identifies the allergy or intolerance
Supported codings for create interactions are obtained from the Allergen search endpoint.
Who the sensitivity is for
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.
When allergy or intolerance was identified
Date first version of the resource instance was recorded
Who recorded the sensitivity
Date of last known occurrence of a reaction
Additional text not captured in other fields
Adverse Reaction Events linked to exposure to substance
Supported severity codes for create interactions are: mild, moderate, severe
Responses
Canvas returns a
null
response body.Errors
AllergyIntolerance search
Search for AllergyIntolerance resources.
Query Parameters
The identifier of the AllergyIntolerance
Who the sensitivity is for
Response Payload Attributes
The FHIR Resource name.
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
The number of resources that match the search parameter.
Attributes relevant to pagination, see our Pagination page for more detail.
The relation of the page search
The search url for the specific relation
The results bundle that lists out each object returned in the search
The attributes specific to the resource type, see the Attributes section below
Attributes
The identifier of the AllergyIntolerance
Canvas supports a note identifier extension on this resource for create, read, update, and search interactions. The note identifier can be used with the Canvas Note API.
Important: For create interactions, Canvas recommends sending the note identifier extension or the Encounter reference, but not both. If both are supplied, they must both refer to the same note.
The url
for the extension is: http://schemas.canvasmedical.com/fhir/extensions/note-id
The valueId
contains the note identifier.
See the request and response examples for more information.
The clinical status of the allergy or intolerance
Supported codes for create interactions are: active, inactive
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
Identification of the underlying physiological mechanism for the reaction risk
Supported codes for create interactions are: allergy, intolerance
Code that identifies the allergy or intolerance
Supported codings for create interactions are obtained from the Allergen search endpoint.
Who the sensitivity is for
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.
When allergy or intolerance was identified
Date first version of the resource instance was recorded
Who recorded the sensitivity
Date of last known occurrence of a reaction
Additional text not captured in other fields
Adverse Reaction Events linked to exposure to substance
Supported severity codes for create interactions are: mild, moderate, severe
Responses
Errors
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", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5", } ], "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", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5", } ], "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", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5", } ], "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", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5", } ], "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", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5", } ], "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", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "2a8154d8-9420-4ab5-97f8-c2dae5a10af5", } ], "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" } } ] }