PACIO Transitions of Care Implementation Guide
1.0.0-ballot - STU 1 Ballot United States of America flag

This page is part of the PACIO Transitions of Care Implementation Guide (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

CapabilityStatement: TOC CapabilityStatement

Official URL: http://hl7.org/fhir/us/pacio-toc/CapabilityStatement/toc Version: 1.0.0-ballot
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

Generated Narrative: CapabilityStatement toc

TOC CapabilityStatement

  • Implementation Guide Version: 1.0.0-ballot
  • 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

  • https://build.fhir.org/ig/HL7/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
    • (Status 410): deleted 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.
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-RSUCH-ISearches_include_revincludeOperations
Bundle yyyyyy_id, composition, identifier, timestamp, type
CompositionSupported Profiles
  https://hl7.org/fhir/us/pacio-toc/StructureDefinition-TOC-Composition-Header.html		yyyyyy
Organization yyyyyy
PatientSupported Profiles
  https://www.hl7.org/fhir/us/core/StructureDefinition-us-core-patient.html|6.1.0		yyyyyy_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
OperationDefinitionhttps://hl7.org/fhir/R4/patient-operation-match.html$$match

Resource Conformance: SHALL Bundle

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

Search Parameters
ConformanceParameterTypeDocumentation
SHOULD_idtoken
SHOULDcompositionreference
SHOULDidentifiertoken
SHOULDtimestampdate
SHOULDtypetoken
 

Resource Conformance: MAY Composition

Core FHIR Resource
Composition
Reference Policy
resolves
Interaction summary
  • SHOULD support vread, history-instance.
  • MAY support create, search-type, read, update.

Supported Profiles

https://hl7.org/fhir/us/pacio-toc/StructureDefinition-TOC-Composition-Header.html

Resource Conformance: SHALL Organization

Core FHIR Resource
Organization
Reference Policy
resolves
Interaction summary
  • SHALL support create, search-type, read, update.
  • SHOULD support vread, history-instance.

Resource Conformance: MAY Patient

Core FHIR Resource
Patient
Reference Policy
resolves
Interaction summary
  • SHALL support create, search-type, read, update.
  • SHOULD support vread, history-instance.

Supported Profiles

https://www.hl7.org/fhir/us/core/StructureDefinition-us-core-patient.html|6.1.0

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-id.html

SHALLbirthdatedate

https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-birthdate.html

SHALLfamilystring

https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-family.html

SHALLgendertoken

https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-given.html

SHALLgivenstring

https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-given.html

SHALLidentifiertoken

https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-identifier.html

SHALLnamestring

https://www.hl7.org/fhir/us/core/SearchParameter-us-core-patient-name.html

SHOULDactivetoken
SHOULDemailtoken
SHOULDphonetoken
SHOULDtelecomtoken
MAYaddressstring
MAYaddress-citystring
MAYaddress-countrystring
MAYaddress-postalcodestring
MAYaddress-statestring
MAYaddress-usetoken
MAYdeath-datedate
MAYdeceasedtoken
MAYgeneral-practitionerreference
MAYlanguagetoken
MAYlinkreference
MAYorganizationreference
MAYphoneticstring
MAYracetoken

https://www.hl7.org/fhir/us/core/SearchParameter-us-core-race.html

MAYethnicitytoken

https://www.hl7.org/fhir/us/core/SearchParameter-us-core-ethnicity.html

 

Resource Conformance: supported OperationDefinition

Base System Profile
https://hl7.org/fhir/R4/patient-operation-match.html
Profile Conformance
SHALL
Reference Policy

Interaction summary

    Extended Operations
    ConformanceOperationDocumentation
    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.