AllergyIntolerance Profile
This AllergyIntolerance profile is part of the set of resource profiles supported by the API Server used with the athenaPractice 12.3 and athenaFlow 9.12 products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.
Overview
AllergyIntolerance is a recorded clinical assessment of an allergy or intolerance.
Scope and Usage
This profile is used to define the content that will be returned by the API Server in response to requests to access AllergyIntolerance resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.
Source
The AllergyIntolerance resource is derived from the Allergy table in athenaPractice and athenaFlow. Specific detail can be found in the Mappings section below.
Supported Operations
The operations supported by this resource are listed below.
Read Operation
Read operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To read a AllergyIntolerance, an application shall perform an HTTP GET, specifying the identifier of the resources being retrieved.
GET [base]/fhir/AllergyIntolerance/[id]{?_format=[json|xml]&_summary=[true|data]}
Read Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [id] | Specifies the identifier of the AllergyIntolerance resource to retrieve |
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
| [_summary] | Filters the output to include only summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides slightly improved API response times. |
Read Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The requested resource was found and is contained within the body of the HTTP response. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 404 Not Found | The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates that the resource could not be found. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
Search Operation
Search operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for AllergyIntolerance resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.
GET [base]/fhir/AllergyIntolerance?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}
Search Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [_count] | Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results AllergyIntolerance resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the AthenaHealth Partner program. Note: The API Server support the HL7 FHIR Paging capability. |
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
| [_summary] | Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets. |
| _id (token ) | The ID of the resource |
| _lastUpdated (date ) | |
| _lastUpdated-fromnow (quantity ) | Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time , e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| _security (token ) | |
| _tag (token ) | |
| category (token ) | food | medication | environment | other - Category of Substance |
| criticality (token ) | CRITL | CRITH | CRITU |
| date (date ) | When recorded |
| date-fromnow (quantity ) | Like date except expressed as a positive or negative offset from the current time in units of time , e.g. date-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| encounter (reference ) | |
| encounter-or-historical (reference ) | |
| enddate (date ) | |
| enddate-fromnow (quantity ) | Like enddate except expressed as a positive or negative offset from the current time in units of time , e.g. enddate-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| identifier (token ) | External ids for this item |
| manifestation (token ) | Clinical symptoms/signs associated with the Event |
| onset-or-approximate (date ) | |
| onset-or-approximate-fromnow (quantity ) | Like onset-or-approximate except expressed as a positive or negative offset from the current time in units of time , e.g. onset-or-approximate-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| patient (reference ) | Who the sensitivity is for |
| recorder (reference ) | Who recorded the sensitivity |
| start (date ) | |
| start-fromnow (quantity ) | Like start except expressed as a positive or negative offset from the current time in units of time , e.g. start-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| status (token ) | active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error |
| substance (token ) | Substance, (or class) considered to be responsible for risk |
Search Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
Profile Content
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/allergyintolerance-profile
Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance)
| Name | Flags | Card. | Type | Description & Constraints | |
|---|---|---|---|---|---|
  AllergyIntolerance | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance) | ||
 meta | S ∑ | 0..1 | Meta | Metadata about the resource | |
 implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created | |
| language | 0..1 | code | Language of the resource content Binding: IETF BCP-47  (required ) | ||
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | ||
 allergyintolerance-encounter | 0..1 | Reference (Reference) | Extension | ||
 url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/allergyintolerance-encounter" | ||
  valueReference | 1..1 | Reference (Reference) | Value of extension | ||
| allergyintolerance-approxonset | 0..1 | string | Extension | ||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/allergyintolerance-approxonset" | ||
| valueString | 1..1 | string | Value of extension | ||
| allergyintolerance-enddate | 0..1 | dateTime | Extension | ||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/allergyintolerance-enddate" | ||
| valueDateTime | 1..1 | dateTime | Value of extension | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
 identifier | S ∑ | 0..* | Identifier | External ids for this item | |
| onset | S ∑ | 0..1 | dateTime | Date(/time) when manifestations showed | |
| recordedDate | S ∑ | 0..1 | dateTime | When recorded | |
| recorder | S ∑ | 0..1 | Reference (Practitioner | Patient ) | Who recorded the sensitivity | |
| patient | S ∑ | 1..1 | Reference (Patient ) | Who the sensitivity is for | |
| reporter | S ∑ | 0..1 | Reference (Patient | RelatedPerson | Practitioner ) | Source of the information about the allergy | |
| substance | ∑ | 1..1 | CodeableConcept | Identification of the allergy or intolearnce Binding: AllergyIntolerance Substance and Negation Codes (example ) | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
 coding | ∑ | Coding | Code defined by a terminology system Slice: Unordered, Closed, by system | ||
| coding | ∑ | 0..5 | Coding | Code defined by a terminology system | |
| coding | ∑ | 0..1 | Coding | Code defined by a terminology system | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| system | ∑ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/ndc | |
| version | ∑ | 0..1 | string | Version of the system - if relevant | |
| code | ∑ | 1..1 | code | Symbol in syntax defined by the system | |
| display | ∑ | 0..1 | string | Representation defined by the system | |
| userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user | |
| coding | ∑ | 0..1 | Coding | Code defined by a terminology system | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| system | ∑ | 1..1 | uri | Identity of the terminology system Fixed Value: http://docs.wolterskluwercdi.com/codesystems/gpi | |
| version | ∑ | 0..1 | string | Version of the system - if relevant | |
| code | ∑ | 1..1 | code | Symbol in syntax defined by the system | |
| display | ∑ | 0..1 | string | Representation defined by the system | |
| userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user | |
| coding | ∑ | 0..1 | Coding | Code defined by a terminology system | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| system | ∑ | 1..1 | uri | Identity of the terminology system Fixed Value: http://docs.wolterskluwercdi.com/codesystems/ddid | |
| version | ∑ | 0..1 | string | Version of the system - if relevant | |
| code | ∑ | 1..1 | code | Symbol in syntax defined by the system | |
| display | ∑ | 0..1 | string | Representation defined by the system | |
| userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user | |
| coding | ∑ | 0..1 | Coding | Code defined by a terminology system | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| system | ∑ | 1..1 | uri | Identity of the terminology system Fixed Value: http://docs.wolterskluwercdi.com/codesystems/kdc | |
| version | ∑ | 0..1 | string | Version of the system - if relevant | |
| code | ∑ | 1..1 | code | Symbol in syntax defined by the system | |
| display | ∑ | 0..1 | string | Representation defined by the system | |
| userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user | |
| coding | ∑ | 0..1 | Coding | Code defined by a terminology system | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| system | ∑ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| version | ∑ | 0..1 | string | Version of the system - if relevant | |
| code | ∑ | 1..1 | code | Symbol in syntax defined by the system | |
| display | ∑ | 0..1 | string | Representation defined by the system | |
| userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user | |
| coding | ∑ | 0..1 | Coding | Code defined by a terminology system | |
| text | ∑ | 0..1 | string | Plain text representation of the concept | |
| status | ?! S∑ | 0..1 | code | active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error Binding: AllergyIntoleranceStatus (required ) | |
| criticality | S ∑ | 0..1 | code | CRITL | CRITH | CRITU Binding: AllergyIntoleranceCriticality (required ) | |
| type | S ∑ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required ) | |
| category | S ∑ | 0..1 | code | food | medication | environment | other - Category of Substance Binding: AllergyIntoleranceCategory (required ) | |
| lastOccurence | ∑ | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |
| note | S | 0..1 | Annotation | Additional text not captured in other fields | |
| reaction | S | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
 extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| substance | S ∑ | 0..1 | CodeableConcept | Specific substance considered to be responsible for event Binding: Substance Code (example ) | |
| certainty | ∑ | 0..1 | code | unlikely | likely | confirmed - clinical certainty about the specific substance Binding: AllergyIntoleranceCertainty (required ) | |
| manifestation | S ∑ | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: SNOMED CT Clinical Findings (example ) | |
| description | S | 0..1 | string | Description of the event as a whole | |
| onset | ∑ | 0..1 | dateTime | Date(/time) when manifestations showed | |
| severity | ∑ | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required ) | |
| exposureRoute | ∑ | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMED CT Route Codes (example ) | |
| note | 0..1 | Annotation | Text about event not captured in other fields | ||
athenaPractice Mapping
The mappings in this section represent the how data stored within athenaPractice is served through the product's APIs. athenaPractice and athenaFlow share a common schema for patient clinical data and only one is shown when these are the same. Use of this information is subject to the the API Server Terms and Conditions.
| AllergyIntolerance Profile | ||
| AllergyIntolerance | AllergyIntolerance-Profile | FHIR_ALLERGYVIEW |
| ├ id | MakeId("ALLERGY",%ALLERGYGROUPID%) | |
| ├ extension | encounter | |
| ├ extension | approxonset | |
| ├ extension | enddate | |
| ├ identifier | External Allergy Identifier | MakeIdentifier("U",getSiteSystem("AllergyId"),%EXTALLERGYID%) |
| ├ onset | %ONSETDATE% | |
| ├ recordedDate | %DB_CREATE_DATE% | |
| ├ recorder | MakeReference("USR",%USRID%,"Practitioner") | |
| ├ patient | MakeReference("PERSON",%PID%,"Patient") | |
| │ ├ coding | AllergyIntolerance Code | |
| │ ├ coding | LabProd | |
| │ │ └ code | %NDCLABPROD% | |
| │ ├ coding | GPI | |
| │ │ └ code | %GPI% | |
| │ ├ coding | DDID | |
| │ │ └ code | %DDID% | |
| │ ├ coding | KDC | |
| │ │ └ code | %KDC% | |
| │ ├ coding | SNOMED | |
| │ │ └ code | %SNOMED% | |
| │ ├ coding | RXNORM | MakeRxnormCodingList(%RXNORM%,"http://www.nlm.nih.gov/research/umls/rxnorm",null) |
| │ └ text | %NAME% | |
| ├ status | IsActiveOrMapCode(%STOPDATE%,"active",%STOPREASON%,"ALLERGYSTATUS") | |
| ├ criticality | MapCode(%ISCRITICAL%,"ALLERGYCRIT") | |
| └ category | MapCode(%ALLCLASS%,"ALLERGYCLASS") | |
| └ manifestation | MakeConcept(%REACTIONCODE%,"http://snomed.info/sct", %DESCRIPTION%) | |
athenaFlow Mapping
The mappings in this section represent the how data stored within athenaFlow is served through the product's APIs. Use of this information is subject to the the API Server Terms and Conditions.
| AllergyIntolerance Profile | ||
| AllergyIntolerance | AllergyIntolerance-Profile | FHIR_ALLERGYVIEW |
| ├ id | MakeId("ALLERGY",%ALLERGYGROUPID%) | |
| ├ extension | encounter | |
| ├ extension | approxonset | |
| ├ extension | enddate | |
| ├ identifier | External Allergy Identifier | MakeIdentifier("U",getSiteSystem("AllergyId"),%EXTALLERGYID%) |
| ├ onset | %ONSETDATE% | |
| ├ recordedDate | %DB_CREATE_DATE% | |
| ├ recorder | MakeReference("USR",%USRID%,"Practitioner") | |
| ├ patient | MakeReference("PERSON",%PID%,"Patient") | |
| │ ├ coding | AllergyIntolerance Code | |
| │ ├ coding | LabProd | |
| │ │ └ code | %NDCLABPROD% | |
| │ ├ coding | GPI | |
| │ │ └ code | %GPI% | |
| │ ├ coding | DDID | |
| │ │ └ code | %DDID% | |
| │ ├ coding | KDC | |
| │ │ └ code | %KDC% | |
| │ ├ coding | SNOMED | |
| │ │ └ code | %SNOMED% | |
| │ ├ coding | RXNORM | MakeRxnormCodingList(%RXNORM%,"http://www.nlm.nih.gov/research/umls/rxnorm",null) |
| │ └ text | %NAME% | |
| ├ status | IsActiveOrMapCode(%STOPDATE%,"active",%STOPREASON%,"ALLERGYSTATUS") | |
| ├ criticality | MapCode(%ISCRITICAL%,"ALLERGYCRIT") | |
| └ category | MapCode(%ALLCLASS%,"ALLERGYCLASS") | |
| └ manifestation | MakeConcept(%REACTIONCODE%,"http://snomed.info/sct", %DESCRIPTION%) | |