Da Vinci PDex Plan Net
2.0.0-ballot - STU 2 ballot 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 2.0.0-ballot 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

Conformance Expectations

Page standards status: Informative

Use of Conformance Verbs^This implementation guide uses specific terminology such as SHALL, SHOULD, MAY to flag statements that have relevance for the evaluation of conformance with the guide.§plan-net-conf-1 As well, profiles in this implementation guide make use of the mustSupport element. Base expectations for the intepretations of these terms are set in the FHIR core specification and general Da Vinci-wide expectations are defined in HRex

Additional conformance expectations specific to this guide are as follows:

Conformance Expectations

  • This guide inherits all conformance expectations identified in the Health Record Exchange (Hrex) Conformance Expectations section. All systems claiming conformance to this guide SHALL conform to the requirements listed in that section.§plan-net-conf-2
  • Server Actors claiming conformance to the REST API in this guide SHALL meet the capability statement expectation requirements identified in the Plan Net CapabilityStatement and SHALL have a CapabilityStatement that has a CapabilityStatement.instantiates containing the canonical URL http://hl7.org/fhir/us/davinci-pdex-plan-net/CapabilityStatement/plan-net or a URL to the appropriate version of the CapabilityStatement.§plan-net-conf-3
  • Server Actors claiming conformance to this guide SHOULD meet the capability statement expectation requirements identified in the Plan-Net Bulk Publish CapabilityStatement. Server Actors claiming conformance to this guide MAY have a CapabilityStatement that has a CapabilityStatement.instantiates with a URL of http://hl7.org/fhir/us/davinci-pdex-plan-net/CapabilityStatement/plan-net-bulk-publish.§plan-net-conf-4
  • Detailed conformance requirements are specified on the Implementation page of this guide.

MustSupport

  • The must support requirements for this IG inherit from the Conformance Expectations section of the Da Vinci HRex IG and from US Core.

Server Actor Requirements

§plan-net-conf-5

Server Actor Requirements

  • Health Plan API actors SHALL be capable of populating all Must Support data elements as part of the query results.
  • In situations where information on a particular Must Support data element is not present and the minimum cardinality is 0 , the Health Plan API actors SHALL NOT include the data elements in the resource instance returned as part of the query results.
  • In situations where information on a particular data element is not present and the minimum cardinality is >0 SHALL send the reason for the missing information using values (such as nullFlavors) from the value set where they exist or use the dataAbsentReason extension.

Application Actor Requirements

§plan-net-conf-6

Application Actor Requirements

  • Application actors SHALL be capable of processing resource instances containing the Must Support data elements without generating an error or causing the application to fail.
  • Application actors SHOULD be capable of displaying the data elements for human use or storing the information for other purposes.
  • When querying Health Plan API actors, Application actors SHALL interpret missing Must Support data elements within resource instances as data not present in the Health Plan API actors system.
  • Consumer App actors SHALL be able to process resource instances containing Must Support data elements asserting missing information.

Conformance Statements

A table of all conformance statements in the guide is below:

IdExpectationRule
 SHALL
 SHOULD
 MAY
 SHALL NOT
§plan-net-conf-1SHALL
SHOULD
MAY
Use of Conformance Verbs^This implementation guide uses specific terminology such as SHALL, SHOULD, MAY to flag statements that have relevance for the evaluation of conformance with the guide.
§plan-net-conf-2SHALLThis guide inherits all conformance expectations identified in the Health Record Exchange (Hrex) Conformance Expectations section. All systems claiming conformance to this guide SHALL conform to the requirements listed in that section.
§plan-net-conf-3SHALLServer Actors claiming conformance to the REST API in this guide SHALL meet the capability statement expectation requirements identified in the Plan Net CapabilityStatement and SHALL have a CapabilityStatement that has a CapabilityStatement.instantiates containing the canonical URL http://hl7.org/fhir/us/davinci-pdex-plan-net/CapabilityStatement/plan-net or a URL to the appropriate version of the CapabilityStatement.
§plan-net-conf-4SHOULD
MAY
Server Actors claiming conformance to this guide SHOULD meet the capability statement expectation requirements identified in the Plan-Net Bulk Publish CapabilityStatement. Server Actors claiming conformance to this guide MAY have a CapabilityStatement that has a CapabilityStatement.instantiates with a URL of http://hl7.org/fhir/us/davinci-pdex-plan-net/CapabilityStatement/plan-net-bulk-publish.
§plan-net-conf-5SHALL NOT
SHALL

Server Actor Requirements

§plan-net-conf-6SHALL
SHOULD

Application Actor Requirements

§plan-net-imp-1SHALL NOTA conformant Plan-Net service SHALL NOT require a directory mobile application to send consumer identifying information in order to query content.
§plan-net-imp-2SHALL NOTA directory mobile application SHALL NOT send consumer identifiable information when querying a Plan-Net service.
§plan-net-imp-3SHALLServer Actors SHALL use the Plan-Net profiles and search parameters defined in this IG as well as the core FHIR R4 search parameters used by this IG consistently in order to achieve true interoperability of directory information among payers. The intent of this section is to provide examples of the canonical use of the profiles provided in this IG that will guide implementers towards the consistent use of these profiles that will enable 3rd party applications to search the data. The Plan-Net design is based around the following types of searches.
§plan-net-imp-4SHALLWhen sourcing data from other sources such as a generic FHIR server, setting active to false in the source system will make the data invalid from a Plan-Net perspective, so it SHALL be removed from the target Plan-Net directory.
§plan-net-imp-5SHALLServer Actors SHALL provide appropriate set of Plan-Net HealthcareService instances
§plan-net-imp-6SHALL
SHOULD

Plan Net Search Parameter Requirements

§plan-net-imp-7SHALL
SHOULD
MAY

Bulk Data Requirements

§plan-net-security-1SHALLUsers of this implementation guide SHALL conform to the Da Vinci HRex guidelines on privacy, safety, and security.