openapi: 3.0.1
info:
title: AmeriHealth Caritas AllergyIntolerance Condition API
contact: {}
version: 1.0.0
description: The AllergyIntolerance FHIR resource type
servers:
- url: https://api-ext.amerihealthcaritas.com/0500/patient-api
description: AmeriHealth Caritas
security:
- openId:
- openid
- fhirUser
tags:
- name: Condition
description: The Condition FHIR resource type
paths:
/Condition/{id}:
get:
tags:
- Condition
summary: 'read-instance: Read Condition 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:
- Condition
summary: 'update-instance: Update an existing Condition 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: "{\n \"resourceType\": \"Condition\"\n}"
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
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'
delete:
tags:
- Condition
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:
- Condition
summary: 'instance-patch: Patch a resource instance of type Condition 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: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"operation\",\n \"part\": [ {\n \"name\": \"type\",\n \"valueString\": \"add\"\n }, {\n \"name\": \"path\",\n \"valueString\": \"Patient\"\n }, {\n \"name\": \"name\",\n \"valueString\": \"birthDate\"\n }, {\n \"name\": \"value\",\n \"valueDate\": \"1930-01-01\"\n } ]\n } ]\n}"
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"
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'
/Condition/{id}/_history/{version_id}:
get:
tags:
- Condition
summary: 'vread-instance: Read Condition 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'
/Condition:
get:
tags:
- Condition
summary: 'search-type: Search for Condition instances'
description: This is a search type
parameters:
- name: onset-info
in: query
description: Onsets as a string
style: simple
- name: code
in: query
description: Code for the condition
style: simple
- name: evidence
in: query
description: Manifestation/symptom
style: simple
- name: resource-placeholder
in: query
description: Search for resources of type [Condition] populated with the resource-placeholder extension
style: simple
- name: subject
in: query
description: Who has the condition?
style: simple
- name: verification-status
in: query
description: unconfirmed | provisional | differential | 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: clinical-status
in: query
description: The clinical status of the condition
style: simple
- name: onset-date
in: query
description: Date related onsets (dateTime and Period)
style: simple
- name: abatement-date
in: query
description: Date-related abatements (dateTime and period)
style: simple
- name: patient
in: query
description: Who has the condition?
style: simple
- name: abatement-age
in: query
description: Abatement as age or age range
style: simple
- name: evidence-detail
in: query
description: Supporting information found elsewhere
style: simple
- name: severity
in: query
description: The severity of the condition
style: simple
- name: identifier
in: query
description: A unique identifier of the condition record
style: simple
- name: recorded-date
in: query
description: Date record was first recorded
style: simple
- name: _security
in: query
description: Search for resources which have the given security labels
style: simple
- name: encounter
in: query
description: Encounter created as part of
style: simple
- name: asserter
in: query
description: Person who asserts this condition
style: simple
- name: stage
in: query
description: Simple summary (disease specific)
style: simple
- name: _profile
in: query
description: Search for resources which have the given profile
style: simple
- name: abatement-string
in: query
description: Abatement as a string
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: onset-age
in: query
description: Onsets as age or age range
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: The category of the condition
style: simple
- name: body-site
in: query
description: Anatomical location, if relevant
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
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:
- Condition
summary: 'create-type: Create a new Condition instance'
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: "{\n \"resourceType\": \"Condition\"\n}"
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
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'
/Condition/_history:
get:
tags:
- Condition
summary: 'type-history: Fetch the resource change history for all resources of type Condition'
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'
/Condition/{id}/_history:
get:
tags:
- Condition
summary: 'instance-history: Fetch the resource change history for all resources of type Condition'
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'
/Condition/$validate:
get:
tags:
- Condition
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'
/Condition/{id}/$validate:
get:
tags:
- Condition
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'
/Condition/{id}/$meta-delete:
post:
tags:
- Condition
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: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n }, {\n \"name\": \"return\"\n } ]\n}"
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'
/Condition/{id}/$meta-add:
post:
tags:
- Condition
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: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n }, {\n \"name\": \"return\"\n } ]\n}"
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'
/Condition/$meta:
get:
tags:
- Condition
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'
/Condition/{id}/$meta:
get:
tags:
- Condition
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'
/Condition/$expunge:
post:
tags:
- Condition
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n }, {\n \"name\": \"count\"\n } ]\n}"
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'
/Condition/{id}/$expunge:
post:
tags:
- Condition
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: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"limit\",\n \"valueInteger\": 0\n }, {\n \"name\": \"expungeDeletedResources\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungePreviousVersions\",\n \"valueBoolean\": false\n }, {\n \"name\": \"expungeEverything\",\n \"valueBoolean\": false\n }, {\n \"name\": \"count\"\n } ]\n}"
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'
/Condition/{id}/$graphql:
get:
tags:
- Condition
description: This operation invokes a GraphQL expression for fetching an joining a graph of resources, returning them in a custom format.
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'
/Condition/{id}/$binary-access-write:
post:
tags:
- Condition
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: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"path\",\n \"valueString\": \"example\"\n } ]\n}"
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'
/Condition/{id}/$binary-access-read:
get:
tags:
- Condition
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
- name: path
in: query
required: true
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'
/Condition/{id}/$diff:
get:
tags:
- Condition
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: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
- 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'
components:
schemas:
FHIR-JSON-RESOURCE:
type: object
description: A FHIR resource
FHIR-XML-RESOURCE:
type: object
description: A FHIR resource
securitySchemes:
openId:
type: openIdConnect
openIdConnectUrl: https://api-ext.amerihealthcaritas.com/0500/patient-api/.well-known/smart-configuration