# description
The Capability Statement describes the capabilities of this Plan-Net Server which provides responses to queries submitted by Consumer Applications. The complete list of FHIR profiles, RESTful operations, and search parameters supported by the Server are defined. This capability statement should meet the CMS Interoperability and Patient Access 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. A separate instance of the Plan-Net Server may be provided for Pharmacy Directory information.

# rest[].documentation
The Plan-Net  Server **SHALL**:

1. Support all profiles defined in this Implementation Guide..
1.  Implement the RESTful behavior according to the FHIR specification.
1. 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.
1. Support json source formats for all Plan-Net interactions.
1. Identify the Plan-Net  profiles supported as part of the FHIR `meta.profile` attribute for each instance.
1. 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.

# rest[].security.description
1. See the [General Security Considerations](implementation.html#general-security-considerations) section for requirements and recommendations.
1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code.

# rest[].resource[].searchParam[].documentation
Identifies where the resource comes from

# rest[].resource[].searchParam[].documentation
The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)

# rest[].resource[].searchParam[].documentation
Profiles this resource claims to conform to

# rest[].resource[].searchParam[].documentation
A name that this endpoint can be identified by

# rest[].resource[].searchParam[].documentation
Identifies this endpoint across multiple systems

# rest[].resource[].searchParam[].documentation
The current status of the Endpoint (usually expected to be active)

# rest[].resource[].searchParam[].documentation
The organization that is managing the endpoint

# rest[].resource[].searchParam[].documentation
Security Labels applied to this resource

# rest[].resource[].searchParam[].documentation
Searches resources based on the version id of the resource

# rest[].resource[].searchParam[].documentation
Protocol/Profile/Standard to be used with this endpoint connection

# rest[].resource[].searchParam[].documentation
One of the HealthcareService's characteristics

# rest[].resource[].searchParam[].documentation
One of the Programs supported by this HealthcareService

# rest[].resource[].searchParam[].documentation
The type of service provided by this healthcare service

# rest[].resource[].searchParam[].documentation
Identifies where the resource comes from

# rest[].resource[].searchParam[].documentation
The specialty of the service provided by this healthcare service

# rest[].resource[].searchParam[].documentation
Location(s) service is intended for/available to

# rest[].resource[].searchParam[].documentation
Profiles this resource claims to conform to

# rest[].resource[].searchParam[].documentation
Technical endpoints providing access to electronic services operated for the healthcare service

# rest[].resource[].searchParam[].documentation
A portion of the Healthcare service name

# rest[].resource[].searchParam[].documentation
Service Category of the Healthcare Service

# rest[].resource[].searchParam[].documentation
The organization that provides this Healthcare Service

# rest[].resource[].searchParam[].documentation
Security Labels applied to this resource

# rest[].resource[].searchParam[].documentation
The Healthcare Service is currently marked as active

# rest[].resource[].searchParam[].documentation
Searches resources based on the version id of the resource

# rest[].resource[].searchParam[].documentation
Identifies where the resource comes from

# rest[].resource[].searchParam[].documentation
A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text

# rest[].resource[].searchParam[].documentation
An organization of which this organization forms a part

# rest[].resource[].searchParam[].documentation
A portion of the organization's name using some kind of phonetic matching algorithm

# rest[].resource[].searchParam[].documentation
Select products that are offered in the specified location

# rest[].resource[].searchParam[].documentation
Profiles this resource claims to conform to

# rest[].resource[].searchParam[].documentation
A portion of the organization's name or alias

# rest[].resource[].searchParam[].documentation
Any identifier for the organization (not the accreditation issuer's identifier)

# rest[].resource[].searchParam[].documentation
Security Labels applied to this resource

# rest[].resource[].searchParam[].documentation
Searches resources based on the version id of the resource

# rest[].resource[].searchParam[].documentation
Identifies where the resource comes from

# rest[].resource[].searchParam[].documentation
Profiles this resource claims to conform to

# rest[].resource[].searchParam[].documentation
Technical endpoints providing access to services operated for the location

# rest[].resource[].searchParam[].documentation
A portion of the location's name or alias

# rest[].resource[].searchParam[].documentation
Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)

# rest[].resource[].searchParam[].documentation
Searches for locations with a specific kind of status

# rest[].resource[].searchParam[].documentation
Searches for locations that are managed by the provided organization

# rest[].resource[].searchParam[].documentation
A location of which this location is a part

# rest[].resource[].searchParam[].documentation
Security Labels applied to this resource

# rest[].resource[].searchParam[].documentation
Searches resources based on the version id of the resource

# rest[].resource[].searchParam[].documentation
Identifies where the resource comes from

# rest[].resource[].searchParam[].documentation
A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text

# rest[].resource[].searchParam[].documentation
A portion of the organization's name using some kind of phonetic matching algorithm

# rest[].resource[].searchParam[].documentation
Select health insurance provider networks available in a region described by the specified location

# rest[].resource[].searchParam[].documentation
Profiles this resource claims to conform to

# rest[].resource[].searchParam[].documentation
Technical endpoints providing access to services operated for the organization

# rest[].resource[].searchParam[].documentation
A portion of the organization's name or alias

# rest[].resource[].searchParam[].documentation
Any identifier for the organization (not the accreditation issuer's identifier)

# rest[].resource[].searchParam[].documentation
An organization of which this organization forms a part

# rest[].resource[].searchParam[].documentation
Security Labels applied to this resource

# rest[].resource[].searchParam[].documentation
Searches resources based on the version id of the resource

# rest[].resource[].searchParam[].documentation
Healthcare services provided through the role

# rest[].resource[].searchParam[].documentation
Identifies where the resource comes from

# rest[].resource[].searchParam[].documentation
Specific specialty of the participatingOrganization in the context of the role

# rest[].resource[].searchParam[].documentation
Profiles this resource claims to conform to

# rest[].resource[].searchParam[].documentation
Technical endpoints providing access to services operated for this role

# rest[].resource[].searchParam[].documentation
The period during which the participatingOrganization is affiliated with the primary organization

# rest[].resource[].searchParam[].documentation
The organization that receives the services from the participating organization

# rest[].resource[].searchParam[].documentation
Security Labels applied to this resource

# rest[].resource[].searchParam[].documentation
Whether this organization affiliation record is in active use

# rest[].resource[].searchParam[].documentation
The organization that provides services to the primary organization

# rest[].resource[].searchParam[].documentation
The location(s) at which the role occurs

# rest[].resource[].searchParam[].documentation
Definition of the role the participatingOrganization plays

# rest[].resource[].searchParam[].documentation
Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)

# rest[].resource[].searchParam[].documentation
Searches resources based on the version id of the resource

# rest[].resource[].searchParam[].documentation
Identifies where the resource comes from

# rest[].resource[].searchParam[].documentation
Multiple Resources: 

* [Patient](patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
* [Person](person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
* [Practitioner](practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
* [RelatedPerson](relatedperson.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text

# rest[].resource[].searchParam[].documentation
One of the languages that the practitioner can communicate with

# rest[].resource[].searchParam[].documentation
Multiple Resources: 

* [Patient](patient.html): A portion of the family name of the patient
* [Practitioner](practitioner.html): A portion of the family name

# rest[].resource[].searchParam[].documentation
Multiple Resources: 

* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm
* [Person](person.html): A portion of name using some kind of phonetic matching algorithm
* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm
* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm

# rest[].resource[].searchParam[].documentation
Multiple Resources: 

* [Patient](patient.html): A value in a phone contact
* [Person](person.html): A value in a phone contact
* [Practitioner](practitioner.html): A value in a phone contact
* [PractitionerRole](practitionerrole.html): A value in a phone contact
* [RelatedPerson](relatedperson.html): A value in a phone contact

# rest[].resource[].searchParam[].documentation
Multiple Resources: 

* [Patient](patient.html): Gender of the patient
* [Person](person.html): The gender of the person
* [Practitioner](practitioner.html): Gender of the practitioner
* [RelatedPerson](relatedperson.html): Gender of the related person

# rest[].resource[].searchParam[].documentation
Profiles this resource claims to conform to

# rest[].resource[].searchParam[].documentation
A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

# rest[].resource[].searchParam[].documentation
Multiple Resources: 

* [Patient](patient.html): A portion of the given name of the patient
* [Practitioner](practitioner.html): A portion of the given name

# rest[].resource[].searchParam[].documentation
Multiple Resources: 

* [Patient](patient.html): A country specified in an address
* [Person](person.html): A country specified in an address
* [Practitioner](practitioner.html): A country specified in an address
* [RelatedPerson](relatedperson.html): A country specified in an address

# rest[].resource[].searchParam[].documentation
Multiple Resources: 

* [Patient](patient.html): The value in any kind of telecom details of the patient
* [Person](person.html): The value in any kind of contact
* [Practitioner](practitioner.html): The value in any kind of contact
* [PractitionerRole](practitionerrole.html): The value in any kind of contact
* [RelatedPerson](relatedperson.html): The value in any kind of contact

# rest[].resource[].searchParam[].documentation
Security Labels applied to this resource

# rest[].resource[].searchParam[].documentation
Multiple Resources: 

* [Patient](patient.html): A use code specified in an address
* [Person](person.html): A use code specified in an address
* [Practitioner](practitioner.html): A use code specified in an address
* [RelatedPerson](relatedperson.html): A use code specified in an address

# rest[].resource[].searchParam[].documentation
Whether the practitioner record is active

# rest[].resource[].searchParam[].documentation
Multiple Resources: 

* [Patient](patient.html): A value in an email contact
* [Person](person.html): A value in an email contact
* [Practitioner](practitioner.html): A value in an email contact
* [PractitionerRole](practitionerrole.html): A value in an email contact
* [RelatedPerson](relatedperson.html): A value in an email contact

# rest[].resource[].searchParam[].documentation
Multiple Resources: 

* [Patient](patient.html): A city specified in an address
* [Person](person.html): A city specified in an address
* [Practitioner](practitioner.html): A city specified in an address
* [RelatedPerson](relatedperson.html): A city specified in an address

# rest[].resource[].searchParam[].documentation
Searches resources based on the version id of the resource

# rest[].resource[].searchParam[].documentation
Multiple Resources: 

* [Patient](patient.html): A state specified in an address
* [Person](person.html): A state specified in an address
* [Practitioner](practitioner.html): A state specified in an address
* [RelatedPerson](relatedperson.html): A state specified in an address

# rest[].resource[].searchParam[].documentation
Multiple Resources: 

* [Patient](patient.html): A postalCode specified in an address
* [Person](person.html): A postal code specified in an address
* [Practitioner](practitioner.html): A postalCode specified in an address
* [RelatedPerson](relatedperson.html): A postal code specified in an address

# rest[].resource[].searchParam[].documentation
The list of healthcare services that this worker provides for this role's Organization/Location(s)

# rest[].resource[].searchParam[].documentation
Identifies where the resource comes from

# rest[].resource[].searchParam[].documentation
Multiple Resources: 

* [Patient](patient.html): A value in a phone contact
* [Person](person.html): A value in a phone contact
* [Practitioner](practitioner.html): A value in a phone contact
* [PractitionerRole](practitionerrole.html): A value in a phone contact
* [RelatedPerson](relatedperson.html): A value in a phone contact

# rest[].resource[].searchParam[].documentation
The practitioner has this specialty at an organization

# rest[].resource[].searchParam[].documentation
Profiles this resource claims to conform to

# rest[].resource[].searchParam[].documentation
Technical endpoints providing access to services operated for the practitioner with this role

# rest[].resource[].searchParam[].documentation
Practitioner that is able to provide the defined services for the organization

# rest[].resource[].searchParam[].documentation
The identity of the organization the practitioner represents / acts on behalf of

# rest[].resource[].searchParam[].documentation
The period during which the practitioner is authorized to perform in these role(s)

# rest[].resource[].searchParam[].documentation
Multiple Resources: 

* [Patient](patient.html): The value in any kind of telecom details of the patient
* [Person](person.html): The value in any kind of contact
* [Practitioner](practitioner.html): The value in any kind of contact
* [PractitionerRole](practitionerrole.html): The value in any kind of contact
* [RelatedPerson](relatedperson.html): The value in any kind of contact

# rest[].resource[].searchParam[].documentation
Security Labels applied to this resource

# rest[].resource[].searchParam[].documentation
Whether this practitioner role record is in active use

# rest[].resource[].searchParam[].documentation
Multiple Resources: 

* [Patient](patient.html): A value in an email contact
* [Person](person.html): A value in an email contact
* [Practitioner](practitioner.html): A value in an email contact
* [PractitionerRole](practitionerrole.html): A value in an email contact
* [RelatedPerson](relatedperson.html): A value in an email contact

# rest[].resource[].searchParam[].documentation
One of the locations at which this practitioner provides care

# rest[].resource[].searchParam[].documentation
The practitioner can perform this role at for the organization

# rest[].resource[].searchParam[].documentation
Searches resources based on the version id of the resource