This page is part of the U.S. Physical Activity IG (v1.0.0: STU 1.0) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/physical-activity/CapabilityStatement/pa-patient-engagement | Version: 1.0.0 | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: PAPatientEngagement |
Describes the expected capabilities of a system intended for use by patients and caregivers of patients who are working to enhance or maintain their levels of physical activity. These will typically be web-based or mobile applications.
Raw OpenAPI-Swagger Definition file | Download
Supported FHIR Version: | 4.0.1 |
---|---|
Imports other Capabilities: | |
Supported exchange formats: | json, xml |
Jump to:
Systems for patients only act as RESTful clients. While they may create and store some of their own data, this data is always made available by 'pushing' it to the server of a care manager or a full service provider system.
Resource | Search | Read | Read Version | Instance History | Resource History | Create | Update | Delete | Operations |
---|---|---|---|---|---|---|---|---|---|
CarePlan | SHOULD | MAY | SHOULD | ||||||
DiagnosticReport | SHALL | ||||||||
DocumentReference | SHOULD | SHOULD | MAY | ||||||
Goal | SHOULD | MAY | SHOULD | ||||||
Observation | SHALL | SHALL | SHOULD | ||||||
Patient | SHALL | ||||||||
Practitioner | SHALL | ||||||||
PractitionerRole | SHALL | ||||||||
Questionnaire | SHALL | ||||||||
QuestionnaireResponse | SHALL | SHALL | SHALL | ||||||
ServiceRequest | SHALL | ||||||||
Subscription | SHALL | SHALL | SHALL | ||||||
Task | SHALL | SHALL | SHALL |
Supported Profile(s):
Versioning support: versioned-update
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known care plan records - and more specifically, retrieving more than one in a single call to check for updates. |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query. |
category | SHALL | token |
Allows retrieving only those plans related to physical activity. |
date | SHOULD | date |
Allows filtering plans based on the time frame they apply(ied) to. |
status | SHOULD | token |
Allows filtering to only active or draft plans. |
patient | SHALL | reference |
Allows filtering to only those plans for a specific patient. Most systems will treat this as a mandatory search parameter, though systems MAY support cross-patient search, at least through bulk-data interfaces for payer or research use. |
Supported Profile(s):
Versioning support: versioned-update
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known reports - and more specifically, retrieving more than one in a single call to poll for updates. |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query. |
basedOn | SHOULD | reference |
Allows filtering to reports created in fulfillement of a particular order or referral. |
code | SHOULD | token |
Allows filtering to specific types of reports. |
date | SHOULD | date |
Allows filtering reports based on the period the cover. |
category | SHALL | token |
Allows retrieving only those reports related to physical activity. |
patient | SHALL | reference |
Allows filtering to only those reports for a specific patient. Most systems will treat this as a mandatory search parameter, though systems MAY support cross-patient search, at least through bulk-data interfaces for payer or research use. |
performer | SHOULD | reference |
Allows filtering to only retrieve reports created by a specific performer. |
status | SHOULD | token |
Allows filtering to only retrieve active or completed reports. |
Supported Profile(s):
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known document-reference records - and more specifically, retrieving more than one in a single call to poll for updates. |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query. |
contenttype | SHOULD | token |
Allows filtering for only PDFs, images, etc. |
category | SHOULD | token |
Allows filtering for only records tied to a particular category (e.g. physical-activity). |
description | SHOULD | string |
Allows filtering based on words found in the description - i.e. with a 'contains' search. |
Supported Profile(s):
Versioning support: versioned-update
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known goal records - and more specifically, retrieving more than one in a single call to poll for updates. |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query. |
category | SHOULD | token |
Allows retrieving only those goals related to physical activity. |
lifecycle-status | SHOULD | token |
Allows filtering to only active, completed or other goal statuses. |
patient | SHALL | reference |
Allows filtering to only those goals for a specific patient. Most systems will treat this as a mandatory search parameter, though systems MAY support cross-patient search, at least through bulk-data interfaces for payer or research use. |
target-date | SHOULD | date |
Allows filtering goals based on when they're to be achieved. |
Supported Profile(s):
Versioning support: versioned-update
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known observation records - and more specifically, retrieving more than one in a single call to poll for updates. |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query. |
category | SHALL | token |
Allows retrieving only those observations related to physical activity. As well, many clinical systems will require searches to specify a category so the server knows which part of the database to search as different types of observations are stored in different areas. |
code | SHALL | token |
Allows filtering to only retrieve a specific type of physical activity vital sign or supporting observation. |
date | SHALL | date |
Allows filtering to only retrieve a observations from a particular time period. |
patient | SHALL | reference |
Allows filtering to only those observations for a specific patient. Most systems will treat this as a mandatory search parameter, though systems MAY support cross-patient search, at least through bulk-data interfaces for payer or research use. |
status | SHALL | token |
Allows excluding entered-in-error or non-final observations. |
value-quantity | SHOULD | quantity |
Allows retrieval of only those observations that fall in a particular range. Particularly useful for cross-patient queries. |
Versioning support: versioned-update
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known reports - and more specifically, retrieving more than one in a single call to poll for updates. |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query. |
birthdate | MAY | date |
Allows filtering of individuals based on their date of birth. |
family | MAY | string |
Allows filtering of individuals based on their family name. |
gender | MAY | token |
Allows filtering of individuals based on their gender. |
given | MAY | string |
Allows filtering of individuals based on their given name. |
identifier | SHALL | token |
Enables filtering of patients based on their unique identifiers. |
name | SHALL | string |
Enables filtering of patients based on their full name. |
Versioning support: versioned-update
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known reports - and more specifically, retrieving more than one in a single call to poll for updates. |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query. |
identifier | SHOULD | token |
Enables filtering of practitioners based on their unique identifiers. |
name | SHOULD | string |
Enables filtering of practitioners based on their full name. |
Versioning support: versioned-update
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known reports - and more specifically, retrieving more than one in a single call to poll for updates. |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query. |
specialty | SHOULD | token |
Allows filtering of practitioner specialty. |
practitioner | SHOULD | reference |
Enables filtering of practitioner roles based on the associated practitioner. |
Supported Profile(s):
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known questionnaire records - and more specifically, retrieving more than one in a single call to poll for updates. |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query. |
url | SHALL | uri |
Allows retrieving a referenced Questionnaire. |
version | SHOULD | token |
Allows retrieving a specific version of a referenced questionnaire. |
context-type-value | SHOULD | composite |
Allows filtering for Questionnaires that are phyical activity-related. |
identifier | SHOULD | token |
Allows retrieving Questionnaires with a known identifier. |
publisher | SHOULD | string |
Allows retrieving Questionnaires based on who is responsible for having defined the form. |
status | SHOULD | token |
Allows filtering to only retrieve active questionnaires. |
subject-type | SHOULD | token |
Allows retrieving Questionnaires that are intended to provide information about patients - as opposed to practitioners, organizations, etc. |
title | SHOULD | string |
Allows searching for forms by name. |
Supported Profile(s):
Versioning support: versioned-update
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known questionnaire response records - and more specifically, retrieving more than one in a single call to poll for updates. |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query. |
author | SHALL | reference |
Allows filtering responses previously created by a particular individual. |
authored | SHOULD | date |
Allows filtering responses based on when they were completed. |
patient | SHALL | reference |
Allows filtering to only those responses for a specific patient. Most systems will treat this as a mandatory search parameter, though systems MAY support cross-patient search, at least through bulk-data interfaces for payer or research use. |
questionnaire | SHALL | reference |
Allows retrieving a referenced Questionnaire. |
status | SHOULD | token |
Allows filtering to only retrieve completed questionnaire responses. |
Supported Profile(s):
Reference policy: literal
Name | Conformance | Description |
---|---|---|
search-type | SHALL |
Allows searching for orders or referrals for a particular patient or for updates to previously retrieved orders. |
Supported Includes: ServiceRequest:patient, ServiceRequest:requester
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known service request records - and more specifically, retrieving more than one in a single call to poll for updates. |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query. |
authored | SHOULD | date |
Allows filtering orders based on when they were created. |
category | SHALL | token |
Allows retrieving only those referrals related to physical activity. |
code | SHALL | token |
Allows retrieving only orders for particular types of interventions. |
patient | SHALL | reference |
Allows filtering to only those orders for a specific patient. Most systems will treat this as a mandatory search parameter, though systems MAY support cross-patient search, at least through bulk-data interfaces for payer or research use. |
performer | SHOULD | reference |
Allows filtering to only retrieve orders targeted to a specific performer. |
requester | SHOULD | reference |
Allows filtering to only retrieve orders solicited by a specific provider. |
status | SHOULD | token |
Allows filtering to only retrieve active or completed orders. |
Supported Profile(s):
Versioning support: versioned-update
Reference policy: literal
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
topic | SHOULD | uri |
Allows filtering for just subscriptions for Task monitoring. |
_id | SHALL | token |
Allows retrieving known subscription records. |
url | SHALL | uri |
Allows filtering only for subscriptions that notify a specific endpoint. Substituting for the 'owner' search parameter, which doesn't exist in R4. |
Supported Profile(s):
Versioning support: versioned-update
Reference policy: literal
Supported Includes: Task:focus, Task:output, Task:patient, ServiceRequest:requester
Parameter | Conformance | Type | Definition & Chaining |
---|---|---|---|
_id | SHALL | token |
Allows retrieving known task records - and more specifically, retrieving more than one in a single call to poll for updates. |
_lastUpdated | SHOULD | date |
Allows filtering for only records that have changed since last query. |
code | SHALL | token |
Allows filtering for 'fulfill' tasks as opposed to others. Some systems may require code to be included as a filter criteria as different Task codes may correspond to different internal database tables. |
owner | SHALL | reference |
Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned). |
patient | SHALL | reference |
Allows filtering to only those tasks for a specific patient. Most systems will treat this as a mandatory search parameter, though systems MAY support cross-patient search, at least through bulk-data interfaces for payer or research use. |
requester | SHOULD | reference |
Allows filtering to only retrieve tasks initiated by a specific provider. |
status | SHALL | token |
Allows filtering to only retrieve active or completed orders. |
focus | SHOULD | reference |
Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest. |
output | SHOULD | reference |
Allows for the 'output' of a Task to be included when retrieving a Task. |