PACIO Transitions of Care Implementation Guide
1.0.0 - STU 1 US

PACIO Transitions of Care Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## CapabilityStatement: TOC CapabilityStatement

Official URL: http://hl7.org/fhir/us/pacio-toc/CapabilityStatement/toc | Version: 1.0.0
Standards status: Trial-use | Maturity Level: 2 | Computable Name: PacioTocCapabilityStatement

This Section describes the expected capabilities of the PACIO Transitions of Care (TOC) Server actor which is responsible for providing responses to the queries submitted by the TOC Requestors.

The TOC information is conveyed via a Bundle.

Raw OpenAPI-Swagger Definition file | Download

## TOC CapabilityStatement

- Implementation Guide Version: 1.0.0
- FHIR Version: 4.0.1
- Supported Formats: `xml`, `json`
- Supported Patch Formats: `application/json-patch+json`
- Published on: 2023-11-10
- Published by: HL7 International / Patient Care

> 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.

### SHALL Support the Following Implementation Guides

- http://hl7.org/fhir/us/pacio-toc/ImplementationGuide/hl7.fhir.us.pacio-toc

## FHIR RESTful Capabilities

### Mode: `server`

The TOC Server SHALL:

1. Support all profiles defined in this Implementation Guide.
2. Implement the RESTful behavior according to the FHIR specification.
3. Return the following response classes:
   - (Status 400): invalid parameter
   - (Status 401/4xx): unauthorized request
   - (Status 403): insufficient scope
   - (Status 404): unknown resource.
4. Support json source formats for all TOC interactions.
5. Support the searchParameters on each profile individually and in combination.

The TOC Server SHOULD:

1. Support xml source formats for all TOC interactions.

Security

> 1. See the Guidance section for requirements and recommendations.
> 2. A server SHALL reject any unauthorized requests by returning an HTTP 401 "Unauthorized", HTTP 403 "Forbidden", or HTTP 404 "Not Found" response code.

### 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 | C | H-I | Searches | `_include` | `_revinclude` | Operations
--- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | ---
Bundle | Supported Profiles Transition of Care Bundle | Y | Y | Y | Y | Y | Y | _id, composition, identifier, timestamp, type |  |  |
Composition | Supported Profiles Transition of Care Composition | Y | Y | y? | Y | Y | Y |  |  |  |
Organization |  | Y | Y | Y | Y | Y | Y |  |  |  |
Patient | Supported Profiles US Core Patient Profileversion: 8.0.1) | Y | Y | Y | Y | Y | Y | _id, active, address, address-city, address-country, address-postalcode, address-state, address-use, birthdate, death-date, deceased, email, family, gender, general-practitioner, given, identifier, language, link, name, organization, phone, phonetic, telecom, race, ethnicity |  |  |
OperationDefinition |  |  |  |  |  |  |  |  |  |  | `$match`

#### Resource Conformance: SHALLBundle

Core FHIR Resource
Bundle
Reference Policy
`resolves`
Interaction summary

- SHALL support `create`, `read`, `update`.
- SHOULD support `search-type`, `vread`, `history-instance`.

Supported Profiles

Transition of Care Bundle

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHOULD | _id | `token` |
SHOULD | composition | `reference` |
SHOULD | identifier | `token` |
SHOULD | timestamp | `date` |
SHOULD | type | `token` |

#### Resource Conformance: SHALLComposition

Core FHIR Resource
Composition
Reference Policy
`resolves`
Interaction summary

- SHOULD support `create`, `read`, `vread`, `update`, `history-instance`.
- MAY support `search-type`.

Supported Profiles

Transition of Care Composition

#### Resource Conformance: SHALLOrganization

Core FHIR Resource
Organization
Reference Policy
`resolves`
Interaction summary

- SHALL support `create`, `search-type`, `read`, `update`.
- SHOULD support `vread`, `history-instance`.

#### Resource Conformance: MAYPatient

Core FHIR Resource
Patient
Reference Policy
`resolves`
Interaction summary

- SHALL support `create`, `search-type`, `read`, `update`.
- SHOULD support `vread`, `history-instance`.

Supported Profiles

US Core Patient Profileversion: 8.0.1)

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` | https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-id.html
SHALL | birthdate | `date` | https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-birthdate.html
SHALL | family | `string` | https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-family.html
SHALL | gender | `token` | https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-given.html
SHALL | given | `string` | https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-given.html
SHALL | identifier | `token` | https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-identifier.html
SHALL | name | `string` | https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-name.html
SHOULD | active | `token` |
SHOULD | email | `token` |
SHOULD | phone | `token` |
SHOULD | telecom | `token` |
MAY | address | `string` |
MAY | address-city | `string` |
MAY | address-country | `string` |
MAY | address-postalcode | `string` |
MAY | address-state | `string` |
MAY | address-use | `token` |
MAY | death-date | `date` |
MAY | deceased | `token` |
MAY | general-practitioner | `reference` |
MAY | language | `token` |
MAY | link | `reference` |
MAY | organization | `reference` |
MAY | phonetic | `string` |
MAY | race | `token` | https://www.hl7.org/fhir/us/core/SearchParameter-us-core-race.html
MAY | ethnicity | `token` | https://www.hl7.org/fhir/us/core/SearchParameter-us-core-ethnicity.html

#### Resource Conformance: unspecifiedOperationDefinition

Core FHIR Resource
OperationDefinition
Reference Policy
Interaction summary

Extended Operations

Conformance | Operation | Documentation
--- | --- | ---
SHALL | $match | $match is a service used to manage patient identification in a context where multiple patient databases exist.To ask an MPI to match a patient, clients use the '$match' operation, which accepts a patient resource which may be only partially complete. The data provided is interpreted as an MPI input and processed by an algorithm of some kind that uses the data to determine the most appropriate matches in the patient set.