Generated Narrative: CapabilityStatement pacio-pfe-cap Personal Functioning and Engagement Capability Statement Implementation Guide Version: 2.0.0 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 http://hl7.org/fhir/us/pacio-pfe/ImplementationGuide/hl7.fhir.us.pacio-pfe FHIR RESTful Capabilities Mode: server The PFE Server SHALL: Support all profiles defined in this Implementation Guide. Implement the RESTful behavior according to the FHIR specification. 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. Support json source formats for all PFE interactions. Support the searchParameters on each profile individually and in combination. The PFE Server SHOULD: Support xml source formats for all PFE interactions. Security 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. Summary of System-wide Interactions MAY support the batchinteraction. MAY support the search-systeminteraction. 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 P C D H-I H-T Searches _include _revinclude Operations Observation Supported Profiles Personal Functioning and Engagement Clinical Test Observationversion: null2.0.0) Personal Functioning and Engagement Collectionversion: null2.0.0) Personal Functioning and Engagement Single Observationversion: null2.0.0) 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, patient+code+date, patient+category+status, patient+category+date, patient+category, patient+code 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: null2.0.0) y y y y y y y y y date, category, status, code, patient, identifier, encounter, patient+code+date, patient+status, patient+category+date, patient+category, patient+code 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: null2.0.0) 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: null2.0.0) Personal Functioning and Engagement Condition Problems and Health Concerns Profileversion: null2.0.0) y y y y y y y y y identifier, status, abatement date, onset date, recorded date, subject, patient, bodySite, asserter, recordedDate, code, encounter, patient+recorded-date, patient+asserted-date, patient+category+clinical-status, patient+onset-date, patient+abatement-date, patient+clinical-status, patient+category+encounter, patient+code, patient+category Condition.identifier, Condition.subject, Condition.patient, Condition.bodySite, Condition.asserter, Condition.recordedDate, Condition.code, Condition.encounter Goal Supported Profiles Personal Functioning and Engagement Goal Profileversion: null2.0.0) y y y y y y y y y identifier, subject, patient, target date, lifecycle status, achievementStatus, addresses, patient+target-date, patient+description, patient+lifecycle-status Goal.identifier, Goal.subject, Goal.patient, Goal.achievementStatus, Goal.addresses NutritionOrder Supported Profiles Personal Functioning and Engagement Nutrition Order Profileversion: null2.0.0) y y y y y y y y y identifier, patient, encounter, orderer, status NutritionOrder.identifier, NutritionOrder.patient, NutritionOrder.encounter, NutritionOrder.orderer, NutritionOrder.status ServiceRequest Supported Profiles Personal Functioning and Engagement Service Request Profileversion: null2.0.0) y y y y y y y y y identifier, subject, patient, status, code, category, authored, requester, performer, reason reference, patient+category+authored, patient+status, patient+category, patient+code+authored, patient+code ServiceRequest.identifier, ServiceRequest.subject, ServiceRequest.patient, ServiceRequest.status, ServiceRequest.code, ServiceRequest.requester, ServiceRequest.performer, ServiceRequest.reasonReference Resource Conformance: SHALL Observation Core FHIR Resource Observation Reference Policy literal, logical Interaction summary SHALL support create, update, read, search-type. SHOULD support vread, history-instance. MAY support delete, history-type, patch. Supported Profiles Personal Functioning and Engagement Clinical Test Observationversion: null2.0.0) Personal Functioning and Engagement Collectionversion: null2.0.0) Personal Functioning and Engagement Single Observationversion: null2.0.0) Search Parameters Conformance Parameter Type Documentation SHALL date date Obtained date/time. If the obtained element is a period, a date that falls in the period SHALL code token The code of the observation type SHALL patient reference The subject that the observation is about (if patient) SHALL category token The classification of the type of observation SHALL status token The status of the observation 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 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 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 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 Combined Search Parameters Conformance Parameters Types SHALL patient+category+date reference+token+date SHALL patient+category reference+token SHALL patient+code reference+token SHOULD patient+code+date reference+token+date SHOULD patient+category+status reference+token+token Resource Conformance: MAY DiagnosticReport Core FHIR Resource DiagnosticReport Reference Policy literal, logical Interaction summary SHALL support create, update, read, search-type. SHOULD support vread, history-instance. MAY support delete, history-type, patch. Supported Profiles Personal Functioning and Engagement Narrative History of Statusversion: null2.0.0) Search Parameters Conformance Parameter Type Documentation SHALL date date Obtained date/time. If the obtained element is a period, a date that falls in the period SHALL category token The classification of the type of diagnostic report SHALL status token Search by status SHALL code token The code of the report type SHALL patient reference The subject that the report is about (if patient) MAY identifier token The unique id for a particular report MAY encounter reference Encounter related to the report Combined Search Parameters Conformance Parameters Types SHALL patient+category+date reference+token+date SHALL patient+category reference+token SHALL patient+code reference+token SHOULD patient+code+date reference+token+date SHOULD patient+status reference+token Resource Conformance: SHOULD DeviceUseStatement Core FHIR Resource DeviceUseStatement Reference Policy literal, logical Interaction summary SHOULD support create, update, delete, read. MAY support vread, history-instance, history-type, search-type, patch. Supported Profiles Personal Functioning and Engagement Use of Deviceversion: null2.0.0) Search Parameters 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 Resource Conformance: SHOULD Condition Core FHIR Resource Condition Reference Policy literal, logical Interaction summary SHOULD support create, update, delete, read. MAY support vread, history-instance, history-type, search-type, patch. Supported Profiles Personal Functioning and Engagement Condition Encounter Diagnosis Profileversion: null2.0.0) Personal Functioning and Engagement Condition Problems and Health Concerns Profileversion: null2.0.0) Search Parameters Conformance Parameter Type Documentation SHALL status token Search by status SHALL abatement date date Search by abatement date SHALL onset date date Search by onset date SHALL recorded date date Search by recorded date SHALL subject reference Search by subject SHALL patient reference Search by subject - a patient SHALL code token Search by code SHALL encounter reference Search by encounter MAY identifier token Search by identifier MAY bodySite token Search by body site MAY asserter reference Search by asserter MAY recordedDate date Search by recorded date Combined Search Parameters Conformance Parameters Types SHALL patient+category reference+<unknown> SHOULD patient+recorded-date reference+<unknown> SHOULD patient+asserted-date reference+<unknown> SHOULD patient+category+clinical-status reference+<unknown>+<unknown> SHOULD patient+onset-date reference+<unknown> SHOULD patient+abatement-date reference+<unknown> SHOULD patient+clinical-status reference+<unknown> SHOULD patient+category+encounter reference+<unknown>+reference SHOULD patient+code reference+token Resource Conformance: SHOULD Goal Core FHIR Resource Goal Reference Policy literal, logical Interaction summary SHOULD support create, update, delete, read. MAY support vread, history-instance, history-type, search-type, patch. Supported Profiles Personal Functioning and Engagement Goal Profileversion: null2.0.0) Search Parameters Conformance Parameter Type Documentation SHALL subject reference Search by subject SHALL patient reference Search by subject - a patient SHALL target date date Search by goal target date SHALL lifecycle status token Search by lifecycle status MAY identifier token Search by identifier MAY achievementStatus token Search by achievement status MAY addresses reference Search by addresses Combined Search Parameters Conformance Parameters Types SHOULD patient+target-date reference+<unknown> SHOULD patient+description reference+<unknown> SHOULD patient+lifecycle-status reference+<unknown> Resource Conformance: SHOULD NutritionOrder Core FHIR Resource NutritionOrder Reference Policy literal, logical Interaction summary SHOULD support create, update, delete, read. MAY support vread, history-instance, history-type, search-type, patch. Supported Profiles Personal Functioning and Engagement Nutrition Order Profileversion: null2.0.0) Search Parameters Conformance Parameter Type Documentation MAY identifier token Search by identifier MAY patient reference Search by subject - a patient MAY encounter reference Search by encounter MAY orderer reference Search by orderer MAY status token Search by status Resource Conformance: SHOULD ServiceRequest Core FHIR Resource ServiceRequest Reference Policy literal, logical Interaction summary SHOULD support create, update, delete, read. MAY support vread, history-instance, history-type, search-type, patch. Supported Profiles Personal Functioning and Engagement Service Request Profileversion: null2.0.0) Search Parameters Conformance Parameter Type Documentation SHALL subject reference Search by subject SHALL patient reference Search by subject - a patient SHALL status token Search by status SHALL code token Search by code SHALL category token Search by category SHALL authored date Search by date authored MAY identifier token Search by identifier MAY requester reference Search by requester MAY performer reference Search by performer MAY reason reference reference Search by reason reference Combined Search Parameters Conformance Parameters Types SHALL patient+category+authored reference+token+date SHALL patient+category reference+token SHALL patient+code reference+token SHOULD patient+status reference+token SHOULD patient+code+authored reference+token+date
Personal Functioning and Engagement Capability Statement
This Capability Statement defines the expected capabilities of a Personal Functioning and Engagement FHIR server conforming to the Personal Functioning and Engagement Implementation Guide.
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.
1. See the [Guidance](security_and_data_sharing.html) section for requirements and recommendations. 1. A server **SHALL** reject any unauthorized requests by returning an HTTP 401 "Unauthorized", HTTP 403 "Forbidden", or HTTP 404 "Not Found" response code.
Obtained date/time. If the obtained element is a period, a date that falls in the period
The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.
Code and quantity value parameter pair, including in components
The subject that the observation is about
The reason why the expected value in the element Observation.component.value[x] is missing.
The value of the observation, if the value is a CodeableConcept
The value of the observation, if the value is a date or period of time
Component code and component quantity value parameter pair
Reference to the test or procedure request.
The subject that the observation is about (if patient)
The component code of the observation type
Code and coded value parameter pair, including in components
The value of the observation, if the value is a string, and also searches in CodeableConcept.text
The unique id for a particular observation
The code of the observation type or component type
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)
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)
The reason why the expected value in the element Observation.value[x] is missing.
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)
Component code and component coded value parameter pair
The value of the component observation, if the value is a CodeableConcept
The classification of the type of observation
The Device that generated the observation data.
The value or component value of the observation, if the value is a CodeableConcept
The classification of the type of diagnostic report
The subject that the report is about (if patient)