openapi: 3.0.1
info:
title: AmeriHealth Caritas AllergyIntolerance Location 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: Location
description: The Location FHIR resource type
paths:
/Location/{id}:
get:
tags:
- Location
summary: 'read-instance: Read Location 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:
- Location
summary: 'update-instance: Update an existing Location 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\": \"Location\"\n}"
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: <Location 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:
- Location
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:
- Location
summary: 'instance-patch: Patch a resource instance of type Location 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'
/Location/{id}/_history/{version_id}:
get:
tags:
- Location
summary: 'vread-instance: Read Location 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'
/Location:
get:
tags:
- Location
summary: 'search-type: Search for Location instances'
description: This is a search type
parameters:
- name: address-state
in: query
description: A state specified in an address
style: simple
- name: resource-placeholder
in: query
description: Search for resources of type [Location] 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: operational-status
in: query
description: Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)
style: simple
- name: identifier-system-loc
in: query
description: A location identifier with system LOC
style: simple
- name: type
in: query
description: A code for the type of location
style: simple
- name: address-country
in: query
description: A country specified in an address
style: simple
- name: endpoint
in: query
description: Technical endpoints providing access to services operated for the location
style: simple
- name: near
in: query
description: 'Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes).
If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant)
Servers may search using various techniques that might have differing accuracies, depending on implementation efficiency.
Requires the near-distance parameter to be provided also'
style: simple
- name: address-city
in: query
description: A city specified in an address
style: simple
- name: partof
in: query
description: A location of which this location is a part
style: simple
- name: identifier
in: query
description: An identifier for the location
style: simple
- name: address
in: query
description: A (part of the) address of the location
style: simple
- name: _security
in: query
description: Search for resources which have the given security labels
style: simple
- name: address-postalcode
in: query
description: A postal code specified in an address
style: simple
- name: identifier-system-loc-unique
in: query
style: simple
- name: _profile
in: query
description: Search for resources which have the given profile
style: simple
- name: organization
in: query
description: Searches for locations that are managed by the provided organization
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: name
in: query
description: A portion of the location's name or alias
style: simple
- name: address-use
in: query
description: A use code specified in an address
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: status
in: query
description: Searches for locations with a specific kind of status
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:
- Location
summary: 'create-type: Create a new Location instance'
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: "{\n \"resourceType\": \"Location\"\n}"
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: <Location 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'
/Location/_history:
get:
tags:
- Location
summary: 'type-history: Fetch the resource change history for all resources of type Location'
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'
/Location/{id}/_history:
get:
tags:
- Location
summary: 'instance-history: Fetch the resource change history for all resources of type Location'
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'
/Location/$validate:
get:
tags:
- Location
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'
/Location/{id}/$validate:
get:
tags:
- Location
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'
/Location/{id}/$meta-delete:
post:
tags:
- Location
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'
/Location/{id}/$meta-add:
post:
tags:
- Location
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'
/Location/$meta:
get:
tags:
- Location
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'
/Location/{id}/$meta:
get:
tags:
- Location
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'
/Location/$expunge:
post:
tags:
- Location
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'
/Location/{id}/$expunge:
post:
tags:
- Location
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'
/Location/{id}/$graphql:
get:
tags:
- Location
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'
/Location/{id}/$binary-access-write:
post:
tags:
- Location
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'
/Location/{id}/$binary-access-read:
get:
tags:
- Location
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'
/Location/{id}/$diff:
get:
tags:
- Location
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