Clover Health FHIR R4 ProviderDirectory API API
The FHIR R4 ProviderDirectory API API from Clover Health — 17 operation(s) for fhir r4 providerdirectory api.
OpenAPI Specification
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: "<?xml version='1.0' encoding='UTF-8'?>\n<Bundle xmlns=\"http://hl7.org/fhir\">\n <id value=\"decd7fe7-9e5f-4c9d-bfc4-d0243c601834\"/>\n <meta>\n <lastUpdated value=\"2022-12-29T04:00:56.159Z\"/>\n <profile value=\"http://hl7.org/fhir/StructureDefinition/Bundle\"/>\n </meta>\n <type value=\"searchset\"/>\n <total value=\"2\"/>\n <link>\n <relation value=\"self\"/>\n <url value=\"https://public-api.cloverhealth.com/providerdirectory/api/Endpoint\"/>\n </link>\n <entry>\n <fullUrl value=\"https://public-api.cloverhealth.com/providerdirectory/api/Endpoint/6d179858-2560-5ec6-a162-2205ab32f378\"/>\n <resource>\n <Endpoint xmlns=\"http://hl7.org/fhir\">\n <id value=\"6d179858-2560-5ec6-a162-2205ab32f378\"/>\n <meta>\n <lastUpdated value=\"2022-12-25T00:00:00.000+00:00\"/>\n <profile value=\"http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint\"/>\n </meta>\n <status value=\"active\"/>\n <connectionType>\n <system value=\"http://terminology.hl7.org/CodeSystem/endpoint-connection-type\"/>\n <code value=\"hl7-fhir-rest\"/>\n </connectionType>\n <managingOrganization>\n <reference value=\"Organization/c6672acb-ea60-5431-802d-c637901772d3\"/>\n </managingOrganization>\n <payloadType>\n <coding>\n <system value=\"http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/EndpointPayloadTypeCS\"/>\n <code value=\"NA\"/>\n </coding>\n </payloadType>\n <address value=\"https://public-api.cloverhealth.com/providerdirectory/api/Location\"/>\n </Endpoint>\n </resource>\n <search>\n <mode value=\"match\"/>\n </search>\n </entry>\n <entry>\n <fullUrl value=\"https://public-api.cloverhealth.com/providerdirectory/api/Endpoint/d440e938-30ab-5d46-8005-5ba41160e098\"/>\n <resource>\n <Endpoint xmlns=\"http://hl7.org/fhir\">\n <id value=\"d440e938-30ab-5d46-8005-5ba41160e098\"/>\n <meta>\n <lastUpdated value=\"2022-12-25T00:00:00.000+00:00\"/>\n <profile value=\"http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint\"/>\n </meta>\n <status value=\"active\"/>\n <connectionType>\n <system value=\"http://terminology.hl7.org/CodeSystem/endpoint-connection-type\"/>\n <code value=\"hl7-fhir-rest\"/>\n </connectionType>\n <managingOrganization>\n <reference value=\"Organization/c6672acb-ea60-5431-802d-c637901772d3\"/>\n </managingOrganization>\n <payloadType>\n <coding>\n <system value=\"http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/EndpointPayloadTypeCS\"/>\n <code value=\"NA\"/>\n </coding>\n </payloadType>\n <address value=\"https://public-api.cloverhealth.com/providerdirectory/api/PractitionerRole\"/>\n </Endpoint>\n </resource>\n <search>\n <mode value=\"match\"/>\n </search>\n </entry>\n</Bundle>"
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: "<?xml version='1.0' encoding='UTF-8'?>\n<Endpoint xmlns=\"http://hl7.org/fhir\">\n <id value=\"6d179858-2560-5ec6-a162-2205ab32f378\"/>\n <meta>\n <lastUpdated value=\"2022-12-25T00:00:00.000+00:00\"/>\n <profile value=\"http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint\"/>\n </meta>\n <status value=\"active\"/>\n <connectionType>\n <system value=\"http://terminology.hl7.org/CodeSystem/endpoint-connection-type\"/>\n <code value=\"hl7-fhir-rest\"/>\n </connectionType>\n <managingOrganization>\n <reference value=\"Organization/c6672acb-ea60-5431-802d-c637901772d3\"/>\n </managingOrganization>\n <payloadType>\n <coding>\n <system value=\"http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/EndpointPayloadTypeCS\"/>\n <code value=\"NA\"/>\n </coding>\n </payloadType>\n <address value=\"https://public-api.cloverhealth.com/providerdirectory/api/Location\"/>\n</Endpoint>"
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: "<?xml version='1.0' encoding='UTF-8'?>\n<Bundle xmlns=\"http://hl7.org/fhir\">\n <id value=\"df0b9553-ba8d-4c7e-ae45-3c8c0eb89f7e\"/>\n <meta>\n <lastUpdated value=\"2022-12-30T04:30:46.642Z\"/>\n </meta>\n <type value=\"searchset\"/>\n <total value=\"2\"/>\n <link>\n <relation value=\"self\"/>\n <url value=\"https://public-api.cloverhealth.com/providerdirectory/api/HealthcareService\"/>\n </link>\n <entry>\n <fullUrl value=\"https://public-api.cloverhealth.com/providerdirectory/api/HealthcareService/00001c05-d3c7-5094-8ac3-fea55830942d\"/>\n <resource>\n <HealthcareService>\n <id value=\"00001c05-d3c7-5094-8ac3-fea55830942d\"/>\n <meta>\n <lastUpdated value=\"2022-12-25T00:00:00Z\"/>\n <profile value=\"http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService\"/>\n </meta>\n <extension url=\"http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method\">\n <extension url=\"type\">\n <valueCodeableConcept>\n <coding>\n <system value=\"http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/DeliveryMethodCS\"/>\n <code value=\"physical\"/>\n </coding>\n </valueCodeableConcept>\n </extension>\n </extension>\n <identifier>\n <system value=\"http://hl7.org/fhir/sid/us-npi\"/>\n <value value=\"1144513540\"/>\n </identifier>\n <active value=\"true\"/>\n <category>\n <coding>\n <system value=\"http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/HealthcareServiceCategoryCS\"/>\n <code value=\"prov\"/>\n </coding>\n </category>\n <type>\n <coding>\n <system value=\"http://terminology.hl7.org/CodeSystem/service-type\"/>\n <code value=\"349\"/>\n </coding>\n </type>\n <specialty>\n <coding>\n <system value=\"http://nucc.org/provider-taxonomy\"/>\n <code value=\"3336C0004X\"/>\n <display value=\"Compounding Pharmacy\"/>\n </coding>\n </specialty>\n <location>\n <reference value=\"Location/e1578c9c-a885-5bed-9263-60b92fea4b44\"/>\n </location>\n <name value=\"Moyosoye Folayan Oyeyinka\"/>\n <telecom>\n <extension url=\"http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary\">\n <valueReference>\n <reference value=\"Location/e1578c9c-a885-5bed-9263-60b92fea4b44\"/>\n </valueReference>\n </extension>\n </telecom>\n </HealthcareService>\n </resource>\n <search>\n <mode value=\"match\"/>\n </search>\n </entry>\n <entry>\n <fullUrl value=\"https://public-api.cloverhealth.com/providerdirectory/api/HealthcareService/00001c2f-35a7-5118-bb2c-3756317fa0db\"/>\n <resource>\n <HealthcareService>\n <id value=\"00001c2f-35a7-5118-bb2c-3756317fa0db\"/>\n <meta>\n <lastUpdated value=\"2022-12-25T00:00:00Z\"/>\n <profile value=\"http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService\"/>\n </meta>\n <extension url=\"http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method\">\n <extension url=\"type\">\n <valueCodeableConcept>\n <coding>\n <system value=\"http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/DeliveryMethodCS\"/>\n <code value=\"physical\"/>\n </coding>\n </valueCodeableConcept>\n </extension>\n </extension>\n <identifier>\n <system value=\"http://hl7.org/fhir/sid/us-npi\"/>\n <value value=\"1952337263\"/>\n </identifier>\n <active value=\"true\"/>\n <providedBy>\n <reference value=\"Organization/54b466ed-7ea1-59d0-9437-2afe7354470d\"/>\n </providedBy>\n <category>\n <coding>\n <system value=\"http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/HealthcareServiceCategoryCS\"/>\n <code value=\"outpat\"/>\n </coding>\n </category>\n <type>\n <coding>\n <system value=\"http://terminology.hl7.org/CodeSystem/service-type\"/>\n <code value=\"335\"/>\n </coding>\n </type>\n <specialty>\n <coding>\n <system value=\"http://nucc.org/provider-taxonomy\"/>\n <code value=\"3336C0004X\"/>\n <display value=\"Compounding Pharmacy\"/>\n </coding>\n </specialty>\n <location>\n <reference value=\"Location/c263b088-f3e8-5114-9971-0e8ff6226c74\"/>\n </location>\n <name value=\"South Texas Rural Health Services Inc\"/>\n <telecom>\n <extension url=\"http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary\">\n <valueReference>\n <reference value=\"Location/c263b088-f3e8-5114-9971-0e8ff6226c74\"/>\n </valueReference>\n </extension>\n </telecom>\n </HealthcareService>\n </resource>\n <search>\n <mode value=\"match\"/>\n </search>\n </entry>\n</Bundle>"
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/davin
# --- truncated at 32 KB (255 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clover-health/refs/heads/main/openapi/clover-health-fhir-r4-providerdirectory-api-api-openapi.yml