This page is part of the Da Vinci Patient Cost Transparency Implementation Guide (v2.0.0-ballot: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
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
json
, SHOULD support xml
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.
server
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
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 Collection Bundle 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: HRex PractitionerRole Profile | y | y | y | y | y | y | y | y | y | _id, specialty, role, organization, practitioner, telecom, active+name, active+specialty, active+role | $gfe-retrieve |
create
, search-type
, read
, update
.vread
, patch
, delete
, history-instance
, history-type
.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 |
create
, search-type
, read
, update
.vread
, patch
, delete
, history-instance
, history-type
.http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-gfe-coordination-bundle
http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-gfe-collection-bundle
http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-gfe-information-bundle
http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-gfe-bundle
http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-gfe-missing-bundle
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 |
search-type
, read
.create
, vread
, update
, patch
, delete
, history-instance
, history-type
.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 |
search-type
, read
.create
, vread
, update
, patch
, delete
, history-instance
, history-type
.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. |
Conformance | Parameters | Types |
---|---|---|
SHALL | active+name | <unknown> +string |
search-type
, read
.create
, vread
, update
, patch
, delete
, history-instance
, history-type
.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. |
Conformance | Operation | Documentation |
---|---|---|
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 |