1. FHIR DSTU 2 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.
  • note cannot be added if note already exists. An existing note field cannot be modified.

Authorization Types

This operation supports the following authorization types:

  • Provider
  • System

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
The body of the update operation.
Root Schema : AllergyIntoleranceUpdate
Type: object
Show Source
  • The category of the identified substance.
    Example: 
    {
  "type": "food"
}
  • Contained, inline resources.
    Note: These resources should be Practitioner or RelatedPerson resources that are referenced with the reporter field.
    Example:
    Contained RelatedPerson 
    {
  "contained": [
    {
      "resourceType": "RelatedPerson",
      "id": "5366328",
      "relationship": {
        "coding": [
          {
            "system": "http://hl7.org/fhir/v3/RoleCode",
            "code": "SIGOTHR"
          }
        ]
      }
    }
  ]
}

    Contained Practitioner 
    {
  "contained": [
    {
      "resourceType": "Practitioner",
      "id": "123",
      "practitionerRole": [
        {
          "role": {
            "coding": [
              {
                "system": "http://hl7.org/fhir/v2/0286",
                "code": "RP"
              }
            ]
          }
        }
      ]
    }
  ]
}
  • The estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
    Example: 
    {
  "criticality": "CRITU"
}
  • The logical ID of the resource to update.
    Note: The ID value must match the AllergyIntolerance value.
    Example: 
    {
  "id": "123412"
}
  • note
    Additional text not captured in other fields.
    Example: 
    {
  "note": {
    "authorReference": {
      "reference": "Practitioner/21500971"
    },
    "time": "2015-10-14T13:13:20-06:00",
    "text": "Patient complains of discomfort"
  }
}
  • note.authorReference
    The individual responsible for the annotation.
    Example: 
    {
  "note": {
    "authorReference": {
      "reference": "Practitioner/21500971"
    }
  }
}
  • The text content.
    Example: 
    {
  "note": {
    "text": "Patient complains of discomfort"
  }
}
  • When the annotation was made.
    Example: 
    {
  "note": {
    "time": "2015-10-14T13:13:20-06:00"
  }
}
  • The date, time, or both when manifestations showed.
    Example: 
    {
  "onset: "2012-07-13T00:00:00Z"
}
  • patient
    Who the sensitivity is for.
    Example: 
    {
  "patient": {
    "reference": "Patient/5366327"
  }
}
  • reaction
    The adverse reaction events linked to exposure to the substance.
    Example: 
    {
  "reaction": [
    {
      "manifestation": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "39579001",
              "display": "Anaphylactic reaction"
            }
          ]
        }
      ]
    }
  ]
}
  • When the sensitivity was recorded.
    Example: 
    {
  "recordedDate": "2015-10-14T13:13:20-06:00"
}
  • recorder
    Who recorded the sensitivity.
    Note: The recorder must be a Practitioner reference.
    Example: 
    {
  "recorder": {
    "reference": "Practitioner/21500971"
  }
}
  • The source of the information about the allergy.
    Note: If the reporter is a contained reference, a matching RelatedPerson or Practitioner reference must be provided in the contained field.
    Example:
    Reporter as a Patient Reference 
    {
  "reporter": {
    "reference": "Patient/5366327"
  }
}

    Reporter as a contained reference 
    {
  "reporter": "#5366328"
}
  • Allowed Values: [ "AllergyIntolerance" ]
    The type of the FHIR resource.
  • The assertion about the certainty associated with the propensity, or potential risk, of a reaction to the identified substance.
    Example: 
    {
  "status": "resolved"
}
  • substance
    The substance (or class) that is considered responsible for risk.
    Example: 
    {
  "substance": {
    "coding": [
      {
        "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
        "code": "4125",
        "display": "Ethiodized oil"
      }
    ]
  }
}
  • The identification of the underlying physiological mechanism for the reaction risk.
    Example: 
    {
  "type": "allergy"
}
Nested Schema : note
Type: object
Additional text not captured in other fields.
Example: 
{
  "note": {
    "authorReference": {
      "reference": "Practitioner/21500971"
    },
    "time": "2015-10-14T13:13:20-06:00",
    "text": "Patient complains of discomfort"
  }
}
Show Source
Nested Schema : note.authorReference
Type: object
The individual responsible for the annotation.
Example: 
{
  "note": {
    "authorReference": {
      "reference": "Practitioner/21500971"
    }
  }
}
Show Source
Nested Schema : patient
Type: object
Who the sensitivity is for.
Example: 
{
  "patient": {
    "reference": "Patient/5366327"
  }
}
Show Source
Nested Schema : reaction
Type: array
The adverse reaction events linked to exposure to the substance.
Example: 
{
  "reaction": [
    {
      "manifestation": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "39579001",
              "display": "Anaphylactic reaction"
            }
          ]
        }
      ]
    }
  ]
}
Show Source
Nested Schema : recorder
Type: object
Who recorded the sensitivity.
Note: The recorder must be a Practitioner reference.
Example: 
{
  "recorder": {
    "reference": "Practitioner/21500971"
  }
}
Show Source
Nested Schema : substance
Type: object
The substance (or class) that is considered responsible for risk.
Example: 
{
  "substance": {
    "coding": [
      {
        "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
        "code": "4125",
        "display": "Ethiodized oil"
      }
    ]
  }
}
Show Source
Nested Schema : authorReference
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • The logical ID of the reaction event.
    Example: 
    {
  "id": "543123"
}
  • reaction.manifestation
    The clinical symptoms or signs associated with the event.
    Example:
    Manifestation with a coding: 
    {
  "reaction": [
    {
      "manifestation": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "39579001",
              "display": "Anaphylactic reaction"
            }
          ]
        }
      ]
    }
  ]
}

    Manifestation with a free-text value: 
    {
  "reaction": [
    {
      "manifestation": [
        {
          "text": "Anaphylactic reaction"
        }
      ]
    }
  ]
}
Nested Schema : reaction.manifestation
Type: array
The clinical symptoms or signs associated with the event.
Example:
Manifestation with a coding: 
{
  "reaction": [
    {
      "manifestation": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "39579001",
              "display": "Anaphylactic reaction"
            }
          ]
        }
      ]
    }
  ]
}

Manifestation with a free-text value: 
{
  "reaction": [
    {
      "manifestation": [
        {
          "text": "Anaphylactic reaction"
        }
      ]
    }
  ]
}
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/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance/12760025
Example Request Body: 
{
    'resourceType': 'AllergyIntolerance',
    'id': '12760025',
    'meta': {
      'versionId': '12760025',
      'lastUpdated': '2020-03-04T20:16:02.000Z'
    },
    'contained': [
      {
        'resourceType': 'Practitioner',
        'id': '638994',
        'practitionerRole': [
          {
            'role': {
              'coding': [
                {
                  'system': 'http://hl7.org/fhir/practitioner-role',
                  'code': 'doctor',
                  'display': 'Doctor'
                }
              ],
              'text': 'Doctor'
            }
          }
        ]
      }
    ],
    'onset': '2020-2',
    'recordedDate': '2020-05-04T14:16:02.000-06:00',
    'patient': {
      'reference': 'Patient/12742399'
    },
    'substance': {
      'coding': [
        {
          'system': 'http://snomed.info/sct',
          'code': '102263004',
          'display': 'Eggs (edible) (substance)',
          'userSelected': false
        }
      ],
      'text': 'Egg'
    },
    'status': 'active',
    'criticality': 'CRITH',
    'category': 'food',
    'reaction': [
      {
        'id': '3363737',
        'manifestation': [
          {
            'coding': [
              {
                'system': 'http://snomed.info/sct',
                'code': '79962008',
                'display': 'Diffuse spasm of esophagus (disorder)',
                'userSelected': false
              }
            ],
            'text': 'Barsony-Teschendorf syndrome'
          }
        ]
      }
    ]
  }
Example Response: 
  HTTP Status: 200 OK
  Date: Tue, 28 Feb 2017 21:19:18 GMT
  Cache-Control: no-cache
  Vary: Origin,User-Agent,Accept-Encoding
  Strict-Transport-Security: max-age=631152000
  X-Xss-Protection: 1; mode=block
  Pragma: no-cache
  X-Request-Id: 11111111111111111111111111111111
  Etag: W/"6167741"
  X-Frame-Options: SAMEORIGIN
  X-Content-Type-Options: nosniff
  Expires: Mon, 01 Jan 1990 00:00:00 GMT
  Last-Modified: Tue, 28 Feb 2017 21:03:00 GMT
  Content-Length: 0
  Content-Type: application/json
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