Directorio de Proveedores
Overview
The Provider Directory API accesses the Alliance FHIR server portion of the Provider and Pharmacy Directories. Using read-only RESTful GET API calls (PUT and POST are not currently supported), you can create an application to access information about our providers and pharmacies.
This section describes the FHIR profiles, resources and RESTful capabilities that the Provider Directory API supports. A profile is a set of rules which allows a resource to be constrained, or to include extensions, so the resource can add additional attributes. The RESTful capabilities are discussed in further detail below.
Conformance Language & Capability Statement
Resources in the Conformance category are used to represent metadata about the datatypes, resources, and CCAH Provider Directory API features of the FHIR specification and can be used to create derived specifications. Haga clic aquí to see the detailed categorization and full set of resources that fall into this category in the HL7® FHIR® Standard.
Implementation Notes
- Authentication is not required to access the Conformance resource.
This specification uses SHALL, SHOULD y MAY as a guideline for required, recommended and optional data FHIR standards.
- SHALL: An absolute requirement for all implementations. The FHIR server must return this data.
- SHOULD: A best practice or recommendation for the implementation. The FHIR server is recommended to return this data.
- MAY: An optional inclusion for the implementation; not a requirement. The FHIR server may return the data, but there is no requirement to do so.
FHIR RESTful API Capabilities
- Implements RESTful behaviors according to the FHIR specification
- Returns the following http status codes:
| HTTP Status Code | Description |
| 200 | Successful Request |
| 400 | Invalid Parameter |
| 401 | Not Authorized |
| 403 | Insufficient Scope |
| 404 | Unknown Resource |
| 410 | Deleted Resource |
Nota: For more information about the FHIR RESTful API, please refer to the HL7® FHIR® RESTful API topics.
Provider Directory Resources
These are the resources and the endpoints available with the Alliance Provider Directory API. The Provider Directory API supports the following FHIR approved implementation guide, and supports the following profiles:
Implementation Guide
Supported Profiles
Base URL
The base URL for each endpoint: [The Provider Directory platform is being retooled and this link will be available soon]
Below are the FHIR endpoints:
1) Endpoint
[The Provider Directory platform is being retooled and this link will be available soon]
| Key | Value |
| id | 5751535189661177282 |
| _lastUpdated | 20210319 044421.080 |
| meta.profile | http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint |
| name | Endpoint |
| address | [The Provider Directory platform is being retooled and this link will be available soon] |
2) HealthcareService
The Healthcare Service resource typically describes services offered by an organization/practitioner at a location. The resource may be used to encompass a variety of services covering the entire health care spectrum, including promotion, prevention, diagnostics, hospital and ambulatory care, home care, long-term care and other health-related and community services.
El programa DaVinci PDEX Plan-Net HealthcareService profile is based on the core FHIR HealthcareService resource.
[The Provider Directory platform is being retooled and this link will be available soon]
| Key | Value |
| id | 8255303642851950000 |
| _lastUpdated | 20210322 135044.124 |
| meta.profile | http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService |
| name | TEST, CCAH |
| location | Location/5240889202256475099 |
| specialty | http://www.nucc.org/taxonomy |
| service-category | http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/HealthcareServiceCategoryCS |
Fetch and Search Criteria
- The Alliance FHIR server SHALL be capable of returning a HealthcareService resource using:
GET [base]/HealthcareService/[id]
- The Alliance FHIR server SHOULD be capable of returning a HealthcareService resource using:
GET [base]/HealthcareService/[id]/_history/vid
- The Alliance FHIR server SHALL be capable of supporting the following _include parameters:
GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService:location
GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService:coverage-area
GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService:organization
- The Alliance FHIR server SHALL be capable of supporting the following _revinclude parameters:
GET [base]/HealthcareService?[parameter=value]&_revinclude=PractitionerRole:service
GET [base]/HealthcareService?[parameter=value]&_revinclude=OrganizationAffiliation:service
Extensions
Search Parameters
| Conformance | Search Parameter | Definition | Search Parameter Type | Ejemplo |
| SHALL | location | Select HealthcareServices available at the specified location. | reference | GET [base]/HealthcareService?location=[location] |
| SHALL | coverage-area | Select services available in a region described by the specified location. | reference | GET [base]/HealthcareService?coverage-area=[coverage-area] |
| SHALL | organization | Select HealthcareServices provided by the specified organization. | reference | GET [base]/HealthcareService?organization=[organization] |
| SHALL | name | Select HealthcareServices with the specified name. | string | GET [base]/HealthcareService?name=[name] |
| SHALL | service-category | Select HealthcareServices providing the specified category of services. | token | GET [base]/HealthcareService?category=[category] |
| SHALL | service-type | Select HealthcareServices of the specified type. | token | GET [base]/HealthcareService?service-type=[service-type] |
| SHALL | specialty | Select services associated with the specified specialty. | token | GET [base]/HealthcareService?specialty=[specialty] |
| SHALL | _id | The logical ID of the resource. | token | GET [base]/HealthcareService?_id=[id] |
| SHALL | _lastUpdated | When the resource version last changed. | date | GET [base]/HealthcareService?_lastUpdated=[_lastUpdated] |
3) InsurancePlan
Insurance Plan describes a health insurance offering comprised of a list of covered benefits (for example: the product), costs associated with those benefits (for example: the plan) and additional information about the offering, such as who it is owned and administered by, a coverage area, contact information, etc.
El programa DaVinci PDEX Plan-Net InsurancePlan profile is based on the core FHIR InsurancePlan resource.
[The Provider Directory platform is being retooled and this link will be available soon]
| Key | Value |
| id | 5259084001070900000 |
| _lastUpdated | 20210319 044421.156 |
| meta.profile | http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-InsurancePlan |
| name | DHCS |
| administered-by | Organization/2643920332232162708 |
| owned-by | Organization/6711270871498486941 |
| coverage-area | Location/6439372744080560247 |
| plan-type | http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/InsurancePlanTypeCS |
| type | http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/InsuranceProductTypeCS |
Fetch and Search Criteria
- The Alliance FHIR server SHALL be capable of returning an InsurancePlan resource using:
GET [base]/InsurancePlan/[id]
- The Alliance FHIR server SHOULD be capable of returning an InsurancePlan resource using:
GET [base]/InsurancePlan/[id]/_history/vid
- The Alliance FHIR server SHALL be capable of supporting the following _include parameters:
GET [base]/InsurancePlan?[parameter=value]&_include=InsurancePlan:administered-by
GET [base]/InsurancePlan?[parameter=value]&_include=InsurancePlan:owned-by
GET [base]/InsurancePlan?[parameter=value]&_include=InsurancePlan:coverage-area
Search Parameters
| Conformance | Search Parameter | Definition | Search Parameter Type | Ejemplo |
| SHALL | administered-by | Select products that are administered by the specified organization. | reference | GET [base]/InsurancePlan?administered-by=[administered-by] |
| SHALL | owned-by | Select products that are owned by the specified organization. | reference | GET [base]/InsurancePlan?owned-by=[owned-by] |
| SHALL | coverage-area | Select products that are offered in the specified location. | reference | GET [base]/InsurancePlan?coverage-area=[coverage-area] |
| SHALL | name | Select products with the specified name. | string | GET [base]/InsurancePlan?name=[name] |
| SHALL | plan-type | Select plans of the specified type. | token | GET [base]/InsurancePlan?plan-type=[system]|[code] |
| SHALL | identifier | Select products with the specified identifier. | token | GET [base]/InsurancePlan?identifier=[system]|[code] |
| SHALL | _id | The logical ID of the resource. | token | GET [base]/InsurancePlan?_id=[id] |
| SHALL | _lastUpdated | When the resource version last changed. | date | GET [base]/InsurancePlan?_lastUpdated=[_lastUpdated] |
| SHALL | type | Select insurance plans of the specified type. | token | GET [base]/InsurancePlan?type=[system]|[code] |
4) Location
A Location is the physical place where health care services are provided, practitioners are employed, organizations are based, etc. Locations can range in scope from a room in a building to a geographic region/area.
El programa DaVinci PDEX Plan-Net Location profile is based on the core FHIR US Core Location resource.
[The Provider Directory platform is being retooled and this link will be available soon]
| Key | Value |
| id | 5240889202256400000 |
| _lastUpdated | 20210317 073313.285 |
| meta.profile | http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location |
| name | CCAH TEST LMFT ATRBC Art for Access |
| address | 123 TEST STREET RANCHO LN STE 200C |
| address-postalcode | 94527 |
| address-state | CA |
| address-city | CONCORD |
| type | http://terminology.hl7.org/CodeSystem/v3-RoleCode |
Fetch and Search Criteria
- The Alliance FHIR server SHALL be capable of returning a Location resource using:
GET [base]/Location/[id]
- The Alliance FHIR server SHOULD be capable of returning an Organization resource using:
GET [base]/Location/[id]/_history/vid
- The Alliance FHIR server SHALL be capable of supporting the following _include parameters:
GET [base]/Location?[parameter=value]&_include=Location:organization
GET [base]/Location?[parameter=value]&_include=Location:partof
- The Alliance FHIR server SHALL be capable of supporting the following _revinclude parameters:
GET [base]/Location?[parameter=value]&_revinclude=HealthcareService:location
GET [base]/Location?[parameter=value]&_revinclude=InsurancePlan:coverage-area
GET [base]/Location?[parameter=value]&_revinclude=OrganizationAffiliation:location
GET [base]/Location?[parameter=value]&_revinclude=PractitionerRole:location
Extensions
Search Parameters
| Conformance | Search Parameter | Definition | Search Parameter Type | Ejemplo |
| SHALL | partof | Select Locations that are part of the specified location. | reference | GET [base]/Location?partof=[partof] |
| SHALL | organization | Select Locations managed by the specified organization. | reference | GET [base]/Location?organization=[organization] |
| SHALL | address-city | Select Locations with the specified city address. | string | GET [base]/Location?address-city=[address-city] |
| SHALL | address-state | Select Locations with the specified state address. | string | GET [base]/Location?address-state=[address-state] |
| SHALL | address-postalcode | Select Locations with the specified postal code address. | string | GET [base]/Location?address=[address] |
| SHALL | address | Select Locations with the specified address. | string | GET [base]/Location?address=[address] |
| SHALL | type | Select Locations of the specified type. | token | GET [base]/Location?type=[system]|[code] |
| SHALL | _id | The logical ID of the resource. | token | GET [base]/Location?_id=[id] |
| SHALL | _lastUpdated | When the resource version last changed. | date | GET [base]/Location?_lastUpdated=[_lastUpdated] |
5) Organization
A Network refers to a health care provider insurance network. A health care provider insurance network is an aggregation of organizations and individuals that deliver a set of services across a geography through health insurance products/plans. A network is typically owned by a payer. An Organization refers to a formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, health care practice groups, payer/insurer, etc.
El programa DaVinci PDEX Plan-Net Network profile is based on the core FHIR Organization resource, and the DaVinci PDEX Plan-Net Organization profile is based on the core FHIR US Core Organization resource.
[The Provider Directory platform is being retooled and this link will be available soon]
| Key | Value |
| id | 4802000587909327601 |
| _lastUpdated | 20210317 070944.584 |
| meta.profile | http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization |
| name | Test, CCAH |
| address | 123 TEST Street |
| address-postalcode | 943041601 |
| address-state | CA |
| address-city | PALO ALTO |
| type | http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrgTypeCS |
Fetch and Search Criteria
- The Alliance FHIR server SHALL be capable of returning an Organization resource using:
GET [base]/Organization/[id]
- The Alliance FHIR server SHOULD be capable of returning an Organization resource using:
GET [base]/Organization/[id]/_history/vid
- The Alliance FHIR server SHALL be capable of supporting the following _include parameters:
GET [base]/Organization?[parameter=value]&_include=Organization:partof
GET [base]/Organization?[parameter=value]&_include=Organization:coverage-area
- The Alliance FHIR server SHALL be capable of supporting the following _revinclude parameters:
GET [base]/Organization?[parameter=value]&_revinclude=HealthcareService:organization
GET [base]/Organization?[parameter=value]&_revinclude=InsurancePlan:administered-by
GET [base]/Organization?[parameter=value]&_revinclude=InsurancePlan:owned-by
GET [base]/Organization?[parameter=value]&_revinclude=OrganizationAffiliation:primary-organization
GET [base]/Organization?[parameter=value]&_revinclude=PractitionerRole:organization
GET [base]/Organization?[parameter=value]&_revinclude=PractitionerRole:network
GET [base]/Organization?[parameter=value]&_revinclude=OrganizationAffiliation:participating-organization
Extensions
- Location Reference
- Contactpoint Availabletime
- Via Intermediary
- Qualification
- Org Description
- Geolocation
Search Parameters
| Conformance | Search Parameter | Definition | Search Parameter Type | Ejemplo |
| SHALL | partof | Select Organizations that are part of the specified organization. | reference | GET [base]/Organization?partof=[partof] |
| SHALL | address | Select organizations with the specified address (matches any of the string elements of an address). | string | GET [base]/Organization?address=[address] |
| SHALL | name | Select Organizations with the specified name. | string | GET [base]/Organization?name=[name] |
| SHALL | _id | The logical ID of the resource. | token | GET [base]/Organization?_id=[id] |
| SHALL | _lastUpdated | When the resource version last changed. | date | GET [base]/Organization?_lastUpdated=[_lastUpdated] |
| SHALL | type | Select Organizations of the specified type. | token | GET [base]/Organization?type=[system]|[code] |
| SHALL | coverage-area | Select health insurance provider networks available in a region described by the specified location. | reference | GET [base]/Organization?coverage-area=[coverage-area] |
6) OrganizationAffiliation
The Organization Affiliation resource describes relationships between two or more organizations, including the services one organization provides another, the location(s) where they provide services, the availability of those services, electronic endpoints and other relevant information.
El programa DaVinci PDEX Plan-Net OrganizationAffiliation profile is based on the core FHIR OrganizationAffiliation resource.
[The Provider Directory platform is being retooled and this link will be available soon]
| Key | Value |
| id | 2655074298945687219 |
| _lastUpdated | 20210317 111720.712 |
| meta.profile | http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation |
| primary-organization | Organization/2105939142400949903 |
| participating-organization | Organization/2105939142400949903 |
| location | Location/5240889202256475099 |
| network | Organization/123456 |
Fetch and Search Criteria
- The Alliance FHIR server SHALL be capable of returning an OrganizationAffiliation resource using:
GET [base]/OrganizationAffiliation/[id]
- The Alliance FHIR server SHOULD be capable of returning an OrganizationAffiliation resource using:
GET [base]/OrganizationAffiliation/[id]/_history/vid
- The Alliance FHIR server SHALL be capable of supporting the following _include parameters:
GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation:primary-organization
GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation:participating-organization
GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation:location
GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation:service
GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation:network
Extensions
Search Parameters
| Conformance | Search Parameter | Definition | Search Parameter Type | Ejemplo |
| SHALL | primary-organization | Select roles offered by the specified organization. | reference | GET [base]/OrganizationAffiliation?primary-organization=[primary-organization] |
| SHALL | participating-organization | Select roles filled by the specified organization. | reference | GET [base]/OrganizationAffiliation?participating-organization=[participating-organization] |
| SHALL | location | Select OrganizationAffiliations available at the specified location. | reference | GET [base]/OrganizationAffiliation?location=[location] |
| SHALL | service | Select OrganizationAffiliations providing the specified service. | reference | GET [base]/OrganizationAffiliation?service=[service] |
| SHALL | network | Select roles where the organization is a member of the specified health insurance provider network. | reference | GET [base]/OrganizationAffiliation?network=[network] |
| SHALL | role | Select OrganizationAffiliations with the specified role. | token | GET [base]/OrganizationAffiliation?role=[role] |
| SHALL | specialty | Select OrganizationAffiliations associated with the specified specialty. | token | GET [base]/OrganizationAffiliation?specialty=[specialty] |
| SHALL | _id | The logical ID of the resource. | token | GET [base]/OrganizationAffiliation?_id=[id] |
| SHALL | _lastUpdated | When the resource version last changed. | date | GET [base]/OrganizationAffiliation?_lastUpdated=[_lastUpdated] |
7) Practitioner
A Practitioner is a person who is directly or indirectly involved in the provisioning of health care.
El programa DaVinci PDEX Plan-Net Practitioner profile is based on the core FHIR US Core Practitioner resource.
[The Provider Directory platform is being retooled and this link will be available soon]
| Key | Value |
| id | 8D32FCA7-F4EC-423D-93B8-000C269D1813 |
| _lastUpdated | 20210401 160100.978 |
| meta.profile | http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner |
| family | HEALTH MEDICAL CENTER |
| identifier.value | 1841525862 |
| identifier.system | http://hl7.org/fhir/sid/us-npi/ |
Fetch and Search Criteria
- The Alliance FHIR server SHALL be capable of returning a Practitioner resource using:
GET [base]/Practitioner/[id]
- The Alliance FHIR server SHOULD be capable of returning a Practitioner resource using:
GET [base]/Practitioner/[id]/_history/vid
- The Alliance FHIR server SHALL be capable of supporting the following _revinclude parameter:
GET [base]/Practitioner?[parameter=value]&_revinclude=PractitionerRole:practitioner
Extensions
- Contactpoint Availabletime
- Via Intermediary
- Geolocation
- Practitioner Qualification
- Communication Proficiency
Search Parameters
| Conformance | Search Parameter | Definition | Search Parameter Type | Ejemplo |
| SHALL | name | Select Practitioners with the specified name (matches against any of the elements in the HumanName data type). | string | GET [base]/Practitioner?name=[name] |
| SHALL | _id | The logical ID of the resource. | token | GET [base]/Practitioner?_id=[id] |
| SHALL | _lastUpdated | When the resource version last changed. | date | GET [base]/Practitioner?_lastUpdated=[_lastUpdated] |
| SHALL | family | Select Practitioners with the specified family name. | string | GET [base]/Practitioner?family=[family] |
| SHALL | given | Select Practitioners with the specified given name. | string | GET [base]/Practitioner?given=[given] |
8) PractitionerRole
A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
El programa DaVinci PDEX Plan-Net PractitionerRole profile is based on the core FHIR PractitionerRole resource.
[The Provider Directory platform is being retooled and this link will be available soon]
| Key | Value |
| id | 8160106400499867011 |
| _lastUpdated | 20210322 074912.539 |
| meta.profile | http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService |
| practitioner | Practitioner/1402157620721263560 |
| organization | Organization/4802000587909327601 |
| location | Location/2957802095982738323 |
Fetch and Search Criteria
- The Alliance FHIR server SHALL be capable of returning a PractitionerRole resource using:
GET [base]/PractitionerRole/[id]
- The Alliance FHIR server SHOULD be capable of returning a Practitioner resource using:
GET [base]/PractitionerRole/[id]/_history/vid
- The Alliance FHIR server SHALL be capable of supporting the following _include parameters:
GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:practitioner
GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:organization
GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:location
GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:service
GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:network
Extensions
Search Parameters
| Conformance | Search Parameter | Definition | Search Parameter Type | Ejemplo |
| SHALL | practitioner | Select roles filled by the specified practitioner. | reference | GET [base]/PractitionerRole?practitioner=[practitioner] |
| SHALL | organization | Select PractitionerRoles available at the specified organization. | reference | GET [base]/PractitionerRole?organization=[organization] |
| SHALL | location | Select PractitionerRoles available at the specified location. | reference | GET [base]/PractitionerRole?location=[location] |
| SHALL | service | Select PractitionerRoles providing the specified service. | reference | GET [base]/PractitionerRole?service=[service] |
| SHALL | network | Select roles where the practitioner is a member of the specified health insurance provider network. | reference | GET [base]/PractitionerRole?network=[network] |
| SHALL | role | Select PractitionerRoles with the specified role. | token | GET [base]/PractitionerRole?role=[role] |
| SHALL | specialty | Select PractitionerRoles associated with the specified specialty. | token | GET [base]/PractitionerRole?specialty=[specialty] |
| SHALL | _id | The logical ID of the resource. | token | GET [base]/PractitionerRole?_id=[id] |
| SHALL | _lastUpdated | When the resource version last changed. | date | GET [base]/PractitionerRole?_lastUpdated=[_lastUpdated] |
