Aetna

Aetna Drug Formulary FHIR API

Da Vinci PDex US Drug Formulary 2.0.0 STU 2 formulary data, delivered as part of the Patient Access API product rather than as a separate base URL. MedicationKnowledge carries covered drugs, tiers, cost sharing and restrictions such as prior authorization and step therapy; formulary InsurancePlan, Basic and Location resources were added on 2024-04-19 when the older List API was decommissioned.

Documentation GitHub OpenAPI

Operations 40

GET /v2/patientaccess/AllergyIntolerance Retrieves all Allergy Intolerances associated to an Authenticated User based on the search criteria (patient fhir logical id) #

GET /v2/patientaccess/AllergyIntolerance/{id} Retrieves AllergyIntolerance details using the Id and formats the response in USCoreAllergyIntolerance profile. #

GET /v2/patientaccess/Binary/{id} This operation returns a Binary Resource associated with the Logical Id #

GET /v2/patientaccess/CarePlan Retrieves all Care Plans associated to an Authenticated User based on the search criteria (patient fhir logical id, date, status and category) #

GET /v2/patientaccess/CarePlan/{id} Retrieves CarePlan details using the Id and formats the response in USCoreCarePlan profile. #

GET /v2/patientaccess/CareTeam This operation retrieves all CareTeam records associated to an Authenticated User based on the search criteria #

GET /v2/patientaccess/CareTeam/{id} This operation returns a CareTeam Resource associated with the Logical Id #

GET /v2/patientaccess/Condition Retrieves all Conditions associated with a patient and formats the response to the USCoreCondition profile. #

GET /v2/patientaccess/Condition/{id} Retrieves conditon details using the Id and formats the response to the USCoreCondition profile. #

GET /v2/patientaccess/Coverage Retrieves a patient's coverage details using the Id and formats the response to the CARIN profile. #

GET /v2/patientaccess/Coverage/{id} Retrieves a patient's coverage details using the Id and formats the response to the CARIN profile. #

GET /v2/patientaccess/Device This operation retrieves all Device records associated to an Authenticated User based on the search criteria #

GET /v2/patientaccess/Device/{id} This operation returns a Device Resource associated with the Logical Id #

GET /v2/patientaccess/DiagnosticReport This operation retrieves all DiagnosticReports associated to an Authenticated User based on the search criteria (patient fhir logical id, date, code, category) #

GET /v2/patientaccess/DiagnosticReport/{id} This operation returns a DiagnosticReport Resource associated with the Logical Id #

GET /v2/patientaccess/DocumentReference This operation retrieves all DocumentReferences associated to an Authenticated User based on the search criteria (patient fhir logical id, date, category, type) #

GET /v2/patientaccess/DocumentReference/{id} This operation returns a DocumentReference Resource associated with the Logical Id #

GET /v2/patientaccess/Encounter This operation retrieves all Encounters associated to an Authenticated User based on the search criteria (patient fhir logical id, date) #

GET /v2/patientaccess/Encounter/{id} This operation returns a Encounter Resource associated with the Logical Id #

GET /v2/patientaccess/Endpoint/{id} This operation returns a Endpoint Resource associated with the Logical Id. #

GET /v2/patientaccess/ExplanationOfBenefit Retrieves a patient's Explanation Of Benefit details using the Member Id and formats the response to the available CARIN profiles. #

GET /v2/patientaccess/ExplanationOfBenefit/{id} Retrieves a patient's Explanation Of Benefit details using the EOB Logical Identifier and formats the response to the available CARIN profiles. #

GET /v2/patientaccess/Goal This operation retrieves all Goal records associated to an Authenticated User based on the search criteria #

GET /v2/patientaccess/Goal/{id} This operation returns a Goal Resource associated with the Logical Id #

GET /v2/patientaccess/Immunization This operation retrieves all Immunizations associated to an Authenticated User based on the search criteria patient fhir logical id. #

GET /v2/patientaccess/Immunization/{id} This operation returns a Immunization Resource associated with the Logical Id #

GET /v2/patientaccess/MedicationKnowledge Retrieves all MedicationKnowledge resources associated with an authenticated patient and formats the response to the USDFFormularyDrug profile. #

GET /v2/patientaccess/MedicationKnowledge/{id} Returns a MedicationKnowledge resource associated with the unique logical id. #

GET /v2/patientaccess/MedicationRequest This operation retrieves all MedicationRequests associated with an Authenticated User based on the search criteria (patient fhir logical id, status, intent) #

GET /v2/patientaccess/MedicationRequest/{id} This operation returns a MedicationRequest Resource associated with the Logical Id #

GET /v2/patientaccess/Medication/{id} This operation returns a Medication Resource associated with the Logical Id #

GET /v2/patientaccess/Observation This operation will retrieve all Observation details associated with a patient and formats the response to the Observation profile. #

GET /v2/patientaccess/Observation/{id} Retrieves observation details using the Id and formats the response in Observation profile. #

GET /v2/patientaccess/Organization/{id} Read the current state of the resource using the Logical (unique) ID [FHIR Base]/Organization/{id} #

GET /v2/patientaccess/Patient Retrieves a patient's details #

GET /v2/patientaccess/Patient/{id} Retrieves a patient's details using the Id and formats the response to the CARINBBPatient profile. #

GET /v2/patientaccess/PractitionerRole/{id} Read the current state of the resource using the Logical (unique) ID [FHIR Base]/PractitionerRole/{id} #

GET /v2/patientaccess/Practitioner/{id} Read the current state of the resource using the Logical (unique) ID [FHIR Base]/Practitioner/{id} #

GET /v2/patientaccess/Procedure This operation retrieves all Procedures associated to an Authenticated User based on the search criteria patient fhir logical id. #

GET /v2/patientaccess/Procedure/{id} This operation returns a Procedure Resource associated with the Logical Id #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/aetna-drug-formulary-fhir-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.0.3
info:
  title: Aetna Patient Access API
  version: 1.0.0
  description: "The Aetna Patient Access API is an enterprise API that implements the HL7 FHIR standard to meet\
    \ the CMS requirements for Interoperability. The API provides the ability for Aetna members to access their\
    \ Clinical data using Third-party client applications supporting those standards. The Patient Access API supports\
    \ the FHIR AllergyIntolerance resource that conforms to the HL7 FHIR USCore Implementation Guide STU3 Release\
    \ v3.1.1 and supports USCore AllergyIntolerance Profile. The API follows the User token security model.\n\n\
    The AllergyIntolerance SEARCH API supports the following operations:\n\nSMART on FHIR - Resource Retrieval\n\
    1. Launch AllergyIntolerance with no params by calling GET [base]/AllergyIntolerance which will request all\
    \ AllergyIntolerances associated with an Authenticated user.\n - GET [base]/AllergyIntolerance \n2. Launch AllergyIntolerance\
    \ with patient by calling GET [base]/AllergyIntolerance?patient=1234567891011 which will request all AllergyIntolerances\
    \ associated with an Authenticated user.\n- GET [base]/AllergyIntolerance?patient=1234567891011\n\n1 and 2 perform\
    \ the same search functionality.\n\nThis value will be provided by the Server.  If a search returns more resources\
    \ than fit on one page, the response includes a pagination URL in the Bundle.link field. The value with Bundle.link.relation\
    \ = next indicates that you can use the corresponding Bundle.link.url to retrieve the next page. \n - GET [base]/AllergyIntolerance?_count=10&code=2058922&_page_token=Cjj3YQP%2Bdf%2F%2F%2F%2F%2BABchXMXghfgD%2FAf%2F%2BZTA5NWM4YmI0YWNlYWQ4Yjc5NDhjYTk2M2RhMDA5N2QAARAKIeRmIPX4MlS1OQAAAACKAfyeSAFQAFoLCfRXKWB76f3NEANgg8Tc2gc%3D\n\
    \n_revinclude=Provenance:target is supported\n - GET [base]/AllergyIntolerance?_revinclude=Provenance:target"
  contact:
    name: Aetna Interoperability Developer Support
    email: InteroperabilityDeveloperSupport@aetna.com
    url: https://developerportal.aetna.com/
  x-assembled-by: API Evangelist enrichment pipeline
  x-assembly-note: 'Assembled from 40 single-operation Swagger 2.0 documents that Aetna publishes itself at https://developerportal.aetna.com/managedcontent/yaml/<file>,
    listed in the portal''s own API catalog at https://developerportal.aetna.com/assets/Data/Fhir.json. Every path,
    parameter, description, schema, example and security definition below is Aetna''s verbatim content; the union,
    the Swagger 2.0 -> OpenAPI 3.0.3 structural conversion, and the operationIds are ours (Aetna sets every operationId
    to the literal string "GET", which is not unique across a merged document). The unmodified sources are archived
    in openapi/_original/. NOTE ON MERGE FIDELITY: where two source documents define a schema of the same name with
    different content (FHIR profile variants), the first definition encountered wins and that divergence is not
    represented here; the per-operation source of truth is always the archived original named in each operation''s
    x-source-file.'
servers:
- url: https://apif1.aetna.com/fhir
paths:
  /v2/patientaccess/AllergyIntolerance:
    get:
      summary: Retrieves all Allergy Intolerances associated to an Authenticated User based on the search criteria
        (patient fhir logical id)
      description: Retrieves all Allergy Intolerances associated to an Authenticated User based on the search criteria
        (patient fhir logical id)
      operationId: get_v2_patientaccess_AllergyIntolerance
      responses:
        '200':
          description: This response returns a list of a Patient's AllergyIntolerances
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bundle'
              example:
                entry:
                - search:
                    mode: match
                  resource:
                    code:
                      coding:
                      - system: http://snomed.info/sct
                        code: '763875007'
                        display: Product containing sulfonamide (product)
                      text: sulfonamide antibacterial
                    reaction:
                    - severity: mild
                      manifestation:
                      - coding:
                        - system: http://snomed.info/sct
                          code: '271807003'
                          display: skin rash
                        text: skin rash
                    verificationStatus:
                      coding:
                      - system: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
                        code: confirmed
                    patient:
                      reference: Patient/example
                      display: Amy V. Shaw
                    criticality: high
                    text:
                      div: '<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative</b></p><p><b>clinicalStatus</b>:
                        <span title="Codes: {http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical active}">Active</span></p><p><b>verificationStatus</b>:
                        <span title="Codes: {http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
                        confirmed}">Confirmed</span></p><p><b>category</b>: medication</p><p><b>criticality</b>:
                        high</p><p><b>code</b>: <span title="Codes: {http://snomed.info/sct 763875007}">sulfonamide
                        antibacterial</span></p><p><b>patient</b>: <a href="Patient-example.html">Amy V. Shaw. Generated
                        Summary: Medical Record Number: 1032702 (USUAL); active; Amy V. Shaw , Amy V. Baxter ; Phone:
                        555-555-5555, amy.shaw@example.com; gender: female; birthDate: 1987-02-20</a></p><h3>Reactions</h3><table
                        class="grid"><tr><td>-</td><td><b>Manifestation</b></td><td><b>Severity</b></td></tr><tr><td>*</td><td><span
                        title="Codes: {http://snomed.info/sct 271807003}">skin rash</span></td><td>mild</td></tr></table></div>'
                      status: generated
                    clinicalStatus:
                      coding:
                      - system: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
                        code: active
                    category:
                    - medication
                    recorded: '2021-01-07'
                    resourceType: AllergyIntolerance
                    status: completed
                  fullUrl: https://healthcare.googleapis.com/v1/projects/cdr-devl/locations/us-east4/datasets/cdr-fhir-ds/fhirStores/cdr-fhir-r4-test/fhir/AllergyIntolerance/11181211064
                - search:
                    mode: match
                  resource:
                    code:
                      coding:
                      - system: http://snomed.info/sct
                        code: '763875007'
                        display: Product containing sulfonamide (product)
                      text: sulfonamide antibacterial
                    reaction:
                    - severity: mild
                      manifestation:
                      - coding:
                        - system: http://snomed.info/sct
                          code: '271807003'
                          display: skin rash
                        text: skin rash
                    verificationStatus:
                      coding:
                      - system: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
                        code: confirmed
                    patient:
                      reference: Patient/example
                      display: Amy V. Shaw
                    criticality: high
                    text:
                      div: '<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative</b></p><p><b>clinicalStatus</b>:
                        <span title="Codes: {http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical active}">Active</span></p><p><b>verificationStatus</b>:
                        <span title="Codes: {http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
                        confirmed}">Confirmed</span></p><p><b>category</b>: medication</p><p><b>criticality</b>:
                        high</p><p><b>code</b>: <span title="Codes: {http://snomed.info/sct 763875007}">sulfonamide
                        antibacterial</span></p><p><b>patient</b>: <a href="Patient-example.html">Amy V. Shaw. Generated
                        Summary: Medical Record Number: 1032702 (USUAL); active; Amy V. Shaw , Amy V. Baxter ; Phone:
                        555-555-5555, amy.shaw@example.com; gender: female; birthDate: 1987-02-20</a></p><h3>Reactions</h3><table
                        class="grid"><tr><td>-</td><td><b>Manifestation</b></td><td><b>Severity</b></td></tr><tr><td>*</td><td><span
                        title="Codes: {http://snomed.info/sct 271807003}">skin rash</span></td><td>mild</td></tr></table></div>'
                      status: generated
                    clinicalStatus:
                      coding:
                      - system: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
                        code: active
                    category:
                    - medication
                    recorded: '2021-01-07'
                    resourceType: AllergyIntolerance
                    status: completed
                  fullUrl: https://healthcare.googleapis.com/v1/projects/cdr-devl/locations/us-east4/datasets/cdr-fhir-ds/fhirStores/cdr-fhir-r4-test/fhir/AllergyIntolerance/11181210653
                total: 2
                link:
                - url: https://healthcare.googleapis.com/v1/projects/cdr-devl/locations/us-east4/datasets/cdr-fhir-ds/fhirStores/cdr-fhir-r4-test/fhir/AllergyIntolerance/?_count=2
                  relation: search
                - url: https://healthcare.googleapis.com/v1/projects/cdr-devl/locations/us-east4/datasets/cdr-fhir-ds/fhirStores/cdr-fhir-r4-test/fhir/AllergyIntolerance/?_count=2&_page_token=Cjj3YEef7v%2F%2F%2F%2F%2BABb0c6BuGuAD%2FAf%2F%2BOGQzY2FiYmE2OTc5N2U0NGFmNmNiM2Y1OTAwYWRhOGIAARACIRdZYDGqWfwzOQAAAAARYLifSAJQAFoLCcJRz98ugOf9EANg3JPmgwY%3D
                  relation: next
                - url: https://healthcare.googleapis.com/v1/projects/cdr-devl/locations/us-east4/datasets/cdr-fhir-ds/fhirStores/cdr-fhir-r4-test/fhir/AllergyIntolerance/?_count=2
                  relation: first
                - url: https://healthcare.googleapis.com/v1/projects/cdr-devl/locations/us-east4/datasets/cdr-fhir-ds/fhirStores/cdr-fhir-r4-test/fhir/AllergyIntolerance/?_count=2
                  relation: self
                id: a7bca4215fbc6e68b01b0801
                type: searchset
                resourceType: Bundle
        '400':
          description: A required parameter isn’t provided, or an unknown parameter is provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
              example:
                issue:
                - severity: error
                  code: required
                  details:
                    coding:
                    - system: http://hl7.org/fhir/ValueSet/operation-outcome
                      code: MSG_RESOURCE_ID_MISSING
                      display: Resource Id Missing
                id: 14c27ea91f91d8f01234
                resourceType: OperationOutcome
        '404':
          description: The specified id doesn’t identify an existing Resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
              example:
                issue:
                - severity: error
                  code: not-found
                  details:
                    coding:
                    - system: http://hl7.org/fhir/ValueSet/operation-outcome
                      code: MSG_NO_MATCH
                      display: No Resource found
                id: 687401f85fd3fefb43182c22
                resourceType: OperationOutcome
        '500':
          description: Internal Server Error. Failures on the server side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
              example:
                issue:
                - severity: fatal
                  diagnostics: Backend service failure
                  code: exception
                  details:
                    coding:
                    - system: http://hl7.org/fhir/ValueSet/operation-outcome
                      code: MSG_SVC_FAILURE
                      display: Error occurred while processing response
                id: 53c27ea45fd8f0ff0af91f91
                resourceType: OperationOutcome
        x-USCoreAllergyIntolerance:
          description: The API will never return this response. This parameter is here to facilitate the generation
            of the USCore AllergyIntolerance profile schema within the interface.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/USCoreAllergyIntolerance'
      parameters:
      - in: query
        name: patient
        description: "This is the FHIR Logical Id of a Patient (Patient.id)\n Ex. GET [base]/AllergyIntolerance?patient=98765212349744"
        required: false
        schema:
          type: string
      - in: query
        name: _page_token
        description: This value will be provided by the Server. Used to retrieve the next page of results.  If a
          search returns more resources than fit on one page, the response includes a pagination URL in the Bundle.link
          field.  The value with Bundle.link.relation = next indicates that you can use the corresponding Bundle.link.url
          to retrieve the next page.  ex. GET [base]/AllergyIntolerance?_count=10&_page_token=Cjj3YQP%2Bdf%2F%2F%2F%2F%2BABchXMXghfgD%2FAf%2F%2BZTA5NWM4YmI0YWNlYWQ4Yjc5NDhjYTk2M2RhMDA5N2QAARAKIeRmIPX4MlS1OQAAAACKAfyeSAFQAFoLCfRXKWB76f3NEANgg8Tc2gc%3D
        required: false
        schema:
          type: string
      - in: query
        name: _count
        description: Used to specify the number of records returned per page
        required: false
        schema:
          type: number
      - in: query
        name: _revinclude
        description: 'Adds support for searching the US Core Profile resource types for all the Provenance records
          for those resources using the _revinclude search parameter:


          GET [base]/[AllergyIntolerance]?_revinclude=Provenance:target'
        required: false
        schema:
          type: string
      x-source-file: _v2_patientaccess_AllergyIntolerance.yaml
  /v2/patientaccess/AllergyIntolerance/{id}:
    get:
      summary: Retrieves AllergyIntolerance details using the Id and formats the response in USCoreAllergyIntolerance  profile.
      description: Returns a Patient's Allergy Intolerance resource associated with the Logical Id
      operationId: get_v2_patientaccess_AllergyIntolerance_id
      responses:
        '200':
          description: This response returns a representation of a FHIR AllergyIntolerance resource which conforms
            to the USCore AllergyIntolerance profile.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/USCoreAllergyIntolerance'
              example:
                code:
                  coding:
                  - system: http://snomed.info/sct
                    code: '763875007'
                    display: Product containing sulfonamide (product)
                  text: sulfonamide antibacterial
                reaction:
                - severity: mild
                  manifestation:
                  - coding:
                    - system: http://snomed.info/sct
                      code: '271807003'
                      display: skin rash
                    text: skin rash
                verificationStatus:
                  coding:
                  - system: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
                    code: confirmed
                meta:
                  extension:
                  - valueString: AllergyIntolerance Example
                    url: http://hl7.org/fhir/StructureDefinition/instance-name
                  - valueMarkdown: This is a allergyintolerance example for the *US Core AllergyIntolerance Profile*.
                    url: http://hl7.org/fhir/StructureDefinition/instance-description
                  profile:
                  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance
                patient:
                  reference: Patient/example
                  display: Amy V. Shaw
                criticality: high
                id: example
                text:
                  div: '<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative</b></p><p><b>clinicalStatus</b>:
                    <span title="Codes: {http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical active}">Active</span></p><p><b>verificationStatus</b>:
                    <span title="Codes: {http://terminology.hl7.org/CodeSystem/allergyintolerance-verification confirmed}">Confirmed</span></p><p><b>category</b>:
                    medication</p><p><b>criticality</b>: high</p><p><b>code</b>: <span title="Codes: {http://snomed.info/sct
                    763875007}">sulfonamide antibacterial</span></p><p><b>patient</b>: <a href="Patient-example.html">Amy
                    V. Shaw. Generated Summary: Medical Record Number: 1032702 (USUAL); active; Amy V. Shaw , Amy
                    V. Baxter ; Phone: 555-555-5555, amy.shaw@example.com; gender: female; birthDate: 1987-02-20</a></p><h3>Reactions</h3><table
                    class="grid"><tr><td>-</td><td><b>Manifestation</b></td><td><b>Severity</b></td></tr><tr><td>*</td><td><span
                    title="Codes: {http://snomed.info/sct 271807003}">skin rash</span></td><td>mild</td></tr></table></div>'
                  status: generated
                clinicalStatus:
                  coding:
                  - system: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
                    code: active
                category:
                - medication
                resourceType: AllergyIntolerance
        '400':
          description: A required parameter isn’t provided, or an unknown parameter is provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
              example:
                issue:
                - severity: error
                  code: required
                  details:
                    coding:
                    - system: http://hl7.org/fhir/ValueSet/operation-outcome
                      code: MSG_RESOURCE_ID_MISSING
                      display: Resource Id Missing
                id: 14c27ea91f91d8f01234
                resourceType: OperationOutcome
        '404':
          description: The specified id doesn’t identify an existing Resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
              example:
                issue:
                - severity: error
                  code: not-found
                  details:
                    coding:
                    - system: http://hl7.org/fhir/ValueSet/operation-outcome
                      code: MSG_NO_MATCH
                      display: No Resource found
                id: 687401f85fd3fefb43182c22
                resourceType: OperationOutcome
        '500':
          description: Internal Server Error. Failures on the server side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
              example:
                issue:
                - severity: fatal
                  diagnostics: Backend service failure
                  code: exception
                  details:
                    coding:
                    - system: http://hl7.org/fhir/ValueSet/operation-outcome
                      code: MSG_SVC_FAILURE
                      display: Error occurred while processing response
                id: 53c27ea45fd8f0ff0af91f91
                resourceType: OperationOutcome
        x-USCoreAllergyIntolerance:
          description: The API will never return this response. This parameter is here to facilitate the generation
            of the USCore AllergyIntolerance profile schema within the interface.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/USCoreAllergyIntolerance'
      parameters:
      - in: path
        name: id
        description: This is the AllergyIntolerance (unique) logical ID.
        required: true
        schema:
          type: string
      x-source-file: _v2_patientaccess_AllergyIntolerance_id.yaml
  /v2/patientaccess/Binary/{id}:
    get:
      summary: This operation returns a Binary Resource associated with the Logical Id
      operationId: get_v2_patientaccess_Binary_id
      responses:
        '200':
          description: This response returns a representation of a Binary Resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Binary'
        '400':
          description: A required parameter isn’t provided, or an unknown parameter is provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '404':
          description: The specified id doesn’t identify an existing Resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
        '500':
          description: Internal Server Error. Failures on the server side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
      description: Returns an Binary Resource associated with the Logical Id.
      schemes:
      - https
      parameters:
      - in: path
        name: id
        description: This is the logical id.
        required: true
        schema:
          type: string
      x-source-file: _v2_patientaccess_Binary_id.yaml
  /v2/patientaccess/CarePlan:
    get:
      summary: Retrieves all Care Plans associated to an Authenticated User based on the search criteria (patient
        fhir logical id, date, status and category)
      description: Retrieves all Care Plans associated to an Authenticated User based on the search criteria (patient
        fhir logical id, date, status and category)
      operationId: get_v2_patientaccess_CarePlan
      responses:
        '200':
          description: This response returns a list of a Patient's CarePlans
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bundle'
              example:
                entry:
                - search:
                    mode: match
                  resource:
                    subject:
                      reference: Patient/example
                      display: Amy Shaw
                    text:
                      status: additional
                    category:
                    - coding:
                      - system: http://hl7.org/fhir/us/core/CodeSystem/careplan-category
                        code: assess-plan
                    recorded: '2021-01-07'
                    resourceType: CarePlan
                    status: completed
                  fullUrl: https://healthcare.googleapis.com/v1/projects/cdr-devl/locations/us-east4/datasets/cdr-fhir-ds/fhirStores/cdr-fhir-r4-test/fhir/CarePlan/11181211064
                - search:
                    mode: match
                  resource:
                    subject:
                      reference: Patient/example
                      display: Amy Shaw
                    text:
                      status: additional
                    category:
                    - coding:
                      - system: http://hl7.org/fhir/us/core/CodeSystem/careplan-category
                        code: assess-plan
                    recorded: '2021-01-07'
                    resourceType: CarePlan
                    status: completed
                  fullUrl: https://healthcare.googleapis.com/v1/projects/cdr-devl/locations/us-east4/datasets/cdr-fhir-ds/fhirStores/cdr-fhir-r4-test/fhir/CarePlan/11181210653
                total: 2
                link:
                - url: https://healthcare.googleapis.com/v1/projects/cdr-devl/locations/us-east4/datasets/cdr-fhir-ds/fhirStores/cdr-fhir-r4-test/fhir/CarePlan/?_count=2
                  relation: search
                - url: https://healthcare.googleapis.com/v1/projects/cdr-devl/locations/us-east4/datasets/cdr-fhir-ds/fhirStores/cdr-fhir-r4-test/fhir/CarePlan/?_count=2&_page_token=Cjj3YEef7v%2F%2F%2F%2F%2BABb0c6BuGuAD%2FAf%2F%2BOGQzY2FiYmE2OTc5N2U0NGFmNmNiM2Y1OTAwYWRhOGIAARACIRdZYDGqWfwzOQAAAAARYLifSAJQAFoLCcJRz98ugOf9EANg3JPmgwY%3D
                  relation: next
                - url: https://healthcare.googleapis.com/v1/projects/cdr-devl/locations/us-east4/datasets/cdr-fhir-ds/fhirStores/cdr-fhir-r4-test/fhir/CarePlan/?_count=2
                  relation: first
                - url: https://healthcare.googleapis.com/v1/projects/cdr-devl/locations/us-east4/datasets/cdr-fhir-ds/fhirStores/cdr-fhir-r4-test/fhir/CarePlan/?_count=2
                  relation: self
                id: a7bca4215fbc6e68b01b0801
                type: searchset
                resourceType: Bundle
        '400':
          description: A required parameter isn’t provided, or an unknown parameter is provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
              example:
                issue:
                - severity: error
                  code: required
                  details:
                    coding:
                    - system: http://hl7.org/fhir/ValueSet/operation-outcome
                      code: MSG_RESOURCE_ID_MISSING
                      display: Resource Id Missing
                id: 14c27ea91f91d8f01234
                resourceType: OperationOutcome
        '404':
          description: The specified id doesn’t identify an existing Resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
              example:
                issue:
                - severity: error
                  code: not-found
                  details:
                    coding:
                    - system: http://hl7.org/fhir/ValueSet/operation-outcome
                      code: MSG_NO_MATCH
                      display: No Resource found
                id: 687401f85fd3fefb43182c22
                resourceType: OperationOutcome
        '500':
          description: Internal Server Error. Failures on the server side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationOutcome'
              example:
                issue:
                - severity: fatal
                  diagnostics: Backend service failure
                  code: exception
                  details:
                    coding:
                    - system: http://hl7.org/fhir/ValueSet/operation-outcome
                      code: MSG_SVC_FAILURE
                      display: Error occurred while processing response
                id: 53c27ea45fd8f0ff0af91f91
                resourceType: OperationOutcome
        x-USCoreCarePlan:
          description: The API will never return this response. This parameter is here to facilitate the generation
            of the USCore CarePlan profile schema within the interface.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/USCoreCarePlan'
      parameters:
      - in: query
        name: patient
        description: "This is the FHIR Logical Id of a Patient (Patient.id)\n Ex. GET [base]/CarePlan?patient=98765212349744"
        required: false
        schema:
          type: string
      - in: query
        name: category
        description: Example codes indicating the category a care plan falls within. Note that these are in no way
          complete and might not even be appropriate for some uses.
        required: false
        schema:
          type: string
      - in: query
        name: _page_token
        description: This value will be provided by the Server. It is used to retrieve the next page of results.   If
          a search returns more resources than fit on one page, the response includes a pagination URL in the Bundle.link
          field.  The value with Bundle.link.relation = next indicates that you can use the corresponding Bundle.link.url
          to retrieve the next page.  ex. GET [base]/CarePlan?_count=10&_page_token=Cjj3YQP%2Bdf%2F%2F%2F%2F%2BABchXMXghfgD%2FAf%2F%2BZTA5NWM4YmI0YWNlYWQ4Yjc5NDhjYTk2M2RhMDA5N2QAARAKIeRmIPX4MlS1OQAAAACKAfyeSAFQAFoLCfRXKWB76f3NEANgg8Tc2gc%3D
        required: false
        schema:
          type: string
      - in: query
        name: _count
        description: Used to specify the number of records returned per page
        required: false
        schema:
          type: number
      - in: query
        name: _revinclude
        description: 'Adds support for searching the US Core Profile resource types for all the Provenance records
          for those resources using the _revinclude search parameter:


          GET [base]/[CarePlan]?_revinclude=Provenance:target'
        required: false
        schema:
          type: string
      x-source-file: _v2_patientaccess_CarePlan.yaml
  /v2/patientaccess/CarePlan/{id}:
    get:
      summary: Retrieves CarePlan details using the Id and formats the response in USCoreCarePlan profile.
      description: Returns a Patient's Care Plan resource associated with the Logical Id
      operationId: get_v2_patientaccess_CarePlan_id
      responses:
        '200':
          description: This response returns a representation of a FHIR CarePlan resource which conforms to the
            USCore CarePlan profile.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/USCoreCarePlan'
              example:
                meta:
                  extension:
                  - valueString: Colonoscopy Example
                    url: http://hl7.org/fhir/StructureDefinition/instance-name
                  - valueMarkdown: This is a colonoscopy example for the *US Core CarePlan Profile*.
                    url: http://hl7.org/fhir/StructureDefinition/instance-description
                  profile:
                  - http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan
                subject:
                  reference: Patient/example
                  display: Amy Shaw
                id: colonoscopy
                text:
                  div: '<div xmlns="http://www.w3.org/1999/xhtml"> &#9;&#9;&#9;<strong>Assessment</strong> &#9;&#9;&#9;<ol>&#9;&#9;&#9;&#9;<li>Recurrent
                    GI bleed of unknown etiology; hypotension perhaps secondary to this but as likely secondary
                    to polypharmacy.</li>&#9;&#9;&#9;&#9;<li>Acute on chronic anemia secondary to #1.</li>&#9;&#9;&#9;&#9;<li>Azotemia,
                    acute renal failure with volume loss secondary to #1.</li>&#9;&#9;&#9;&#9;<li>Hyperkalemia secondary
                    to #3 and on ACE and K+ supplement.</li>&#9;&#9;&#9;&#9;<li>Other chronic diagnoses as noted
                    above, currently stable.</li>&#9;&#9;&#9;</ol> &#9;&#9;&#9;<table>&#9;&#9;&#9;&#9;<thead> &#9;&#9;&#9;&#9;&#9;<tr>&#9;&#9;&#9;&#9;&#9;&#9;<th>Planned
                    Activity</th> &#9;&#9;&#9;&#9;&#9;&#9;<th>Planned Date</th> &#9;&#9;&#9;&#9;&#9;</tr>&#9;&#9;&#9;&#9;</thead>
                    &#9;&#9;&#9;&#

# --- truncated at 32 KB (940 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aetna/refs/heads/main/openapi/aetna-patient-access-api-openapi.yml