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:
- Provider
- System
Request
Supported Media Types
- application/json+fhir
Header Parameters
-
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 create operation.
Root Schema : AllergyIntoleranceCreate
Type:
Show Source
object
-
category(required):
string
The category of the identified substance.
Example:{ "type": "food" }
-
contained:
string
Contained, inline resources.
Note: These resources should bePractitioner
orRelatedPerson
resources that are referenced with thereporter
field.
Examples:
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" } ] } } ] } ] }
-
criticality(required):
string
The estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
Example:{ "criticality": "CRITU" }
-
note:
object 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:
object note.authorReference
The individual responsible for the annotation.
Example:{ "note": { "authorReference": { "reference": "Practitioner/21500971" } } }
-
note.text(required):
string
The text content.
Example:{ "note": { "text": "Patient complains of discomfort" } }
-
note.time:
string
When the annotation was made.
Example:{ "note": { "time": "2015-10-14T13:13:20-06:00" } }
-
onset:
string
The date, time, or both when manifestations showed.
Example:{ "onset: "2012-07-13T00:00:00Z" }
-
patient(required):
object patient
Who the sensitivity is for.
Example:{ "patient": { "reference": "Patient/5366327" } }
-
reaction:
array 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" } ] } ] } ] }
-
recordedDate(required):
string
When the sensitivity was recorded.
Example:{ "recordedDate": "2015-10-14T13:13:20-06:00" }
-
recorder:
object recorder
Who recorded the sensitivity.
Note: The recorder must be aPractitioner
reference.
Example:{ "recorder": { "reference": "Practitioner/21500971" } }
-
reporter(required):
The source of the information about the allergy.
Note: If the reporter is a contained reference, a matchingRelatedPerson
orPractitioner
reference must be provided in thecontained
field.
Examples:
Reporter as a Patient Reference{ "reporter": { "reference": "Patient/5366327" } }
Reporter as a Contained Reference{ "reporter": "#5366328" }
-
resourceType(required):
string
Allowed Values:
[ "AllergyIntolerance" ]
The type of the FHIR resource. -
status(required):
string
The assertion about the certainty associated with the propensity, or potential risk, of a reaction to the identified substance.
Example:{ "status": "resolved" }
-
substance(required):
object 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" } ] } }
-
type:
string
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:
Show Source
Example:
{
"note": {
"authorReference": {
"reference": "Practitioner/21500971"
},
"time": "2015-10-14T13:13:20-06:00",
"text": "Patient complains of discomfort"
}
}
Nested Schema : patient
Type:
object
Who the sensitivity is for.
Example:
Show Source
Example:
{
"patient": {
"reference": "Patient/5366327"
}
}
Nested Schema : reaction
Type:
array
The adverse reaction events linked to exposure to the substance.
Example:
Show Source
Example:
{
"reaction": [
{
"manifestation": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "39579001",
"display": "Anaphylactic reaction"
}
]
}
]
}
]
}
Nested Schema : recorder
Type:
object
Who recorded the sensitivity.
Note: The recorder must be a
Example:
Show Source
Note: The recorder must be a
Practitioner
reference.
Example:
{
"recorder": {
"reference": "Practitioner/21500971"
}
}
Nested Schema : substance
Type:
object
The substance (or class) that is considered responsible for risk.
Example:
Show Source
Example:
{
"substance": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "4125",
"display": "Ethiodized oil"
}
]
}
}
Nested Schema : items
Type:
Show Source
object
-
reaction.manifestation:
array reaction.manifestation
The clinical symptoms or signs associated with the event.
Examples:
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.
Examples:
Manifestation with a coding:
Manifestation with a free-text value:
Show Source
Examples:
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"
}
]
}
]
}
Response
Supported Media Types
- application/json+fhir
Default Response
Example Request:
POST https://fhir-ehr-code.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance
Example Request Body:
{
'resourceType': 'AllergyIntolerance',
'category': 'medication',
'criticality': 'CRITL',
'recordedDate': '2017-02-28T15:03:00-06:00',
'status': 'active',
'type': 'allergy',
'onset': '2015-12-15T00:00:00Z',
'patient': {
'reference': 'Patient/12742399'
},
'reporter': {
'reference': 'Patient/12742399'
},
'recorder': {
'reference': 'Practitioner/683925'
},
'reaction': [
{
'manifestation': [
{
'text': 'Hives'
}
]
}
],
'note': {
'authorReference': {
'reference': 'Practitioner/683925'
},
'time': '2017-02-28T09:03:00Z',
'text': 'Note 1'
},
'substance': {
'coding': [
{
'system': 'http://www.nlm.nih.gov/research/umls/rxnorm',
'code': '3498'
}
]
}
}
Example Response:
HTTP Status: 201 Created
Date: Tue, 28 Feb 2017 21:08:20 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/"6167733"
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
Location: https://fhir-ehr-code.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance/6167733
Content-Length: 0
Content-Type: application/json
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. -
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.