openapi: 3.0.1
info:
title: AmeriHealth Caritas AllergyIntolerance Encounter 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: Encounter
description: The Encounter FHIR resource type
paths:
/Encounter/{id}:
get:
tags:
- Encounter
summary: 'read-instance: Read Encounter 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:
- Encounter
summary: 'update-instance: Update an existing Encounter 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\": \"Encounter\"\n}"
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: <Encounter 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:
- Encounter
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:
- Encounter
summary: 'instance-patch: Patch a resource instance of type Encounter 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: "<Parameters xmlns=\"http://hl7.org/fhir\">\n <parameter>\n <name value=\"operation\"/>\n <part>\n <name value=\"type\"/>\n <valueString value=\"add\"/>\n </part>\n <part>\n <name value=\"path\"/>\n <valueString value=\"Patient\"/>\n </part>\n <part>\n <name value=\"name\"/>\n <valueString value=\"birthDate\"/>\n </part>\n <part>\n <name value=\"value\"/>\n <valueDate value=\"1930-01-01\"/>\n </part>\n </parameter>\n</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'
/Encounter/{id}/_history/{version_id}:
get:
tags:
- Encounter
summary: 'vread-instance: Read Encounter 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'
/Encounter:
get:
tags:
- Encounter
summary: 'search-type: Search for Encounter instances'
description: This is a search type
parameters:
- name: date
in: query
description: A date within the period the Encounter lasted
style: simple
- name: participant-type
in: query
description: Role of participant in encounter
style: simple
- name: subject
in: query
description: The patient or group present at the encounter
style: simple
- name: resource-placeholder
in: query
description: Search for resources of type [Encounter] populated with the resource-placeholder extension
style: simple
- name: _lastUpdated
in: query
description: Only return resources which were last updated as specified by the given range
style: simple
- name: appointment
in: query
description: The appointment that scheduled this encounter
style: simple
- name: part-of
in: query
description: Another Encounter this encounter is part of
style: simple
- name: type
in: query
description: Specific type of encounter
style: simple
- name: participant
in: query
description: Persons involved in the encounter other than the patient
style: simple
- name: reason-code
in: query
description: Coded reason the encounter takes place
style: simple
- name: based-on
in: query
description: The ServiceRequest that initiated this encounter
style: simple
- name: patient
in: query
description: The patient or group present at the encounter
style: simple
- name: identifier-system-tx-unique
in: query
style: simple
- name: location-period
in: query
description: Time period during which the patient was present at the location
style: simple
- name: special-arrangement
in: query
description: Wheelchair, translator, stretcher, etc.
style: simple
- name: class
in: query
description: Classification of patient encounter
style: simple
- name: identifier
in: query
description: Identifier(s) by which this encounter is known
style: simple
- name: practitioner
in: query
description: Persons involved in the encounter other than the patient
style: simple
- name: episode-of-care
in: query
description: Episode(s) of care that this encounter should be recorded against
style: simple
- name: length
in: query
description: Length of encounter in days
style: simple
- name: _security
in: query
description: Search for resources which have the given security labels
style: simple
- name: diagnosis
in: query
description: The diagnosis or procedure relevant to the encounter
style: simple
- name: identifier-system-tx
in: query
description: An encounter identifier with system TX
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: reason-reference
in: query
description: Reason the encounter takes place (reference)
style: simple
- name: service-provider
in: query
description: The organization (facility) responsible for this encounter
style: simple
- name: location
in: query
description: Location the encounter takes place
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: _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: account
in: query
description: The set of accounts that may be used for billing for this Encounter
style: simple
- name: status
in: query
description: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
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:
- Encounter
summary: 'create-type: Create a new Encounter instance'
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: "{\n \"resourceType\": \"Encounter\"\n}"
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: <Encounter 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'
/Encounter/_history:
get:
tags:
- Encounter
summary: 'type-history: Fetch the resource change history for all resources of type Encounter'
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'
/Encounter/{id}/_history:
get:
tags:
- Encounter
summary: 'instance-history: Fetch the resource change history for all resources of type Encounter'
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'
/Encounter/$validate:
get:
tags:
- Encounter
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'
/Encounter/{id}/$validate:
get:
tags:
- Encounter
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'
/Encounter/{id}/$meta-delete:
post:
tags:
- Encounter
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'
/Encounter/{id}/$meta-add:
post:
tags:
- Encounter
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'
/Encounter/$meta:
get:
tags:
- Encounter
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'
/Encounter/{id}/$meta:
get:
tags:
- Encounter
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'
/Encounter/$expunge:
post:
tags:
- Encounter
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'
/Encounter/{id}/$expunge:
post:
tags:
- Encounter
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'
/Encounter/$everything:
get:
tags:
- Encounter
parameters:
- name: _count
in: query
description: Results from this method are returned across multiple pages. This parameter controls the size of those pages.
required: false
style: simple
- name: _offset
in: query
description: Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page.
required: false
style: simple
- name: _lastUpdated
in: query
description: Only return resources which were last updated as specified by the given range
required: false
style: simple
- name: _content
in: query
description: Filter the resources to return only resources matching the given _content filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)
required: false
style: simple
- name: _text
in: query
description: Filter the resources to return only resources matching the given _text filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)
required: false
style: simple
- name: _filter
in: query
description: Filter the resources to return only resources matching the given _filter filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)
required: false
style: simple
- name: _type
in: query
description: Filter the resources to return only resources matching the given _type filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)
required: false
style: simple
- name: _id
in: query
description: Filter the resources to return based on the patient ids provided.
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'
/Encounter/{id}/$everything:
get:
tags:
- Encounter
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: '123'
- name: _count
in: query
description: Results from this method are returned across multiple pages. This parameter controls the size of those pages.
required: false
style: simple
- name: _offset
in: query
description: Results from this method are returned across multiple pages. This parameter controls the offset when fetching a page.
required: false
style: simple
- name: _lastUpdated
in: query
description: Only return resources which were last updated as specified by the given range
required: false
style: simple
- name: _content
in: query
description: Filter the resources to return only resources matching the given _content filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)
required: false
style: simple
- name: _text
in: query
description: Filter the resources to return only resources matching the given _text filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)
required: false
style: simple
- name: _filter
in: query
description: Filter the resources to return only resources matching the given _filter filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)
required: false
style: simple
- name: _type
in: query
description: Filter the resources to return only resources matching the given _type filter (note that this filter is applied only to results which link to the given patient, not to the patient itself or to supporting resources linked to by the matched resources)
required: false
style: simple
- name: _id
in: query
description: Filter the resources to return based on the patient ids provided.
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'
/Encounter/{id}/$graphql:
get:
tags:
- Encounter
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'
/Encounter/{id}/$binary-access-write:
post:
tags:
- Encounter
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'
/Encounter/{id}/$binary-access-read:
get:
tags:
- Encounter
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'
/Encounter/{id}/$diff:
get:
tags:
- Encounter
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