Update an allergy intolerance
put
/AllergyIntolerance/{ID}
Updates an allergy intolerance.
Note: Missing fields are interpreted as nulling out or removing data from the resource. See FHIR Update for additional details about update operations.
Authorization Types
This operation supports the following authorization types:
Request
Supported Media Types
- application/fhir+json
Path Parameters
-
ID(required): string
The logical resource ID associated with the resource.
Header Parameters
-
If-Match(required): string
The current version of the AllergyIntolerance resource.
-
accept(required): string
The media type to be requested. See what the resource's operation produces for what is supported.
-
authorization(required): string
Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.
The body of the update operation.
Root Schema : AllergyIntoleranceUpdate
Type:
Show Source
object
-
asserter:
object asserter
Indicates the source of information about the allergy.
Note: The asserter must be provided and linked to the contained resource if a contained resource is specified.
Example:{ "asserter":{ "reference":"#638994" } }
-
category:
array category
The category of the identified code.
Note:- The category code of
biologic
is not supported. - Only a single category is written to the allergy.
- When multiple categories are provided, the selected category is based on precedence (medication > food > environment).
Example:{ "category":[ "environment", "food", "medication" ] }
- The category code of
-
clinicalStatus:
object clinicalStatus
The clinical status of the allergy intolerance.
Example:{ "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "resolved" } ] } }
-
code(required):
object code
A code that identifies the allergy or intolerance.
Note: A code must always be provided while creating an allergy.
Example:{ "code":{ "coding": [ { "system": "http://snomed.info/sct", "code": "9220005" } ], "text": "Plant phenol oil" } }
-
contained:
string
Contained, inline resources.
Note: These resources should be eitherPractitionerRole
orRelatedPerson
resources that are relative references from theasserter
field.
Examples:
Contained RelatedPerson
Contained PractitionerRole{ "contained": [ { "resourceType":"RelatedPerson", "id":"638996", "relationship":[ { "coding":[ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "PRN", } ] } ], "patient":{ "reference":"Patient/12742400" } } ] }
{ "contained": [ { "resourceType":"PractitionerRole", "id":"638994", "code":[ { "coding":[ { "system":"http://terminology.hl7.org/CodeSystem/practitioner-role", "code":"doctor" } ] } ] } ] }
-
criticality:
array criticality
Values are
low
,high
, andunable-to-assess
.
Example:{ "criticality": "high" }
-
encounter:
object encounter
Indicates the encounter when the allergy or intolerance was asserted.
Example:{ "encounter": { "reference":"Encounter/1693915" } }
-
note:
array note
Additional narrative about the allergy not captured in other fields.
Note: Updates do not allow an author to be specified. One is inferred from the authorization token. If an ID is not provided with the note, the system assumes that the note is new and writes it as such. If an ID is provided, the system assumes that the note is existing and does not update or re-create it.
Example:{ "note": [ { "text": "Updated with additional details provided by patient." } ] }
-
onset[x]:
The estimated date, actual date, or date and time when the allergy began, in the opinion of the clinician.
Note:- Only a type of
dateTime
is supported. - The
dateTime
is converted to a GMT date.
Example:{ "onsetDateTime": "2015-10-14T13:13:20-06:00" }
- Only a type of
-
patient(required):
object patient
Indicates the patient who the sensitivity is for.
Example:{ "patient": { "reference": "Patient/631923" } }
-
reaction:
array reaction
Adverse reaction events linked to exposure to substance.
Example:{ "reaction":[ { "manifestation":[ { "coding":[ { "system":"http://snomed.info/sct", "code":"414322003" } ], "text":"Blastobacter" } ], "severity":"severe" } ] }
-
resourceType(required):
string
Allowed Values:
[ "AllergyIntolerance" ]
The type of the FHIR resource. -
type:
string
The underlying mechanism (if known), either
allergy
orintolerance
.
Example:{ "type": "allergy" }
-
verificationStatus:
object verificationStatus
The verification status to support or decline the clinical status of the allergy.
Note: The verificationStatus code ofrefuted
is not supported during AllergyIntolerance updates.
Example:{ "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed" } ] } }
Nested Schema : asserter
Type:
object
Indicates the source of information about the allergy.
Note: The asserter must be provided and linked to the contained resource if a contained resource is specified.
Example:
Show Source
Note: The asserter must be provided and linked to the contained resource if a contained resource is specified.
Example:
{
"asserter":{
"reference":"#638994"
}
}
Nested Schema : category
Type:
array
The category of the identified code.
Note:
Example:
Show Source
Note:
- The category code of
biologic
is not supported. - Only a single category is written to the allergy.
- When multiple categories are provided, the selected category is based on precedence (medication > food > environment).
Example:
{
"category":[
"environment",
"food",
"medication"
]
}
Nested Schema : clinicalStatus
Type:
object
The clinical status of the allergy intolerance.
Example:
Show Source
Example:
{
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "resolved"
}
]
}
}
Nested Schema : code
Type:
object
A code that identifies the allergy or intolerance.
Note: A code must always be provided while creating an allergy.
Example:
Show Source
Note: A code must always be provided while creating an allergy.
Example:
{
"code":{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "9220005"
}
],
"text": "Plant phenol oil"
}
}
Nested Schema : criticality
Type:
array
Values are
Example:
Show Source
low
, high
, and unable-to-assess
.
Example:
{
"criticality": "high"
}
Nested Schema : encounter
Type:
object
Indicates the encounter when the allergy or intolerance was asserted.
Example:
Show Source
Example:
{
"encounter": {
"reference":"Encounter/1693915"
}
}
Nested Schema : note
Type:
array
Additional narrative about the allergy not captured in other fields.
Note: Updates do not allow an author to be specified. One is inferred from the authorization token. If an ID is not provided with the note, the system assumes that the note is new and writes it as such. If an ID is provided, the system assumes that the note is existing and does not update or re-create it.
Example:
Show Source
Note: Updates do not allow an author to be specified. One is inferred from the authorization token. If an ID is not provided with the note, the system assumes that the note is new and writes it as such. If an ID is provided, the system assumes that the note is existing and does not update or re-create it.
Example:
{
"note": [
{
"text": "Updated with additional details provided by patient."
}
]
}
Nested Schema : patient
Type:
object
Indicates the patient who the sensitivity is for.
Example:
Show Source
Example:
{
"patient": {
"reference": "Patient/631923"
}
}
Nested Schema : reaction
Type:
array
Adverse reaction events linked to exposure to substance.
Example:
Show Source
Example:
{
"reaction":[
{
"manifestation":[
{
"coding":[
{
"system":"http://snomed.info/sct",
"code":"414322003"
}
],
"text":"Blastobacter"
}
],
"severity":"severe"
}
]
}
Nested Schema : verificationStatus
Type:
object
The verification status to support or decline the clinical status of the allergy.
Note: The verificationStatus code of
Example:
Show Source
Note: The verificationStatus code of
refuted
is not supported during AllergyIntolerance updates.
Example:
{
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
}
}
Nested Schema : items
Type:
Show Source
object
-
reaction.manifestation:
array reaction.manifestation
Clinical symptoms or signs associated with the event.
Note: Only one manifestation can be provided.
Example:{ { "manifestation":[ { "coding":[ { "system":"http://snomed.info/sct", "code":"414322003" } ], "text":"Blastobacter" } ] } }
-
reaction.severity:
string
Vlaues are
mild
,moderate
, andsevere
(of event as a whole).
Example:{ "severity":"severe" }
Nested Schema : reaction.manifestation
Type:
array
Clinical symptoms or signs associated with the event.
Note: Only one manifestation can be provided.
Example:
Show Source
Note: Only one manifestation can be provided.
Example:
{
{
"manifestation":[
{
"coding":[
{
"system":"http://snomed.info/sct",
"code":"414322003"
}
],
"text":"Blastobacter"
}
]
}
}
Response
Supported Media Types
- application/fhir+json
Default Response
Example Request:
PUT https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance/12760025
Example Request Body:
{
'resourceType': 'AllergyIntolerance',
'id': '12760025',
'clinicalStatus': {
'coding': [
{
'system': 'http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical',
'code': 'active'
}
]
},
'verificationStatus': {
'coding': [
{
'system': 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification',
'code': 'unconfirmed'
}
]
},
'category': [
'food'
],
'code': {
'coding': [
{
'system': 'http://snomed.info/sct',
'code': '102263004',
'display': 'Eggs (edible) (substance)'
}
],
'text': 'Egg'
},
'patient': {
'reference': 'Patient/12742399'
},
'recordedDate': '2019-02-08T00:00:00Z',
'recorder': {
'reference': 'Practitioner/12724045'
},
'note': [
{
'text': 'Updated with additional details provided by patient.'
}
]
}
Example Response:
HTTP Status: 200 OK
Cache-Control: no-cache
Content-Length: 0
Content-Type: application/json
Date: Thu, 05 Dec 2019 17:21:08 GMT
Etag: W/"8167765"
Last-Modified: Thu, 05 Dec 2019 17:21:08 GMT
X-Request-Id: 11111111111111111111111111111111
Vary: Origin
Headers
-
Etag: string
For Update or Patch versioning controls. Related to
If-Match
. When a resource performs an operation that creates or updates a record, anEtag
value is returned as a header. This same value should be included in request headers as anIf-Match
for any subsequent update to that record. -
If-Match: string
For Update or Patch versioning controls. Related to
Etag
. When a resource performs an operation that creates or updates a record, anEtag
value is returned as a header. This same value should be included in request headers as anIf-Match
for any subsequent update to that record. -
X-Request-Id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
X-Request-Id
, if present. -
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
opc-Request-Id
, if present.