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

Create an allergy intolerance

post

/AllergyIntolerance

Creates a new allergy intolerance.

Note: Only the body fields mentioned below are supported. Unsupported fields are ignored.

Authorization Types

This operation supports the following authorization types:

Request

Supported Media Types
Header Parameters
Body ()
The body of the create operation.
Root Schema : AllergyIntoleranceCreate
Type: object
A summary representation of the create (POST) operation for the AllergyIntolerance resource.
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.
    Note: A clinicalStatus must always be provided while creating an allergy.
    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: An author and text can be specified but note.time is always defaulted.
    Example: 
    {
  "note": [
    {
      "authorReference": {
        "reference": "Practitioner/2578010"
      },
      "text": "Allergy reported 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 an allergy.
    Note: verificationStatus codes of entered-in-error and refuted are not supported during AllergyIntolerance creates.
    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.
Note: A clinicalStatus must always be provided while creating an allergy.
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: An author and text can be specified but note.time is always defaulted.
Example: 
{
  "note": [
    {
      "authorReference": {
        "reference": "Practitioner/2578010"
      },
      "text": "Allergy reported 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 an allergy.
Note: verificationStatus codes of entered-in-error and refuted are not supported during AllergyIntolerance creates.
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
    The 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"
      }
    ]
  }
}
  • Values are mild, moderate, and severe (of the event as a whole).
    Example: 
    {
  "severity":"severe"
}
Nested Schema : reaction.manifestation
Type: array
The 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: 
POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance
Example Request Body: 
{
    'resourceType': 'AllergyIntolerance',
    'contained': [
      {
        'resourceType': 'PractitionerRole',
        'id': '638995',
        'code': [
          {
            'coding': [
              {
                'system': 'http://terminology.hl7.org/CodeSystem/practitioner-role',
                'code': 'nurse'
              }
            ]
          }
        ]
      }
    ],
    'clinicalStatus': {
      'coding': [
        {
          'system': 'http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical',
          'code': 'active'
        }
      ]
    },
    'verificationStatus': {
      'coding': [
        {
          'system': 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification',
          'code': 'confirmed'
        }
      ]
    },
    'type': 'allergy',
    'category': [
      'medication'
    ],
    'criticality': 'high',
    'code': {
      'coding': [
        {
          'system': 'http://www.nlm.nih.gov/research/umls/rxnorm',
          'code': '723'
        }
      ],
      'text': 'amoxicillin'
    },
    'patient': {
      'reference': 'Patient/12742399'
    },
    'encounter': {
      'reference': 'Encounter/97953523'
    },
    'onsetDateTime': '2019-09-11T05:00:00.000Z',
    'asserter': {
      'reference': '#638995'
    },
    'note': [
      {
        'authorReference': {
          'reference': 'Practitioner/12742399'
        },
        'text': 'Updated with additional details provided by patient.'
      }
    ],
    'reaction': [
      {
        'manifestation': [
          {
            'coding': [
              {
                'system': 'http://snomed.info/sct',
                'code': '271757001'
              }
            ],
            'text': 'Papular eruption'
          }
        ],
        'severity': 'severe'
      }
    ]
  }
Example Response: 
  HTTP Status: 201 Created
  Cache-Control: no-cache
  Content-Length: 0
  Content-Type: text/html
  Date: Wed, 14 Aug 2019 17:23:14 GMT
  Etag: W/"6767735"
  Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance/6767735
  Last-Modified: Wed, 14 Aug 2019 17:23:14 GMT
  Vary: Origin
  X-Request-Id: 11111111111111111111111111111111
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.
  • 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