Patient Cost Transparency Implementation Guide
2.0.0-ballot - STU 2 Ballot United States of America flag

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.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-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.0-ballot
Standards status: Trial-use 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

Patient Cost Transparency Implementation Guide Coordination Platform Capability Statement

  • Implementation Guide Version: 2.0.0-ballot
  • FHIR Version: 4.0.1
  • Supported Formats: SHALL support json, SHOULD support xml
  • Supported Patch Formats:
  • 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.

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions

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 TypeProfileRV-RSUPCDH-IH-TSearches_include_revincludeOperations
TaskSupported profiles:
  PCT GFE Contributor Task
yyyyyyyyy_id, code, part-of, owner, requester, task-requested-period, status, identifier, _lastUpdated, code+status, code+status+owner, code+status+requester, part-of+owner
BundleSupported profiles:
  PCT GFE Coordination Bundle
  PCT GFE Collection Bundle
  PCT GFE Information Bundle
  PCT GFE Bundle
  PCT GFE Missing Bundle
yyyyyyyyy_id
OrganizationSupported profiles:
  PCT Organization
yyyyyyyyy_id, active, identifier, name, address, active+name
PractitionerSupported profiles:
  PCT Practitioner
yyyyyyyyy_id, identifier, name, address, telecom, active+name
PractitionerRoleSupported profiles:
  HRex PractitionerRole Profile
yyyyyyyyy_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.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Searching by Logical id of this artifact. Allows retrieval of resources with special search result parameters, such as _summary

SHALLcodetoken

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)

SHALLpart-ofreference

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

SHALLownerreference

Search by task owner. For Patient Cost Transparency, this is the provider assigned to the Task. Usually a GFE Contributor

SHALLrequesterreference

Search by task requester. For Patient Cost Transparency, this is the provider that is the GFE Coordination requester

SHALLstatustoken

Search by task status

SHOULDtask-requested-perioddate

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

SHOULDidentifiertoken

Search for a task instance by its business identifier

SHOULD_lastUpdateddate

Allows filtering for only records that have changed since last query

Combined Search Parameters
ConformanceParametersTypes
SHALLcode+statustoken+token
SHALLcode+status+ownertoken+token+reference
SHALLcode+status+requestertoken+token+reference
SHALLpart-of+ownerreference+reference

Resource Conformance: SHALLBundle

Core FHIR Resource
Bundle
Reference Policy
Interaction summary
  • SHALL support create, search-type, read, update.
  • MAY support vread, patch, delete, history-instance, history-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

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.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Searching by Logical id of this artifact. Allows retrieval of resources with special search result parameters, such as _summary

SHALLactivetoken

Any identifier for the organization (not the accreditation issuer's identifier)

SHALLidentifiertoken

Any identifier for the organization (not the accreditation issuer's identifier)

SHALLnamestring

A portion of the organization's name or alias

SHOULDaddressstring

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
ConformanceParametersTypes
SHALLactive+nametoken+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.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Searching by Logical id of this artifact. Allows retrieval of resources with special search result parameters, such as _summary

SHALLidentifiertoken

A practitioner's Identifier

SHALLnamestring

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

SHOULDaddressstring

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

SHOULDtelecomtoken

The value in any kind of contact.

Combined Search Parameters
ConformanceParametersTypes
SHALLactive+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.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Searching by Logical id of this artifact. Allows retrieval of resources with special search result parameters, such as _summary

SHALLspecialtytoken

Practitioner that is able to provide the defined services for the organization

SHALLroletoken

The practitioner can perform this role at for the organization

SHOULDorganizationreference

The identity of the organization the practitioner represents / acts on behalf of

SHOULDpractitionerreference

Practitioner that is able to provide the defined services for the organization.

SHOULDtelecomtoken

The value in any kind of contact.

Combined Search Parameters
ConformanceParametersTypes
SHOULDactive+name<unknown>+<unknown>
SHOULDactive+specialty<unknown>+token
SHOULDactive+role<unknown>+token
Extended Operations
ConformanceOperationDocumentation
SHALL$gfe-retrieve

This operation is used by an entity to retrieve a GFE Collection Bundle 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 Collection Bundle. If the task reference is to a Coordination Task, this will return the GFE Collection Bundle. 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 Collection Bundle if the referenced task was a Coordination Task.)