openapi: 3.0.1
info:
title: AmeriHealth Caritas
contact: {}
version: 1.0.0
servers:
- url: https://api-ext.amerihealthcaritas.com/0500/patient-api
description: AmeriHealth Caritas
security:
- openId:
- openid
- fhirUser
tags:
- name: System Level Operations
description: Server-level operations
- name: AllergyIntolerance
description: The AllergyIntolerance FHIR resource type
- name: Claim
description: The Claim FHIR resource type
- name: Condition
description: The Condition FHIR resource type
- name: Coverage
description: The Coverage FHIR resource type
- name: Encounter
description: The Encounter FHIR resource type
- name: ExplanationOfBenefit
description: The ExplanationOfBenefit FHIR resource type
- name: HealthcareService
description: The HealthcareService FHIR resource type
- name: Immunization
description: The Immunization FHIR resource type
- name: InsurancePlan
description: The InsurancePlan FHIR resource type
- name: List
description: The List FHIR resource type
- name: Location
description: The Location FHIR resource type
- name: Medication
description: The Medication FHIR resource type
- name: MedicationDispense
description: The MedicationDispense FHIR resource type
- name: MedicationKnowledge
description: The MedicationKnowledge FHIR resource type
- name: MedicationRequest
description: The MedicationRequest FHIR resource type
- name: Observation
description: The Observation FHIR resource type
- name: Organization
description: The Organization FHIR resource type
- name: OrganizationAffiliation
description: The OrganizationAffiliation FHIR resource type
- name: Patient
description: The Patient FHIR resource type
- name: Practitioner
description: The Practitioner FHIR resource type
- name: PractitionerRole
description: The PractitionerRole FHIR resource type
- name: Procedure
description: The Procedure FHIR resource type
paths:
/metadata:
get:
tags:
- System Level Operations
summary: "server-capabilities: Fetch the server FHIR CapabilityStatement"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "CapabilityStatement"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: <CapabilityStatement xmlns="http://hl7.org/fhir"/>
/:
post:
tags:
- System Level Operations
summary: "server-transaction: Execute a FHIR Transaction (or FHIR Batch) Bundle"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/_history:
get:
tags:
- System Level Operations
summary: "server-history: Fetch the resource change history across all resource\
\ types on the server"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$reindex:
post:
tags:
- System Level Operations
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueString": "example"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$submit-attachment:
post:
tags:
- System Level Operations
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$diff:
get:
tags:
- System Level Operations
summary: Comparte two resources or two versions of a single resource
description: "This operation examines two resource versions (can be two versions\
\ of the same resource, or two different resources) and generates a FHIR Patch\
\ document showing the differences."
parameters:
- name: from
in: query
description: The resource ID and version to diff from
required: true
style: simple
example: Patient/example/version/1
- name: to
in: query
description: The resource ID and version to diff to
required: true
style: simple
example: Patient/example/version/2
- name: includeMeta
in: query
description: Should differences in the Resource.meta element be included in
the diff
required: false
style: simple
example: "false"
- name: fromVersion
in: query
description: The resource ID and version to diff from
required: false
style: simple
example: Patient/example/version/1
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$process-message:
post:
tags:
- System Level Operations
description: Accept a FHIR Message Bundle for processing
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "content"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$perform-reindexing-pass:
post:
tags:
- System Level Operations
description: Forces a single pass of the resource reindexing processor
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "status"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$meta:
get:
tags:
- System Level Operations
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$mark-all-resources-for-reindexing:
post:
tags:
- System Level Operations
description: "Marks all currently existing resources of a given type, or all\
\ resources of all types, for reindexing."
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "type",
"valueCode": "example"
}, {
"name": "status"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$get-resource-counts:
get:
tags:
- System Level Operations
summary: "Provides the number of resources currently stored on the server, broken\
\ down by resource type"
description: "Provides the number of resources currently stored on the server,\
\ broken down by resource type"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$expunge:
post:
tags:
- System Level Operations
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$reindex-terminology:
post:
tags:
- System Level Operations
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters"
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/$graphql:
get:
tags:
- System Level Operations
description: "This operation invokes a GraphQL expression for fetching an joining\
\ a graph of resources, returning them in a custom format."
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/AllergyIntolerance/{id}:
get:
tags:
- AllergyIntolerance
summary: "read-instance: Read AllergyIntolerance instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
put:
tags:
- AllergyIntolerance
summary: "update-instance: Update an existing AllergyIntolerance instance, or\
\ create using a client-assigned ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "AllergyIntolerance"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: <AllergyIntolerance xmlns="http://hl7.org/fhir"/>
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
delete:
tags:
- AllergyIntolerance
summary: "instance-delete: Perform a logical delete on a resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
patch:
tags:
- AllergyIntolerance
summary: "instance-patch: Patch a resource instance of type AllergyIntolerance\
\ by ID"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "operation",
"part": [ {
"name": "type",
"valueString": "add"
}, {
"name": "path",
"valueString": "Patient"
}, {
"name": "name",
"valueString": "birthDate"
}, {
"name": "value",
"valueDate": "1930-01-01"
} ]
} ]
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: |-
<Parameters xmlns="http://hl7.org/fhir">
<parameter>
<name value="operation"/>
<part>
<name value="type"/>
<valueString value="add"/>
</part>
<part>
<name value="path"/>
<valueString value="Patient"/>
</part>
<part>
<name value="name"/>
<valueString value="birthDate"/>
</part>
<part>
<name value="value"/>
<valueDate value="1930-01-01"/>
</part>
</parameter>
</Parameters>
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/AllergyIntolerance/{id}/_history/{version_id}:
get:
tags:
- AllergyIntolerance
summary: "vread-instance: Read AllergyIntolerance instance with specific version"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "1"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/AllergyIntolerance:
get:
tags:
- AllergyIntolerance
summary: "search-type: Search for AllergyIntolerance instances"
description: This is a search type
parameters:
- name: date
in: query
description: Date first version of the resource instance was recorded
style: simple
- name: code
in: query
description: Code that identifies the allergy or intolerance
style: simple
- name: resource-placeholder
in: query
description: "Search for resources of type [AllergyIntolerance] populated\
\ with the resource-placeholder extension"
style: simple
- name: verification-status
in: query
description: unconfirmed | confirmed | refuted | entered-in-error
style: simple
- name: _lastUpdated
in: query
description: Only return resources which were last updated as specified by
the given range
style: simple
- name: criticality
in: query
description: low | high | unable-to-assess
style: simple
- name: clinical-status
in: query
description: active | inactive | resolved
style: simple
- name: type
in: query
description: allergy | intolerance - Underlying mechanism (if known)
style: simple
- name: patient
in: query
description: Who the sensitivity is for
style: simple
- name: severity
in: query
description: mild | moderate | severe (of event as a whole)
style: simple
- name: identifier
in: query
description: External ids for this item
style: simple
- name: manifestation
in: query
description: Clinical symptoms/signs associated with the Event
style: simple
- name: recorder
in: query
description: Who recorded the sensitivity
style: simple
- name: _security
in: query
description: Search for resources which have the given security labels
style: simple
- name: onset
in: query
description: Date(/time) when manifestations showed
style: simple
- name: route
in: query
description: How the subject was exposed to the substance
style: simple
- name: asserter
in: query
description: Source of the information about the allergy
style: simple
- name: _profile
in: query
description: Search for resources which have the given profile
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: _tag
in: query
description: Search for resources which have the given tag
style: simple
- name: _source
in: query
description: Search for resources which have the given source value (Resource.meta.source)
style: simple
- name: _id
in: query
description: The ID of the resource
style: simple
- name: category
in: query
description: food | medication | environment | biologic
style: simple
- name: _content
in: query
description: Search the contents of the resource's data using a fulltext search
style: simple
- name: _text
in: query
description: Search the contents of the resource's narrative using a fulltext
search
style: simple
- name: last-date
in: query
description: Date(/time) of last known occurrence of a reaction
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
post:
tags:
- AllergyIntolerance
summary: "create-type: Create a new AllergyIntolerance instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "AllergyIntolerance"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: <AllergyIntolerance xmlns="http://hl7.org/fhir"/>
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/AllergyIntolerance/_history:
get:
tags:
- AllergyIntolerance
summary: "type-history: Fetch the resource change history for all resources\
\ of type AllergyIntolerance"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/AllergyIntolerance/{id}/_history:
get:
tags:
- AllergyIntolerance
summary: "instance-history: Fetch the resource change history for all resources\
\ of type AllergyIntolerance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/AllergyIntolerance/$validate:
get:
tags:
- AllergyIntolerance
parameters:
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/AllergyIntolerance/{id}/$validate:
get:
tags:
- AllergyIntolerance
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: resource
in: query
required: false
style: simple
- name: mode
in: query
required: false
style: simple
- name: profile
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/AllergyIntolerance/{id}/$meta-delete:
post:
tags:
- AllergyIntolerance
description: "Delete tags, profiles, and/or security labels from a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/AllergyIntolerance/{id}/$meta-add:
post:
tags:
- AllergyIntolerance
description: "Add tags, profiles, and/or security labels to a resource"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "meta"
}, {
"name": "return"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/AllergyIntolerance/$meta:
get:
tags:
- AllergyIntolerance
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/AllergyIntolerance/{id}/$meta:
get:
tags:
- AllergyIntolerance
description: "Request a list of tags, profiles, and security labels for a specfic\
\ resource instance"
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
- name: return
in: query
required: false
style: simple
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/AllergyIntolerance/$expunge:
post:
tags:
- AllergyIntolerance
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
/AllergyIntolerance/{id}/$expunge:
post:
tags:
- AllergyIntolerance
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: "123"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
}, {
"name": "count"
} ]
}
responses:
"200":
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
application/fhir+xml:
schema:
$ref: '#/components/s
# --- truncated at 32 KB (544 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amerihealth-caritas/refs/heads/main/openapi/amerihealth-caritas-patient-access-openapi.yml