Data Consumer Client CapabilityStatement

• Title:Data Consumer Client CapabilityStatement
• Implementation Guide Version: 2.1.0-preview
• FHIR Version: 4.0.1
• Intended Use: requirements
• Supported Formats: SHALL support json; MAY support xml;
• Supported Patch Formats: MAY support application/json-patch+json;
• Published: 2024-05-13 20:40:17-0800
• Published by: HL7 International / Payer/Provider Information Exchange Work Group
• Status: active
• Copyright:

  Used by permission of HL7 International all rights reserved Creative Commons License

Description:

Support and Requirements for Other Artifacts

Instantiates other capabilities:

• SHOULD support US Core Client CapabilityStatement
• SHOULD support US Core Client CapabilityStatement

Supports other guides:

• SHOULD support US Core
• SHOULD support US Core Implementation Guide
• SHOULD support Da Vinci Health Record Exchange (HRex)
• SHOULD support Da Vinci - Documentation Templates and Rules
• SHOULD support Subscriptions R5 Backport

Jump to:

• REST client

FHIR client RESTful Capabilities

Security:

System-wide client Capabilities

Interactions

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

Summary of Resource/Profile Capabilities

Resource Type	Supported Interactions	Supported Profiles	Supported Searches	Supported _includes	Supported _revincludes	Supported Operations
Bundle	create, search-type, read, vread, update, patch, delete, history-instance, history-type,	CDex Signature Bundle Profile,
Patient	create, search-type, read, vread, update, patch, delete, history-instance, history-type,	CDex Patient Demographics Profile,
PractitionerRole	create, search-type, read, vread, update, patch, delete, history-instance, history-type,	CDex PractitionerRole Profile,
Provenance	create, search-type, read, vread, update, patch, delete, history-instance, history-type,
Questionnaire	create, search-type, read, vread, update, patch, delete, history-instance, history-type,	DTR Standard Questionnaire, DTR Questionnaire for adaptive form,
QuestionnaireResponse	create, search-type, read, vread, update, patch, delete, history-instance, history-type,	CDex SDC QuestionnaireResponse Profile,
Subscription	create, search-type, read, vread, update, patch, delete, history-instance, history-type,
Task	create, search-type, read, vread, update, patch, delete, history-instance, history-type,	CDex Task Data Request Profile, CDex Task Attachment Request Profile,

RESTful client Capabilities by Resource/Profile:

Bundle

Conformance Expectation: SHOULD

Resource Specific Documentation:

Required resource type to fetch Clinical Information from data source. SHALL support CDex Signature Bundle Profile for signed Bundles.

Supported Profiles:

• SHOULD support CDex Signature Bundle Profile

Modify Criteria:

• A client MAY be capable of a create interaction posting a Bundle resource using: POST [base]/Bundle/[id]{?_format=[mime-type]}
• A client MAY be capable of putting a existing Bundle resource using: PUT [base]/Bundle/[id]{?_format=[mime-type]}
• A client MAY be capable of patching an existing Bundle resource using: PATCH [base]/Bundle/[id]{?_format=[mime-type]}
• A client MAY be capable of deleting a Bundle resource using: DELETE [base]//[id]

Fetch and Search Criteria:

• A client SHOULD be capable of a search-type interaction fetching Bundle resources matching a search query using: GET [base]/Bundle/[id]{?[parameters]{&_format=[mime-type]}}
• A client SHOULD be capable of a read interaction fetching a Bundle resource using: GET [base]/Bundle/[id]
• A client SHOULD be capable of a vread interaction fetching a Bundle resource using: GET [base]/Bundle/[id]/_history/vid
• A client MAY be capable of a history-instance interaction fetching a history of a Bundle using: GET [base]/Bundle/[id]/_history{?[parameters]&_format=[mime-type]}
• A client MAY be capable of a history-type interaction fetching the history of Bundle resources using: GET [base]/Bundle/_history{?[parameters]&_format=[mime-type]}

Patient

Conformance Expectation: SHOULD

Resource Specific Documentation:

Required resource type to supply patient demographic data when requesting attachments.

Supported Profiles:

• SHALL support CDex Patient Demographics Profile

Modify Criteria:

• A client MAY be capable of a create interaction posting a Patient resource using: POST [base]/Patient/[id]{?_format=[mime-type]}
• A client MAY be capable of putting a existing Patient resource using: PUT [base]/Patient/[id]{?_format=[mime-type]}
• A client MAY be capable of patching an existing Patient resource using: PATCH [base]/Patient/[id]{?_format=[mime-type]}
• A client MAY be capable of deleting a Patient resource using: DELETE [base]//[id]

Fetch and Search Criteria:

• A client MAY be capable of a search-type interaction fetching Patient resources matching a search query using: GET [base]/Patient/[id]{?[parameters]{&_format=[mime-type]}}
• A client MAY be capable of a read interaction fetching a Patient resource using: GET [base]/Patient/[id]
• A client MAY be capable of a vread interaction fetching a Patient resource using: GET [base]/Patient/[id]/_history/vid
• A client MAY be capable of a history-instance interaction fetching a history of a Patient using: GET [base]/Patient/[id]/_history{?[parameters]&_format=[mime-type]}
• A client MAY be capable of a history-type interaction fetching the history of Patient resources using: GET [base]/Patient/_history{?[parameters]&_format=[mime-type]}

PractitionerRole

Conformance Expectation: SHOULD

Resource Specific Documentation:

Required resource type to supply patient demographic data when requesting attachments.

Supported Profiles:

• SHALL support CDex PractitionerRole Profile

Modify Criteria:

• A client MAY be capable of a create interaction posting a PractitionerRole resource using: POST [base]/PractitionerRole/[id]{?_format=[mime-type]}
• A client MAY be capable of putting a existing PractitionerRole resource using: PUT [base]/PractitionerRole/[id]{?_format=[mime-type]}
• A client MAY be capable of patching an existing PractitionerRole resource using: PATCH [base]/PractitionerRole/[id]{?_format=[mime-type]}
• A client MAY be capable of deleting a PractitionerRole resource using: DELETE [base]//[id]

Fetch and Search Criteria:

• A client MAY be capable of a search-type interaction fetching PractitionerRole resources matching a search query using: GET [base]/PractitionerRole/[id]{?[parameters]{&_format=[mime-type]}}
• A client MAY be capable of a read interaction fetching a PractitionerRole resource using: GET [base]/PractitionerRole/[id]
• A client MAY be capable of a vread interaction fetching a PractitionerRole resource using: GET [base]/PractitionerRole/[id]/_history/vid
• A client MAY be capable of a history-instance interaction fetching a history of a PractitionerRole using: GET [base]/PractitionerRole/[id]/_history{?[parameters]&_format=[mime-type]}
• A client MAY be capable of a history-type interaction fetching the history of PractitionerRole resources using: GET [base]/PractitionerRole/_history{?[parameters]&_format=[mime-type]}

Provenance

Conformance Expectation: SHOULD

Resource Specific Documentation:

Required resource type to fetch provenance along with clinical information

Modify Criteria:

• A client MAY be capable of a create interaction posting a Provenance resource using: POST [base]/Provenance/[id]{?_format=[mime-type]}
• A client MAY be capable of putting a existing Provenance resource using: PUT [base]/Provenance/[id]{?_format=[mime-type]}
• A client MAY be capable of patching an existing Provenance resource using: PATCH [base]/Provenance/[id]{?_format=[mime-type]}
• A client MAY be capable of deleting a Provenance resource using: DELETE [base]//[id]

Fetch and Search Criteria:

• A client SHOULD be capable of a search-type interaction fetching Provenance resources matching a search query using: GET [base]/Provenance/[id]{?[parameters]{&_format=[mime-type]}}
• A client SHOULD be capable of a read interaction fetching a Provenance resource using: GET [base]/Provenance/[id]
• A client SHOULD be capable of a vread interaction fetching a Provenance resource using: GET [base]/Provenance/[id]/_history/vid
• A client MAY be capable of a history-instance interaction fetching a history of a Provenance using: GET [base]/Provenance/[id]/_history{?[parameters]&_format=[mime-type]}
• A client MAY be capable of a history-type interaction fetching the history of Provenance resources using: GET [base]/Provenance/_history{?[parameters]&_format=[mime-type]}

Questionnaire

Conformance Expectation: SHOULD

Resource Specific Documentation:

Required resource type to when requesting data or attachments using Questionnaire

Supported Profiles:

• SHOULD support DTR Standard Questionnaire
• SHOULD support DTR Questionnaire for adaptive form

Modify Criteria:

• A client SHOULD be capable of a create interaction posting a Questionnaire resource using: POST [base]/Questionnaire/[id]{?_format=[mime-type]}
• A client SHOULD be capable of putting a existing Questionnaire resource using: PUT [base]/Questionnaire/[id]{?_format=[mime-type]}
• A client MAY be capable of patching an existing Questionnaire resource using: PATCH [base]/Questionnaire/[id]{?_format=[mime-type]}
• A client MAY be capable of deleting a Questionnaire resource using: DELETE [base]//[id]

Fetch and Search Criteria:

• A client SHOULD be capable of a search-type interaction fetching Questionnaire resources matching a search query using: GET [base]/Questionnaire/[id]{?[parameters]{&_format=[mime-type]}}
• A client SHOULD be capable of a read interaction fetching a Questionnaire resource using: GET [base]/Questionnaire/[id]
• A client SHOULD be capable of a vread interaction fetching a Questionnaire resource using: GET [base]/Questionnaire/[id]/_history/vid
• A client MAY be capable of a history-instance interaction fetching a history of a Questionnaire using: GET [base]/Questionnaire/[id]/_history{?[parameters]&_format=[mime-type]}
• A client MAY be capable of a history-type interaction fetching the history of Questionnaire resources using: GET [base]/Questionnaire/_history{?[parameters]&_format=[mime-type]}

QuestionnaireResponse

Conformance Expectation: SHOULD

Resource Specific Documentation:

Required resource type to fetch completed questionnaires from data source. SHALL support CDex SDC QuestionnaireResponse Profile for signed QuestionnaireResponse.

Supported Profiles:

• SHOULD support CDex SDC QuestionnaireResponse Profile

Modify Criteria:

• A client MAY be capable of a create interaction posting a QuestionnaireResponse resource using: POST [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}
• A client MAY be capable of putting a existing QuestionnaireResponse resource using: PUT [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}
• A client MAY be capable of patching an existing QuestionnaireResponse resource using: PATCH [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}
• A client MAY be capable of deleting a QuestionnaireResponse resource using: DELETE [base]//[id]

Fetch and Search Criteria:

• A client SHOULD be capable of a search-type interaction fetching QuestionnaireResponse resources matching a search query using: GET [base]/QuestionnaireResponse/[id]{?[parameters]{&_format=[mime-type]}}
• A client SHOULD be capable of a read interaction fetching a QuestionnaireResponse resource using: GET [base]/QuestionnaireResponse/[id]
• A client SHOULD be capable of a vread interaction fetching a QuestionnaireResponse resource using: GET [base]/QuestionnaireResponse/[id]/_history/vid
• A client MAY be capable of a history-instance interaction fetching a history of a QuestionnaireResponse using: GET [base]/QuestionnaireResponse/[id]/_history{?[parameters]&_format=[mime-type]}
• A client MAY be capable of a history-type interaction fetching the history of QuestionnaireResponse resources using: GET [base]/QuestionnaireResponse/_history{?[parameters]&_format=[mime-type]}

Subscription

Conformance Expectation: SHOULD

Resource Specific Documentation:

Required resource type to subscribe to data source for Task-based requests.

Modify Criteria:

• A client SHOULD be capable of a create interaction posting a Subscription resource using: POST [base]/Subscription/[id]{?_format=[mime-type]}
• A client SHOULD be capable of putting a existing Subscription resource using: PUT [base]/Subscription/[id]{?_format=[mime-type]}
• A client MAY be capable of patching an existing Subscription resource using: PATCH [base]/Subscription/[id]{?_format=[mime-type]}
• A client MAY be capable of deleting a Subscription resource using: DELETE [base]//[id]

Fetch and Search Criteria:

• A client SHOULD be capable of a search-type interaction fetching Subscription resources matching a search query using: GET [base]/Subscription/[id]{?[parameters]{&_format=[mime-type]}}
• A client SHOULD be capable of a read interaction fetching a Subscription resource using: GET [base]/Subscription/[id]
• A client SHOULD be capable of a vread interaction fetching a Subscription resource using: GET [base]/Subscription/[id]/_history/vid
• A client MAY be capable of a history-instance interaction fetching a history of a Subscription using: GET [base]/Subscription/[id]/_history{?[parameters]&_format=[mime-type]}
• A client MAY be capable of a history-type interaction fetching the history of Subscription resources using: GET [base]/Subscription/_history{?[parameters]&_format=[mime-type]}

Task

Conformance Expectation: SHOULD

Resource Specific Documentation:

Required resource type to request and fetch clinical information using Task-based query and for requesting attachments.

1. If Da Vinci CDex Data Consumer Client supports Task-based query, they SHALL support the CDex Task Data Request Profile.
2. If Da Vinci CDex Data Consumer Client supports requesting attachments, they SHALL support the following profiles:
   • CDex Task Attachment Request Profile
   • CDex Patient Demographic Profile
   • CDex PractitionerRequest Profile

Supported Profiles:

• SHOULD support CDex Task Data Request Profile
• SHOULD support CDex Task Attachment Request Profile

Modify Criteria:

• A client SHOULD be capable of a create interaction posting a Task resource using: POST [base]/Task/[id]{?_format=[mime-type]}
• A client SHOULD be capable of putting a existing Task resource using: PUT [base]/Task/[id]{?_format=[mime-type]}
• A client MAY be capable of patching an existing Task resource using: PATCH [base]/Task/[id]{?_format=[mime-type]}
• A client MAY be capable of deleting a Task resource using: DELETE [base]//[id]

Fetch and Search Criteria:

• A client SHOULD be capable of a search-type interaction fetching Task resources matching a search query using: GET [base]/Task/[id]{?[parameters]{&_format=[mime-type]}}
• A client SHOULD be capable of a read interaction fetching a Task resource using: GET [base]/Task/[id]
• A client SHOULD be capable of a vread interaction fetching a Task resource using: GET [base]/Task/[id]/_history/vid
• A client MAY be capable of a history-instance interaction fetching a history of a Task using: GET [base]/Task/[id]/_history{?[parameters]&_format=[mime-type]}
• A client MAY be capable of a history-type interaction fetching the history of Task resources using: GET [base]/Task/_history{?[parameters]&_format=[mime-type]}