Patient Cost Transparency Implementation Guide
2.0.1 - STU 2

Patient Cost Transparency Implementation Guide, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pct/ and changes regularly. See the Directory of published versions

## CapabilityStatement: Patient Cost Transparency Implementation Guide Coordination Platform Capability Statement

Official URL: http://hl7.org/fhir/us/davinci-pct/CapabilityStatement/davinci-pct-coordination-platform | Version: 2.0.1
Standards status: Trial-use | Maturity Level: 2 | Computable Name: CoordinationPlatformPatientCostTransparencyCapabilityStatement
Other Identifiers: OID:2.16.840.1.113883.4.642.40.4.13.2
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

Coordination Platform Capability Statement for the Da Vinci Patient Cost Transparency Implementation Guide

Raw OpenAPI-Swagger Definition file | Download

version: 1; Last updated: 2024-03-23 19:21:32+0000

## Patient Cost Transparency Implementation Guide Coordination Platform Capability Statement

- Implementation Guide Version: 2.0.1
- FHIR Version: 4.0.1
- Supported Formats: SHALL support `json`, SHOULD support `xml`
- Published on: 2024-03-23 14:21:32-0500
- Published by: HL7 International / Financial Management

> Note to Implementers: FHIR Capabilities

> Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

This CapabilityStatement imports the CapabilityStatement US Core Server CapabilityStatementversion: 7.0.0)

## FHIR RESTful Capabilities

### Mode: `server`

### Capabilities by Resource/Profile

#### Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

- The relevant profiles (if any)
- The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
- The required, recommended, and some optional search parameters (if any).
- The linked resources enabled for `_include`
- The other resources enabled for `_revinclude`
- The operations on the resource (if any)

Resource Type | Profile | R | V-R | S | U | P | C | D | H-I | H-T | Searches | `_include` | `_revinclude` | Operations
--- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | ---
Task | Supported Profiles PCT GFE Contributor Task | Y | y? | Y | Y | y? | Y | y? | y? | y? | _id, code, part-of, owner, requester, task-requested-period, status, identifier, _lastUpdated, code+status, code+status+owner, code+status+requester, part-of+owner |  |  |
Bundle | Supported Profiles PCT GFE Coordination Bundle PCT GFE Packet PCT GFE Information Bundle PCT GFE Bundle PCT GFE Missing Bundle | Y | y? | Y | Y | y? | Y | y? | y? | y? | _id |  |  |
Organization | Supported Profiles PCT Organization | Y | y? | Y | y? | y? | y? | y? | y? | y? | _id, active, identifier, name, address, active+name |  |  |
Practitioner | Supported Profiles PCT Practitioner | Y | y? | Y | y? | y? | y? | y? | y? | y? | _id, identifier, name, address, telecom, active+name |  |  |
PractitionerRole | Supported Profiles US Core PractitionerRole Profileversion: 7.0.0) | Y | y? | Y | y? | y? | y? | y? | y? | y? | _id, specialty, role, organization, practitioner, telecom, active+name, active+specialty, active+role |  |  | `$gfe-retrieve`

#### Resource Conformance: SHALLTask

Core FHIR Resource
Task
Reference Policy
Interaction summary

- SHALL support `create`, `search-type`, `read`, `update`.
- MAY support `vread`, `patch`, `delete`, `history-instance`, `history-type`.

Supported Profiles

PCT GFE Contributor Task

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Searching by Logical id of this artifact. Allows retrieval of resources with special search result parameters, such as _summary
SHALL | code | `token` | Search by task type. For Patient Cost Transparency, this is the either the Coordination Task (gfe-coordination-task) or the GFE Contributor Task (gfe-contributor-task)
SHALL | part-of | `reference` | Search by task this task is part of. For Patient Cost Transparency, this is used for searching for Contributor Tasks that are part of a Coordination Task
SHALL | owner | `reference` | Search by task owner. For Patient Cost Transparency, this is the provider assigned to the Task. Usually a GFE Contributor
SHALL | requester | `reference` | Search by task requester. For Patient Cost Transparency, this is the provider that is the GFE Coordination requester
SHALL | status | `token` | Search by task status
SHOULD | task-requested-period | `date` | Search for a task by when the task should be performed. For Patient Cost Transparency, this is when the GFE Bundle should be provided by
SHOULD | identifier | `token` | Search for a task instance by its business identifier
SHOULD | _lastUpdated | `date` | Allows filtering for only records that have changed since last query

Combined Search Parameters

Conformance | Parameters | Types
--- | --- | ---
SHALL | code+status | `token`+`token`
SHALL | code+status+owner | `token`+`token`+`reference`
SHALL | code+status+requester | `token`+`token`+`reference`
SHALL | part-of+owner | `reference`+`reference`

#### Resource Conformance: SHOULDBundle

Core FHIR Resource
Bundle
Reference Policy
Interaction summary

- SHALL support `create`, `search-type`, `read`, `update`.
- MAY support `vread`, `patch`, `delete`, `history-instance`, `history-type`.

Supported Profiles

PCT GFE Coordination Bundle
PCT GFE Packet
PCT GFE Information Bundle
PCT GFE Bundle
PCT GFE Missing Bundle

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Searching by Logical id of this artifact. Allows retrieval of resources with special search result parameters, such as _summary

#### Resource Conformance: SHALLOrganization

Core FHIR Resource
Organization
Reference Policy
Interaction summary

- SHALL support `search-type`, `read`.
- MAY support `create`, `vread`, `update`, `patch`, `delete`, `history-instance`, `history-type`.

Supported Profiles

PCT Organization

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Searching by Logical id of this artifact. Allows retrieval of resources with special search result parameters, such as _summary
SHALL | active | `token` | Any identifier for the organization (not the accreditation issuer's identifier)
SHALL | identifier | `token` | Any identifier for the organization (not the accreditation issuer's identifier)
SHALL | name | `string` | A portion of the organization's name or alias
SHOULD | address | `string` | 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

Combined Search Parameters

Conformance | Parameters | Types
--- | --- | ---
SHALL | active+name | `token`+`string`

#### Resource Conformance: SHALLPractitioner

Core FHIR Resource
Practitioner
Reference Policy
Interaction summary

- SHALL support `search-type`, `read`.
- MAY support `create`, `vread`, `update`, `patch`, `delete`, `history-instance`, `history-type`.

Supported Profiles

PCT Practitioner

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Searching by Logical id of this artifact. Allows retrieval of resources with special search result parameters, such as _summary
SHALL | identifier | `token` | A practitioner's Identifier
SHALL | name | `string` | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
SHOULD | address | `string` | 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
SHOULD | telecom | `token` | The value in any kind of contact.

Combined Search Parameters

Conformance | Parameters | Types
--- | --- | ---
SHALL | active+name | `<unknown>`+`string`

#### Resource Conformance: SHALLPractitionerRole

Core FHIR Resource
PractitionerRole
Reference Policy
Interaction summary

- SHALL support `search-type`, `read`.
- MAY support `create`, `vread`, `update`, `patch`, `delete`, `history-instance`, `history-type`.

Supported Profiles

US Core PractitionerRole Profileversion: 7.0.0)

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | Searching by Logical id of this artifact. Allows retrieval of resources with special search result parameters, such as _summary
SHALL | specialty | `token` | Practitioner that is able to provide the defined services for the organization
SHALL | role | `token` | The practitioner can perform this role at for the organization
SHOULD | organization | `reference` | The identity of the organization the practitioner represents / acts on behalf of
SHOULD | practitioner | `reference` | Practitioner that is able to provide the defined services for the organization.
SHOULD | telecom | `token` | The value in any kind of contact.

Combined Search Parameters

Conformance | Parameters | Types
--- | --- | ---
SHOULD | active+name | `<unknown>`+`<unknown>`
SHOULD | active+specialty | `<unknown>`+`token`
SHOULD | active+role | `<unknown>`+`token`

Extended Operations

Conformance | Operation | Documentation
--- | --- | ---
SHALL | $gfe-retrieve | This operation is used by an entity to retrieve a GFE Packet containing the GFE Bundle(s) and other referenced resources based on a GFE Coordination Task. The only input parameter is the single reference to the GFE Coordination Task resource. The only output is a GFE Packet. If the task reference is to a Coordination Task, this will return the GFE Packet. If this task reference is for a GFE Contributor Task, it returns the GFE Bundle, if present. If the Task reference points to a Task resource that is neither a Coordination Task or a GFE Contributor Task, the response is an HTTP error `400 - Bad Request`. If a Task is not found, the response is an HTTP error `400 - Bad Request`. If a GFE Bundle does not exist for an associated GFE Contributor Task, in place of a GFE Bundle, a GFE Missing Bundle is provided in its place (either directly ina response if the referenced task was a GFE Contributor Task or inside the GFE Packet if the referenced task was a Coordination Task.)