Devoted Health Insurance Plan API
The InsurancePlan FHIR resource type
The InsurancePlan FHIR resource type
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/devoted-health:devoted-health-insurance-plan-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: HAPI FHIR Server Insurance Plan API
contact: {}
version: 6.6.0
description: The InsurancePlan FHIR resource type
servers:
- url: https://fhir.devoted.com/fhir
description: HAPI FHIR Server
tags:
- name: Insurance Plan
description: The InsurancePlan FHIR resource type
paths:
/InsurancePlan/{id}:
get:
tags:
- Insurance Plan
summary: 'read-instance: Read InsurancePlan instance'
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: null
example: '123'
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
operationId: getInsurancePlanById
x-operation-id-source: derived
put:
tags:
- Insurance Plan
summary: 'update-instance: Update an existing InsurancePlan instance, or create using a…'
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: null
example: '123'
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: "{\n \"resourceType\": \"InsurancePlan\"\n}"
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: <InsurancePlan xmlns="http://hl7.org/fhir"/>
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
operationId: putInsurancePlanById
x-operation-id-source: derived
delete:
tags:
- Insurance Plan
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: null
example: '123'
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
operationId: deleteInsurancePlanById
x-operation-id-source: derived
patch:
tags:
- Insurance Plan
summary: 'instance-patch: Patch a resource instance of type InsurancePlan by ID'
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: null
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'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
operationId: patchInsurancePlanById
x-operation-id-source: derived
/InsurancePlan/{id}/_history/{version_id}:
get:
tags:
- Insurance Plan
summary: 'vread-instance: Read InsurancePlan instance with specific version'
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: null
example: '123'
- name: version_id
in: path
description: The resource version ID
required: true
style: simple
schema:
minimum: 1
type: string
example: null
example: '1'
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
operationId: getInsurancePlanByIdHistoryByVersionId
x-operation-id-source: derived
/InsurancePlan:
get:
tags:
- Insurance Plan
summary: 'search-type: Search for InsurancePlan instances'
description: This is a search type
parameters:
- name: address-state
in: query
description: A state specified in an address
style: simple
- name: _lastUpdated
in: query
description: Accesses the last updated date of an InsurancePlan
style: simple
- name: type
in: query
description: Accesses the Type of an InsurancePlan
style: simple
- name: address-country
in: query
description: A country specified in an address
style: simple
- name: administered-by
in: query
description: Product administrator
style: simple
- name: endpoint
in: query
description: Technical endpoint
style: simple
- name: phonetic
in: query
description: A portion of the organization's name using some kind of phonetic matching algorithm
style: simple
- name: coverage-area
in: query
description: Search InsurancePlan by coverage location.
style: simple
- name: address-city
in: query
description: A city specified in an address
style: simple
- name: identifier
in: query
description: Accesses the business identifier of an InsurancePlan
style: simple
- name: period
in: query
description: Accesses the active period of an InsurancePlan
style: simple
- name: address
in: query
description: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
style: simple
- name: owned-by
in: query
description: An organization of which this organization forms a part
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: address-postalcode
in: query
description: A postal code specified in an address
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: formulary-coverage
in: query
description: Accesses the Coverage Formulary Reference of an InsurancePlan
style: simple
- name: coverage-type
in: query
description: Accesses the coverage type of an InsurancePlan
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: address-use
in: query
description: A use code specified in an address
style: simple
- name: name
in: query
description: Accesses the name of an InsurancePlan
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: Accesses the status of an InsurancePlan
style: simple
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
operationId: getInsurancePlan
x-operation-id-source: derived
post:
tags:
- Insurance Plan
summary: 'create-type: Create a new InsurancePlan instance'
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: "{\n \"resourceType\": \"InsurancePlan\"\n}"
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: <InsurancePlan xmlns="http://hl7.org/fhir"/>
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
operationId: postInsurancePlan
x-operation-id-source: derived
/InsurancePlan/_history:
get:
tags:
- Insurance Plan
summary: 'type-history: Fetch the resource change history for all resources of type…'
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
operationId: getInsurancePlanHistory
x-operation-id-source: derived
/InsurancePlan/{id}/_history:
get:
tags:
- Insurance Plan
summary: 'instance-history: Fetch the resource change history for all resources of type…'
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: null
example: '123'
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
operationId: getInsurancePlanByIdHistory
x-operation-id-source: derived
/InsurancePlan/_search:
get:
tags:
- Insurance Plan
summary: 'search-type: Search for InsurancePlan instances'
description: This is a search type
parameters:
- name: address-state
in: query
description: A state specified in an address
style: simple
- name: _lastUpdated
in: query
description: Accesses the last updated date of an InsurancePlan
style: simple
- name: type
in: query
description: Accesses the Type of an InsurancePlan
style: simple
- name: address-country
in: query
description: A country specified in an address
style: simple
- name: administered-by
in: query
description: Product administrator
style: simple
- name: endpoint
in: query
description: Technical endpoint
style: simple
- name: phonetic
in: query
description: A portion of the organization's name using some kind of phonetic matching algorithm
style: simple
- name: coverage-area
in: query
description: Search InsurancePlan by coverage location.
style: simple
- name: address-city
in: query
description: A city specified in an address
style: simple
- name: identifier
in: query
description: Accesses the business identifier of an InsurancePlan
style: simple
- name: period
in: query
description: Accesses the active period of an InsurancePlan
style: simple
- name: address
in: query
description: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
style: simple
- name: owned-by
in: query
description: An organization of which this organization forms a part
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: address-postalcode
in: query
description: A postal code specified in an address
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: formulary-coverage
in: query
description: Accesses the Coverage Formulary Reference of an InsurancePlan
style: simple
- name: coverage-type
in: query
description: Accesses the coverage type of an InsurancePlan
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: address-use
in: query
description: A use code specified in an address
style: simple
- name: name
in: query
description: Accesses the name of an InsurancePlan
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: _id
in: query
description: Logical id of this artifact
style: simple
- name: _text
in: query
description: Search on the narrative of the resource
style: simple
- name: _content
in: query
description: Search on the entire content of the resource
style: simple
- name: status
in: query
description: Accesses the status of an InsurancePlan
style: simple
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
operationId: getInsurancePlanSearch
x-operation-id-source: derived
/InsurancePlan/$validate:
get:
tags:
- Insurance Plan
parameters:
- name: mode
in: query
required: false
style: simple
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
summary: Get insurance plan $validate
x-summary-source: derived
operationId: getInsurancePlan$validate
x-operation-id-source: derived
post:
tags:
- Insurance Plan
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: null
example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"InsurancePlan\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}"
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
summary: Create insurance plan $validate
x-summary-source: derived
operationId: postInsurancePlan$validate
x-operation-id-source: derived
/InsurancePlan/{id}/$validate:
get:
tags:
- Insurance Plan
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: null
example: '123'
- name: mode
in: query
required: false
style: simple
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
summary: Get insurance plan by id $validate
x-summary-source: derived
operationId: getInsurancePlanById$validate
x-operation-id-source: derived
post:
tags:
- Insurance Plan
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: null
example: '123'
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: null
example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"resource\",\n \"resource\": {\n \"resourceType\": \"InsurancePlan\",\n \"id\": \"1\"\n }\n }, {\n \"name\": \"mode\",\n \"valueCode\": \"example\"\n }, {\n \"name\": \"profile\"\n } ]\n}"
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
summary: Create insurance plan by id $validate
x-summary-source: derived
operationId: postInsurancePlanById$validate
x-operation-id-source: derived
/InsurancePlan/{id}/$meta-delete:
post:
tags:
- Insurance Plan
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: null
example: '123'
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: null
example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}"
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
summary: Create insurance plan by id $meta delete
x-summary-source: derived
operationId: postInsurancePlanById$metaDelete
x-operation-id-source: derived
/InsurancePlan/{id}/$meta-add:
post:
tags:
- Insurance Plan
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: null
example: '123'
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: null
example: "{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"meta\"\n } ]\n}"
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
summary: Create insurance plan by id $meta add
x-summary-source: derived
operationId: postInsurancePlanById$metaAdd
x-operation-id-source: derived
/InsurancePlan/$meta:
get:
tags:
- Insurance Plan
description: Request a list of tags, profiles, and security labels for a specfic resource instance
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
summary: Get insurance plan $meta
x-summary-source: derived
operationId: getInsurancePlan$meta
x-operation-id-source: derived
post:
tags:
- Insurance Plan
description: Request a list of tags, profiles, and security labels for a specfic resource instance
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: null
example: "{\n \"resourceType\": \"Parameters\"\n}"
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
summary: Create insurance plan $meta
x-summary-source: derived
operationId: postInsurancePlan$meta
x-operation-id-source: derived
/InsurancePlan/{id}/$meta:
get:
tags:
- Insurance Plan
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: null
example: '123'
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
summary: Get insurance plan by id $meta
x-summary-source: derived
operationId: getInsurancePlanById$meta
x-operation-id-source: derived
post:
tags:
- Insurance Plan
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: null
example: '123'
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: null
example: "{\n \"resourceType\": \"Parameters\"\n}"
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
summary: Create insurance plan by id $meta
x-summary-source: derived
operationId: postInsurancePlanById$meta
x-operation-id-source: derived
/InsurancePlan/$expunge:
post:
tags:
- Insurance Plan
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: null
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}"
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
summary: Create insurance plan $expunge
x-summary-source: derived
operationId: postInsurancePlan$expunge
x-operation-id-source: derived
/InsurancePlan/{id}/$expunge:
post:
tags:
- Insurance Plan
parameters:
- name: id
in: path
description: The resource ID
required: true
style: simple
schema:
minimum: 1
type: string
example: null
example: '123'
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: null
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}"
responses:
'200':
description: Success
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
summary: Create insurance plan by id $expunge
x-summary-source: derived
operationId: postInsurancePlanById$expunge
x-operation-id-source: derived
components:
schemas:
FHIR-JSON-RESOURCE:
type: object
description: A FHIR resource
example: null
FHIR-XML-RESOURCE:
type: object
description: A FHIR resource
example: null