Public (non-member) FHIR R4 API for Devoted's provider and pharmacy directory and drug formulary data. Resources: Practitioner, PractitionerRole, Organization, OrganizationAffiliation, Location, HealthcareService, InsurancePlan, MedicationKnowledge, and List. Served by a HAPI FHIR 6.6.0 server.
openapi: 3.0.1
info:
title: HAPI FHIR Server
contact: {}
version: 6.6.0
servers:
- url: https://fhir.devoted.com/fhir
description: HAPI FHIR Server
tags:
- name: System Level Operations
description: Server-level operations
- name: CodeSystem
description: The CodeSystem FHIR resource type
- name: HealthcareService
description: The HealthcareService 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: MedicationKnowledge
description: The MedicationKnowledge FHIR resource type
- name: OperationDefinition
description: The OperationDefinition FHIR resource type
- name: Organization
description: The Organization FHIR resource type
- name: OrganizationAffiliation
description: The OrganizationAffiliation FHIR resource type
- name: Practitioner
description: The Practitioner FHIR resource type
- name: PractitionerRole
description: The PractitionerRole FHIR resource type
- name: SearchParameter
description: The SearchParameter FHIR resource type
- name: StructureDefinition
description: The StructureDefinition FHIR resource type
- name: Subscription
description: The Subscription FHIR resource type
- name: ValueSet
description: The ValueSet 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'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
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
/_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'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
/$reindex:
post:
tags:
- System Level Operations
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: null
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "url",
"valueString": "example"
}, {
"name": "reindexSearchParameters",
"valueCode": "example"
}, {
"name": "optimizeStorage",
"valueCode": "example"
}, {
"name": "optimisticLock",
"valueBoolean": false
} ]
}
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
/$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: null
example: |-
{
"resourceType": "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
/$meta:
get:
tags:
- System Level Operations
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
post:
tags:
- System Level Operations
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: |-
{
"resourceType": "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
/$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: null
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "type",
"valueCode": "example"
} ]
}
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
/$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'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
post:
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"
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: null
example: |-
{
"resourceType": "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
/$expunge:
post:
tags:
- System Level Operations
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: null
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "limit",
"valueInteger": 0
}, {
"name": "expungeDeletedResources",
"valueBoolean": false
}, {
"name": "expungePreviousVersions",
"valueBoolean": false
}, {
"name": "expungeEverything",
"valueBoolean": false
} ]
}
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
/$reindex-terminology:
post:
tags:
- System Level Operations
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: null
example: |-
{
"resourceType": "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
/CodeSystem/$upload-external-code-system:
post:
tags:
- CodeSystem
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: null
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "system",
"valueUri": "example"
}, {
"name": "file"
} ]
}
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
/CodeSystem/$apply-codesystem-delta-remove:
post:
tags:
- CodeSystem
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: null
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "system",
"valueUri": "example"
}, {
"name": "file"
}, {
"name": "codeSystem"
} ]
}
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
/CodeSystem/$apply-codesystem-delta-add:
post:
tags:
- CodeSystem
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: null
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "system",
"valueUri": "example"
}, {
"name": "file"
}, {
"name": "codeSystem"
} ]
}
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
/HealthcareService/{id}:
get:
tags:
- HealthcareService
summary: "read-instance: Read HealthcareService 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
put:
tags:
- HealthcareService
summary: "update-instance: Update an existing HealthcareService 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: null
example: "123"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "HealthcareService"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: <HealthcareService 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
delete:
tags:
- HealthcareService
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
patch:
tags:
- HealthcareService
summary: "instance-patch: Patch a resource instance of type HealthcareService\
\ 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: |-
{
"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'
example: null
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: null
/HealthcareService/{id}/_history/{version_id}:
get:
tags:
- HealthcareService
summary: "vread-instance: Read HealthcareService 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
/HealthcareService:
get:
tags:
- HealthcareService
summary: "search-type: Search for HealthcareService instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: External identifiers for this item
style: simple
- name: specialty
in: query
description: The specialty of the service provided by this healthcare service
style: simple
- name: service-category
in: query
description: Service Category of the Healthcare Service
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: service-type
in: query
description: The type of service provided by this healthcare service
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: active
in: query
description: The Healthcare Service is currently marked as active
style: simple
- name: program
in: query
description: One of the Programs supported by this HealthcareService
style: simple
- name: characteristic
in: query
description: One of the HealthcareService's characteristics
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: endpoint
in: query
description: Technical endpoints providing access to electronic services operated
for the healthcare service
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: coverage-area
in: query
description: Location(s) service is intended for/available to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: organization
in: query
description: The organization that provides this Healthcare Service
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: A portion of the Healthcare service name
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: location
in: query
description: The location of the Healthcare Service
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
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
post:
tags:
- HealthcareService
summary: "create-type: Create a new HealthcareService instance"
requestBody:
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIR-JSON-RESOURCE'
example: |-
{
"resourceType": "HealthcareService"
}
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIR-XML-RESOURCE'
example: <HealthcareService 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
/HealthcareService/_history:
get:
tags:
- HealthcareService
summary: "type-history: Fetch the resource change history for all resources\
\ of type HealthcareService"
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
/HealthcareService/{id}/_history:
get:
tags:
- HealthcareService
summary: "instance-history: Fetch the resource change history for all resources\
\ of type HealthcareService"
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
/HealthcareService/_search:
get:
tags:
- HealthcareService
summary: "search-type: Search for HealthcareService instances"
description: This is a search type
parameters:
- name: identifier
in: query
description: External identifiers for this item
style: simple
- name: specialty
in: query
description: The specialty of the service provided by this healthcare service
style: simple
- name: service-category
in: query
description: Service Category of the Healthcare Service
style: simple
- name: _lastUpdated
in: query
description: When the resource version last changed
style: simple
- name: service-type
in: query
description: The type of service provided by this healthcare service
style: simple
- name: _security
in: query
description: Security Labels applied to this resource
style: simple
- name: active
in: query
description: The Healthcare Service is currently marked as active
style: simple
- name: program
in: query
description: One of the Programs supported by this HealthcareService
style: simple
- name: characteristic
in: query
description: One of the HealthcareService's characteristics
style: simple
- name: _filter
in: query
description: Search the contents of the resource's data using a filter
style: simple
- name: endpoint
in: query
description: Technical endpoints providing access to electronic services operated
for the healthcare service
style: simple
- name: _profile
in: query
description: Profiles this resource claims to conform to
style: simple
- name: coverage-area
in: query
description: Location(s) service is intended for/available to
style: simple
- name: _tag
in: query
description: Tags applied to this resource
style: simple
- name: organization
in: query
description: The organization that provides this Healthcare Service
style: simple
- name: _has
in: query
description: Return resources linked to by the given target
style: simple
- name: name
in: query
description: A portion of the Healthcare service name
style: simple
- name: _source
in: query
description: Identifies where the resource comes from
style: simple
- name: location
in: query
description: The location of the Healthcare Service
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
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
/HealthcareService/$validate:
get:
tags:
- HealthcareService
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
post:
tags:
- HealthcareService
requestBody:
content:
application/fhir+json:
schema:
title: FHIR Resource
type: object
example: null
example: |-
{
"resourceType": "Parameters",
"parameter": [ {
"name": "resource",
"resource": {
"resourceType": "HealthcareService",
"id": "1"
}
}, {
"name": "mode",
"valueCode": "example"
}, {
"name": "profile"
} ]
}
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
/HealthcareService/{id}/$validate:
get:
tags:
- HealthcareService
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
post:
tags:
- HealthcareService
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:
ti
# --- truncated at 32 KB (534 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/devoted-health/refs/heads/main/openapi/devoted-health-provider-directory-openapi-original.yml