Client CapabilityStatement

• Implementation Guide Version: 0.1.0
• FHIR Version: 4.0.1
• Supported formats: JSON
• Published: 2021-01-28
• Published by: Argonaut Project

This CapabilityStatement outlines the conformance requirements and expectations for Argonaut User Facing Patient List Client applications. It identifies the specific profiles and RESTful transactions for requesting user facing patient list data from an EHR using the Argonaut User Facing Patient List API. This includes the following interactions:

1. Discovery of User Facing Patient Lists
2. Fetching User Facing Patient Lists
3. Fetching Additional Data about each Patient in a User Facing Patient Lists

This is a Requirements CapabilityStatement describing what capabilities are potentially relevant. It can be used as a template for creating an Instance CapabilityStatement by removing expectation extensions and making actual assertions associated with each capability to describe the capabilities of a deployed and configured implementation.

SHOULD Support the Following Implementation Guides:

• HL7 FHIR® US Core Implementation Guide STU3 Release 3.1.1

FHIR RESTful Capabilities

The Client SHALL:

1. Support fetching user facing lists
2. Support JSON source formats for all transactions

The Client SHOULD:

1. Support fetching user facing lists and patients using the _include search parameter
2. Declare a CapabilityStatement identifying the transactions and profiles supported
3. Support XML source formats for all transactions

The Client MAY:

1. Support discovery of user facing patient lists
2. Support fetching additional data about each patient in a user facing patient lists
3. Support multipleOr values for the patient and '_id' search parameter

Security:

1. See the US Core General Security Considerations section for requirements and recommendations.

Summary of System Wide Interactions

• MAY support the transaction interaction.
• MAY support the batch interaction.
• MAY support the search-system interaction.
• MAY support the history-system interaction.

RESTful Capabilities by Resource/Profile:

Summary of Search Criteria

Resource Type	Supported Profiles	Supported Searches	Supported _includes	Supported _revincludes	Supported Operations
Appointment		_id
Encounter	US Core Encounter Profile	_id
Group	Argonaut User Facing Patient List (Group) Profile	type, _summary, managing-entity, characteristic, value-reference, _include, _id characteristic+value-reference	Group:member
Questionnaire	SDC Base Questionnaire	_id
QuestionnaireResponse	SDC Questionnaire Response	_id

Appointment

Conformance Expectation: MAY

Resource Specific Documentation:

For getting additional data about Group members, the Argonaut Patient List (Group) Profile support an extension on the Group.member element for directly accessing one or more Appointment resources for each patient on the patient list. The Server MAY supply one or both of these extensions so that the Client can efficiently fetch the Appointment resource.

Profile Interaction Summary:

• SHOULD support search-type, read.
• MAY support create, vread, update, patch, delete, history-instance, history-type.

Fetch and Search Criteria:

• A Client SHOULD be capable of fetching a Appointment resource using: GET [base]/Appointment/[id]

Search Parameter Summary:

Conformance	Parameter	Type	Documentation
MAY	_id	token	for fetching of additional appointment data about group members. The Client MAY use with comma-separated values.

---

Encounter

Conformance Expectation: MAY

Supported Profiles: US Core Encounter Profile

Resource Specific Documentation:

For getting additional data about Group members, the Argonaut Patient List (Group) Profile supports an extension on the Group.member element for directly accessing one or more Encounter resources for each patient on the patient list. The Server MAY supply one or both of these extensions so that the Client can efficiently fetch the Encounter resource.

Profile Interaction Summary:

• SHOULD support search-type, read.
• MAY support create, vread, update, patch, delete, history-instance, history-type.

Fetch and Search Criteria:

• A Client SHOULD be capable of fetching a Encounter resource using: GET [base]/Encounter/[id]

Search Parameter Summary:

Conformance	Parameter	Type	Documentation
MAY	_id	token	for fetching of additional encounter data about group members. The Client MAY use with comma-separated values.

---

Group

Conformance Expectation: SHALL

Supported Profiles: Argonaut User Facing Patient List (Group) Profile

Resource Specific Documentation:

Required resource type for discovery and fetching of user facing lists.

Profile Interaction Summary:

• SHALL support read.
• SHOULD support search-type^†, vread.
• MAY support create, update, patch, delete, history-instance, history-type.

search-type^†

1. Clients SHALL use the following required search parameters and parameter values for discovery of user-facing lists:

   • _summary=“true”
   • type=“person”.

2. Clients MAY discover all available patient lists that are managed by a particular organization or practitioner' using the required parameters and the managing-entity search parameter.

3. Clients MAY discover all available patient lists that have a particular characteristic using the required parameters and the combination of characteristic and value-reference search parameters

Fetch and Search Criteria:

• A Client SHALL be capable of fetching a Group resource using: GET [base]/Group/[id]
• A Client SHOULD be capable of supporting the following _includes: Group:member - GET [base]/Group?[parameter=value]&_include=Group:member

Search Parameter Summary:

Conformance	Parameter	Type	Documentation
MAY	type	token	required search parameters and parameter value type=person for discovery of user-facing lists:
MAY	_summary	token	required search parameters and parameter value _summary=true for discovery of user-facing lists:
MAY	managing-entity	reference	for discovery of user-facing lists managed by a particular organization or practitioner
MAY	characteristic	token	for discovery of user-facing lists by a characteristic used in combination with value-reference
MAY	value-reference	reference	for discovery of user-facing lists by a characteristic used in combination with characteristic
SHOULD	_include	token	the _include parameter can be used when fetching a Group resource to include all the Patient resources in addition to Group
SHOULD	_id	token	for fetching of user facing lists

Search Parameter Combination Summary:

Conformance	Parameter Combination	Types
SHOULD	characteristic+value-reference	token+reference

---

Questionnaire

Conformance Expectation: MAY

Supported Profiles: SDC Base Questionnaire

Resource Specific Documentation:

For getting additional data about Group members, the Argonaut Patient List (Group) Profile supports 2 extension for directly accessing the Group level Questionnaire and the resultant pre-filled QuestionnaireResponse form for each patient on the patient list: The Server MAY supply these extensions so that the Client can fetch the form definitions in the Questionnaire resource and the form data in the QuestionnaireResponse resource.

Profile Interaction Summary:

• SHOULD support search-type, read.
• MAY support create, vread, update, patch, delete, history-instance, history-type.

Fetch and Search Criteria:

• A Client SHOULD be capable of fetching a Questionnaire resource using: GET [base]/Questionnaire/[id]

Search Parameter Summary:

Conformance	Parameter	Type	Documentation
MAY	_id	token	for fetching the definitions of associated data about group members represented in the Questionnaire resource. The Client MAY use with comma-separated values.

---

QuestionnaireResponse

Conformance Expectation: MAY

Supported Profiles: SDC Questionnaire Response

Resource Specific Documentation:

For getting additional data about Group members, the Argonaut Patient List (Group) Profile supports 2 extension for directly accessing the Group level Questionnaire and the resultant pre-filled QuestionnaireResponse form for each patient on the patient list: The Server MAY supply these extensions so that the Client can fetch the form definitions in the Questionnaire resource and the form data in the QuestionnaireResponse resource.

Profile Interaction Summary:

• SHOULD support search-type, read.
• MAY support create, vread, update, patch, delete, history-instance, history-type.

Fetch and Search Criteria:

• A Client SHOULD be capable of fetching a QuestionnaireResponse resource using: GET [base]/QuestionnaireResponse/[id]

Search Parameter Summary:

Conformance	Parameter	Type	Documentation
MAY	_id	token	for fetching associated data about group members represented in the QuestionnaireResponse resource. The Client MAY use with comma-separated values.

---