PACIO Personal Functioning and Engagement Implementation Guide
2.0.0-ballot - STU2 Ballot
PACIO Personal Functioning and Engagement Implementation Guide
2.0.0-ballot - STU2 Ballot
This page is part of the PACIO Personal Functioning and Engagement 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.0.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/pacio-pfe/CapabilityStatement/pacio-pfe-cap | Version: 2.0.0-ballot | |||
| Draft as of 2022-08-12 | Computable Name: Personal_Functioning_And_Engagement_CapabilityStatement | |||
This Capability Statement defines the expected capabilities of a Personal Functioning and Engagement FHIR server conforming to the Personal Functioning and Engagement Implementation Guide.
Raw OpenAPI-Swagger Definition file | Download
Generated Narrative: CapabilityStatement pacio-pfe-cap
xml, jsonNote 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.
serverThe PFE Server SHALL:
The PFE Server SHOULD:
- See the Guidance section for requirements and recommendations.
- A server SHALL reject any unauthorized requests by returning an HTTP 401 "Unauthorized", HTTP 403 "Forbidden", or HTTP 404 "Not Found" response code.
batchinteraction.search-systeminteraction.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 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Observation | Supported Profiles Personal Functioning and Engagement Clinical Test Observationversion: {0}2.0.0-ballot) Personal Functioning and Engagement Collectionversion: {0}2.0.0-ballot) Personal Functioning and Engagement Single Observationversion: {0}2.0.0-ballot) | y | y | y | y | y | y | y | y | y | date, combo-data-absent-reason, code, combo-code-value-quantity, subject, component-data-absent-reason, value-concept, value-date, code-value-string, component-code-value-quantity, based-on, code-value-date, patient, specimen, component-code, code-value-quantity, combo-code-value-concept, value-string, identifier, performer, combo-code, method, value-quantity, component-value-quantity, data-absent-reason, combo-value-quantity, encounter, code-value-concept, component-code-value-concept, component-value-concept, category, device, combo-value-concept, status | Observation.subject, Observation.based-on, Observation.patient, Observation.specimen, Observation.context, Observation.performer, Observation.encounter, Observation.device | ChargeItem.service, ClinicalImpression.finding-ref, ClinicalImpression.investigation, DiagnosticReport.result, Immunization.reaction, ImmunizationRecommendation.information, MedicationStatement.part-of, Procedure.part-of, QuestionnaireResponse.parent | |
| DiagnosticReport | Supported Profiles Personal Functioning and Engagement Narrative History of Statusversion: {0}2.0.0-ballot) | y | y | y | y | y | y | y | y | y | date, code, patient, identifier, encounter | DiagnosticReport.based-on, DiagnosticReport.subject, DiagnosticReport.patient, DiagnosticReport.encounter, DiagnosticReport.media, DiagnosticReport.performer, DiagnosticReport.result, DiagnosticReport.results-interpreter, DiagnosticReport.specimen | ||
| DeviceUseStatement | Supported Profiles Personal Functioning and Engagement Use of Deviceversion: {0}2.0.0-ballot) | y | y | y | y | y | y | y | y | y | identifier, subject, patient, device | DeviceUseStatement.subject, DeviceUseStatement.patient, DeviceUseStatement.device | ||
| Condition | Supported Profiles Personal Functioning and Engagement Condition Encounter Diagnosis Profileversion: {0}2.0.0-ballot) Personal Functioning and Engagement Condition Problems and Health Concerns Profileversion: {0}2.0.0-ballot) | y | y | y | y | y | y | y | y | y | identifier, subject, bodySite, asserter, recordedDate, code, encounter | Condition.identifier, Condition.subject, Condition.bodySite, Condition.asserter, recordedDate, code, encounter | ||
| Goal | Supported Profiles Personal Functioning and Engagement Goal Profileversion: {0}2.0.0-ballot) | y | y | y | y | y | y | y | y | y | identifier, subject, patient, achievementStatus, addresses | Goal.identifier, Goal.subject, Goal.patient, Goal.achievementStatus, Goal.addresses | ||
| NutritionOrder | Supported Profiles Personal Functioning and Engagement Nutrition Order Profileversion: {0}2.0.0-ballot) | y | y | y | y | y | y | y | y | y | identifier, subject, patient, encounter, orderer, status | NutritionOrder.identifier, NutritionOrder.subject, NutritionOrder.patient, NutritionOrder.encounter, NutritionOrder.orderer, NutritionOrder.status | ||
| ServiceRequest | Supported Profiles Personal Functioning and Engagement Service Request Profileversion: {0}2.0.0-ballot) | y | y | y | y | y | y | y | y | y | identifier, subject, patient, status, code, requester, performer, reason reference | ServiceRequest.identifier, ServiceRequest.subject, ServiceRequest.patient, ServiceRequest.status, ServiceRequest.code, ServiceRequest.requester, ServiceRequest.performer, ServiceRequest.reasonReference |
literal, logicalcreate, update, read, search-type.vread, history-instance.delete, history-type, patch.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| MAY | date | date | Obtained date/time. If the obtained element is a period, a date that falls in the period |
| MAY | combo-data-absent-reason | token | The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing. |
| MAY | code | token | The code of the observation type |
| MAY | combo-code-value-quantity | composite | Code and quantity value parameter pair, including in components |
| MAY | subject | reference | The subject that the observation is about |
| MAY | component-data-absent-reason | token | The reason why the expected value in the element Observation.component.value[x] is missing. |
| MAY | value-concept | token | The value of the observation, if the value is a CodeableConcept |
| MAY | value-date | date | The value of the observation, if the value is a date or period of time |
| MAY | code-value-string | composite | Code and string value parameter pair |
| MAY | component-code-value-quantity | composite | Component code and component quantity value parameter pair |
| MAY | based-on | reference | Reference to the test or procedure request. |
| MAY | code-value-date | composite | Code and date/time value parameter pair |
| MAY | patient | reference | The subject that the observation is about (if patient) |
| MAY | specimen | reference | Specimen used for this observation |
| MAY | component-code | token | The component code of the observation type |
| MAY | code-value-quantity | composite | Code and quantity value parameter pair |
| MAY | combo-code-value-concept | composite | Code and coded value parameter pair, including in components |
| MAY | value-string | string | The value of the observation, if the value is a string, and also searches in CodeableConcept.text |
| MAY | identifier | token | The unique id for a particular observation |
| MAY | performer | reference | Who performed the observation |
| MAY | combo-code | token | The code of the observation type or component type |
| MAY | method | token | The method used for the observation |
| MAY | value-quantity | quantity | The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
| MAY | component-value-quantity | quantity | The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
| MAY | data-absent-reason | token | The reason why the expected value in the element Observation.value[x] is missing. |
| MAY | combo-value-quantity | quantity | The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
| MAY | encounter | reference | Encounter related to the observation |
| MAY | code-value-concept | composite | Code and coded value parameter pair |
| MAY | component-code-value-concept | composite | Component code and component coded value parameter pair |
| MAY | component-value-concept | token | The value of the component observation, if the value is a CodeableConcept |
| MAY | category | token | The classification of the type of observation |
| MAY | device | reference | The Device that generated the observation data. |
| MAY | combo-value-concept | token | The value or component value of the observation, if the value is a CodeableConcept |
| MAY | status | token | The status of the observation |
literal, logicalcreate, update, read, search-type.vread, history-instance.delete, history-type, patch.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The subject that the report is about (if patient) |
| MAY | date | date | Obtained date/time. If the obtained element is a period, a date that falls in the period |
| MAY | code | token | The code of the report type |
| MAY | identifier | token | The unique id for a particular report |
| MAY | encounter | reference | Encounter related to the report |
literal, logicalcreate, update, delete, read.vread, history-instance, history-type, search-type, patch.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| MAY | identifier | token | Search by identifier |
| MAY | subject | reference | Search by subject |
| MAY | patient | reference | Search by subject - a patient |
| MAY | device | reference | Search by device |
literal, logicalcreate, update, delete, read.vread, history-instance, history-type, search-type, patch.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| MAY | identifier | token | Search by identifier |
| MAY | subject | reference | Search by subject |
| MAY | bodySite | token | Search by body site |
| MAY | asserter | reference | Search by asserter |
| MAY | recordedDate | token | Search by recorded date |
| MAY | code | token | Search by code |
| MAY | encounter | reference | Search by encounter |
literal, logicalcreate, update, delete, read.vread, history-instance, history-type, search-type, patch.http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-goal|2.0.0
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| MAY | identifier | token | Search by identifier |
| MAY | subject | reference | Search by subject |
| MAY | patient | reference | Search by subject - a patient |
| MAY | achievementStatus | token | Search by achievement status |
| MAY | addresses | reference | Search by addresses |
literal, logicalcreate, update, delete, read.vread, history-instance, history-type, search-type, patch.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| MAY | identifier | token | Search by identifier |
| MAY | subject | reference | Search by subject |
| MAY | patient | reference | Search by subject - a patient |
| MAY | encounter | reference | Search by encounter |
| MAY | orderer | reference | Search by orderer |
| MAY | status | reference | Search by status |
literal, logicalcreate, update, delete, read.vread, history-instance, history-type, search-type, patch.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| MAY | identifier | token | Search by identifier |
| MAY | subject | reference | Search by subject |
| MAY | patient | reference | Search by subject - a patient |
| MAY | status | token | Search by status |
| MAY | code | token | Search by code |
| MAY | requester | reference | Search by requester |
| MAY | performer | reference | Search by performer |
| MAY | reason reference | reference | Search by reason reference |
IG © 2022+ HL7 International / Patient Care. Package hl7.fhir.us.pacio-pfe#2.0.0-ballot based on FHIR 4.0.1. Generated 2024-08-13
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change