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

  • Title:Patient Cost Transparency Implementation Guide Coordination Platform Capability Statement
  • Implementation Guide Version: 2.0.0-ballot
  • FHIR Version: 4.0.1
  • Intended Use: Requirements
  • Supported Formats: SHALL support json; SHOULD support xml;
  • Published: 2024-03-23 14:21:32-0500
  • Published by: HL7 International / Financial Management
  • Status: Active
  • Copyright:

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


Description:

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


Support and Requirements for Other Artifacts

Imports other capabilities:

Jump to:


FHIR Server RESTful Capabilities

System-wide Server Capabilities

Summary of Resource/Profile Capabilities

♦ = SHALL expectation; ⋄ = SHOULD expectation; ▿ = MAY expectation;

Resource Type Supported Interactions Supported Profiles Supported Searches Supported _includes Supported _revincludes Supported Operations
Task create♦, search-type♦, read♦, vread▿, update♦, patch▿, delete▿, history-instance▿, history-type▿, PCT GFE Contributor Task♦, _id♦, code♦, part-of♦, owner♦, requester♦, task-requested-period⋄, status♦, identifier⋄, _lastUpdated⋄, code+status+♦, code+status+owner+♦, code+status+requester+♦, part-of+owner+♦,
Bundle create♦, search-type♦, read♦, vread▿, update♦, patch▿, delete▿, history-instance▿, history-type▿, PCT GFE Coordination Bundle, PCT GFE Collection Bundle, PCT GFE Information Bundle, PCT GFE Bundle, PCT GFE Missing Bundle, _id♦,
Organization create▿, search-type♦, read♦, vread▿, update▿, patch▿, delete▿, history-instance▿, history-type▿, PCT Organization♦, _id♦, active♦, identifier♦, name♦, address⋄, active+name+♦,
Practitioner create▿, search-type♦, read♦, vread▿, update▿, patch▿, delete▿, history-instance▿, history-type▿, PCT Practitioner♦, _id♦, identifier♦, name♦, address⋄, telecom⋄, active+name+♦,
PractitionerRole create▿, search-type♦, read♦, vread▿, update▿, patch▿, delete▿, history-instance▿, history-type▿, HRex PractitionerRole Profile♦, _id♦, specialty♦, role♦, organization⋄, practitioner⋄, telecom⋄, active+name+⋄, active+specialty+⋄, active+role+⋄, $gfe-retrieve♦

RESTful Server Capabilities by Resource/Profile:

Task

Conformance Expectation:

Supported Profiles:


Modify Criteria:

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

Fetch and Search Criteria:

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

Search Parameter Summary:

Conformance Parameter Type Example
SHALL org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@428eb3d5 Token GET [base]/Task?_id=[id]
SHALL org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@5ddd84d2 Token GET [base]/Task?code=[system]|[code]
SHALL org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@3fd5d679 Reference GET [base]/Task?part-of=[type]/[id]
SHALL org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@7aa15a80 Reference GET [base]/Task?owner=[type]/[id]
SHALL org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@4d065e1a Reference GET [base]/Task?requester=[type]/[id]
SHOULD org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@7c4ca87c Date/DateTime GET [base]/Task?task-requested-period=[dateTime]
SHALL org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@6dbbdf92 Token GET [base]/Task?status=[system]|[code]
SHOULD org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@1dbeedff Token GET [base]/Task?identifier=[system]|[code]
SHOULD org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@62b786dc Date/DateTime GET [base]/Task?_lastUpdated=[dateTime]

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example
SHALL code+status+ Token+Token+ GET [base]/Task?code=[system]|[code]&status=[system]|[code]&
SHALL code+status+owner+ Token+Token+Reference+ GET [base]/Task?code=[system]|[code]&status=[system]|[code]&owner=[type]/[id]&
SHALL code+status+requester+ Token+Token+Reference+ GET [base]/Task?code=[system]|[code]&status=[system]|[code]&requester=[type]/[id]&
SHALL part-of+owner+ Reference+Reference+ GET [base]/Task?part-of=[type]/[id]&owner=[type]/[id]&

Search Parameter Requirements (When Used Alone or in Combination):

  • _id (Token):

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

  • 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)

  • 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

  • owner (Reference):

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

  • requester (Reference):

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

  • task-requested-period (Date/DateTime):

    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

  • status (Token):

    Search by task status

  • identifier (Token):

    Search for a task instance by its business identifier

  • _lastUpdated (Date/DateTime):

    Allows filtering for only records that have changed since last query

Bundle

Conformance Expectation:

Supported Profiles:


Modify Criteria:

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

Fetch and Search Criteria:

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

Search Parameter Summary:

Conformance Parameter Type Example
SHALL org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@4e8afdad Token GET [base]/Bundle?_id=[id]

Search Parameter Requirements (When Used Alone or in Combination):

  • _id (Token):

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

Organization

Conformance Expectation:

Supported Profiles:


Modify Criteria:

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

Fetch and Search Criteria:

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

Search Parameter Summary:

Conformance Parameter Type Example
SHALL org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@79b8ecb Token GET [base]/Organization?_id=[id]
SHALL org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@3722f39d Token GET [base]/Organization?active=[system]|[code]
SHALL org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@4ec8d9b2 Token GET [base]/Organization?identifier=[system]|[code]
SHALL org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@57b63253 String GET [base]/Organization?name=[name]
SHOULD org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@c0013b8 String GET [base]/Organization?address=[address]

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example
SHALL active+name+ Token+String+ GET [base]/Organization?active=[system]|[code]&name=[name]&

Search Parameter Requirements (When Used Alone or in Combination):

  • _id (Token):

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

  • active (Token):

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

  • identifier (Token):

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

  • name (String):

    A portion of the organization's name or alias

  • 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

Practitioner

Conformance Expectation:

Supported Profiles:


Modify Criteria:

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

Fetch and Search Criteria:

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

Search Parameter Summary:

Conformance Parameter Type Example
SHALL org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@2c1ea7be Token GET [base]/Practitioner?_id=[id]
SHALL org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@2493eec6 Token GET [base]/Practitioner?identifier=[system]|[code]
SHALL org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@42d174ad String GET [base]/Practitioner?name=[name]
SHOULD org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@4ec0229c String GET [base]/Practitioner?address=[address]
SHOULD org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@173a5fad Token GET [base]/Practitioner?telecom=[system]|[code]

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example
SHALL name+ String+ GET [base]/Practitioner?name=[name]&

Search Parameter Requirements (When Used Alone or in Combination):

  • _id (Token):

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

  • identifier (Token):

    A practitioner's Identifier

  • 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

  • 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

  • telecom (Token):

    The value in any kind of contact.

PractitionerRole

Conformance Expectation:

Supported Profiles:

PractitionerRole Interaction Summary:

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

Modify Criteria:

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

Fetch and Search Criteria:

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

Search Parameter Summary:

Conformance Parameter Type Example
SHALL org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@2ce47652 Token GET [base]/PractitionerRole?_id=[id]
SHALL org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@65d90b7f Token GET [base]/PractitionerRole?specialty=[system]|[code]
SHALL org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@2a42019a Token GET [base]/PractitionerRole?role=[system]|[code]
SHOULD org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@6fc0e448 Reference GET [base]/PractitionerRole?organization=[type]/[id]
SHOULD org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@60194904 Reference GET [base]/PractitionerRole?practitioner=[type]/[id]
SHOULD org.hl7.fhir.r5.model.CapabilityStatement$CapabilityStatementRestResourceSearchParamComponent@4db6348b Token GET [base]/PractitionerRole?telecom=[system]|[code]

Search Parameter Combination Summary:

Conformance Parameter Combination Types Example
SHOULD GET [base]/PractitionerRole?
SHOULD specialty+ Token+ GET [base]/PractitionerRole?specialty=[system]|[code]&
SHOULD role+ Token+ GET [base]/PractitionerRole?role=[system]|[code]&

Search Parameter Requirements (When Used Alone or in Combination):

  • _id (Token):

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

  • specialty (Token):

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

  • role (Token):

    The practitioner can perform this role at for the organization

  • organization (Reference):

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

  • practitioner (Reference):

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

  • telecom (Token):

    The value in any kind of contact.