openapi: 3.2.0 info: version: 6.1.0 title: FHIR Single API - US Core 6.1.0 Allergy Intolerance API description: Fast Healthcare Interoperability Resources (HL7® FHIR®, pronounced "Fire") defines a set of "Resources" that represent granular clinical concepts. x-fhir-version: 4.0.1 x-us-core-version: 6.1.0 servers: - url: https://providerapi.advancedmd.com/v1/r4 security: - bearerAuth: [] tags: - name: Allergy Intolerance paths: /AllergyIntolerance: get: tags: - Allergy Intolerance description: 'This interaction searches a set of AllergyIntolerances based on some filter criteria. Search interactions take a series of query parameters for a GET. 📘 FHIR documentation for AllergyIntolerance. 🛡️ **Authorization behavior:** - **Patients** (using `patient/*.read` scope) can access only their own resources. - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient. - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient''s data.' parameters: - name: patient in: query description: Who the sensitivity is for schema: type: string examples: patient_id: summary: Logical patient id value: '6077169' patient_reference: summary: Relative Patient reference value: Patient/6077169 responses: '200': description: Success content: application/fhir+json;charset=utf-8: schema: $ref: '#/components/schemas/AllergyIntolerance' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error' summary: Get allergy intolerance x-summary-source: derived operationId: getAllergyIntolerance x-operation-id-source: derived /AllergyIntolerance/{id}: get: tags: - Allergy Intolerance description: 'This interaction searches AllergyIntolerance based on allergy intolerance id.Search interactions take allergy intolerance id in path for a GET. 📘 FHIR documentation for AllergyIntolerance. 🛡️ **Authorization behavior:** - **Patients** (using `patient/*.read` scope) can access only their own resources. - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient. - **Practitioners** (using `user/*.read` scope) must provide the `patient` query parameter to access another patient''s data.' parameters: - name: id in: path required: true schema: type: integer example: 213 - name: patient in: query description: Patient ID to filter the search. schema: type: integer example: 6077169 responses: '200': description: Success content: application/fhir+json;charset=utf-8: schema: $ref: '#/components/schemas/AllergyIntolerance' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error' summary: Get allergy intolerance by id x-summary-source: derived operationId: getAllergyIntoleranceById x-operation-id-source: derived /AllergyIntolerance/_search: post: tags: - Allergy Intolerance description: 'This interaction searches a set of AllergyIntolerances based on some filter criteria. Search interactions take a series of parameters of name''''=''''value pairs encoded as an application/x-www-form-urlencoded submission for a POST. 📘 FHIR documentation for AllergyIntolerance. 🛡️ **Authorization behavior:** - **Patients** (using `patient/*.read` scope) can access only their own resources. - **Practitioners** (using `patient/*.read` scope) can access to only one assigned patient. - **Practitioners** (using `user/*.read` scope) must provide the `patient` parameter (in the request body) to access another patient''s data.' operationId: AllergyIntolerancesSearchUsingPOST requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: patient: type: integer description: Who allergy intolerance is for example: 6077169 required: - patient responses: '200': description: AllergyIntolerance bundle content: application/fhir+json;charset=utf-8: schema: type: array items: $ref: '#/components/schemas/AllergyIntolerance' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error' summary: Allergy intolerances search using POST x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: AllergyIntolerances Search using POST components: schemas: AllergyIntolerance: x-us-core-profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance required: - asserter - category - clinicalStatus - code - criticality - id - identifier - lastOccurrence - meta - note - onsetDateTime - patient - reaction - recordedDate - recorder - resourceType - text - type - verificationStatus type: object properties: resourceType: minLength: 1 type: string id: minLength: 1 type: string text: required: - div - status type: object properties: status: minLength: 1 type: string div: minLength: 1 type: string identifier: description: Business identifiers assigned to the allergy or intolerance record by source systems. minItems: 1 uniqueItems: true type: array items: description: Identifier with a namespace in `system` and a resource-specific value in `value`. required: - system - value type: object properties: system: description: Namespace or URI that defines the identifier value. minLength: 1 type: string value: description: Identifier value unique within the stated system. minLength: 1 type: string clinicalStatus: required: - coding type: object properties: coding: minItems: 1 uniqueItems: true type: array items: required: - code - display - system type: object properties: system: minLength: 1 type: string code: minLength: 1 type: string display: minLength: 1 type: string verificationStatus: required: - coding type: object properties: coding: minItems: 1 uniqueItems: true type: array items: required: - code - display - system type: object properties: system: minLength: 1 type: string code: minLength: 1 type: string display: minLength: 1 type: string type: minLength: 1 type: string category: type: array items: type: object properties: {} criticality: minLength: 1 type: string code: required: - coding type: object properties: coding: minItems: 1 uniqueItems: true type: array items: required: - code - display - system type: object properties: system: minLength: 1 type: string code: minLength: 1 type: string display: minLength: 1 type: string patient: required: - reference type: object properties: reference: minLength: 1 type: string onsetDateTime: minLength: 1 type: string recordedDate: minLength: 1 type: string recorder: required: - reference type: object properties: reference: minLength: 1 type: string asserter: required: - reference type: object properties: reference: minLength: 1 type: string lastOccurrence: minLength: 1 type: string note: minItems: 1 uniqueItems: true type: array items: required: - text type: object properties: text: minLength: 1 type: string reaction: minItems: 1 uniqueItems: true type: array items: required: - description - onset - severity type: object properties: substance: required: - coding type: object properties: coding: minItems: 1 uniqueItems: true type: array items: required: - code - display - system type: object properties: system: minLength: 1 type: string code: minLength: 1 type: string display: minLength: 1 type: string manifestation: minItems: 1 uniqueItems: true type: array items: type: object properties: coding: minItems: 1 uniqueItems: true type: array items: required: - code - display - system type: object properties: system: minLength: 1 type: string code: minLength: 1 type: string display: minLength: 1 type: string description: minLength: 1 type: string onset: minLength: 1 type: string severity: minLength: 1 type: string exposureRoute: required: - coding type: object properties: coding: minItems: 1 uniqueItems: true type: array items: required: - code - display - system type: object properties: system: minLength: 1 type: string code: minLength: 1 type: string display: minLength: 1 type: string meta: required: - tag type: object properties: tag: minItems: 1 uniqueItems: true type: array items: required: - code - display - system type: object properties: system: minLength: 1 type: string code: minLength: 1 type: string display: minLength: 1 type: string description: '' Error: required: - text - issue type: object properties: resourceType: minLength: 1 type: string text: required: - div - status type: object properties: status: minLength: 1 type: string div: minLength: 1 type: string issue: type: array items: required: - severity - code - diagnostics type: object properties: severity: minLength: 1 type: string code: minLength: 1 type: string diagnostics: minLength: 1 type: string securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT externalDocs: description: HL7 FHIR US Core IG STU 6.1.0 url: https://hl7.org/fhir/us/core/STU6.1/