This page is part of the DaVinci PDEX Plan Net (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
Raw OpenAPI-Swagger Definition file | Download
This Section describes the expected capabilities of the Plan-Net Server actor which is responsible for providing responses to the queries submitted by the Plan-Net Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Plan-Net Servers are defined. Systems implementing this capability statement should meet the CMS FInal Rule requirement for provider directory access. Plan-Net Clients can use the required capabilities to access necessary data based on their local use cases and other contextual requirements.
The Plan-Net Server SHALL:
meta.profile
attribute for each instance.The Plan-Net Server SHOULD:
Security:
HTTP 401
unauthorized response code.Summary of Search Criteria
Resource Type | Supported Profiles | Supported Searches | Supported _includes | Supported _revincludes | Supported Operations |
---|---|---|---|---|---|
Endpoint | Plan-Net Endpoint | organization, _id, _lastUpdated | Endpoint:organization | ||
HealthcareService | Plan-Net HealthcareService | location, coverage-area, organization, endpoint, name, service-category, service-type, specialty, _id, _lastUpdated | HealthcareService:location, HealthcareService:coverage-area, HealthcareService:organization, HealthcareService:endpoint | PractitionerRole:service, OrganizationAffiliation:service | |
InsurancePlan | Plan-Net InsurancePlan | administered-by, owned-by, coverage-area, name, plan-type, identifier, _id, _lastUpdated, type | InsurancePlan:administered-by, InsurancePlan:owned-by, InsurancePlan:coverage-area | ||
Location | Plan-Net Location | partof, organization, endpoint, address-city, address-state, address-postalcode, address, type, _id, _lastUpdated | Location:endpoint, Location:organization, Location:partof | HealthcareService:location, InsurancePlan:coverage-area, OrganizationAffiliation:location, PractitionerRole:location | |
Organization | Plan-Net Network, Plan-Net Organization | partof, endpoint, address, name, _id, _lastUpdated, type, coverage-area | Organization:partof, Organization:endpoint, Organization:coverage-area | Endpoint:organization, HealthcareService:organization, InsurancePlan:administered-by, InsurancePlan:owned-by, OrganizationAffiliation:primary-organization, PractitionerRole:organization, PractitionerRole:network, OrganizationAffiliation:participating-organization | |
OrganizationAffiliation | Plan-Net OrganizationAffiliation | primary-organization, participating-organization, location, service, network, endpoint, role, specialty, _id, _lastUpdated | OrganizationAffiliation:primary-organization, OrganizationAffiliation:participating-organization, OrganizationAffiliation:location, OrganizationAffiliation:service, OrganizationAffiliation:endpoint, OrganizationAffiliation:network | ||
Practitioner | Plan-Net Practitioner | name, _id, _lastUpdated, family, given | PractitionerRole:practitioner | ||
PractitionerRole | Plan-Net PractitionerRole | practitioner, organization, location, service, network, endpoint, role, specialty, _id, _lastUpdated | PractitionerRole:practitioner, PractitionerRole:organization, PractitionerRole:location, PractitionerRole:service, PractitionerRole:network, PractitionerRole:endpoint |
Conformance Expectation: SHALL
Supported Profiles: Plan-Net Endpoint
Reference Policy: resolves
Profile Interaction Summary:
search-type
,
read
.vread
.Fetch and Search Criteria:
GET [base]/Endpoint/[id]
GET [base]/Endpoint/[id]/_history/vid
GET [base]/Endpoint?[parameter=value]&_include=Endpoint:organization
Search Parameter Summary:
Conformance | Parameter | Type | Example |
---|---|---|---|
SHALL | organization | reference | GET [base]/Endpoint?organization=[organization] |
SHALL | _id | token | GET [base]/Endpoint?_id=[id] |
SHALL | _lastUpdated | date | GET [base]/Endpoint?_lastUpdated=[_lastUpdated] |
Conformance Expectation: SHALL
Supported Profiles: Plan-Net HealthcareService
Reference Policy: resolves
Profile Interaction Summary:
search-type
,
read
.vread
.Fetch and Search Criteria:
GET [base]/HealthcareService/[id]
GET [base]/HealthcareService/[id]/_history/vid
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
GET [base]/HealthcareService?[parameter=value]&_include=HealthcareService:endpoint
GET [base]/HealthcareService?[parameter=value]&_revinclude=PractitionerRole:service
GET [base]/HealthcareService?[parameter=value]&_revinclude=OrganizationAffiliation:service
Search Parameter Summary:
Conformance | Parameter | Type | Example |
---|---|---|---|
SHALL | location | reference | GET [base]/HealthcareService?location=[location] |
SHALL | coverage-area | reference | GET [base]/HealthcareService?coverage-area=[coverage-area] |
SHALL | organization | reference | GET [base]/HealthcareService?organization=[organization] |
SHALL | endpoint | reference | GET [base]/HealthcareService?endpoint=[endpoint] |
SHALL | name | string | GET [base]/HealthcareService?name=[name] |
SHALL | service-category | token | GET [base]/HealthcareService?service-category=[system]|[code] |
SHALL | service-type | token | GET [base]/HealthcareService?service-type=[system]|[code] |
SHALL | specialty | token | GET [base]/HealthcareService?specialty=[system]|[code] |
SHALL | _id | token | GET [base]/HealthcareService?_id=[id] |
SHALL | _lastUpdated | date | GET [base]/HealthcareService?_lastUpdated=[_lastUpdated] |
Conformance Expectation: SHALL
Supported Profiles: Plan-Net InsurancePlan
Reference Policy: resolves
Profile Interaction Summary:
search-type
,
read
.vread
.Fetch and Search Criteria:
GET [base]/InsurancePlan/[id]
GET [base]/InsurancePlan/[id]/_history/vid
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 Parameter Summary:
Conformance | Parameter | Type | Example |
---|---|---|---|
SHALL | administered-by | reference | GET [base]/InsurancePlan?administered-by=[administered-by] |
SHALL | owned-by | reference | GET [base]/InsurancePlan?owned-by=[owned-by] |
SHALL | coverage-area | reference | GET [base]/InsurancePlan?coverage-area=[coverage-area] |
SHALL | name | string | GET [base]/InsurancePlan?name=[name] |
SHALL | plan-type | token | GET [base]/InsurancePlan?plan-type=[system]|[code] |
SHALL | identifier | token | GET [base]/InsurancePlan?identifier=[system]|[code] |
SHALL | _id | token | GET [base]/InsurancePlan?_id=[id] |
SHALL | _lastUpdated | date | GET [base]/InsurancePlan?_lastUpdated=[_lastUpdated] |
SHALL | type | token | GET [base]/InsurancePlan?type=[system]|[code] |
Conformance Expectation: SHALL
Supported Profiles: Plan-Net Location
Reference Policy: resolves
Profile Interaction Summary:
search-type
,
read
.vread
.Fetch and Search Criteria:
GET [base]/Location/[id]
GET [base]/Location/[id]/_history/vid
GET [base]/Location?[parameter=value]&_include=Location:endpoint
GET [base]/Location?[parameter=value]&_include=Location:organization
GET [base]/Location?[parameter=value]&_include=Location:partof
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
Search Parameter Summary:
Conformance | Parameter | Type | Example |
---|---|---|---|
SHALL | partof | reference | GET [base]/Location?partof=[partof] |
SHALL | organization | reference | GET [base]/Location?organization=[organization] |
SHALL | endpoint | reference | GET [base]/Location?endpoint=[endpoint] |
SHALL | address-city | string | GET [base]/Location?address-city=[address-city] |
SHALL | address-state | string | GET [base]/Location?address-state=[address-state] |
SHALL | address-postalcode | string | GET [base]/Location?address-postalcode=[address-postalcode] |
SHALL | address | string | GET [base]/Location?address=[address] |
SHALL | type | token | GET [base]/Location?type=[system]|[code] |
SHALL | _id | token | GET [base]/Location?_id=[id] |
SHALL | _lastUpdated | date | GET [base]/Location?_lastUpdated=[_lastUpdated] |
Conformance Expectation: SHALL
Supported Profiles: Plan-Net Network, Plan-Net Organization
Reference Policy: resolves
Profile Interaction Summary:
search-type
,
read
.vread
.Fetch and Search Criteria:
GET [base]/Organization/[id]
GET [base]/Organization/[id]/_history/vid
GET [base]/Organization?[parameter=value]&_include=Organization:partof
GET [base]/Organization?[parameter=value]&_include=Organization:endpoint
GET [base]/Organization?[parameter=value]&_include=Organization:coverage-area
GET [base]/Organization?[parameter=value]&_revinclude=Endpoint:organization
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
Search Parameter Summary:
Conformance | Parameter | Type | Example |
---|---|---|---|
SHALL | partof | reference | GET [base]/Organization?partof=[partof] |
SHALL | endpoint | reference | GET [base]/Organization?endpoint=[endpoint] |
SHALL | address | string | GET [base]/Organization?address=[address] |
SHALL | name | string | GET [base]/Organization?name=[name] |
SHALL | _id | token | GET [base]/Organization?_id=[id] |
SHALL | _lastUpdated | date | GET [base]/Organization?_lastUpdated=[_lastUpdated] |
SHALL | type | token | GET [base]/Organization?type=[system]|[code] |
SHALL | coverage-area | reference | GET [base]/Organization?coverage-area=[coverage-area] |
Conformance Expectation: SHALL
Supported Profiles: Plan-Net OrganizationAffiliation
Reference Policy: resolves
Profile Interaction Summary:
search-type
,
read
.vread
.Fetch and Search Criteria:
GET [base]/OrganizationAffiliation/[id]
GET [base]/OrganizationAffiliation/[id]/_history/vid
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:endpoint
GET [base]/OrganizationAffiliation?[parameter=value]&_include=OrganizationAffiliation:network
Search Parameter Summary:
Conformance | Parameter | Type | Example |
---|---|---|---|
SHALL | primary-organization | reference | GET [base]/OrganizationAffiliation?primary-organization=[primary-organization] |
SHALL | participating-organization | reference | GET [base]/OrganizationAffiliation?participating-organization=[participating-organization] |
SHALL | location | reference | GET [base]/OrganizationAffiliation?location=[location] |
SHALL | service | reference | GET [base]/OrganizationAffiliation?service=[service] |
SHALL | network | reference | GET [base]/OrganizationAffiliation?network=[network] |
SHALL | endpoint | reference | GET [base]/OrganizationAffiliation?endpoint=[endpoint] |
SHALL | role | token | GET [base]/OrganizationAffiliation?role=[system]|[code] |
SHALL | specialty | token | GET [base]/OrganizationAffiliation?specialty=[system]|[code] |
SHALL | _id | token | GET [base]/OrganizationAffiliation?_id=[id] |
SHALL | _lastUpdated | date | GET [base]/OrganizationAffiliation?_lastUpdated=[_lastUpdated] |
Conformance Expectation: SHALL
Supported Profiles: Plan-Net Practitioner
Reference Policy: resolves
Profile Interaction Summary:
search-type
,
read
.vread
.Fetch and Search Criteria:
GET [base]/Practitioner/[id]
GET [base]/Practitioner/[id]/_history/vid
GET [base]/Practitioner?[parameter=value]&_revinclude=PractitionerRole:practitioner
Search Parameter Summary:
Conformance | Parameter | Type | Example |
---|---|---|---|
SHALL | name | string | GET [base]/Practitioner?name=[name] |
SHALL | _id | token | GET [base]/Practitioner?_id=[id] |
SHALL | _lastUpdated | date | GET [base]/Practitioner?_lastUpdated=[_lastUpdated] |
SHALL | family | string | GET [base]/Practitioner?family=[family] |
SHALL | given | string | GET [base]/Practitioner?given=[given] |
Conformance Expectation: SHALL
Supported Profiles: Plan-Net PractitionerRole
Reference Policy: resolves
Profile Interaction Summary:
search-type
,
read
.vread
.Fetch and Search Criteria:
GET [base]/PractitionerRole/[id]
GET [base]/PractitionerRole/[id]/_history/vid
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
GET [base]/PractitionerRole?[parameter=value]&_include=PractitionerRole:endpoint
Search Parameter Summary:
Conformance | Parameter | Type | Example |
---|---|---|---|
SHALL | practitioner | reference | GET [base]/PractitionerRole?practitioner=[practitioner] |
SHALL | organization | reference | GET [base]/PractitionerRole?organization=[organization] |
SHALL | location | reference | GET [base]/PractitionerRole?location=[location] |
SHALL | service | reference | GET [base]/PractitionerRole?service=[service] |
SHALL | network | reference | GET [base]/PractitionerRole?network=[network] |
SHALL | endpoint | reference | GET [base]/PractitionerRole?endpoint=[endpoint] |
SHALL | role | token | GET [base]/PractitionerRole?role=[system]|[code] |
SHALL | specialty | token | GET [base]/PractitionerRole?specialty=[system]|[code] |
SHALL | _id | token | GET [base]/PractitionerRole?_id=[id] |
SHALL | _lastUpdated | date | GET [base]/PractitionerRole?_lastUpdated=[_lastUpdated] |