Repository navigation
Client Must Support
The must support flag is one mechanism used within FHIR to denote elements that may not be required on all instances of a profile but are necessary to represent the full scope of situations that the profile is designed to handle. Each FHIR IG defines the precise meaning of must support within the profiles that it defines and sets the requirements that the must support flag places on the different actors defined by the IG.
Inferno generally validates must support definitions by analyzing a set of resources gathered over one or more tests and checking that each must support element defined in the relevant profile(s) has been observed populated at least once.
PAS, in both the v2.0.1 and v2.2.1 versions that Inferno currently has suites for, requires that PAS clients follow the must support requirements defined in the Da Vinci HRex IG, including when acting as a:
-
Data Source: PAS clients act as a data source when they send information to
the payer via the
$submitand$inquireoperations. HRex requires data sources to "be capable of populating the data element when sharing resources compliant with the profile." Taken together, this means that the PAS IG requires that PAS clients demonstrate the ability to populate all must support elements defined on PAS profiles that can appear within$submitand$inquireoperation requests. -
Data Consumer: PAS clients act as a data consumer when they receive Bundles
including a ClaimResponse and related details in
$submitand$inquireoperation responses or Subscription notifications. HRex requires data consumers to "be capable of processing resource instances containing the data elements without generating an error or causing the application to fail." Taken together, this means that the PAS IG requires that PAS clients demonstrate the ability to receive without erroring all must support elements defined on PAS profiles that can appear within$submitand$inquireoperation responses (PAS Subscription notifications include the equivalent of a$submitresponse Bundle). A portion of this requirement is restated explicitly by the PAS IG for the Claim Response and Claim Inquiry Response profiles (in v2.0.1, v2.2.1).
There are active discussions within the Da Vinci Burden Reduction community about relaxing PAS must support requirements. Specifically, as of September 2026, there is an open ticket that proposes to require PAS clients to support only those elements which are collected and surfaced to users. However, at this time, no final decision has been made and it is unclear if the change would be applied to prior versions of the IG.
During testing, Inferno and the PAS client pass many requests and responses back and forth. These are the messages that Inferno will consider when looking for demonstration of must support elements. The "Must Support Elements" group allows testers to make additional requests covering must support elements not yet demonstrated, but elements previously demonstrated during previously executed scenario groups do not need to be demonstrated again.
However, Inferno will only consider requests and responses exchanged during the most recent execution of each group. When any group is re-run, including the "Must Support Elements" group, the requests made during the previous run of that group will no longer be considered.
In the v2.2.1 client suite, the "Must Support Elements" group is split into two groups that can be run separately: "Demonstrate Must Support Coverage", where the PAS client makes the additional requests, and "Must Support Coverage", which evaluates them. Re-running only "Must Support Coverage", for example after re-running a scenario group, keeps the requests made during the most recent run of "Demonstrate Must Support Coverage".
Note that Inferno's mocked responses do not include all must support elements, so testers will need to provide responses for Inferno to use that include examples of all must support elements to pass these tests.
To pass the client must support tests for the PAS Client suites defined in this repository, Inferno requires that testers use the PAS client to
- Send
$submitand$inquirerequests that demonstrate the full scope of PAS profiles that can appear in those requests and their must support elements. - Receive
$submitand$inquireresponses and notifications that demonstrate the full scope of PAS profiles that can appear in those responses and their must support elements. Additionally, confirm that the PAS client handled them without erroring as Inferno cannot directly observe how the PAS client reacts. These attestations are performed immediately following each interaction.
The following sections detail what this means specifically in each supported PAS IG version.
To pass the PAS client v2.0.1 must support tests, Inferno must see
- On Requests
- All must support elements defined on the PAS Claim
or PAS Claim Update
profiles on
$submitrequests, or the PAS Claim Inquiry profile on$inquirerequests. - For
$submitrequests, at least one instance of one of the request resource profiles (DeviceRequest, MedicationRequest, NutritionOrder, or ServiceRequest) referenced from the Requested Service extension on elementClaim.item, and all must support elements defined in the profiles for each request resource type that was observed. - For both
$submitand$inquirerequests, at least one instance of each other profile referenced from the PAS Claim profiles and all must support elements defined on those profiles. Specific profiles for which must support coverage must be demonstrated include:
- All must support elements defined on the PAS Claim
or PAS Claim Update
profiles on
- On Responses
- All must support elements defined on the PAS Claim Response
or PAS Claim Inquiry Response
profiles for
$submitand$inquireresponses respectively. - For both
$submitand$inquireresponses, at least one instance of each other profile referenced from the PAS ClaimResponse profiles and all must support elements defined on those profiles. Specific profiles for which must support coverage must be demonstrated include:
- All must support elements defined on the PAS Claim Response
or PAS Claim Inquiry Response
profiles for
To pass the PAS client v2.2.1 must support tests, Inferno must see
- On Requests
- All must support elements defined on the PAS Claim
or PAS Claim Update
profiles on
$submitrequests, or the PAS Claim Inquiry profile on$inquirerequests. - For
$submitrequests, at least one instance of one of the request resource profiles (DeviceRequest, MedicationRequest, NutritionOrder, or ServiceRequest) referenced from the Requested Service extension on elementClaim.item, and all must support elements defined in the profiles for each request resource type that was observed. - For both
$submitand$inquirerequests, at least one instance of each other profile referenced from the PAS Claim profiles and all must support elements defined on those profiles. Specific profiles for which must support coverage must be demonstrated include:
- All must support elements defined on the PAS Claim
or PAS Claim Update
profiles on
- On Responses
- All must support elements defined on the PAS Claim Response
or PAS Claim Inquiry Response
profiles for
$submitand$inquireresponses respectively. - For both
$submitand$inquireresponses, at least one instance of each other profile referenced from the PAS ClaimResponse profiles and all must support elements defined on those profiles. Specific profiles for which must support coverage must be demonstrated include:
- All must support elements defined on the PAS Claim Response
or PAS Claim Inquiry Response
profiles for
Test kit documentation is stored within the ./docs folder of
this repository and is automatically synchronized to this wiki with each update
to the main branch using the Publish Docs Wiki
workflow. Do not change content
within this wiki directly as changes will be overwritten.
Using this Test Kit
Client Suite
- Client Testing Details
- Client v2.0.1 Testing Walkthrough
- Client v2.2.1 Testing Instructions
- Controlling Inferno's Simulated Responses
- Simulated Subscriptions and Notifications
- Client Must Support Tests
Server Suite
Contributing to this Test Kit
Reference Documents & External Links