General Supported FHIR Version: 4.0.1 Imports other Capabilities: US Core Client CapabilityStatement Supported exchange formats: json, xml Jump to: REST client REST client behavior 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 summary 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 CarePlan Supported Profile(s): PA Care Plan Behavior Versioning support: versioned-update Reference policy: literal Interactions Name Conformance Description update SHOULD Allows a patient system to make updates to a plan. search-type SHOULD Allows retrieval of care plans for a given patient. history-instance MAY Allows seeing how a care plan has changed over time. This may be particularly important if multiple stakeholders have the ability to make adjustments to the plan. However, history is not widely supported. Search 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. DiagnosticReport Supported Profile(s): PA Intervention Report Behavior Versioning support: versioned-update Reference policy: literal Interactions Name Conformance Description search-type SHALL Allows searching for recorded reports. Search 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. DocumentReference Supported Profile(s): US Core DocumentReference Profile Behavior Reference policy: literal Interactions Name Conformance Description create SHOULD Allows a ServiceProvider to add additional images/documents for later retrieval. update MAY Allows a ServiceProvider to replace an existing image/document with a newer version. search-type SHOULD Allows monitoring of previously-retrieved DocumentReferences in the event the image/document is amended, corrected, or updated. Search 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. Goal Supported Profile(s): PA Goal Behavior Versioning support: versioned-update Reference policy: literal Interactions Name Conformance Description update SHOULD Allows patients to modify a goal - for example shifting target values or dates, updating the status, etc. Allowing patients and care-givers to help maintain goals is a key aspect of a patient-centered care plan. However not all care manager or service provider systems (or their organizations) yet have the technical mechanisms or policies in place to support this. search-type SHOULD Allows retrieval of goals for a given patient. history-instance MAY Allows seeing how goals have changed over time. This may be particularly important if multiple stakeholders have the ability to make adjustments to goals. However, history is not widely supported. Search 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. Observation Supported Profile(s): PA Observation - EVS, Days/Week PA Observation - EVS, Minutes/Day PA Observation - EVS, Minutes/Week PA Observation - EVS, Strength Days/Week PA Observation - Supporting, Activity-based PA Observation - Supporting, Activity Group PA Observation - Supporting, Time-based Behavior Versioning support: versioned-update Reference policy: literal Interactions Name Conformance Description create SHALL Allows recording new observations update SHOULD Allows correcting a previous observation or revising the status search-type SHALL Allows viewing of previously recorded observations - e.g. to help calculate primary measures and/or to view trends. Search 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. Patient Behavior Versioning support: versioned-update Reference policy: literal Interactions Name Conformance Description search-type SHALL Allows searching of the patients. Search 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. Practitioner Behavior Versioning support: versioned-update Reference policy: literal Interactions Name Conformance Description search-type SHALL Allows searching of the practitioners. Search 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. PractitionerRole Behavior Versioning support: versioned-update Reference policy: literal Interactions Name Conformance Description search-type SHALL Allows searching of the practitioner roles. Search 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. Questionnaire Supported Profile(s): Populatable Questionnaire - Observation Extractable Questionnaire - Observation Behavior Reference policy: literal Interactions Name Conformance Description search-type SHALL Allows retrieval of questionnaires to be completed. Search 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. QuestionnaireResponse Supported Profile(s): SDC Questionnaire Response Behavior Versioning support: versioned-update Reference policy: literal Interactions Name Conformance Description update SHALL Allows correction of or continued editing of a previously recorded questionnaire response. create SHALL Allows other systems to record questionnaire responses. search-type SHALL Allows retrieval of completed or in-progresss questionnaire responses. Search 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. ServiceRequest Supported Profile(s): PA Service Request Behavior Reference policy: literal Interactions Name Conformance Description search-type SHALL Allows searching for orders or referrals for a particular patient or for updates to previously retrieved orders. Search 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. Subscription Supported Profile(s): R4/B Topic-Based Subscription Behavior Versioning support: versioned-update Reference policy: literal Interactions Name Conformance Description create SHALL Allows establishing a new subscription. update SHALL Allows revising an existing subscription - to cancel it or change the email address or SMS number. search-type SHALL Allows retrieval of existing subscriptions prior to update. Search 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. Task Supported Profile(s): PA Task for Referral Management SDOHCC Task For Patient Behavior Versioning support: versioned-update Reference policy: literal Interactions Name Conformance Description create SHALL Allows a creation of Task on a Full Service Provider system. update SHALL Allows updating the status and/or specifying outputs for patient tasks. search-type SHALL Allows retrieval of existing tasks to check for changes or prior to making updates. This will typically be prompted by a subscription notification. Search 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.
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.
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](CapabilityStatement-pa-care-manager.html) or a [full service provider](CapabilityStatement-pa-service-provider-full.html) system.
Allows accessing and manipulating Care Plans.
Allows a patient system to make updates to a plan.
Allows retrieval of care plans for a given patient.
Allows seeing how a care plan has changed over time. This may be particularly important if multiple stakeholders have the ability to make adjustments to the plan. However, history is not widely supported.
Allows retrieving known care plan records - and more specifically, retrieving more than one in a single call to check for updates.
Allows filtering for only records that have changed since last query.
Allows retrieving only those plans related to physical activity.
Allows filtering plans based on the time frame they apply(ied) to.
Allows filtering to only active or draft plans.
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.
Allows viewiong of the reports summarizing the results of a referral.
Allows retrieving known reports - and more specifically, retrieving more than one in a single call to poll for updates.
Allows filtering to reports created in fulfillement of a particular order or referral.
Allows filtering to specific types of reports.
Allows filtering reports based on the period the cover.
Allows retrieving only those reports related to physical activity.
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.
Allows filtering to only retrieve reports created by a specific performer.
Allows filtering to only retrieve active or completed reports.
Allows retrieving PDFs or similar content referenced by a Patient Task. These generally will not be patient-specific resources.
Allows a ServiceProvider to add additional images/documents for later retrieval.
Allows a ServiceProvider to replace an existing image/document with a newer version.
Allows monitoring of previously-retrieved DocumentReferences in the event the image/document is amended, corrected, or updated.
Allows retrieving known document-reference records - and more specifically, retrieving more than one in a single call to poll for updates.
Allows filtering for only PDFs, images, etc.
Allows filtering for only records tied to a particular category (e.g. physical-activity).
Allows filtering based on words found in the description - i.e. with a 'contains' search.
Allows accessing and potentially updating patient goals.
Allows patients to modify a goal - for example shifting target values or dates, updating the status, etc. Allowing patients and care-givers to help maintain goals is a key aspect of a patient-centered care plan. However not all care manager or service provider systems (or their organizations) yet have the technical mechanisms or policies in place to support this.
Allows retrieval of goals for a given patient.
Allows seeing how goals have changed over time. This may be particularly important if multiple stakeholders have the ability to make adjustments to goals. However, history is not widely supported.
Allows retrieving known goal records - and more specifically, retrieving more than one in a single call to poll for updates.
Allows retrieving only those goals related to physical activity.
Allows filtering to only active, completed or other goal statuses.
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.
Allows filtering goals based on when they're to be achieved.
Allows recording and viewing patient physical activity observations.
Allows correcting a previous observation or revising the status
Allows viewing of previously recorded observations - e.g. to help calculate primary measures and/or to view trends.
Allows retrieving known observation records - and more specifically, retrieving more than one in a single call to poll for updates.
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.
Allows filtering to only retrieve a specific type of physical activity vital sign or supporting observation.
Allows filtering to only retrieve a observations from a particular time period.
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.
Allows excluding entered-in-error or non-final observations.
Allows retrieval of only those observations that fall in a particular range. Particularly useful for cross-patient queries.
Allows filtering of individuals based on their date of birth.
Allows filtering of individuals based on their family name.
Allows filtering of individuals based on their gender.
Allows filtering of individuals based on their given name.
Enables filtering of patients based on their unique identifiers.
Enables filtering of patients based on their full name.
Enables filtering of practitioners based on their unique identifiers.
Enables filtering of practitioners based on their full name.
Allows searching of the practitioner roles.
Allows filtering of practitioner specialty.
Enables filtering of practitioner roles based on the associated practitioner.
Allows retrieval of Questionnaires referenced by a patient Task.
Allows retrieval of questionnaires to be completed.
Allows retrieving known questionnaire records - and more specifically, retrieving more than one in a single call to poll for updates.
Allows retrieving a referenced Questionnaire.
Allows retrieving a specific version of a referenced questionnaire.
Allows filtering for Questionnaires that are phyical activity-related.
Allows retrieving Questionnaires with a known identifier.
Allows retrieving Questionnaires based on who is responsible for having defined the form.
Allows filtering to only retrieve active questionnaires.
Allows retrieving Questionnaires that are intended to provide information about patients - as opposed to practitioners, organizations, etc.
Allows recording and updating of questionnaire responses in response to patient tasks.
Allows correction of or continued editing of a previously recorded questionnaire response.
Allows other systems to record questionnaire responses.
Allows retrieval of completed or in-progresss questionnaire responses.
Allows retrieving known questionnaire response records - and more specifically, retrieving more than one in a single call to poll for updates.
Allows filtering responses previously created by a particular individual.
Allows filtering responses based on when they were completed.
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.
Allows filtering to only retrieve completed questionnaire responses.
Allows retrieval 'execise prescriptions' - referrals addressed to the patient themselves - as well as monitoring of referrals assigned to others.
Allows searching for orders or referrals for a particular patient or for updates to previously retrieved orders.
Allows retrieving known service request records - and more specifically, retrieving more than one in a single call to poll for updates.
Allows filtering orders based on when they were created.
Allows retrieving only those referrals related to physical activity.
Allows retrieving only orders for particular types of interventions.
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.
Allows filtering to only retrieve orders targeted to a specific performer.
Allows filtering to only retrieve orders solicited by a specific provider.
Allows filtering to only retrieve active or completed orders.
Allows establishing and maintaining subscriptions for Task notifications. Only needed if not handled manually.
Allows revising an existing subscription - to cancel it or change the email address or SMS number.
Allows retrieval of existing subscriptions prior to update.
Allows filtering for just subscriptions for Task monitoring.
Allows retrieving known subscription records.
Allows filtering only for subscriptions that notify a specific endpoint. Substituting for the 'owner' search parameter, which doesn't exist in R4.
Allows creation of tasks assigned to the patient, as well as potentially monitoring Tasks assigned to a service provider.
Allows a creation of Task on a Full Service Provider system.
Allows updating the status and/or specifying outputs for patient tasks.
Allows retrieval of existing tasks to check for changes or prior to making updates. This will typically be prompted by a subscription notification.
Allows retrieving known task records - and more specifically, retrieving more than one in a single call to poll for updates.
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.
Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned).
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.
Allows filtering to only retrieve tasks initiated by a specific provider.
Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest.
Allows for the 'output' of a Task to be included when retrieving a Task.