Da Vinci PDex Plan Net
1.2.0 - STU 2 (ci-build) United States of America flag

Da Vinci PDex Plan Net, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 1.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pdex-plan-net/ and changes regularly. See the Directory of published versions

CapabilityStatement: Plan-Net CapabilityStatement

Official URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/CapabilityStatement/plan-net Version: 1.2.0
Standards status: Trial-use Computable Name: DavinciPdexPlanNetCapabilityStatement

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.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement plan-net

Plan-Net CapabilityStatement

  • Implementation Guide Version: 1.2.0
  • FHIR Version: 4.0.1
  • Supported Formats: xml, json
  • Supported Patch Formats: application/json-patch+json
  • Published on: 2022-03-18
  • Published by: HL7 International / Financial Management

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

The Plan-Net Server SHALL:

  1. Support all profiles defined in this Implementation Guide..
  2. Implement the RESTful behavior according to the FHIR specification.
  3. Return the following response classes:
    • (Status 400): invalid parameter
    • (Status 401/4xx): unauthorized request
    • (Status 403): insufficient scope
    • (Status 404): unknown resource
    • (Status 410): deleted resource.
  4. Support json source formats for all Plan-Net interactions.
  5. Identify the Plan-Net profiles supported as part of the FHIR meta.profile attribute for each instance.
  6. Support the searchParameters on each profile individually and in combination. 1.Support forward and reverse chaining on all search parameters that specify the 'chain' property

The Plan-Net Server SHOULD:

  1. Support xml source formats for all Plan-Net interactions.
Security
  1. See the General Security Considerations section for requirements and recommendations.
  2. A server SHALL reject any unauthorized requests by returning an HTTP 401 unauthorized response code.
Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRV-RSUCSearches_include_revincludeOperations
EndpointSupported Profiles
  Plan-Net Endpoint		yyyorganization, _id, _lastUpdatedEndpoint:organization
HealthcareServiceSupported Profiles
  Plan-Net HealthcareService		yyylocation, coverage-area, organization, endpoint, name, service-category, service-type, specialty, _id, _lastUpdatedHealthcareService:location, HealthcareService:coverage-area, HealthcareService:organization, HealthcareService:endpointPractitionerRole:service, OrganizationAffiliation:service
InsurancePlanSupported Profiles
  Plan-Net InsurancePlan		yyyadministered-by, owned-by, coverage-area, name, plan-type, identifier, _id, _lastUpdated, typeInsurancePlan:administered-by, InsurancePlan:owned-by, InsurancePlan:coverage-area
LocationSupported Profiles
  Plan-Net Location		yyypartof, organization, endpoint, address-city, address-state, address-postalcode, address, type, _id, _lastUpdatedLocation:endpoint, Location:organization, Location:partofHealthcareService:location, InsurancePlan:coverage-area, OrganizationAffiliation:location, PractitionerRole:location
OrganizationSupported Profiles
  Plan-Net Network
  Plan-Net Organization		yyypartof, endpoint, address, name, _id, _lastUpdated, type, coverage-areaOrganization:partof, Organization:endpoint, Organization:coverage-areaEndpoint:organization, HealthcareService:organization, InsurancePlan:administered-by, InsurancePlan:owned-by, OrganizationAffiliation:primary-organization, PractitionerRole:organization, PractitionerRole:network, OrganizationAffiliation:participating-organization
OrganizationAffiliationSupported Profiles
  Plan-Net OrganizationAffiliation		yyyprimary-organization, participating-organization, location, service, network, endpoint, role, specialty, _id, _lastUpdatedOrganizationAffiliation:primary-organization, OrganizationAffiliation:participating-organization, OrganizationAffiliation:location, OrganizationAffiliation:service, OrganizationAffiliation:endpoint, OrganizationAffiliation:network
PractitionerSupported Profiles
  Plan-Net Practitioner		yyyname, _id, _lastUpdated, family, givenPractitionerRole:practitioner
PractitionerRoleSupported Profiles
  Plan-Net PractitionerRole		yyypractitioner, organization, location, service, network, endpoint, role, specialty, _id, _lastUpdatedPractitionerRole:practitioner, PractitionerRole:organization, PractitionerRole:location, PractitionerRole:service, PractitionerRole:network, PractitionerRole:endpoint
Core FHIR Resource
Endpoint
Reference Policy
resolves
Interaction summary
  • SHALL support search-type, read.
  • SHOULD support vread.

Supported Profiles

Plan-Net Endpoint

Search Parameters
ConformanceParameterTypeDocumentation
SHALLorganizationreference
SHALL_idtoken
SHALL_lastUpdateddate
 
Core FHIR Resource
HealthcareService
Reference Policy
resolves
Interaction summary
  • SHALL support search-type, read.
  • SHOULD support vread.

Supported Profiles

Plan-Net HealthcareService

Search Parameters
ConformanceParameterTypeDocumentation
SHALLlocationreference
SHALLcoverage-areareference
SHALLorganizationreference
SHALLendpointreference
SHALLnamestring
SHALLservice-categorytoken
SHALLservice-typetoken
SHALLspecialtytoken
SHALL_idtoken
SHALL_lastUpdateddate
 
Core FHIR Resource
InsurancePlan
Reference Policy
resolves
Interaction summary
  • SHALL support search-type, read.
  • SHOULD support vread.

Supported Profiles

Plan-Net InsurancePlan

Search Parameters
ConformanceParameterTypeDocumentation
SHALLadministered-byreference
SHALLowned-byreference
SHALLcoverage-areareference
SHALLnamestring
SHALLplan-typetoken
SHALLidentifiertoken
SHALL_idtoken
SHALL_lastUpdateddate
SHALLtypetoken
 
Core FHIR Resource
Location
Reference Policy
resolves
Interaction summary
  • SHALL support search-type, read.
  • SHOULD support vread.

Supported Profiles

Plan-Net Location

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpartofreference
SHALLorganizationreference
SHALLendpointreference
SHALLaddress-citystring
SHALLaddress-statestring
SHALLaddress-postalcodestring
SHALLaddressstring
SHALLtypetoken
SHALL_idtoken
SHALL_lastUpdateddate
 
Core FHIR Resource
Organization
Reference Policy
resolves
Interaction summary
  • SHALL support search-type, read.
  • SHOULD support vread.

Supported Profiles

Plan-Net Network
Plan-Net Organization

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpartofreference
SHALLendpointreference
SHALLaddressstring
SHALLnamestring
SHALL_idtoken
SHALL_lastUpdateddate
SHALLtypetoken
SHALLcoverage-areareference
 
Core FHIR Resource
OrganizationAffiliation
Reference Policy
resolves
Interaction summary
  • SHALL support search-type, read.
  • SHOULD support vread.

Supported Profiles

Plan-Net OrganizationAffiliation

Search Parameters
ConformanceParameterTypeDocumentation
SHALLprimary-organizationreference
SHALLparticipating-organizationreference
SHALLlocationreference
SHALLservicereference
SHALLnetworkreference
SHALLendpointreference
SHALLroletoken
SHALLspecialtytoken
SHALL_idtoken
SHALL_lastUpdateddate
 
Core FHIR Resource
Practitioner
Reference Policy
resolves
Interaction summary
  • SHALL support search-type, read.
  • SHOULD support vread.

Supported Profiles

Plan-Net Practitioner

Search Parameters
ConformanceParameterTypeDocumentation
SHALLnamestring
SHALL_idtoken
SHALL_lastUpdateddate
SHALLfamilystring
SHALLgivenstring
 
Core FHIR Resource
PractitionerRole
Reference Policy
resolves
Interaction summary
  • SHALL support search-type, read.
  • SHOULD support vread.

Supported Profiles

Plan-Net PractitionerRole

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpractitionerreference
SHALLorganizationreference
SHALLlocationreference
SHALLservicereference
SHALLnetworkreference
SHALLendpointreference
SHALLroletoken
SHALLspecialtytoken
SHALL_idtoken
SHALL_lastUpdateddate