PACIO Personal Functioning and Engagement Implementation Guide
3.0.0-ballot - STU 3 Ballot United States of America flag

PACIO Personal Functioning and Engagement Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 3.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/fhir-pacio-pfe/ and changes regularly. See the Directory of published versions

CapabilityStatement: Personal Functioning and Engagement Capability Statement

Official URL: http://hl7.org/fhir/us/pacio-pfe/CapabilityStatement/pacio-pfe-cap Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: Personal_Functioning_And_Engagement_CapabilityStatement
Other Identifiers: OID:2.16.840.1.113883.4.642.40.67.13.1

This Capability Statement defines the expected capabilities of a Personal Functioning and Engagement FHIR server conforming to the Personal Functioning and Engagement Implementation Guide.

PACIO Personal Functioning and Engagement Servers SHALL support the capabilities described in the US Core Server CapabilityStatement. Some RESTful operations and search parameters described in the PACIO Personal Functioning and Engagement Server CapabilityStatement are redundant to the US Core Server CapabilityStatement, but are listed here to highlight which capabilities are specifically relevant to PACIO Personal Functioning and Engagement.

Raw OpenAPI-Swagger Definition file | Download

Language: en

Personal Functioning and Engagement Capability Statement

  • Implementation Guide Version: 3.0.0-ballot
  • FHIR Version: 4.0.1
  • Supported Formats: xml, json
  • Supported Patch Formats: application/json-patch+json
  • Published on: 2022-08-12 00:00:00+0000
  • 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

FHIR RESTful Capabilities

Mode: server

The PFE 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 PFE interactions.
  5. Support the searchParameters on each profile individually and in combination.

The PFE Server SHOULD:

  1. Support xml source formats for all PFE 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 TypeProfileRSUCSearches_include_revincludeOperations
ConditionSupported Profiles
  http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-condition-encounter-diagnosis|2.0.0
  http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-condition-problems-health-concerns|2.0.0		YYpatient, category, patient+category
DeviceSupported Profiles
  http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-device|2.0.0		YYpatient
DeviceRequestSupported Profiles
  http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-device-request|2.0.0		YYpatient
DeviceUseStatementSupported Profiles
  http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-use-of-device|2.0.0		YYpatient
DiagnosticReportSupported Profiles
  http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-narrative-history-of-status|2.0.0		YYYYdate, category, code, patient, patient+category+date, patient+category, patient+code
GoalSupported Profiles
  http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-goal|2.0.0		YYpatient
NutritionOrderSupported Profiles
  http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-nutrition-order|2.0.0		YYpatient
ObservationSupported Profiles
  http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-observation-clinicaltest|2.0.0
  http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-collection|2.0.0
  http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-observation-single|2.0.0		YYYYdate, code, patient, category, patient+category+date, patient+category, patient+code
PatientSupported Profiles
  US Core Patient Profileversion: 6.1.0)		YY_id, identifier, name, birthdate, birthdate+name
ServiceRequestSupported Profiles
  http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-service-request|2.0.0		YY_id, patient, code, category, authored, patient+category+authored, patient+category, patient+code
Core FHIR Resource
Condition
Reference Policy
literal, logical
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-condition-encounter-diagnosis|2.0.0
http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-condition-problems-health-concerns|2.0.0

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Search by subject - a patient

MAYcategorytoken

Search by encounter

Combined Search Parameters
ConformanceParametersTypes
SHALLpatient+categoryreference+token
Core FHIR Resource
Device
Reference Policy
literal, logical
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-device|2.0.0

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Patient information, if the resource is affixed to a person

 
Core FHIR Resource
DeviceRequest
Reference Policy
literal, logical
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-device-request|2.0.0

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Individual the service is ordered for

 
Core FHIR Resource
DeviceUseStatement
Reference Policy
literal, logical
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-use-of-device|2.0.0

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Search by subject - a patient

 
Core FHIR Resource
DiagnosticReport
Reference Policy
literal, logical
Interaction summary
  • SHALL support create, update, read, search-type.

Supported Profiles

http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-narrative-history-of-status|2.0.0

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The subject that the report is about (if patient)

MAYdatedate

Obtained date/time. If the obtained element is a period, a date that falls in the period

MAYcategorytoken

The classification of the type of diagnostic report

MAYcodetoken

The code of the report type

Combined Search Parameters
ConformanceParametersTypes
SHALLpatient+category+datereference+token+date
SHALLpatient+categoryreference+token
SHALLpatient+codereference+token
Core FHIR Resource
Goal
Reference Policy
literal, logical
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-goal|2.0.0

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Search by subject - a patient

 
Core FHIR Resource
NutritionOrder
Reference Policy
literal, logical
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-nutrition-order|2.0.0

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Search by subject - a patient

 
Core FHIR Resource
Observation
Reference Policy
literal, logical
Interaction summary
  • SHALL support create, update, read, search-type.

Supported Profiles

http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-observation-clinicaltest|2.0.0
http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-collection|2.0.0
http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-observation-single|2.0.0

Search Parameters
ConformanceParameterTypeDocumentation
MAYdatedate

Obtained date/time. If the obtained element is a period, a date that falls in the period

MAYcodetoken

The code of the observation type

MAYpatientreference

The subject that the observation is about (if patient)

MAYcategorytoken

The classification of the type of observation

Combined Search Parameters
ConformanceParametersTypes
SHALLpatient+category+datereference+token+date
SHALLpatient+categoryreference+token
SHALLpatient+codereference+token
Core FHIR Resource
Patient
Reference Policy
literal, logical
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

US Core Patient Profileversion: 6.1.0)

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALLidentifiertoken

A patient identifier

SHALLnamestring

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

MAYbirthdatedate

The patient's date of birth

Combined Search Parameters
ConformanceParametersTypes
SHALLbirthdate+namedate+string
Core FHIR Resource
ServiceRequest
Reference Policy
literal, logical
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-service-request|2.0.0

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Search by id

SHALLpatientreference

Search by subject - a patient

MAYcodetoken

Search by code

MAYcategorytoken

Search by category

MAYauthoreddate

Search by date authored

Combined Search Parameters
ConformanceParametersTypes
SHALLpatient+category+authoredreference+token+date
SHALLpatient+categoryreference+token
SHALLpatient+codereference+token