1. FHIR R4 APIs for Oracle Health Millennium Platform
  2. Tasks
  3. AllergyIntolerance

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
Path Parameters
Header Parameters
Body ()
The body of the update operation.
Root Schema : AllergyIntoleranceUpdate
Type: object
Show Source
  • 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
    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"
  ]
}
  • clinicalStatus
    The clinical status of the allergy intolerance.
    Example: 
    {
  "clinicalStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
        "code": "resolved"
      }
    ]
  }
}
  • 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, inline resources.
    Note: These resources should be either PractitionerRole or RelatedPerson resources that are relative references from the asserter field.
    Examples:
    Contained RelatedPerson 
    {
  "contained": [
    {
      "resourceType":"RelatedPerson",
      "id":"638996",
      "relationship":[
        {
          "coding":[
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
              "code": "PRN",
            }
          ]
        }
      ],
      "patient":{
        "reference":"Patient/12742400"
      }
    }
  ]
}
    Contained PractitionerRole 
    {
  "contained": [
    {
      "resourceType":"PractitionerRole",
      "id":"638994",
      "code":[
        {
          "coding":[
            {
              "system":"http://terminology.hl7.org/CodeSystem/practitioner-role",
              "code":"doctor"
            }
          ]
        }
      ]
    }
  ]
}
  • criticality
    Values are low, high, and unable-to-assess.
    Example: 
    {
  "criticality": "high"
}
  • encounter
    Indicates the encounter when the allergy or intolerance was asserted.
    Example: 
    {
  "encounter": {
    "reference":"Encounter/1693915"
  }
}
  • 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."
    }
  ]
}
  • 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"
}
  • patient
    Indicates the patient who the sensitivity is for.
    Example: 
    {
  "patient": {
    "reference": "Patient/631923"
  }
}
  • reaction
    Adverse reaction events linked to exposure to substance.
    Example: 
    {
  "reaction":[
    {
      "manifestation":[
        {
          "coding":[
            {
              "system":"http://snomed.info/sct",
              "code":"414322003"
            }
          ],
          "text":"Blastobacter"
        }
      ],
      "severity":"severe"
    }
  ]
}
  • Allowed Values: [ "AllergyIntolerance" ]
    The type of the FHIR resource.
  • The underlying mechanism (if known), either allergy or intolerance.
    Example: 
    {
  "type": "allergy"
}
  • verificationStatus
    The verification status to support or decline the clinical status of the allergy.
    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 : 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: 
{
  "asserter":{
    "reference":"#638994"
  }
}
Show Source
Nested Schema : category
Type: array
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"
  ]
}
Show Source
Nested Schema : clinicalStatus
Type: object
The clinical status of the allergy intolerance.
Example: 
{
  "clinicalStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
        "code": "resolved"
      }
    ]
  }
}
Show Source
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: 
{
  "code":{
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "9220005"
      }
    ],
    "text": "Plant phenol oil"
  }
}
Show Source
Nested Schema : criticality
Type: array
Values are low, high, and unable-to-assess.
Example: 
{
  "criticality": "high"
}
Show Source
Nested Schema : encounter
Type: object
Indicates the encounter when the allergy or intolerance was asserted.
Example: 
{
  "encounter": {
    "reference":"Encounter/1693915"
  }
}
Show Source
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: 
 {
  "note": [
    {
      "text": "Updated with additional details provided by patient."
    }
  ]
}
Show Source
Nested Schema : patient
Type: object
Indicates the patient who the sensitivity is for.
Example: 
{
  "patient": {
    "reference": "Patient/631923"
  }
}
Show Source
Nested Schema : reaction
Type: array
Adverse reaction events linked to exposure to substance.
Example: 
{
  "reaction":[
    {
      "manifestation":[
        {
          "coding":[
            {
              "system":"http://snomed.info/sct",
              "code":"414322003"
            }
          ],
          "text":"Blastobacter"
        }
      ],
      "severity":"severe"
    }
  ]
}
Show Source
Nested Schema : verificationStatus
Type: object
The verification status to support or decline the clinical status of the allergy.
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"
      }
    ]
  }
}
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : authorReference
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • 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"
      }
    ]
  }
}
  • Vlaues are mild, moderate, and severe (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: 
{
  {
    "manifestation":[
      {
        "coding":[
          {
            "system":"http://snomed.info/sct",
            "code":"414322003"
          }
        ],
        "text":"Blastobacter"
      }
    ]
  }
}
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

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
  • For Update or Patch versioning controls. Related to If-Match. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
  • For Update or Patch versioning controls. Related to Etag. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.
Back to Top