Jump to

• Request
• Response

Get a list of allergy intolerances

get

/AllergyIntolerance

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

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

Request

Query Parameters

• _count: string
  The maximum number of results per page.
• _id: string
  The logical resource ID.
• _lastUpdated: string
  The last updated date used to filter results.
• _revinclude: string
  The inclusion of related Provenance resources.

  Allowed Values: [ "Provenance:target" ]
• clinical-status: string
  The clinical status token used to filter results.
• patient: string
  The reference to a patient associated with the allergy intolerance.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

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" ]
• total: integer
• 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/BundleLinkForAllergyIntolerance"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fullUrl":{
                        "type":"string",
                        "format":"uri"
                    },
                    "resource":{
                        "$ref":"#/components/schemas/AllergyIntolerance"
                    },
                    "search":{
                        "$ref":"#/components/schemas/SearchForAllergyIntolerance"
                    }
                }
            }
        },
        "total":{
            "type":"integer"
        }
    }
}

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/SearchForAllergyIntolerance"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLinkForAllergyIntolerance

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

Nested Schema : items

Type: object

Show Source

• fullUrl: string (uri)
• resource: object AllergyIntolerance
  FHIR R4 AllergyIntolerance resource.
• search: object SearchForAllergyIntolerance

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

Nested Schema : AllergyIntolerance

Type: object

FHIR R4 AllergyIntolerance resource.

Show Source

• _onsetDateTime: object PrimitiveElementForAllergyIntolerance
• asserter: object ReferenceForAllergyIntolerance
• category: array category
• clinicalStatus: object CodeableConcept
• code: object CodeableConcept
• contained: array contained
• criticality: string
• encounter: object ReferenceForAllergyIntolerance
• id(required): string
• meta: object meta
• note: array note
• onsetDateTime: string (date-time)
• patient: object ReferenceForAllergyIntolerance
• reaction: array reaction
• recordedDate: string (date-time)
• recorder: object ReferenceForAllergyIntolerance
• resourceType(required): string
  Allowed Values: [ "AllergyIntolerance" ]
• text: object Narrative
• type: string
• verificationStatus: object CodeableConcept

{
    "type":"object",
    "description":"FHIR R4 AllergyIntolerance resource.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "AllergyIntolerance"
            ]
        },
        "id":{
            "type":"string"
        },
        "meta":{
            "type":"object",
            "properties":{
                "versionId":{
                    "type":"string"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "text":{
            "$ref":"#/components/schemas/Narrative"
        },
        "contained":{
            "type":"array",
            "items":{
                "oneOf":[
                    {
                        "$ref":"#/components/schemas/ContainedRelatedPersonForAllergyIntolerance"
                    },
                    {
                        "$ref":"#/components/schemas/ContainedPractitionerRoleForAllergyIntolerance"
                    }
                ]
            }
        },
        "clinicalStatus":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "verificationStatus":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "type":{
            "type":"string"
        },
        "category":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "criticality":{
            "type":"string"
        },
        "code":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "patient":{
            "$ref":"#/components/schemas/ReferenceForAllergyIntolerance"
        },
        "encounter":{
            "$ref":"#/components/schemas/ReferenceForAllergyIntolerance"
        },
        "onsetDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "_onsetDateTime":{
            "$ref":"#/components/schemas/PrimitiveElementForAllergyIntolerance"
        },
        "recordedDate":{
            "type":"string",
            "format":"date-time"
        },
        "recorder":{
            "$ref":"#/components/schemas/ReferenceForAllergyIntolerance"
        },
        "asserter":{
            "$ref":"#/components/schemas/ReferenceForAllergyIntolerance"
        },
        "note":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AnnotationForAllergyIntolerance"
            }
        },
        "reaction":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReactionForAllergyIntolerance"
            }
        }
    },
    "required":[
        "resourceType",
        "id"
    ]
}

Nested Schema : SearchForAllergyIntolerance

Type: object

Show Source

• mode: string

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

Nested Schema : PrimitiveElementForAllergyIntolerance

Type: object

Show Source

• extension: array extension

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForAllergyIntolerance"
            }
        }
    }
}

Nested Schema : ReferenceForAllergyIntolerance

Type: object

Show Source

• display: string
• reference: string

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

Nested Schema : category

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : contained

Type: array

Show Source

• Array of: items

{
    "type":"array",
    "items":{
        "oneOf":[
            {
                "$ref":"#/components/schemas/ContainedRelatedPersonForAllergyIntolerance"
            },
            {
                "$ref":"#/components/schemas/ContainedPractitionerRoleForAllergyIntolerance"
            }
        ]
    }
}

Nested Schema : meta

Type: object

Show Source

• lastUpdated: string (date-time)
• security: array security
• versionId: string

{
    "type":"object",
    "properties":{
        "versionId":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "security":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : note

Type: array

Show Source

• Array of: object AnnotationForAllergyIntolerance

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

Nested Schema : reaction

Type: array

Show Source

• Array of: object ReactionForAllergyIntolerance

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

Nested Schema : Narrative

Type: object

Show Source

• div: string
  The XHTML narrative content.
• status: string
  The narrative generation status.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The narrative generation status."
        },
        "div":{
            "type":"string",
            "description":"The XHTML narrative content."
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForAllergyIntolerance

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

Nested Schema : ExtensionForAllergyIntolerance

Type: object

Show Source

• url: string (uri)
• valueCodeableConcept: object CodeableConcept

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "format":"uri"
        },
        "valueCodeableConcept":{
            "$ref":"#/components/schemas/CodeableConcept"
        }
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : items

Match One Schema

Show Source

• object ContainedRelatedPersonForAllergyIntolerance
• object ContainedPractitionerRoleForAllergyIntolerance

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/ContainedRelatedPersonForAllergyIntolerance"
        },
        {
            "$ref":"#/components/schemas/ContainedPractitionerRoleForAllergyIntolerance"
        }
    ]
}

Nested Schema : ContainedRelatedPersonForAllergyIntolerance

Type: object

Show Source

• id: string
• patient: object ReferenceForAllergyIntolerance
• relationship: array relationship
• resourceType: string
  Allowed Values: [ "RelatedPerson" ]

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "RelatedPerson"
            ]
        },
        "id":{
            "type":"string"
        },
        "patient":{
            "$ref":"#/components/schemas/ReferenceForAllergyIntolerance"
        },
        "relationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        }
    }
}

Nested Schema : ContainedPractitionerRoleForAllergyIntolerance

Type: object

Show Source

• code: array code
• id: string
• resourceType: string
  Allowed Values: [ "PractitionerRole" ]

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "PractitionerRole"
            ]
        },
        "id":{
            "type":"string"
        },
        "code":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        }
    }
}

Nested Schema : relationship

Type: array

Show Source

• Array of: object CodeableConcept

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

Nested Schema : code

Type: array

Show Source

• Array of: object CodeableConcept

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

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

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

Nested Schema : AnnotationForAllergyIntolerance

Type: object

Show Source

• authorReference: object ReferenceForAllergyIntolerance
• id: string
• text: string
• time: string (date-time)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "authorReference":{
            "$ref":"#/components/schemas/ReferenceForAllergyIntolerance"
        },
        "time":{
            "type":"string",
            "format":"date-time"
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : ReactionForAllergyIntolerance

Type: object

Show Source

• id: string
• manifestation: array manifestation
• severity: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "manifestation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "severity":{
            "type":"string"
        }
    }
}

Nested Schema : manifestation

Type: array

Show Source

• Array of: object CodeableConcept

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

Nested Schema : BundleLinkForAllergyIntolerance

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

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top