Jump to

• Request
• Response

Get a list of allergy intolerances

get

/AllergyIntolerance

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Retrieves a list of allergy intolerances that meet the supplied query parameters.

Request

Query Parameters

• _id: string
  The logical resource ID.
• _revinclude: string
  The related Provenance resources to include in the search bundle.

  Allowed Values: [ "Provenance:target" ]
• patient: string
  The patient who has the allergy or intolerance.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fullUrl":{
                        "type":"string",
                        "format":"uri"
                    },
                    "resource":{
                        "$ref":"#/components/schemas/AllergyIntolerance"
                    },
                    "search":{
                        "$ref":"#/components/schemas/Search"
                    }
                }
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fullUrl":{
                "type":"string",
                "format":"uri"
            },
            "resource":{
                "$ref":"#/components/schemas/AllergyIntolerance"
            },
            "search":{
                "$ref":"#/components/schemas/Search"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleLink"
    }
}

Nested Schema : items

Type: object

Show Source

• fullUrl: string (uri)
• resource: object AllergyIntolerance
• search: object Search

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string",
            "format":"uri"
        },
        "resource":{
            "$ref":"#/components/schemas/AllergyIntolerance"
        },
        "search":{
            "$ref":"#/components/schemas/Search"
        }
    }
}

Nested Schema : AllergyIntolerance

Type: object

Show Source

• clinicalStatus: clinicalStatus
  The clinical status of the allergy or intolerance.
• code(required): code
  The code for an allergy or intolerance statement.
• id(required): string
• patient(required): patient
  The patient who has the allergy or intolerance.
• reaction: array reaction
  The details about each adverse reaction event linked to exposure to the identified substance.
• resourceType(required): string
  Allowed Values: [ "AllergyIntolerance" ]
• verificationStatus: verificationStatus
  The assertion about the certainty associated with the propensity, or potential risk, of a reaction to the identified substance.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "code",
        "patient"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "AllergyIntolerance"
            ]
        },
        "id":{
            "type":"string"
        },
        "clinicalStatus":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"The clinical status of the allergy or intolerance."
        },
        "verificationStatus":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"The assertion about the certainty associated with the propensity, or potential risk, of a reaction to the identified substance."
        },
        "code":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"The code for an allergy or intolerance statement."
        },
        "patient":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"The patient who has the allergy or intolerance."
        },
        "reaction":{
            "type":"array",
            "description":"The details about each adverse reaction event linked to exposure to the identified substance.",
            "items":{
                "$ref":"#/components/schemas/AllergyIntoleranceReaction"
            }
        }
    }
}

Nested Schema : Search

Type: object

Show Source

• mode: string

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string"
        }
    }
}

Nested Schema : clinicalStatus

The clinical status of the allergy or intolerance.

Match All

The clinical status of the allergy or intolerance.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"The clinical status of the allergy or intolerance."
}

Nested Schema : code

The code for an allergy or intolerance statement.

Match All

The code for an allergy or intolerance statement.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"The code for an allergy or intolerance statement."
}

Nested Schema : patient

The patient who has the allergy or intolerance.

Match All

The patient who has the allergy or intolerance.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"The patient who has the allergy or intolerance."
}

Nested Schema : reaction

Type: array

The details about each adverse reaction event linked to exposure to the identified substance.

Show Source

• Array of: object AllergyIntoleranceReaction

{
    "type":"array",
    "description":"The details about each adverse reaction event linked to exposure to the identified substance.",
    "items":{
        "$ref":"#/components/schemas/AllergyIntoleranceReaction"
    }
}

Nested Schema : verificationStatus

The assertion about the certainty associated with the propensity, or potential risk, of a reaction to the identified substance.

Match All

The assertion about the certainty associated with the propensity, or potential risk, of a reaction to the identified substance.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"The assertion about the certainty associated with the propensity, or potential risk, of a reaction to the identified substance."
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
• text: string

{
    "type":"object",
    "properties":{
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string (uri)

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : Reference

Type: object

Show Source

• reference: string
• type: string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : AllergyIntoleranceReaction

Type: object

Show Source

• manifestation(required): array manifestation
  The clinical symptoms, signs, or both that are observed or associated with the adverse reaction event.

{
    "type":"object",
    "required":[
        "manifestation"
    ],
    "properties":{
        "manifestation":{
            "type":"array",
            "description":"The clinical symptoms, signs, or both that are observed or associated with the adverse reaction event.",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        }
    }
}

Nested Schema : manifestation

Type: array

The clinical symptoms, signs, or both that are observed or associated with the adverse reaction event.

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "description":"The clinical symptoms, signs, or both that are observed or associated with the adverse reaction event.",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]
• url: string (uri)

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ]
        },
        "url":{
            "type":"string",
            "format":"uri"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

Show Source

• issue(required): array issue
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top