openapi: 3.0.3
info:
title: FHIR fhir-r4-formulary-api FHIR R4 ProviderDirectory API API
version: 1.0.0
description: Formulary and Provider Directory API
tags:
- name: FHIR R4 ProviderDirectory API
paths:
/providerdirectory/api/Endpoint:
get:
operationId: search_endpoint
description: This interaction searches a set of resources based on some filter criteria.
summary: This interaction searches a set of resources based on some filter criteria.
parameters:
- in: query
name: _count
schema:
type: integer
maximum: 10000
minimum: 1
default: 20
title: ' count'
description: Maximum number of results to be returned
- in: query
name: _id
schema:
type: string
title: ' id'
minLength: 1
description: Resource id (not a full URL)
- in: query
name: _include
schema:
enum:
- Endpoint:organization
type: string
title: ' include'
minLength: 1
description: 'Return resources related to the search results (E.g. Endpoint:organization)
* `Endpoint:organization` - Endpoint:organization'
- in: query
name: _offset
schema:
type: integer
minimum: 0
default: 0
title: ' offset'
description: Number of results to be offset
- in: query
name: organization
schema:
type: string
minLength: 1
description: Select Endpoints managed by the specified organization
tags:
- FHIR R4 ProviderDirectory API
security:
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/EndpointSearchResponse'
examples:
JSONExample:
value:
resourceType: Bundle
id: 58704f4b-b975-4357-aa25-54eeb0083bc5
meta:
lastUpdated: '2021-06-11T07:58:26.312Z'
profile:
- http://hl7.org/fhir/StructureDefinition/Bundle
type: searchset
total: 2
link:
- relation: self
url: https://public-api.cloverhealth.com/providerdirectory/api/Endpoint
entry:
- fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/Endpoint/6d179858-2560-5ec6-a162-2205ab32f378
resource:
resourceType: Endpoint
id: 6d179858-2560-5ec6-a162-2205ab32f378
meta:
lastUpdated: '2021-06-10T00:00:00.000+00:00'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint
status: active
connectionType:
system: http://terminology.hl7.org/CodeSystem/endpoint-connection-type
code: hl7-fhir-rest
managingOrganization:
reference: Organization/c6672acb-ea60-5431-802d-c637901772d3
payloadType:
- coding:
- system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/EndpointPayloadTypeCS
code: NA
address: https://public-api.cloverhealth.com/providerdirectory/api/Location
search:
mode: match
- fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/Endpoint/d440e938-30ab-5d46-8005-5ba41160e098
resource:
resourceType: Endpoint
id: d440e938-30ab-5d46-8005-5ba41160e098
meta:
lastUpdated: '2021-06-10T00:00:00.000+00:00'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint
status: active
connectionType:
system: http://terminology.hl7.org/CodeSystem/endpoint-connection-type
code: hl7-fhir-rest
managingOrganization:
reference: Organization/c6672acb-ea60-5431-802d-c637901772d3
payloadType:
- coding:
- system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/EndpointPayloadTypeCS
code: NA
address: https://public-api.cloverhealth.com/providerdirectory/api/PractitionerRole
search:
mode: match
summary: JSON Example
description: '
EndpointBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language'
application/fhir+xml:
schema:
$ref: '#/components/schemas/EndpointSearchResponse'
examples:
XMLExample:
value: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"
summary: XML Example
description: '
EndpointBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language'
description: ''
/providerdirectory/api/Endpoint/{id}:
get:
operationId: get_endpoint
description: The read interaction accesses the current contents of a resource.
summary: The read interaction accesses the current contents of a resource.
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- FHIR R4 ProviderDirectory API
security:
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/EndpointGetResponse'
examples:
JSONExample:
value:
resourceType: Endpoint
id: 6d179858-2560-5ec6-a162-2205ab32f378
meta:
lastUpdated: '2021-06-10T00:00:00.000+00:00'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint
status: active
connectionType:
system: http://terminology.hl7.org/CodeSystem/endpoint-connection-type
code: hl7-fhir-rest
managingOrganization:
reference: Organization/c6672acb-ea60-5431-802d-c637901772d3
payloadType:
- coding:
- system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/EndpointPayloadTypeCS
code: NA
address: https://public-api.cloverhealth.com/providerdirectory/api/Location
summary: JSON Example
description: '
Endpoint
The technical details of an endpoint that can be used for electronic services Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension'
application/fhir+xml:
schema:
$ref: '#/components/schemas/EndpointGetResponse'
examples:
XMLExample:
value: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"
summary: XML Example
description: '
Endpoint
The technical details of an endpoint that can be used for electronic services Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension'
description: ''
/providerdirectory/api/HealthcareService:
get:
operationId: search_healthcare_service
description: This interaction searches a set of resources based on some filter criteria.
summary: This interaction searches a set of resources based on some filter criteria.
parameters:
- in: query
name: _count
schema:
type: integer
maximum: 10000
minimum: 1
default: 20
title: ' count'
description: Maximum number of results to be returned
- in: query
name: _id
schema:
type: string
title: ' id'
minLength: 1
description: Resource id (not a full URL)
- in: query
name: _include
schema:
enum:
- HealthcareService:location
- HealthcareService:coverage-area
- HealthcareService:organization
- HealthcareService:endpoint
type: string
title: ' include'
minLength: 1
description: 'Include resources related to the search results Supported(HealthcareService:location, HealthcareService:coverage-area, HealthcareService:organization, HealthcareService:endpoint)
* `HealthcareService:location` - HealthcareService:location
* `HealthcareService:coverage-area` - HealthcareService:coverage-area
* `HealthcareService:organization` - HealthcareService:organization
* `HealthcareService:endpoint` - HealthcareService:endpoint'
- in: query
name: _offset
schema:
type: integer
minimum: 0
default: 0
title: ' offset'
description: Number of results to be offset
- in: query
name: _revinclude
schema:
enum:
- PractitionerRole:service
- OrganizationAffiliation:service
type: string
title: ' revinclude'
minLength: 1
description: 'Include resource includes this location Supported(PractitionerRole:service, OrganizationAffiliation:service)
* `PractitionerRole:service` - PractitionerRole:service
* `OrganizationAffiliation:service` - OrganizationAffiliation:service'
- in: query
name: coverage-area
schema:
type: string
minLength: 1
description: The coverage area of the Healthcare Service
- in: query
name: identifier
schema:
type: string
minLength: 1
description: NPI for the Healthcare Service
- in: query
name: location
schema:
type: string
minLength: 1
description: The location of the Healthcare Service
- in: query
name: name
schema:
type: string
minLength: 1
description: A portion of the Healthcare service name
- in: query
name: organization
schema:
type: string
minLength: 1
description: The identity of the organization the healthcare service belong to.
- in: query
name: service-category
schema:
type: string
minLength: 1
description: Service Category of the Healthcare Service
- in: query
name: service-type
schema:
type: string
minLength: 1
description: Service Type of the Healthcare Service
- in: query
name: specialty
schema:
type: string
minLength: 1
description: Specialty of the Healthcare Service
tags:
- FHIR R4 ProviderDirectory API
security:
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/HealthcareServiceSearchResponse'
examples:
JSONExample:
value:
resourceType: Bundle
id: f686a47e-d199-4071-98e0-16891cd2cd55
meta:
lastUpdated: '2022-12-30T04:30:36.982Z'
type: searchset
total: 2
link:
- relation: self
url: https://public-api.cloverhealth.com/providerdirectory/api/HealthcareService
entry:
- fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/HealthcareService/00001c05-d3c7-5094-8ac3-fea55830942d
resource:
resourceType: HealthcareService
id: 00001c05-d3c7-5094-8ac3-fea55830942d
meta:
lastUpdated: '2022-12-25T00:00:00Z'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService
identifier:
- value: '1144513540'
system: http://hl7.org/fhir/sid/us-npi
active: true
extension:
- extension:
- url: type
valueCodeableConcept:
coding:
- system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/DeliveryMethodCS
url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method
category:
- coding:
- system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/HealthcareServiceCategoryCS
code: prov
type:
- coding:
- system: http://terminology.hl7.org/CodeSystem/service-type
code: '349'
location:
- reference: Location/e1578c9c-a885-5bed-9263-60b92fea4b44
name: Moyosoye Folayan Oyeyinka
telecom:
- extension:
- url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
valueReference:
reference: Location/e1578c9c-a885-5bed-9263-60b92fea4b44
specialty:
- coding:
- system: http://nucc.org/provider-taxonomy
code: 207R00000X
search:
mode: match
- fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/HealthcareService/00001c2f-35a7-5118-bb2c-3756317fa0db
resource:
resourceType: HealthcareService
id: 00001c2f-35a7-5118-bb2c-3756317fa0db
meta:
lastUpdated: '2022-12-25T00:00:00Z'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService
identifier:
- value: '1952337263'
system: http://hl7.org/fhir/sid/us-npi
active: true
extension:
- extension:
- url: type
valueCodeableConcept:
coding:
- system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/DeliveryMethodCS
url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method
category:
- coding:
- system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/HealthcareServiceCategoryCS
code: outpat
type:
- coding:
- system: http://terminology.hl7.org/CodeSystem/service-type
code: '335'
location:
- reference: Location/c263b088-f3e8-5114-9971-0e8ff6226c74
providedBy:
reference: Organization/54b466ed-7ea1-59d0-9437-2afe7354470d
name: South Texas Rural Health Services Inc
telecom:
- extension:
- url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
valueReference:
reference: Location/c263b088-f3e8-5114-9971-0e8ff6226c74
specialty:
- coding:
- system: http://nucc.org/provider-taxonomy
code: 261QM1300X
search:
mode: match
summary: JSON Example
description: 'HealthcareServiceBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language'
application/fhir+xml:
schema:
$ref: '#/components/schemas/HealthcareServiceSearchResponse'
examples:
XMLExample:
value: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"
summary: XML Example
description: 'HealthcareServiceBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language'
description: ''
/providerdirectory/api/HealthcareService/{id}:
get:
operationId: get_healthcare_service
description: The read interaction accesses the current contents of a resource.
summary: The read interaction accesses the current contents of a resource.
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- FHIR R4 ProviderDirectory API
security:
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/HealthcareServiceGetResponse'
examples:
JSONExample:
value:
resourceType: HealthcareService
id: 00001c05-d3c7-5094-8ac3-fea55830942d
meta:
lastUpdated: '2022-12-25T00:00:00Z'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService
identifier:
- value: '1144513540'
system: http://hl7.org/fhir/sid/us-npi
active: true
extension:
- extension:
- url: type
valueCodeableConcept:
coding:
- system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/DeliveryMethodCS
url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method
category:
- coding:
- system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/HealthcareServiceCategoryCS
code: prov
type:
- coding:
- system: http://terminology.hl7.org/CodeSystem/service-type
code: '349'
location:
- reference: Location/e1578c9c-a885-5bed-9263-60b92fea4b44
name: Moyosoye Folayan Oyeyinka
telecom:
- extension:
- url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
valueReference:
reference: Location/e1578c9c-a885-5bed-9263-60b92fea4b44
specialty:
- coding:
- system: http://nucc.org/provider-taxonomy
code: 207R00000X
summary: JSON Example
description: 'HealthcareService
The details of a healthcare service available at a location Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension'
application/fhir+xml:
schema:
$ref: '#/components/schemas/HealthcareServiceGetResponse'
examples:
XMLExample:
value: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"
summary: XML Example
description: 'HealthcareService
The details of a healthcare service available at a location Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension'
description: ''
/providerdirectory/api/InsurancePlan:
get:
operationId: search_insurance_plan
description: This interaction searches a set of resources based on some filter criteria.
summary: This interaction searches a set of resources based on some filter criteria.
parameters:
- in: query
name: _count
schema:
type: integer
maximum: 10000
minimum: 1
default: 20
title: ' count'
description: Maximum number of results to be returned
- in: query
name: _id
schema:
type: string
title: ' id'
minLength: 1
description: Resource id (not a full URL)
- in: query
name: _include
schema:
enum:
- InsurancePlan:administered-by
- InsurancePlan:owned-by
- InsurancePlan:coverage-area
type: string
title: ' include'
minLength: 1
description: 'Include resources related to the search results Supported(InsurancePlan:administered-by, InsurancePlan:owned-by, InsurancePlan:coverage-area)
* `InsurancePlan:administered-by` - InsurancePlan:administered-by
* `InsurancePlan:owned-by` - InsurancePlan:owned-by
* `InsurancePlan:coverage-area` - InsurancePlan:coverage-area'
- in: query
name: _offset
schema:
type: integer
minimum: 0
default: 0
title: ' offset'
description: Number of results to be offset
- in: query
name: administered-by
schema:
type: string
minLength: 1
description: The organization that administer the plan.
- in: query
name: coverage-area
schema:
type: string
minLength: 1
description: The coverage area of the plan.
- in: query
name: identifier
schema:
type: string
minLength: 1
description: Clover Healthc plan id.
- in: query
name: name
schema:
type: string
minLength: 1
description: A portion of the plan name
- in: query
name: network
schema:
type: string
minLength: 1
description: The network of the plan
- in: query
name: owned-by
schema:
type: string
minLength: 1
description: An organization that owns the plan.
- in: query
name: type
schema:
type: string
minLength: 1
description: The type of the plan.
tags:
- FHIR R4 ProviderDirectory API
security:
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/InsurancePlanSearchResponse'
examples:
JSONExample:
value:
resourceType: Bundle
id: 9db60664-0830-4308-8463-25aee122b0e9
meta:
lastUpdated: '2023-01-04T02:41:05.527Z'
type: searchset
total: 2
link:
- relation: self
url: https://public-api.cloverhealth.com/providerdirectory/api/InsurancePlan
entry:
- fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/InsurancePlan/1a18601c-8d0d-516b-98c0-d2b2e22333ef
resource:
resourceType: InsurancePlan
id: 1a18601c-8d0d-516b-98c0-d2b2e22333ef
meta:
lastUpdated: '2023-01-01T00:00:00Z'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-InsurancePlan
identifier:
- system: https://www.cloverhealth.com/plans
value: '025'
status: active
type:
- coding:
- system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/InsuranceProductTypeCS
code: mediadv
ownedBy:
reference: Organization/c6672acb-ea60-5431-802d-c637901772d3
administeredBy:
reference: Organization/c6672acb-ea60-5431-802d-c637901772d3
network:
- reference: Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056
coverageArea:
- reference: Location/0168d57c-c36a-5fd3-b75f-ee126728d852
- reference: Location/40e711c5-c4c0-57db-a36e-17eb48c5d49e
- reference: Location/415eddd7-40aa-5bd9-aa31-07be1eb01225
- reference: Location/43d6521e-d2d4-5968-8b94-15a43030e027
- reference: Location/7e6f3e39-1e5c-52e8-b860-6b882dcb10af
- reference: Location/be5c8d0c-893f-5b27-8501-6b1f6ea8685a
- reference: Location/f03c0028-4e46-5adb-b39b-0b83efe8d9a6
name: Clover Health Choice (PPO)
search:
mode: match
- fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/InsurancePlan/2017b48f-bb3f-5c13-9499-eed6f0c68049
resource:
resourceType: InsurancePlan
id: 2017b48f-bb3f-5c13-9499-eed6f0c68049
meta:
lastUpdated: '2023-01-01T00:00:00Z'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-InsurancePlan
identifier:
- system: https://www.cloverhealth.com/plans
value: '007'
status: active
type:
- coding:
- system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/InsuranceProductTypeCS
code: mediadv
ownedBy:
reference: Organization/c6672acb-ea60-5431-802d-c637901772d3
administeredBy:
reference: Organization/c6672acb-ea60-5431-802d-c637901772d3
network:
- reference: Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056
coverageArea:
- reference: Location/2ca7813e-9c8a-5dc5-90cd-e5c17020dc82
- reference: Location/3b619aa6-e10f-5530-8282-a3965a8d668a
- reference: Location/43f446d2-0507-53ad-9ce9-7621343f168e
- reference: Location/481e6ae8-1961-59a5-8e5f-8231fdf31fc5
- reference: Location/51d056a7-2dbf-520c-ad85-6d9e2233be43
- reference: Location/646dfb92-f112-5261-98aa-689a0cb4f7ec
- reference: Location/98181050-9066-5ae8-a21c-fc356931d502
- reference: Location/a284c28a-b5b5-532a-8eda-9b74a9825b04
- reference: Location/a38eb4f4-1696-582b-a3f9-afd430932521
- reference: Location/c24b5a32-ac0b-5bb9-a60b-4021970fbeae
- reference: Location/cc5549d6-68ef-5565-80f0-941bea2cc482
- reference: Location/d5a0240f-1a2d-51a2-bc37-1bcbe748c3e7
name: Clover Health Choice Value (PPO)
search:
mode: match
summary: JSON Example
description: 'InsurancePlanBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language
'
application/fhir+xml:
schema:
$ref: '#/components/schemas/InsurancePlanSearchResponse'
examples:
XMLExample:
value: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"
summary: XML Example
description: 'InsurancePlanBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language
'
description: ''
/providerdirectory/api/InsurancePlan/{id}:
get:
operationId: get_insurance_plan
description: The read interaction accesses the current contents of a resource.
summary: The read interaction accesses the current contents of a resource.
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- FHIR R4 ProviderDirectory API
security:
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/InsurancePlanGetResponse'
examples:
JSONExample:
value:
resourceType: InsurancePlan
id: 1a18601c-8d0d-516b-98c0-d2b2e22333ef
meta:
lastUpdated: '2023-01-01T00:00:00Z'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-InsurancePlan
identifier:
- system: https://www.cloverhealth.com/plans
value: '025'
status: active
type:
- coding:
- system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/InsuranceProductTypeCS
code: mediadv
ownedBy:
reference: Organization/c6672acb-ea60-5431-802d-c637901772d3
administeredBy:
reference: Organization/c6672acb-ea60-5431-802d-c637901772d3
network:
- reference: Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056
coverageArea:
- reference: Location/0168d57c-c36a-5fd3-b75f-ee126728d852
- reference: Location/40e711c5-c4c0-57db-a36e-17eb48c5d49e
- reference: Location/415eddd7-40aa-5bd9-aa31-07be1eb01225
- reference: Location/43d6521e-d2d4-5968-8b94-15a43030e027
- reference: Location/7e6f3e39-1e5c-52e8-b860-6b882dcb10af
- reference: Location/be5c8d0c-893f-5b27-8501-6b1f6ea8685a
- reference: Location/f03c0028-4e46-5adb-b39b-0b83efe8d9a6
name: Clover Health Choice (PPO)
summary: JSON Example
description: 'InsurancePlan
Details of a Health Insurance product/plan provided by an organization.
- Rule: The organization SHALL at least have a name or an idendtifier, and possibly more than one Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension'
application/fhir+xml:
schema:
$ref: '#/components/schemas/InsurancePlanGetResponse'
examples:
XMLExample:
value: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"
summary: XML Example
description: 'InsurancePlan
Details of a Health Insurance product/plan provided by an organization.
- Rule: The organization SHALL at least have a name or an idendtifier, and possibly more than one Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension'
description: ''
/providerdirectory/api/Location:
get:
operationId: search_location
description: This interaction searches a set of resources based on some filter criteria.
summary: This interaction searches a set of resources based on some filter criteria.
parameters:
- in: query
name: _count
schema:
type: integer
maximum: 10000
minimum: 1
default: 20
title: ' count'
description: Maximum number of results to be returned
- in: query
name: _id
schema:
type: string
title: ' id'
minLength: 1
description: Resource id (not a full URL)
- in: query
name: _include
schema:
enum:
- Location:endpoint
- Location:organization
- Location:partof
type: string
title: ' include'
minLength: 1
description: 'Include resources related to the search results Supported(Location:organization, Location:partof)
* `Location:endpoint` - Location:endpoint
* `Location:organization` - Location:organization
* `Location:partof` - Location:partof'
- in: query
name: _offset
schema:
type: integer
minimum: 0
default: 0
title: ' offset'
description: Number of results to be offset
- in: query
name: _revinclude
schema:
enum:
- HealthcareService:location
- InsurancePlan:coverage-area
- OrganizationAffiliation:location
- PractitionerRole:location
type: string
title: ' revinclude'
minLength: 1
description: 'Include resource includes this location Supported(HealthcareService:location, InsurancePlan:coverage-area, OrganizationAffiliation:location, PractitionerRole:location)
* `HealthcareService:location` - HealthcareService:location
* `InsurancePlan:coverage-area` - InsurancePlan:coverage-area
* `OrganizationAffiliation:location` - OrganizationAffiliation:location
* `PractitionerRole:location` - PractitionerRole:location'
- in: query
name: address
schema:
type: string
minLength: 1
description: A (part of the) address of the location
- in: query
name: address-city
schema:
type: string
minLength: 1
description: A city specified in an address
- in: query
name: address-postalcode
schema:
type: string
minLength: 1
description: A state specified in an address
- in: query
name: address-state
schema:
type: string
minLength: 1
description: A postalCode specified in an address
- in: query
name: name
schema:
type: string
minLength: 1
description: Name of the location
- in: query
name: near
schema:
type: string
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
- in: query
name: organization
schema:
type: string
minLength: 1
description: The identity of the organization the location belong to.
- in: query
name: partof
schema:
type: string
minLength: 1
description: The id of the location that the matched one is physically part of.
- in: query
name: type
schema:
type: string
minLength: 1
description: The type of the location.
tags:
- FHIR R4 ProviderDirectory API
security:
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/LocationSearchResponse'
examples:
JSONExample:
value:
resourceType: Bundle
id: 82dfaff0-fa91-4522-a566-a7c91dcf3500
meta:
lastUpdated: '2021-06-14T16:35:52.135Z'
type: searchset
total: 2
link:
- relation: self
url: https://public-api.cloverhealth.com/providerdirectory/api/Location
entry:
- fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/Location/00003100-fe74-568b-b7c8-47db031b508d
resource:
resourceType: Location
id: 00003100-fe74-568b-b7c8-47db031b508d
meta:
lastUpdated: '2021-06-14T00:00:00Z'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location
text:
status: generated
div:
status: active
name: Chattanooga Hamilton County Hospital Authority
type:
- coding:
- system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
code: HOSP
telecom:
- system: phone
value: '4237782867'
use: work
address:
line:
- 979 E 3rd St Ste A440
city: Chattanooga
state: TN
postalCode: '37403'
position:
longitude: -85.29039
latitude: 35.0478
managingOrganization:
reference: Organization/216fed38-1f68-552a-9e24-db0b52fd9d71
partOf:
reference: Location/cf2e814e-8393-5d56-bb32-33fdb45b1f97
search:
mode: match
summary: JSON Example
description: 'LocationBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language
'
application/fhir+xml:
schema:
$ref: '#/components/schemas/LocationSearchResponse'
examples:
XMLExample:
value: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"
summary: XML Example
description: 'LocationBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language
'
description: ''
/providerdirectory/api/Location/{id}:
get:
operationId: get_location
description: The read interaction accesses the current contents of a resource.
summary: The read interaction accesses the current contents of a resource.
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- FHIR R4 ProviderDirectory API
security:
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/LocationGetResponse'
examples:
JSONExample:
value:
resourceType: Location
id: 00003100-fe74-568b-b7c8-47db031b508d
meta:
lastUpdated: '2021-06-14T00:00:00Z'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location
text:
status: generated
div:
WALGREENS
status: active
name: WALGREENS
type:
- coding:
- system: http://terminology.hl7.org/CodeSystem/v3-RoleCode
code: PHARM
telecom:
- system: phone
value: 615-781-6489
use: work
address:
line:
- 5429 Nolensville Pike
city: Nashville
state: TN
postalCode: '37211'
position:
longitude: -86.71516
latitude: 36.04969
partOf:
reference: Location/2938bd9d-9c51-5fe7-a2ed-62247ddc7c8f
summary: JSON Example
description: 'Location
Practitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this Resource is used for attribution of activities and responsibilities to these individuals.
'
application/fhir+xml:
schema:
$ref: '#/components/schemas/LocationGetResponse'
examples:
XMLExample:
value: "\n\n \n \n \n \n \n \n \n
J&M PHARMACY
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"
summary: XML Example
description: 'Location
Practitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this Resource is used for attribution of activities and responsibilities to these individuals.
'
description: ''
/providerdirectory/api/Organization:
get:
operationId: search_organization
description: This interaction searches a set of resources based on some filter criteria.
summary: This interaction searches a set of resources based on some filter criteria.
parameters:
- in: query
name: _count
schema:
type: integer
maximum: 10000
minimum: 1
default: 20
title: ' count'
description: Maximum number of results to be returned
- in: query
name: _id
schema:
type: string
title: ' id'
minLength: 1
description: Resource id (not a full URL)
- in: query
name: _include
schema:
enum:
- Organization:partof
- Organization:endpoint
- Organization:coverage-area
type: string
title: ' include'
minLength: 1
description: 'Return resources related to the search results (E.g. Organization:partof, Organization:endpoint and Organization:coverage-area (Not effective))
* `Organization:partof` - Organization:partof
* `Organization:endpoint` - Organization:endpoint
* `Organization:coverage-area` - Organization:coverage-area'
- in: query
name: _offset
schema:
type: integer
minimum: 0
default: 0
title: ' offset'
description: Number of results to be offset
- in: query
name: _revinclude
schema:
enum:
- Endpoint:organization
- HealthcareService:organization
- InsurancePlan:administered-by
- InsurancePlan:owned-by
- OrganizationAffiliation:primary-organization
- OrganizationAffiliation:participating-organization
- PractitionerRole:organization
- PractitionerRole:network
type: string
title: ' revinclude'
minLength: 1
description: 'Return resources filtered by the search results (E.g. Endpoint:Organization, HealthcareService:organization, InsurancePlan:administered-by (Not effective), InsurancePlan:owned-by (Not effective), PractitionerRole:organization, PractitionerRole:network, OrganizationAffiliation:primary-organization, OrganizationAffiliation:participating-organization)
* `Endpoint:organization` - Endpoint:organization
* `HealthcareService:organization` - HealthcareService:organization
* `InsurancePlan:administered-by` - InsurancePlan:administered-by
* `InsurancePlan:owned-by` - InsurancePlan:owned-by
* `OrganizationAffiliation:primary-organization` - OrganizationAffiliation:primary-organization
* `OrganizationAffiliation:participating-organization` - OrganizationAffiliation:participating-organization
* `PractitionerRole:organization` - PractitionerRole:organization
* `PractitionerRole:network` - PractitionerRole:network'
- in: query
name: address
schema:
type: string
minLength: 1
description: Select organizations with the specified address (matches any of the string elements of an address) (case insensitive)
- in: query
name: coverage-area
schema:
type: string
minLength: 1
description: (Not effective due to lack of data) Select health insurance provider networks available in a region described by the specified location
- in: query
name: endpoint
schema:
type: string
minLength: 1
description: Select organizations with the specified endpoint (in terms of endpoint ID)
- in: query
name: name
schema:
type: string
minLength: 1
description: Select organizations with the specified name (matches any of portion of the name) (case insensitive)
- in: query
name: partof
schema:
type: string
minLength: 1
description: Select organizations that are part of the organization (in terms of organization ID)
- in: query
name: type
schema:
type: string
minLength: 1
description: Select organizations of the specified type (E.g. fac, prvgrp, ins, ntwk)
tags:
- FHIR R4 ProviderDirectory API
security:
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/OrganizationSearchResponse'
examples:
JSONExample:
value:
resourceType: Bundle
id: e2100c91-eb92-48ff-8bd6-4bee39c5156d
meta:
lastUpdated: '2021-06-11T00:48:03.465+08:00'
profile:
- http://hl7.org/fhir/StructureDefinition/Bundle
type: searchset
total: 1
link:
- relation: self
url: https://public-api.cloverhealth.com/providerdirectory/api/Organization
entry:
- fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/Organization/c6672acb-ea60-5431-802d-c637901772d3
resource:
resourceType: Organization
id: c6672acb-ea60-5431-802d-c637901772d3
meta:
lastUpdated: '2021-06-10T00:00:00.000+00:00'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization
active: true
type:
- coding:
- system: http://terminology.hl7.org/CodeSystem/organization-type
code: ins
name: Clover Health
telecom:
- system: phone
value: 1-800-836-6890 (TTY 711)
endpoint:
- reference: Endpoint/6d179858-2560-5ec6-a162-2205ab32f378
- reference: Endpoint/d440e938-30ab-5d46-8005-5ba41160e098
- reference: Endpoint/d0ad6fdc-e3c3-5e4e-9e58-ba03f0890acf
- reference: Endpoint/6de7294f-0c82-58b3-aa63-ed25a48e71eb
- reference: Endpoint/4e9e6ab5-acf5-568b-b186-c81a81f9f859
- reference: Endpoint/0dfc6e13-bb9f-562c-8954-35c426feea0b
- reference: Endpoint/8fcc05e9-2b5d-59be-86af-2fc0b4910ce0
- reference: Endpoint/ea64c0b3-b041-51cd-9ac8-b9f230cccfa7
search:
mode: match
summary: JSON Example
description: 'OrganizationBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language'
application/fhir+xml:
schema:
$ref: '#/components/schemas/OrganizationSearchResponse'
examples:
XMLExample:
value: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n"
summary: XML Example
description: 'OrganizationBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language'
description: ''
/providerdirectory/api/Organization/{id}:
get:
operationId: get_organization
description: The read interaction accesses the current contents of a resource.
summary: The read interaction accesses the current contents of a resource.
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- FHIR R4 ProviderDirectory API
security:
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/OrganizationGetResponse'
examples:
JSONExample:
value:
resourceType: Organization
id: c6672acb-ea60-5431-802d-c637901772d3
meta:
lastUpdated: '2021-06-10T00:00:00.000+00:00'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization
active: true
type:
- coding:
- system: http://terminology.hl7.org/CodeSystem/organization-type
code: ins
name: Clover Health
telecom:
- system: phone
value: 1-800-836-6890 (TTY 711)
endpoint:
- reference: Endpoint/6d179858-2560-5ec6-a162-2205ab32f378
- reference: Endpoint/d440e938-30ab-5d46-8005-5ba41160e098
- reference: Endpoint/d0ad6fdc-e3c3-5e4e-9e58-ba03f0890acf
- reference: Endpoint/6de7294f-0c82-58b3-aa63-ed25a48e71eb
- reference: Endpoint/4e9e6ab5-acf5-568b-b186-c81a81f9f859
- reference: Endpoint/0dfc6e13-bb9f-562c-8954-35c426feea0b
- reference: Endpoint/8fcc05e9-2b5d-59be-86af-2fc0b4910ce0
- reference: Endpoint/ea64c0b3-b041-51cd-9ac8-b9f230cccfa7
summary: JSON Example
description: 'Organization
This profile sets minimum expectations for the Organization resource to searching for and fetching a Organization associated with a patient or provider. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.
Example Usage Scenarios:
The following are example usage scenarios for the US Core-Organization profile:
Query by organization name or NPI Mandatory and Must Support Data Elements The following data-elements are mandatory (i.e data MUST be present) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each Organization must have:
A status of the organization A name Each Organization must support:
An identifier National Provider Identifier (NPI) for organizations Clinical Laboratory Improvement Amendments (CLIA) for laboratories. A list of contact information Profile specific implementation guidance:
none Examples Organization-acme-lab
Organization-with-EndPoint
Formal Views of Profile Content Description of Profiles, Differentials, and Snapshots.
A grouping of people or organizations with a common purpose
- Rule: The organization SHALL at least have a name or an identifier, and possibly more than one Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
'
application/fhir+xml:
schema:
$ref: '#/components/schemas/OrganizationGetResponse'
examples:
XMLExample:
value: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"
summary: XML Example
description: 'Organization
This profile sets minimum expectations for the Organization resource to searching for and fetching a Organization associated with a patient or provider. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.
Example Usage Scenarios:
The following are example usage scenarios for the US Core-Organization profile:
Query by organization name or NPI Mandatory and Must Support Data Elements The following data-elements are mandatory (i.e data MUST be present) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each Organization must have:
A status of the organization A name Each Organization must support:
An identifier National Provider Identifier (NPI) for organizations Clinical Laboratory Improvement Amendments (CLIA) for laboratories. A list of contact information Profile specific implementation guidance:
none Examples Organization-acme-lab
Organization-with-EndPoint
Formal Views of Profile Content Description of Profiles, Differentials, and Snapshots.
A grouping of people or organizations with a common purpose
- Rule: The organization SHALL at least have a name or an identifier, and possibly more than one Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
'
description: ''
/providerdirectory/api/OrganizationAffiliation:
get:
operationId: search_organization_affiliation
description: This interaction searches a set of resources based on some filter criteria.
summary: This interaction searches a set of resources based on some filter criteria.
parameters:
- in: query
name: _count
schema:
type: integer
maximum: 10000
minimum: 1
default: 20
title: ' count'
description: Maximum number of results to be returned
- in: query
name: _id
schema:
type: string
title: ' id'
minLength: 1
description: Resource id (not a full URL)
- in: query
name: _include
schema:
enum:
- OrganizationAffiliation:primary-organization
- OrganizationAffiliation:participating-organization
- OrganizationAffiliation:location
- OrganizationAffiliation:service
- OrganizationAffiliation:endpoint
- OrganizationAffiliation:network
type: string
title: ' include'
minLength: 1
description: 'Return resources related to the search results (E.g. OrganizationAffiliation:location, OrganizationAffiliation:service, OrganizationAffiliation:network and OrganizationAffiliation:endpoint (Not effective))
* `OrganizationAffiliation:primary-organization` - OrganizationAffiliation:primary-organization
* `OrganizationAffiliation:participating-organization` - OrganizationAffiliation:participating-organization
* `OrganizationAffiliation:location` - OrganizationAffiliation:location
* `OrganizationAffiliation:service` - OrganizationAffiliation:service
* `OrganizationAffiliation:endpoint` - OrganizationAffiliation:endpoint
* `OrganizationAffiliation:network` - OrganizationAffiliation:network'
- in: query
name: _offset
schema:
type: integer
minimum: 0
default: 0
title: ' offset'
description: Number of results to be offset
- in: query
name: endpoint
schema:
type: string
minLength: 1
description: (Not effective) Select OrganizationAffiliations with the specified endpoint
- in: query
name: location
schema:
type: string
minLength: 1
description: Select OrganizationAffiliations available at the specified location (in terms of location ID)
- in: query
name: network
schema:
type: string
minLength: 1
description: Select roles where the organization is a member of the specified health insurance provider network (in terms of organization ID)
- in: query
name: participating-organization
schema:
type: string
minLength: 1
description: Select roles filled by the specified organization (in terms of organization ID)
- in: query
name: primary-organization
schema:
type: string
minLength: 1
description: Select roles offered by the specified organization (in terms of organization ID)
- in: query
name: role
schema:
type: string
minLength: 1
description: Select OrganizationAffiliations with the specified role code
- in: query
name: service
schema:
type: string
minLength: 1
description: Select OrganizationAffiliations providing the specified service (in terms of healthcare service ID)
- in: query
name: specialty
schema:
type: string
minLength: 1
description: Select OrganizationAffiliations associated with the specified specialty code
tags:
- FHIR R4 ProviderDirectory API
security:
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/OrganizationAffiliationSearchResponse'
examples:
JSONExample:
value:
resourceType: Bundle
id: a3c5d710-1777-4cef-a27b-85b52adde720
meta:
lastUpdated: '2021-06-11T08:15:57.387Z'
profile:
- http://hl7.org/fhir/StructureDefinition/Bundle
type: searchset
total: 2
link:
- relation: self
url: https://public-api.cloverhealth.com/providerdirectory/api/OrganizationAffiliation
entry:
- fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/OrganizationAffiliation/aefac026-bbfc-5545-b6d6-21d30063ae02
resource:
resourceType: OrganizationAffiliation
id: aefac026-bbfc-5545-b6d6-21d30063ae02
meta:
lastUpdated: '2021-06-11T00:00:00.000+00:00'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation
active: true
period:
start: '2013-01-01'
organization:
reference: Organization/d9110c8e-2f8a-5966-b52b-0e08aab0767c
display: University Physician Associates of New Jersey Inc
participatingOrganization:
reference: Organization/10f286ae-8f33-50e4-bd4b-ba8270cc0f7d
display: ARMEHTAMD PAINANDDISABILITYINSTITUTE PC
network:
- reference: Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056
code:
- coding:
- system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrganizationAffiliationRoleCS
code: bt
specialty:
- coding:
- system: http://nucc.org/provider-taxonomy
code: 208100000X
location:
- reference: Location/a5454e38-857d-5f3e-b1a7-0b917b563762
- reference: Location/686d41ce-6486-5e13-b211-23417e86a8b9
healthcareService:
- reference: HealthcareService/7553cbe1-b26f-5255-b0c2-42029e66d368
search:
mode: match
- fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/OrganizationAffiliation/9d9c8b8a-c490-5dd1-b550-f5b0d1b4fc3a
resource:
resourceType: OrganizationAffiliation
id: 9d9c8b8a-c490-5dd1-b550-f5b0d1b4fc3a
meta:
lastUpdated: '2021-06-11T00:00:00.000+00:00'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation
active: true
period:
start: '2018-03-21'
organization:
reference: Organization/09f01493-5f3a-5db0-afaf-e8b789371e7c
display: University Rehabilitation Associates
participatingOrganization:
reference: Organization/10f286ae-8f33-50e4-bd4b-ba8270cc0f7d
display: ARMEHTAMD PAINANDDISABILITYINSTITUTE PC
network:
- reference: Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056
code:
- coding:
- system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrganizationAffiliationRoleCS
code: bt
specialty:
- coding:
- system: http://nucc.org/provider-taxonomy
code: 208100000X
location:
- reference: Location/e33dd5aa-613e-5731-ad69-4a7bb9c659c1
- reference: Location/686d41ce-6486-5e13-b211-23417e86a8b9
healthcareService:
- reference: HealthcareService/7553cbe1-b26f-5255-b0c2-42029e66d368
search:
mode: match
summary: JSON Example
description: '
OrganizationAffiliationBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language
'
application/fhir+xml:
schema:
$ref: '#/components/schemas/OrganizationAffiliationSearchResponse'
examples:
XMLExample:
value: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"
summary: XML Example
description: '
OrganizationAffiliationBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language
'
description: ''
/providerdirectory/api/OrganizationAffiliation/{id}:
get:
operationId: get_organization_affiliation
description: The read interaction accesses the current contents of a resource.
summary: The read interaction accesses the current contents of a resource.
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- FHIR R4 ProviderDirectory API
security:
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/OrganizationAffiliationGetResponse'
examples:
JSONExample:
value:
resourceType: OrganizationAffiliation
id: aefac026-bbfc-5545-b6d6-21d30063ae02
meta:
lastUpdated: '2021-06-11T00:00:00.000+00:00'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation
active: true
period:
start: '2013-01-01'
organization:
reference: Organization/d9110c8e-2f8a-5966-b52b-0e08aab0767c
display: University Physician Associates of New Jersey Inc
participatingOrganization:
reference: Organization/10f286ae-8f33-50e4-bd4b-ba8270cc0f7d
display: ARMEHTAMD PAINANDDISABILITYINSTITUTE PC
network:
- reference: Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056
code:
- coding:
- system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrganizationAffiliationRoleCS
code: bt
specialty:
- coding:
- system: http://nucc.org/provider-taxonomy
code: 208100000X
location:
- reference: Location/a5454e38-857d-5f3e-b1a7-0b917b563762
- reference: Location/686d41ce-6486-5e13-b211-23417e86a8b9
healthcareService:
- reference: HealthcareService/7553cbe1-b26f-5255-b0c2-42029e66d368
summary: JSON Example
description: 'OrganizationAffiliation
Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension'
application/fhir+xml:
schema:
$ref: '#/components/schemas/OrganizationAffiliationGetResponse'
examples:
XMLExample:
value: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n"
summary: XML Example
description: 'OrganizationAffiliation
Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension'
description: ''
/providerdirectory/api/Practitioner:
get:
operationId: search_practitioner
description: This interaction searches a set of resources based on some filter criteria.
summary: This interaction searches a set of resources based on some filter criteria.
parameters:
- in: query
name: _count
schema:
type: integer
maximum: 10000
minimum: 1
default: 20
title: ' count'
description: Maximum number of results to be returned
- in: query
name: _id
schema:
type: string
title: ' id'
minLength: 1
description: Resource id (not a full URL)
- in: query
name: _offset
schema:
type: integer
minimum: 0
default: 0
title: ' offset'
description: Number of results to be offset
- in: query
name: _revinclude
schema:
enum:
- PractitionerRole:practitioner
type: string
title: ' revinclude'
minLength: 1
description: 'Include resources related to the search results Supported(PractitionerRole:practitioner)
* `PractitionerRole:practitioner` - PractitionerRole:practitioner'
- in: query
name: family
schema:
type: string
minLength: 1
description: Practitioner's family name
- in: query
name: given
schema:
type: string
minLength: 1
description: Practitioner's given name
- in: query
name: identifier
schema:
type: string
minLength: 1
description: A practitioner's Identifier (NPI)
- in: query
name: name
schema:
type: string
minLength: 1
description: A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
tags:
- FHIR R4 ProviderDirectory API
security:
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/PractitionerSearchResponse'
examples:
JSONExample:
value:
resourceType: Bundle
id: 53d6ab1b-50fe-4140-8586-4e388e1890c2
meta:
lastUpdated: '2021-06-14T16:31:35.904Z'
type: searchset
total: 2
link:
- relation: self
url: https://public-api.cloverhealth.com/provider-directory/api/Practitioner
entry:
- fullUrl: https://public-api.cloverhealth.com/provider-directory/api/Practitioner/15d1c138-91e4-5c7e-bcde-b0cbafa0dffa
resource:
resourceType: Practitioner
id: 15d1c138-91e4-5c7e-bcde-b0cbafa0dffa
meta:
lastUpdated: '2021-06-14T00:00:00Z'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner
text:
status: generated
div:
identifier:
- system: http://hl7.org/fhir/sid/us-npi
value: '1437172111'
active: true
name:
- family: Brooks
given:
- Ira
telecom:
- extension:
- url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
id: 1cdaedef-a9cf-5166-83f3-3c5a03f2ef90
valueReference:
reference: Location/1cdaedef-a9cf-5166-83f3-3c5a03f2ef90
gender: male
communication:
- coding:
- system: http://terminology.hl7.org/CodeSystem/iso639-3
code: eng
text: eng
search:
mode: match
summary: JSON Example
description: 'PractitionerBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language
'
application/fhir+xml:
schema:
$ref: '#/components/schemas/PractitionerSearchResponse'
examples:
XMLExample:
value: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"
summary: XML Example
description: 'PractitionerBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language
'
description: ''
/providerdirectory/api/Practitioner/{id}:
get:
operationId: get_practitioner
description: The read interaction accesses the current contents of a resource.
summary: The read interaction accesses the current contents of a resource.
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- FHIR R4 ProviderDirectory API
security:
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/PractitionerGetResponse'
examples:
JSONExample:
value:
resourceType: Practitioner
id: 47ba253a-33cb-5681-8406-0050edcaec83
meta:
lastUpdated: '2021-06-14T00:00:00Z'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner
text:
status: generated
div:
Ira M Brooks
identifier:
- system: http://hl7.org/fhir/sid/us-npi
value: '1437172111'
active: true
name:
- family: Brooks
given:
- Ira
telecom:
- extension:
- url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
id: 1cdaedef-a9cf-5166-83f3-3c5a03f2ef90
valueReference:
reference: Location/1cdaedef-a9cf-5166-83f3-3c5a03f2ef90
gender: male
communication:
- coding:
- system: http://terminology.hl7.org/CodeSystem/iso639-3
code: eng
text: eng
summary: JSON Example
description: 'Practitioner
Practitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this Resource is used for attribution of activities and responsibilities to these individuals.
'
application/fhir+xml:
schema:
$ref: '#/components/schemas/PractitionerGetResponse'
examples:
XMLExample:
value: "\n\n \n \n \n \n \n \n \n
Chantal M Brazeau
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"
summary: XML Example
description: 'Practitioner
Practitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this Resource is used for attribution of activities and responsibilities to these individuals.
'
description: ''
/providerdirectory/api/PractitionerRole:
get:
operationId: search_practitioner_role
description: This interaction searches a set of resources based on some filter criteria.
summary: This interaction searches a set of resources based on some filter criteria.
parameters:
- in: query
name: _count
schema:
type: integer
maximum: 10000
minimum: 1
default: 20
title: ' count'
description: Maximum number of results to be returned
- in: query
name: _id
schema:
type: string
title: ' id'
minLength: 1
description: Resource id (not a full URL)
- in: query
name: _include
schema:
enum:
- PractitionerRole:practitioner
- PractitionerRole:organization
- PractitionerRole:location
- PractitionerRole:service
- PractitionerRole:network
- PractitionerRole:endpoint
type: string
title: ' include'
minLength: 1
description: 'Include resources related to the search results (Supported: PractitionerRole:practitioner, PractitionerRole:organization, PractitionerRole:location, PractitionerRole:service, PractitionerRole:network, PractitionerRole:endpoint)
* `PractitionerRole:practitioner` - PractitionerRole:practitioner
* `PractitionerRole:organization` - PractitionerRole:organization
* `PractitionerRole:location` - PractitionerRole:location
* `PractitionerRole:service` - PractitionerRole:service
* `PractitionerRole:network` - PractitionerRole:network
* `PractitionerRole:endpoint` - PractitionerRole:endpoint'
- in: query
name: _offset
schema:
type: integer
minimum: 0
default: 0
title: ' offset'
description: Number of results to be offset
- in: query
name: location
schema:
type: string
minLength: 1
description: Location that the practitioner provider services at.
- in: query
name: network
schema:
type: string
minLength: 1
description: Network that the practitioner is a part of.
- in: query
name: organization
schema:
type: string
minLength: 1
description: The identity of the organization the practitioner represents / acts on behalf of
- in: query
name: practitioner
schema:
type: string
minLength: 1
description: Practitioner that is able to provide the defined services for the organization
- in: query
name: role
schema:
type: string
minLength: 1
description: The practitioner can perform this role at for the organization
- in: query
name: service
schema:
type: string
minLength: 1
description: Service that the practitioner provides.
- in: query
name: specialty
schema:
type: string
minLength: 1
description: The practitioner has this specialty at an organization
tags:
- FHIR R4 ProviderDirectory API
security:
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/PractitionerRoleSearchResponse'
examples:
JSONExample:
value:
resourceType: Bundle
id: be7670b9-3105-4874-8e84-a592f22ca05c
meta:
lastUpdated: '2021-06-14T16:30:36.366Z'
type: searchset
total: 2
link:
- relation: self
url: https://public-api.cloverhealth.com/providerdirectory/api/PractitionerRole
entry:
- fullUrl: https://public-api.cloverhealth.com/providerdirectory/api/PractitionerRole/bfcec0d0-a895-5aea-91f3-1948598b9bdd
resource:
resourceType: PractitionerRole
id: bfcec0d0-a895-5aea-91f3-1948598b9bdd
meta:
lastUpdated: '2021-06-14T00:00:00Z'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole
text:
status: generated
div:
identifier:
- system: http://hl7.org/fhir/sid/us-npi
value: '1649449687'
active: true
extension:
- url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
extension:
- url: acceptingPatients
valueCodeableConcept:
coding:
- system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/AcceptingPatientsCS
code: newpt
- url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/network-reference
valueReference:
reference: Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056
practitioner:
reference: Practitioner/367921f5-2436-5897-96bb-09611da4c51e
display: Scott Sundick
organization:
reference: Organization/3d0a9886-5edc-5c2b-9976-9a88712509bb
display: Cardiovascular Care Group PC
location:
- reference: Location/2d7062f2-eb7e-516e-91e5-fd107b1fe104
healthcareService:
- reference: HealthcareService/d83e1d95-3a94-5fa0-9f27-affe8dda4aea
code:
- coding:
- system: http://terminology.hl7.org/CodeSystem/practitioner-role
code: doctor
specialty:
- coding:
- system: http://nucc.org/provider-taxonomy
code: 2086S0129X
search:
mode: match
summary: JSON Example
description: 'PractitionerRoleBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language
'
application/fhir+xml:
schema:
$ref: '#/components/schemas/PractitionerRoleSearchResponse'
examples:
XMLExample:
value: "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
summary: XML Example
description: 'PractitionerRoleBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language
'
description: ''
/providerdirectory/api/PractitionerRole/{id}:
get:
operationId: get_practitioner_role
description: The read interaction accesses the current contents of a resource.
summary: The read interaction accesses the current contents of a resource.
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- FHIR R4 ProviderDirectory API
security:
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/PractitionerRoleItemResponse'
examples:
JSONExample:
value:
resourceType: PractitionerRole
id: bfcec0d0-a895-5aea-91f3-1948598b9bdd
meta:
lastUpdated: '2021-06-14T00:00:00Z'
profile:
- http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole
text:
status: generated
div:
Scott Sundick
identifier:
- system: http://hl7.org/fhir/sid/us-npi
value: '1649449687'
active: true
extension:
- url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
extension:
- url: acceptingPatients
valueCodeableConcept:
coding:
- system: http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/AcceptingPatientsCS
code: newpt
- url: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/network-reference
valueReference:
reference: Organization/9204cbaf-34e9-5d49-9d5d-1f2ce87d7056
practitioner:
reference: Practitioner/367921f5-2436-5897-96bb-09611da4c51e
display: Scott Sundick
organization:
reference: Organization/3d0a9886-5edc-5c2b-9976-9a88712509bb
display: Cardiovascular Care Group PC
location:
- reference: Location/3767a8b8-4a84-56f7-89b6-2af63a737a7c
healthcareService:
- reference: HealthcareService/86f22c44-882b-5ae6-a21d-3f58d89a6813
code:
- coding:
- system: http://terminology.hl7.org/CodeSystem/practitioner-role
code: doctor
specialty:
- coding:
- system: http://nucc.org/provider-taxonomy
code: 2086S0129X
summary: JSON Example
description: 'PractitionerRole
Roles/organizations the practitioner is associated with Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
'
application/fhir+xml:
schema:
$ref: '#/components/schemas/PractitionerRoleItemResponse'
examples:
XMLExample:
value: "\n \n \n \n \n \n \n \n \n
Jillian K Rumbaugh
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
summary: XML Example
description: 'PractitionerRole
Roles/organizations the practitioner is associated with Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
'
description: ''
/providerdirectory/api/metadata:
get:
operationId: get_metadata
description: This interaction searches a set of resources based on some filter criteria..
summary: This interaction searches a set of resources based on some filter criteria..
tags:
- FHIR R4 ProviderDirectory API
security:
- cookieAuth: []
- basicAuth: []
- {}
responses:
'200':
content:
application/fhir+json:
schema:
$ref: '#/components/schemas/FHIRCapabilityStatement'
examples:
JSONExample:
value:
resourceType: CapabilityStatement
id: '1933611'
meta:
versionId: '1'
lastUpdated: '2021-03-08T19:27:59.034+00:00'
source: '#jURcAPyvWNKEoveb'
status: active
date: '2021-03-08T16:17:22-03:00'
publisher: Clover Health
kind: instance
software:
name: Clover Health FHIR R4 Provider Directory API
version: 4.2.0
implementation:
description: DaVinci PDEX Plan Net
url: https://build.fhir.org/ig/HL7/davinci-pdex-plan-net/
fhirVersion: 4.0.1
format:
- application/fhir+xml
- application/fhir+json
rest:
- mode: server
resource:
- type: Bundle
profile: http://hl7.org/fhir/StructureDefinition/Bundle
interaction:
- code: read
- type: HealthcareService
profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService
interaction:
- code: read
- code: search-type
searchRevInclude:
- PractitionerRole:practitioner
searchInclude:
- HealthcareService:location
- HealthcareService:coverage-area
- HealthcareService:organization
- HealthcareService:endpoint
searchParam:
- name: identifier
type: token
documentation: A healthcare service's Identifier (NPI)
- name: location
type: reference
documentation: The location of a healthcare service
- name: coverage-area
type: reference
documentation: The coverage-area of a healthcare service
- name: organization
type: reference
documentation: The organization that the healthcare service belongs to
- name: service-category
type: string
documentation: The category of a healthcare service
- name: service-type
type: string
documentation: The type of a healthcare service
- name: name
type: string
documentation: The name of a healthcare service
- name: specialty
type: string
documentation: The specialty of a healthcare service
- type: Practitioner
profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner
interaction:
- code: read
- code: search-type
searchRevInclude:
- PractitionerRole:practitioner
searchParam:
- name: identifier
type: token
documentation: A practitioner's Identifier (NPI)
- name: name
type: string
documentation: A practitioner's name
- name: family
type: string
documentation: A practitioner's family name
- name: given
type: string
documentation: A practitioner's given name
- type: PractitionerRole
profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole
interaction:
- code: read
- code: search-type
searchInclude:
- PractitionerRole:organization
- PractitionerRole:practitioner
- PractitionerRole:location
- PractitionerRole:service
- PractitionerRole:network
searchParam:
- name: organization
type: reference
documentation: The identity of the organization the practitioner represents / acts on behalf of
- name: practitioner
type: reference
documentation: Practitioner that is able to provide the defined services for the organization
- name: network
type: reference
documentation: The network work that the practitioner is in.
- name: location
type: reference
documentation: The location that the practitioner provide service at.
- name: service
type: reference
documentation: The healthcare service the practitioner provides.
- name: specialty
type: string
documentation: The specialties of practitioner
- name: role
type: string
documentation: The credential type of a practitioner
- type: Location
profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location
interaction:
- code: read
- code: search-type
searchRevInclude:
- HealthcareService:location
- InsurancePlan:coverage-area
- OrganizationAffiliation:location
- PractitionerRole:location
searchInclude:
- Location:organization
- Location:partof
searchParam:
- name: name
type: string
documentation: The name of the location
- name: near
type: special
documentation: Geo information (longitude, latitude) of the location
- name: identifier
type: token
documentation: NPI of the location
- name: partOf
type: reference
documentation: The location that a location is physically part of.
- name: organization
type: reference
documentation: The organization that a location belongs to.
- name: type
type: string
documentation: The type of a location
- name: address
type: string
documentation: Address of the location
- name: address-city
type: string
documentation: City of the location
- name: address-state
type: string
documentation: State of the location
- name: address-postalCode
type: string
documentation: Postal code of the location
- type: Endpoint
profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint
interaction:
- code: read
- code: search-type
- type: Organization
profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization
interaction:
- code: read
- code: search-type
- type: OrganizationAffiliation
profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation
interaction:
- code: read
- code: search-type
summary: JSON Example
description: 'CapabilityStatementBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language
'
application/fhir+xml:
schema:
$ref: '#/components/schemas/FHIRCapabilityStatement'
examples:
XMLExample:
value:
resourceType: CapabilityStatement
id: '1933611'
meta:
versionId: '1'
lastUpdated: '2021-03-08T19:27:59.034+00:00'
source: '#jURcAPyvWNKEoveb'
status: active
date: '2021-03-08T16:17:22-03:00'
publisher: Clover Health
kind: instance
software:
name: Clover Health FHIR R4 Provider Directory API
version: 4.2.0
implementation:
description: DaVinci PDEX Plan Net
url: https://build.fhir.org/ig/HL7/davinci-pdex-plan-net/
fhirVersion: 4.0.1
format:
- application/fhir+xml
- application/fhir+json
rest:
- mode: server
resource:
- type: Bundle
profile: http://hl7.org/fhir/StructureDefinition/Bundle
interaction:
- code: read
- type: HealthcareService
profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService
interaction:
- code: read
- code: search-type
searchRevInclude:
- PractitionerRole:practitioner
searchInclude:
- HealthcareService:location
- HealthcareService:coverage-area
- HealthcareService:organization
- HealthcareService:endpoint
searchParam:
- name: identifier
type: token
documentation: A healthcare service's Identifier (NPI)
- name: location
type: reference
documentation: The location of a healthcare service
- name: coverage-area
type: reference
documentation: The coverage-area of a healthcare service
- name: organization
type: reference
documentation: The organization that the healthcare service belongs to
- name: service-category
type: string
documentation: The category of a healthcare service
- name: service-type
type: string
documentation: The type of a healthcare service
- name: name
type: string
documentation: The name of a healthcare service
- name: specialty
type: string
documentation: The specialty of a healthcare service
- type: Practitioner
profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner
interaction:
- code: read
- code: search-type
searchRevInclude:
- PractitionerRole:practitioner
searchParam:
- name: identifier
type: token
documentation: A practitioner's Identifier (NPI)
- name: name
type: string
documentation: A practitioner's name
- name: family
type: string
documentation: A practitioner's family name
- name: given
type: string
documentation: A practitioner's given name
- type: PractitionerRole
profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole
interaction:
- code: read
- code: search-type
searchInclude:
- PractitionerRole:organization
- PractitionerRole:practitioner
- PractitionerRole:location
- PractitionerRole:service
- PractitionerRole:network
searchParam:
- name: organization
type: reference
documentation: The identity of the organization the practitioner represents / acts on behalf of
- name: practitioner
type: reference
documentation: Practitioner that is able to provide the defined services for the organization
- name: network
type: reference
documentation: The network work that the practitioner is in.
- name: location
type: reference
documentation: The location that the practitioner provide service at.
- name: service
type: reference
documentation: The healthcare service the practitioner provides.
- name: specialty
type: string
documentation: The specialties of practitioner
- name: role
type: string
documentation: The credential type of a practitioner
- type: Location
profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location
interaction:
- code: read
- code: search-type
searchRevInclude:
- HealthcareService:location
- InsurancePlan:coverage-area
- OrganizationAffiliation:location
- PractitionerRole:location
searchInclude:
- Location:organization
- Location:partof
searchParam:
- name: name
type: string
documentation: The name of the location
- name: near
type: special
documentation: Geo information (longitude, latitude) of the location
- name: identifier
type: token
documentation: NPI of the location
- name: partOf
type: reference
documentation: The location that a location is physically part of.
- name: organization
type: reference
documentation: The organization that a location belongs to.
- name: type
type: string
documentation: The type of a location
- name: address
type: string
documentation: Address of the location
- name: address-city
type: string
documentation: City of the location
- name: address-state
type: string
documentation: State of the location
- name: address-postalCode
type: string
documentation: Postal code of the location
- type: Endpoint
profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint
interaction:
- code: read
- code: search-type
- type: Organization
profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization
interaction:
- code: read
- code: search-type
- type: OrganizationAffiliation
profile: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation
interaction:
- code: read
- code: search-type
summary: XML Example
description: 'CapabilityStatementBundle
Contains a collection of resources
- Rule: total only when a search or history
- Rule: entry.search only when a search
- Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
- Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
- Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
- Rule: A document must have an identifier with a system and a value
- Rule: A document must have a date
- Rule: A document must have a Composition as the first resource
- Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language
'
description: ''
components:
schemas:
FHIRExtendedContactDetail:
type: object
properties:
purpose:
$ref: '#/components/schemas/FHIRCodeableConcept'
name:
type: array
items:
$ref: '#/components/schemas/FHIRHumanName'
telecom:
type: array
items:
$ref: '#/components/schemas/FHIRContactPoint'
address:
$ref: '#/components/schemas/FHIRAddress'
organization:
$ref: '#/components/schemas/CommonReference'
period:
$ref: '#/components/schemas/FHIRPeriod'
PractitionerRoleItemOrganization:
type: object
properties:
reference:
type: string
display:
type: string
required:
- display
- reference
PractitionerRoleSearchResponse:
type: object
properties:
resourceType:
type: string
description: Bundle
id:
type: string
description: Logical id of this artifact
meta:
allOf:
- $ref: '#/components/schemas/BaseBundleMeta'
description: Metadata about the resource
type:
$ref: '#/components/schemas/TypeF76Enum'
total:
type: integer
minimum: 0
description: If search, the total number of matches
link:
type: array
items:
$ref: '#/components/schemas/BaseBundleLink'
description: Links related to this Bundle
timestamp:
type: string
format: date-time
description: When the bundle was assembled
signature:
allOf:
- $ref: '#/components/schemas/BaseBundleSignature'
description: Digital Signature
identifier:
description: Persistent identifier for the bundle
language:
type: string
description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html'
implicitRules:
type: string
description: A set of rules under which this content was created
entry:
type: array
items:
$ref: '#/components/schemas/PractitionerRoleSearchEntry'
description: "Entry in the bundle - will have a resource or information\n\n- Rule: must be a resource unless there's a request or response\n- Rule: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type\n "
required:
- entry
- id
- link
- meta
- resourceType
- total
- type
OrganizationGetResponse:
type: object
properties:
resourceType:
type: string
id:
type: string
meta:
allOf:
- $ref: '#/components/schemas/BaseResourceMeta'
description: Metadata about the resource
text:
allOf:
- $ref: '#/components/schemas/BaseResourceText'
description: Text summary of the resource, for human interpretation
identifier:
type: array
items:
$ref: '#/components/schemas/FHIRIdentifier'
description: Identifies this organization across multiple systems
active:
type: boolean
description: Whether the organization's record is still in active use
type:
allOf:
- $ref: '#/components/schemas/FHIRCodeableConcept'
description: Kind of organization
name:
type: string
description: Name used for the organization
telecom:
allOf:
- $ref: '#/components/schemas/OrganizationGetTelecom'
description: Contact details (e.g.phone/fax/url)
address:
allOf:
- $ref: '#/components/schemas/FHIRAddress'
description: Address for the contact
partOf:
allOf:
- $ref: '#/components/schemas/CommonReference'
description: The organization of which this organization forms a part
contact:
allOf:
- $ref: '#/components/schemas/FHIRExtendedContactDetail'
description: Official contact details for the Organization
endpoint:
allOf:
- $ref: '#/components/schemas/CommonReference'
description: Technical endpoints providing access to services operated for the organization
required:
- active
- id
- identifier
- meta
- name
- resourceType
- text
OrganizationAffiliationGetReference:
type: object
properties:
reference:
type: string
required:
- reference
PractitionerSearchEntry:
type: object
properties:
fullUrl:
type: string
description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
search:
allOf:
- $ref: '#/components/schemas/BaseBundleSearch'
description: Search related information
resource:
$ref: '#/components/schemas/PractitionerGetResponse'
required:
- fullUrl
- resource
- search
FHIRCoding:
type: object
properties:
system:
type: string
description: Identity of the terminology system
version:
type: string
description: Version of the system - if relevant
code:
type: string
description: Symbol in syntax defined by the system
display:
type: string
description: Representation defined by the system
userSelected:
type: string
description: If this coding was chosen directly by the user
FHIRCapabilityStatementSoftware:
type: object
properties:
name:
type: string
description: A name the software is known by
version:
type: string
description: Version covered by this statement
releaseDate:
type: string
format: date-time
description: Date this version was released
PractitionerSearchResponse:
type: object
properties:
resourceType:
type: string
description: Bundle
id:
type: string
description: Logical id of this artifact
meta:
allOf:
- $ref: '#/components/schemas/BaseBundleMeta'
description: Metadata about the resource
type:
$ref: '#/components/schemas/TypeF76Enum'
total:
type: integer
minimum: 0
description: If search, the total number of matches
link:
type: array
items:
$ref: '#/components/schemas/BaseBundleLink'
description: Links related to this Bundle
timestamp:
type: string
format: date-time
description: When the bundle was assembled
signature:
allOf:
- $ref: '#/components/schemas/BaseBundleSignature'
description: Digital Signature
identifier:
description: Persistent identifier for the bundle
language:
type: string
description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html'
implicitRules:
type: string
description: A set of rules under which this content was created
entry:
type: array
items:
$ref: '#/components/schemas/PractitionerSearchEntry'
required:
- entry
- id
- link
- meta
- resourceType
- total
- type
BaseBundleMeta:
type: object
properties:
lastUpdated:
type: string
format: date-time
required:
- lastUpdated
FHIRIdentifierUseEnum:
enum:
- usual
- official
- temp
- secondary
- old
type: string
description: '* `usual` - usual
* `official` - official
* `temp` - temp
* `secondary` - secondary
* `old` - old'
InsurancePlanGetResponse:
type: object
properties:
resourceType:
type: string
id:
type: string
meta:
allOf:
- $ref: '#/components/schemas/BaseResourceMeta'
description: Metadata about the resource
identifier:
allOf:
- $ref: '#/components/schemas/FHIRIdentifier'
description: Business Identifier for Product
status:
$ref: '#/components/schemas/PublicationStatusEnum'
type:
type: array
items:
$ref: '#/components/schemas/FHIRCodeableConcept'
description: Kind of product
ownedBy:
allOf:
- $ref: '#/components/schemas/CommonReference'
description: Product issuer
administeredBy:
allOf:
- $ref: '#/components/schemas/CommonReference'
description: Product administrator
network:
type: array
items:
$ref: '#/components/schemas/CommonReference'
description: What networks are Included
coverageArea:
type: array
items:
$ref: '#/components/schemas/CommonReference'
description: Where product applies
name:
type: string
description: Official name
required:
- id
- meta
- resourceType
- status
FHIRPeriod:
type: object
properties:
start:
type: string
format: date-time
description: Starting time with inclusive boundary
end:
type: string
format: date-time
description: End time with inclusive boundary, if not ongoing
FHIRHumanName:
type: object
properties:
use:
$ref: '#/components/schemas/FHIRHumanNameUseEnum'
text:
type: string
description: Text representation of the full name
family:
type: string
description: Family name (often called 'Surname')
given:
type: array
items:
type: string
description: 'Given names (not always ''first''). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name'
prefix:
type: array
items:
type: string
description: 'Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name'
suffix:
type: array
items:
type: string
description: 'Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name'
period:
allOf:
- $ref: '#/components/schemas/FHIRPeriod'
description: Time period when name was/is in use
CodeEnum:
enum:
- read
- vread
- update
- patch
- delete
- history-instance
- history-type
- create
- search-type
type: string
description: '* `read` - read
* `vread` - vread
* `update` - update
* `patch` - patch
* `delete` - delete
* `history-instance` - history-instance
* `history-type` - history-type
* `create` - create
* `search-type` - search-type'
FHIRContactPoint:
type: object
properties:
system:
$ref: '#/components/schemas/SystemEnum'
value:
type: string
description: The actual contact point details
use:
allOf:
- $ref: '#/components/schemas/FHIRContactPointUseEnum'
description: 'purpose of this contact point
* `home` - home
* `work` - work
* `temp` - temp
* `old` - old
* `mobile` - mobile'
rank:
type: integer
description: Specify preferred order of use (1 = highest)
period:
allOf:
- $ref: '#/components/schemas/FHIRPeriod'
description: Time period when the contact point was/is in use
BaseResourceMeta:
type: object
properties:
lastUpdated:
type: string
format: date-time
description: When the resource version last changed
profile:
type: array
items: {}
description: Profiles this resource claims to conform to
versionId:
type: string
description: Version specific identifier
source:
type: string
description: Identifies where the resource comes from
required:
- profile
HealthcareServiceSearchEntry:
type: object
properties:
fullUrl:
type: string
description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
search:
allOf:
- $ref: '#/components/schemas/BaseBundleSearch'
description: Search related information
resource:
allOf:
- $ref: '#/components/schemas/HealthcareServiceGetResponse'
description: A resource in the bundle
required:
- fullUrl
- resource
- search
TypeF76Enum:
enum:
- document
- message
- transaction
- transaction - response
- batch
- batch - response
- history
- searchset
- collection
type: string
description: '* `document` - document
* `message` - message
* `transaction` - transaction
* `transaction - response` - transaction - response
* `batch` - batch
* `batch - response` - batch - response
* `history` - history
* `searchset` - searchset
* `collection` - collection'
FHIRCapabilityStatementInteractionCode:
type: object
properties:
code:
$ref: '#/components/schemas/CodeEnum'
required:
- code
LocationSearchResponse:
type: object
properties:
resourceType:
type: string
description: Bundle
id:
type: string
description: Logical id of this artifact
meta:
allOf:
- $ref: '#/components/schemas/BaseBundleMeta'
description: Metadata about the resource
type:
$ref: '#/components/schemas/TypeF76Enum'
total:
type: integer
minimum: 0
description: If search, the total number of matches
link:
type: array
items:
$ref: '#/components/schemas/BaseBundleLink'
description: Links related to this Bundle
timestamp:
type: string
format: date-time
description: When the bundle was assembled
signature:
allOf:
- $ref: '#/components/schemas/BaseBundleSignature'
description: Digital Signature
identifier:
description: Persistent identifier for the bundle
language:
type: string
description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html'
implicitRules:
type: string
description: A set of rules under which this content was created
entry:
type: array
items:
$ref: '#/components/schemas/LocationSearchEntry'
required:
- entry
- id
- link
- meta
- resourceType
- total
- type
PractitionerRoleItemSpecialty:
type: object
properties:
coding:
type: array
items:
$ref: '#/components/schemas/PractitionerRoleItemCoding'
required:
- coding
BaseBundleLink:
type: object
properties:
relation:
type: string
url:
type: string
description: Reference details for the link
required:
- relation
- url
HealthcareServiceGetTelecomExtension:
type: object
properties:
url:
type: string
valueReference:
$ref: '#/components/schemas/CommonReference'
required:
- url
- valueReference
GenderEnum:
enum:
- male
- female
- other
- unknown
type: string
description: '* `male` - male
* `female` - female
* `other` - other
* `unknown` - unknown'
LocationSearchEntry:
type: object
properties:
fullUrl:
type: string
description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
search:
allOf:
- $ref: '#/components/schemas/BaseBundleSearch'
description: Search related information
resource:
allOf:
- $ref: '#/components/schemas/LocationGetResponse'
description: A resource in the bundle
required:
- fullUrl
- resource
- search
PractitionerRoleItemEndpoint:
type: object
properties:
reference:
type: string
required:
- reference
EndpointSearchResponse:
type: object
properties:
resourceType:
type: string
description: Bundle
id:
type: string
description: Logical id of this artifact
meta:
allOf:
- $ref: '#/components/schemas/BaseBundleMeta'
description: Metadata about the resource
type:
$ref: '#/components/schemas/TypeF76Enum'
total:
type: integer
minimum: 0
description: If search, the total number of matches
link:
type: array
items:
$ref: '#/components/schemas/BaseBundleLink'
description: Links related to this Bundle
timestamp:
type: string
format: date-time
description: When the bundle was assembled
signature:
allOf:
- $ref: '#/components/schemas/BaseBundleSignature'
description: Digital Signature
identifier:
description: Persistent identifier for the bundle
language:
type: string
description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html'
implicitRules:
type: string
description: A set of rules under which this content was created
entry:
type: array
items:
$ref: '#/components/schemas/EndpointSearchEntry'
required:
- entry
- id
- link
- meta
- resourceType
- total
- type
PractitionerRoleItemCoding:
type: object
properties:
system:
type: string
code:
type: string
required:
- code
- system
HealthcareServiceGetExtension:
type: object
properties:
extension:
type: array
items:
$ref: '#/components/schemas/HealthcareServiceGetExtensionExtension'
url:
type: string
required:
- extension
- url
OrganizationAffiliationSearchEntry:
type: object
properties:
fullUrl:
type: string
description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
search:
allOf:
- $ref: '#/components/schemas/BaseBundleSearch'
description: Search related information
resource:
allOf:
- $ref: '#/components/schemas/OrganizationAffiliationGetResponse'
description: A resource in the bundle
required:
- fullUrl
- resource
- search
BaseBundleSignature:
type: object
properties:
when:
type: string
format: date-time
description: When the signature was created
who:
type: string
description: Who signed
targetFormat:
type: string
description: The technical format of the signed resources
sigFormat:
type: string
description: The technical format of the signature
onBehalfOf:
type: string
description: The party represented
type:
type: array
items: {}
description: Indication of the reason the entity signed the object(s)
data:
type: string
description: The actual signature content (XML DigSig. JWT, picture, etc.)
required:
- data
- type
- when
PractitionerGetTelecomExtension:
type: object
properties:
url:
type: string
id:
type: string
valueReference:
$ref: '#/components/schemas/CommonReference'
required:
- id
- url
- valueReference
FHIRCapabilityStatement:
type: object
properties:
resourceType:
type: string
default: CapabilityStatement
id:
type: string
meta:
allOf:
- $ref: '#/components/schemas/BaseResourceMeta'
description: Metadata about a resource
status:
$ref: '#/components/schemas/PublicationStatusEnum'
date:
type: string
format: date-time
description: Date last changed
publisher:
type: string
description: Name of the publisher/steward
kind:
$ref: '#/components/schemas/KindEnum'
software:
allOf:
- $ref: '#/components/schemas/FHIRCapabilityStatementSoftware'
description: Software that is covered by this capability statement
fhirVersion:
type: string
description: FHIR Version the system supports
format:
type: array
items:
type: string
description: formats supported (xml | json | ttl | mime type)
rest:
type: array
items:
$ref: '#/components/schemas/FHIRCapabilityStatementRest'
description: "\tIf the endpoint is a RESTful one"
required:
- date
- fhirVersion
- format
- kind
- meta
- status
OrganizationAffiliationSearchResponse:
type: object
properties:
resourceType:
type: string
description: Bundle
id:
type: string
description: Logical id of this artifact
meta:
allOf:
- $ref: '#/components/schemas/BaseBundleMeta'
description: Metadata about the resource
type:
$ref: '#/components/schemas/TypeF76Enum'
total:
type: integer
minimum: 0
description: If search, the total number of matches
link:
type: array
items:
$ref: '#/components/schemas/BaseBundleLink'
description: Links related to this Bundle
timestamp:
type: string
format: date-time
description: When the bundle was assembled
signature:
allOf:
- $ref: '#/components/schemas/BaseBundleSignature'
description: Digital Signature
identifier:
description: Persistent identifier for the bundle
language:
type: string
description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html'
implicitRules:
type: string
description: A set of rules under which this content was created
entry:
type: array
items:
$ref: '#/components/schemas/OrganizationAffiliationSearchEntry'
required:
- entry
- id
- link
- meta
- resourceType
- total
- type
PractitionerRoleItemExtensionValueCodeableConcept:
type: object
properties:
url:
type: string
valueCodeableConcept:
$ref: '#/components/schemas/PractitionerRoleItemExtensionValueCodeableConceptCoding'
required:
- url
- valueCodeableConcept
PractitionerRoleItemExtensionValueCodeableConceptCodingCodingContent:
type: object
properties:
system:
type: string
code:
type: string
required:
- code
- system
EndpointGetResponse:
type: object
properties:
resourceType:
type: string
id:
type: string
meta:
allOf:
- $ref: '#/components/schemas/BaseResourceMeta'
description: Metadata about the resource
text:
allOf:
- $ref: '#/components/schemas/BaseResourceText'
description: Text summary of the resource, for human interpretation
status:
$ref: '#/components/schemas/EndpointGetResponseStatusEnum'
connectionType:
allOf:
- $ref: '#/components/schemas/FHIRCodeableConcept'
description: Protocol/Profile/Standard to be used with this endpoint connection
managingOrganization:
allOf:
- $ref: '#/components/schemas/CommonReference'
description: Organization that manages this endpoint
payloadType:
allOf:
- $ref: '#/components/schemas/FHIRCodeableConcept'
description: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
address:
type: string
description: The technical base address for connecting to this endpoint
required:
- address
- id
- meta
- resourceType
- status
- text
SearchModeEnum:
enum:
- match
- include
- outcome
type: string
description: '* `match` - match
* `include` - include
* `outcome` - outcome'
PractitionerRoleItemExtensionValueReference:
type: object
properties:
url:
type: string
valueReference:
$ref: '#/components/schemas/PractitionerRoleItemExtensionValueReferenceReference'
required:
- url
- valueReference
LocationGetPosition:
type: object
properties:
longitude:
type: string
format: decimal
pattern: ^-?0?(?:\.\d{0,18})?$
description: Longitude with WGS84 datum
latitude:
type: string
format: decimal
pattern: ^-?0?(?:\.\d{0,18})?$
description: Latitude with WGS84 datum
required:
- latitude
- longitude
HealthcareServiceGetResponse:
type: object
properties:
resourceType:
type: string
id:
type: string
meta:
allOf:
- $ref: '#/components/schemas/BaseResourceMeta'
description: Metadata about the resource
identifier:
allOf:
- $ref: '#/components/schemas/FHIRIdentifier'
description: External identifiers for this item
active:
type: boolean
description: Whether this HealthcareService record is in active use
extension:
$ref: '#/components/schemas/HealthcareServiceGetExtension'
category:
$ref: '#/components/schemas/FHIRCodeableConcept'
type:
$ref: '#/components/schemas/FHIRCodeableConcept'
location:
$ref: '#/components/schemas/CommonReference'
coverageArea:
$ref: '#/components/schemas/CommonReference'
providedBy:
$ref: '#/components/schemas/CommonReference'
name:
type: string
telecom:
type: array
items:
$ref: '#/components/schemas/HealthcareServiceGetTelecom'
specialty:
$ref: '#/components/schemas/FHIRCodeableConcept'
required:
- active
- category
- id
- meta
- name
- resourceType
- telecom
- type
OrganizationAffiliationGetPeriod:
type: object
properties:
start:
type: string
format: date
description: Starting time with inclusive boundary
end:
type: string
format: date
description: End time with inclusive boundary, if not ongoing
BaseBundleSearch:
type: object
properties:
mode:
$ref: '#/components/schemas/SearchModeEnum'
required:
- mode
HealthcareServiceSearchResponse:
type: object
properties:
resourceType:
type: string
description: Bundle
id:
type: string
description: Logical id of this artifact
meta:
allOf:
- $ref: '#/components/schemas/BaseBundleMeta'
description: Metadata about the resource
type:
$ref: '#/components/schemas/TypeF76Enum'
total:
type: integer
minimum: 0
description: If search, the total number of matches
link:
type: array
items:
$ref: '#/components/schemas/BaseBundleLink'
description: Links related to this Bundle
timestamp:
type: string
format: date-time
description: When the bundle was assembled
signature:
allOf:
- $ref: '#/components/schemas/BaseBundleSignature'
description: Digital Signature
identifier:
description: Persistent identifier for the bundle
language:
type: string
description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html'
implicitRules:
type: string
description: A set of rules under which this content was created
entry:
type: array
items:
$ref: '#/components/schemas/HealthcareServiceSearchEntry'
required:
- entry
- id
- link
- meta
- resourceType
- total
- type
PractitionerGetResponse:
type: object
properties:
resourceType:
type: string
id:
type: string
meta:
allOf:
- $ref: '#/components/schemas/BaseResourceMeta'
description: Metadata about the resource
text:
allOf:
- $ref: '#/components/schemas/BaseResourceText'
description: Text summary of the resource, for human interpretation
identifier:
type: array
items:
$ref: '#/components/schemas/FHIRIdentifier'
description: An identifier for the person as this agent
active:
type: boolean
description: Whether this practitioner's record is in active use
name:
allOf:
- $ref: '#/components/schemas/FHIRHumanName'
description: The name(s) associated with the practitioner
telecom:
type: array
items:
$ref: '#/components/schemas/PractitionerGetTelecom'
description: A contact detail for the practitioner (that apply to all roles)
gender:
$ref: '#/components/schemas/GenderEnum'
communication:
type: array
items:
$ref: '#/components/schemas/FHIRCodeableConcept'
required:
- active
- communication
- gender
- id
- identifier
- meta
- name
- resourceType
- telecom
- text
PractitionerRoleItemHealthcareService:
type: object
properties:
reference:
type: string
required:
- reference
LocationGetTelecom:
type: object
properties:
phone:
$ref: '#/components/schemas/FHIRContactPoint'
fax:
$ref: '#/components/schemas/FHIRContactPoint'
CommonReference:
type: object
properties:
reference:
type: string
required:
- reference
InsurancePlanSearchResponse:
type: object
properties:
resourceType:
type: string
description: Bundle
id:
type: string
description: Logical id of this artifact
meta:
allOf:
- $ref: '#/components/schemas/BaseBundleMeta'
description: Metadata about the resource
type:
$ref: '#/components/schemas/TypeF76Enum'
total:
type: integer
minimum: 0
description: If search, the total number of matches
link:
type: array
items:
$ref: '#/components/schemas/BaseBundleLink'
description: Links related to this Bundle
timestamp:
type: string
format: date-time
description: When the bundle was assembled
signature:
allOf:
- $ref: '#/components/schemas/BaseBundleSignature'
description: Digital Signature
identifier:
description: Persistent identifier for the bundle
language:
type: string
description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html'
implicitRules:
type: string
description: A set of rules under which this content was created
entry:
type: array
items:
$ref: '#/components/schemas/InsurancePlanSearchEntry'
required:
- entry
- id
- link
- meta
- resourceType
- total
- type
PractitionerRoleItemCode:
type: object
properties:
coding:
type: array
items:
$ref: '#/components/schemas/PractitionerRoleItemCoding'
required:
- coding
FHIRCodeableConcept:
type: object
properties:
coding:
type: array
items:
$ref: '#/components/schemas/FHIRCoding'
description: Code defined by a terminology system
text:
type: string
LocationGetResponse:
type: object
properties:
resourceType:
type: string
id:
type: string
meta:
allOf:
- $ref: '#/components/schemas/BaseResourceMeta'
description: Metadata about the resource
text:
allOf:
- $ref: '#/components/schemas/BaseResourceText'
description: Text summary of the resource, for human interpretation
status:
$ref: '#/components/schemas/LocationGetResponseStatusEnum'
name:
type: string
description: Name of the location as used by humans
type:
type: array
items:
$ref: '#/components/schemas/FHIRCodeableConcept'
description: Type of function performed
telecom:
type: array
items:
$ref: '#/components/schemas/LocationGetTelecom'
description: Official contact details for the location
address:
allOf:
- $ref: '#/components/schemas/FHIRAddress'
description: Physical location
position:
allOf:
- $ref: '#/components/schemas/LocationGetPosition'
description: The absolute geographic location
managingOrganization:
allOf:
- $ref: '#/components/schemas/CommonReference'
description: Organization responsible for provisioning and upkeep
partOf:
allOf:
- $ref: '#/components/schemas/CommonReference'
description: Another Location this one is physically a part of
endpoint:
allOf:
- $ref: '#/components/schemas/CommonReference'
description: Technical endpoints providing access to services operated for the location
required:
- id
- meta
- name
- resourceType
- status
- text
OrganizationSearchEntry:
type: object
properties:
fullUrl:
type: string
description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
search:
allOf:
- $ref: '#/components/schemas/BaseBundleSearch'
description: Search related information
resource:
allOf:
- $ref: '#/components/schemas/OrganizationGetResponse'
description: A resource in the bundle
required:
- fullUrl
- resource
- search
FHIRAddressUseEnum:
enum:
- home
- work
- temp
- old
- billing
type: string
description: '* `home` - home
* `work` - work
* `temp` - temp
* `old` - old
* `billing` - billing'
FHIRContactPointUseEnum:
enum:
- home
- work
- temp
- old
- mobile
type: string
description: '* `home` - home
* `work` - work
* `temp` - temp
* `old` - old
* `mobile` - mobile'
PublicationStatusEnum:
enum:
- draft
- active
- retired
- unknown
type: string
description: '* `draft` - draft
* `active` - active
* `retired` - retired
* `unknown` - unknown'
OrganizationSearchResponse:
type: object
properties:
resourceType:
type: string
description: Bundle
id:
type: string
description: Logical id of this artifact
meta:
allOf:
- $ref: '#/components/schemas/BaseBundleMeta'
description: Metadata about the resource
type:
$ref: '#/components/schemas/TypeF76Enum'
total:
type: integer
minimum: 0
description: If search, the total number of matches
link:
type: array
items:
$ref: '#/components/schemas/BaseBundleLink'
description: Links related to this Bundle
timestamp:
type: string
format: date-time
description: When the bundle was assembled
signature:
allOf:
- $ref: '#/components/schemas/BaseBundleSignature'
description: Digital Signature
identifier:
description: Persistent identifier for the bundle
language:
type: string
description: 'Language of the resource content. Supported languages can be found at: https://www.hl7.org/fhir/valueset-languages.html'
implicitRules:
type: string
description: A set of rules under which this content was created
entry:
type: array
items:
$ref: '#/components/schemas/OrganizationSearchEntry'
required:
- entry
- id
- link
- meta
- resourceType
- total
- type
EndpointSearchEntry:
type: object
properties:
fullUrl:
type: string
description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
search:
allOf:
- $ref: '#/components/schemas/BaseBundleSearch'
description: Search related information
resource:
allOf:
- $ref: '#/components/schemas/EndpointGetResponse'
description: A resource in the bundle
required:
- fullUrl
- resource
- search
PractitionerRoleItemPractitioner:
type: object
properties:
reference:
type: string
display:
type: string
required:
- display
- reference
OrganizationAffiliationGetResponse:
type: object
properties:
resourceType:
type: string
id:
type: string
description: Business identifiers that are specific to this role
meta:
allOf:
- $ref: '#/components/schemas/BaseResourceMeta'
description: Metadata about the resource
active:
type: boolean
description: Whether this organization affiliation record is in active use
period:
allOf:
- $ref: '#/components/schemas/OrganizationAffiliationGetPeriod'
description: The period during which the participatingOrganization is affiliated with the primary organization
organization:
allOf:
- $ref: '#/components/schemas/OrganizationAffiliationGetOrganization'
description: Organization where the role is available
participatingOrganization:
allOf:
- $ref: '#/components/schemas/OrganizationAffiliationGetOrganization'
description: Organization that provides/performs the role (e.g. providing services or is a member of)
network:
type: array
items:
$ref: '#/components/schemas/OrganizationAffiliationGetReference'
description: The network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
code:
type: array
items:
$ref: '#/components/schemas/FHIRCodeableConcept'
description: Definition of the role the participatingOrganization plays
specialty:
type: array
items:
$ref: '#/components/schemas/FHIRCodeableConcept'
description: Specific specialty of the participatingOrganization in the context of the role
location:
type: array
items:
$ref: '#/components/schemas/OrganizationAffiliationGetReference'
description: The location(s) at which the role occurs
healthcareService:
type: array
items:
$ref: '#/components/schemas/OrganizationAffiliationGetReference'
description: Healthcare services provided through the role
required:
- active
- code
- healthcareService
- id
- location
- meta
- network
- organization
- participatingOrganization
- resourceType
- specialty
OrganizationAffiliationGetOrganization:
type: object
properties:
reference:
type: string
display:
type: string
required:
- display
- reference
FHIRCapabilityStatementRestModeEnum:
enum:
- client
- server
type: string
description: '* `client` - client
* `server` - server'
FHIRHumanNameUseEnum:
enum:
- usual
- official
- temp
- nickname
- anonymous
- old
- maiden
type: string
description: '* `usual` - usual
* `official` - official
* `temp` - temp
* `nickname` - nickname
* `anonymous` - anonymous
* `old` - old
* `maiden` - maiden'
KindEnum:
enum:
- instance
- capability
- requirements
type: string
description: '* `instance` - instance
* `capability` - capability
* `requirements` - requirements'
FHIRCapabilityStatementRest:
type: object
properties:
mode:
$ref: '#/components/schemas/FHIRCapabilityStatementRestModeEnum'
resource:
type: array
items:
$ref: '#/components/schemas/FHIRCapabilityStatementRestResource'
description: Resource served on the REST interface
required:
- mode
- resource
HealthcareServiceGetTelecom:
type: object
properties:
extension:
type: array
items:
$ref: '#/components/schemas/HealthcareServiceGetTelecomExtension'
required:
- extension
PractitionerGetTelecom:
type: object
properties:
extension:
type: array
items:
$ref: '#/components/schemas/PractitionerGetTelecomExtension'
required:
- extension
FHIRAddressTypeEnum:
enum:
- postal
- physical
- both
type: string
description: '* `postal` - postal
* `physical` - physical
* `both` - both'
PractitionerRoleItemExtensionValue:
oneOf:
- $ref: '#/components/schemas/PractitionerRoleItemExtensionValueCodeableConcept'
- $ref: '#/components/schemas/PractitionerRoleItemExtensionValueReference'
discriminator:
propertyName: type
mapping:
valueCodeableConcept: '#/components/schemas/PractitionerRoleItemExtensionValueCodeableConcept'
valueReference: '#/components/schemas/PractitionerRoleItemExtensionValueReference'
PractitionerRoleItemIdentifier:
type: object
properties:
system:
type: string
value:
type: string
required:
- system
- value
BaseResourceText:
type: object
properties:
status:
type: string
div:
type: string
required:
- div
- status
EndpointGetResponseStatusEnum:
enum:
- active
- suspended
- error
- 'off'
- entered-in-error
- test
type: string
description: '* `active` - active
* `suspended` - suspended
* `error` - error
* `off` - off
* `entered-in-error` - entered-in-error
* `test` - test'
LocationGetResponseStatusEnum:
enum:
- active
- suspended
- inactive
type: string
description: '* `active` - active
* `suspended` - suspended
* `inactive` - inactive'
SystemEnum:
enum:
- phone
- fax
- email
- pager
- url
- sms
- other
type: string
description: '* `phone` - phone
* `fax` - fax
* `email` - email
* `pager` - pager
* `url` - url
* `sms` - sms
* `other` - other'
FHIRCapabilityStatementRestResource:
type: object
properties:
type:
type: string
description: A resource type that is supported
profile:
type: string
description: System-wide profile
interaction:
type: array
items:
$ref: '#/components/schemas/FHIRCapabilityStatementInteractionCode'
searchInclude:
type: array
items:
type: string
description: _include values supported by the server
searchRevInclude:
type: array
items:
type: string
description: _revinclude values supported by the server
required:
- searchInclude
- searchRevInclude
- type
FHIRAddress:
type: object
properties:
use:
allOf:
- $ref: '#/components/schemas/FHIRAddressUseEnum'
description: 'purpose of this address
* `home` - home
* `work` - work
* `temp` - temp
* `old` - old
* `billing` - billing'
type:
$ref: '#/components/schemas/FHIRAddressTypeEnum'
text:
type: string
description: Text representation of the address
line:
type: string
description: 'Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label'
city:
type: string
description: Name of city, town etc.
district:
type: string
description: District name (aka county)
state:
type: string
description: Sub-unit of country (abbreviations ok)
postalCode:
type: string
description: Postal code for area
country:
type: string
description: Country (e.g. may be ISO 3166 2 or 3 letter code)
period:
allOf:
- $ref: '#/components/schemas/FHIRPeriod'
description: Time period when address was/is in use
PractitionerRoleSearchEntry:
type: object
properties:
fullUrl:
type: string
description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
search:
allOf:
- $ref: '#/components/schemas/BaseBundleSearch'
description: Search related information
resource:
allOf:
- $ref: '#/components/schemas/PractitionerRoleItemResponse'
description: A resource in the bundle
required:
- fullUrl
- resource
- search
HealthcareServiceGetExtensionExtension:
type: object
properties:
url:
type: string
valueCodeableConcept:
$ref: '#/components/schemas/FHIRCodeableConcept'
required:
- url
- valueCodeableConcept
FHIRIdentifier:
type: object
properties:
use:
$ref: '#/components/schemas/FHIRIdentifierUseEnum'
type:
allOf:
- $ref: '#/components/schemas/FHIRCodeableConcept'
description: Description of identifier
system:
type: string
description: The namespace for the identifier value
value:
type: string
description: The value that is unique
period:
allOf:
- $ref: '#/components/schemas/FHIRPeriod'
description: Time period when id is/was valid for use
assigner:
type: string
description: Organization that issued id (may be just text)
PractitionerRoleItemExtensionValueReferenceReference:
type: object
properties:
reference:
type: string
required:
- reference
InsurancePlanSearchEntry:
type: object
properties:
fullUrl:
type: string
description: URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
search:
allOf:
- $ref: '#/components/schemas/BaseBundleSearch'
description: Search related information
resource:
allOf:
- $ref: '#/components/schemas/InsurancePlanGetResponse'
description: A resource in the bundle
required:
- fullUrl
- resource
- search
PractitionerRoleItemResponse:
type: object
properties:
resourceType:
type: string
id:
type: string
description: Logical id of this artifact
meta:
allOf:
- $ref: '#/components/schemas/BaseResourceMeta'
description: Metadata about the resource
text:
allOf:
- $ref: '#/components/schemas/BaseResourceText'
description: Text summary of the resource, for human interpretation
identifier:
type: array
items:
$ref: '#/components/schemas/PractitionerRoleItemIdentifier'
description: Business Identifiers that are specific to a role/location
active:
type: boolean
description: Whether this practitioner role record is in active use
extension:
type: array
items:
$ref: '#/components/schemas/PractitionerRoleItemExtensionValue'
practitioner:
allOf:
- $ref: '#/components/schemas/PractitionerRoleItemPractitioner'
description: Practitioner that is able to provide the defined services for the organization
organization:
allOf:
- $ref: '#/components/schemas/PractitionerRoleItemOrganization'
description: Organization where the roles are available
location:
type: array
items:
$ref: '#/components/schemas/PractitionerRoleItemLocation'
description: The location(s) at which this practitioner provides care
healthcareService:
type: array
items:
$ref: '#/components/schemas/PractitionerRoleItemHealthcareService'
description: The list of healthcare services that this worker provides for this role's Organization/Location(s)
endpoint:
allOf:
- $ref: '#/components/schemas/PractitionerRoleItemEndpoint'
description: Technical endpoints providing access to services operated for the practitioner with this role
code:
type: array
items:
$ref: '#/components/schemas/PractitionerRoleItemCode'
description: Roles which this practitioner may perform
specialty:
type: array
items:
$ref: '#/components/schemas/PractitionerRoleItemSpecialty'
description: Specific specialty of the practitioner
required:
- active
- extension
- id
- identifier
- meta
- resourceType
- text
OrganizationGetTelecom:
type: object
properties:
phone:
$ref: '#/components/schemas/FHIRContactPoint'
fax:
$ref: '#/components/schemas/FHIRContactPoint'
PractitionerRoleItemLocation:
type: object
properties:
reference:
type: string
required:
- reference
PractitionerRoleItemExtensionValueCodeableConceptCoding:
type: object
properties:
coding:
type: array
items:
$ref: '#/components/schemas/PractitionerRoleItemExtensionValueCodeableConceptCodingCodingContent'
required:
- coding
securitySchemes:
basicAuth:
type: http
scheme: basic
cookieAuth:
type: apiKey
in: cookie
name: sessionid