{
"description": "Describes the expected capabilities of a system used by a personal trainer, community fitness organization, or other entity that delivers services that help a patient to improve or maintain their level of physical activity. This set of capabilities is appropriate for service providers that CAN expose their own FHIR server and that store Tasks, reports and other resources locally and expose them for query by [Care Managers](CapabilityStatement-pa-care-manager.html) and [Patient Engagement systems](CapabilityStatement-pa-patient-engagement.html).",
"_filename": "CapabilityStatement-pa-service-provider-full.json",
"package_name": "hl7.fhir.us.physical-activity",
"format": [ "json", "xml" ],
"date": "2022-06-18",
"publisher": "HL7 International - Patient Care WG",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "PAServiceProviderFull",
"type": null,
"experimental": null,
"resourceType": "CapabilityStatement",
"title": "Physical Activity Full Service Provider Capability Statement",
"package_version": "1.0.0-ballot",
"status": "active",
"id": "8cf9ae09-c39d-4e32-b8e7-3bfae5e2662f",
"kind": "requirements",
"url": "http://hl7.org/fhir/us/physical-activity/CapabilityStatement/pa-service-provider-full",
"version": "1.0.0-ballot",
"contact": [ {
"name": "HL7 International - Patient Care WG",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/patientcare",
"system": "url"
} ]
} ],
"rest": [ {
"mode": "client",
"resource": [ {
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Allows retrieving known care plan records - and more specifically, retrieving more than one in a single call to check for updates."
}, {
"name": "_lastUpdated",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"documentation": "Allows filtering for only records that have changed since last query."
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-category",
"documentation": "Allows retrieving only those plans related to physical activity."
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "Allows filtering plans based on the time frame they apply(ied) to."
}, {
"name": "lifecycle-status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-status",
"documentation": "Allows filtering to only active or draft plans."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "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."
} ],
"referencePolicy": [ "literal" ],
"type": "CarePlan",
"interaction": [ {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Allows a service provider to make updates to a plan owned by a care manager."
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows retrieval of care plans for a given patient."
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"documentation": "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."
} ],
"documentation": "Allows accessing and manipulating Care Plans stored on a Care Manager.",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-careplan" ],
"versioning": "versioned-update",
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
}, {
"type": "Condition",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows retrieval of conditions for a given patient."
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"documentation": "Allows seeing how a condition has changed over time."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Allows retrieving known condition records - and more specifically, retrieving more than one in a single call to check for updates."
}, {
"name": "_lastUpdated",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"documentation": "Allows filtering for only records that have changed since last query."
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Condition-category",
"documentation": "Allows retrieving only those plans related to physical activity."
}, {
"name": "clinical-status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Condition-clinical-status",
"documentation": "Allows filtering to only active conditions."
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "Allows retrieving specific patient conditions - e.g. all 'low physical activity' conditions."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "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."
}, {
"name": "verification-status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Condition-verification-status",
"documentation": "Allows excluding refuted or erroneous conditions."
} ],
"documentation": "Accessing the formal 'low physical activity' condition may be necessary to support prior authorization or claims.",
"referencePolicy": [ "literal" ],
"supportedProfile": [ "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-condition-low-pa" ],
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ]
}, {
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Allows retrieving known goal records - and more specifically, retrieving more than one in a single call to poll for updates."
}, {
"name": "_lastUpdated",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"documentation": "Allows filtering for only records that have changed since last query."
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Goal-category",
"documentation": "Allows retrieving only those goals related to physical activity."
}, {
"name": "lifecycle-status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Goal-lifecycle-status",
"documentation": "Allows filtering to only active, completed or other goal statuses."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "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."
}, {
"name": "target-date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Goal-target-date",
"documentation": "Allows filtering goals based on when they're to be achieved."
} ],
"referencePolicy": [ "literal" ],
"type": "Goal",
"interaction": [ {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Allows patients or service providers to modify a goal - for example shifting target values or dates, updating the status, etc. Allowing patients, care-givers, and service providers to help maintain goals is a key aspect of a patient-centered care plan. However, not all care manager systems (or their organizations) yet have the technical mechanisms or policies in place to support this."
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows retrieval of goals for a given patient."
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"documentation": "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."
} ],
"documentation": "Allows accessing and potentially updating goals maintained by a Care Manager.",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-goal" ],
"versioning": "versioned-update",
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
}, {
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Allows retrieving known observation records - and more specifically, retrieving more than one in a single call to poll for updates."
}, {
"name": "_lastUpdated",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"documentation": "Allows filtering for only records that have changed since last query."
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Observation-category",
"documentation": "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."
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "Allows filtering to only retrieve a specific type of physical activity vital sign or supporting observation."
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "Allows filtering to only retrieve a observations from a particular time period."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "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."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Observation-status",
"documentation": "Allows excluding entered-in-error or non-final observations."
}, {
"name": "value-quantity",
"type": "quantity",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Observation-value-quantity",
"documentation": "Allows retrieval of only those observations that fall in a particular range. Particularly useful for cross-patient queries."
} ],
"referencePolicy": [ "literal" ],
"type": "Observation",
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows retrieval of observations for a given patient."
} ],
"documentation": "Allows accessing observations maintained by a Care Manager.",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-observation-evs-days-per-week", "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-observation-evs-min-per-day", "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-observation-evs-min-per-week", "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-observation-strength-days-per-week", "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-observation-activity-measure", "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-observation-activity-group", "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-observation-time-measure" ],
"versioning": "versioned-update",
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ]
}, {
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Allows retrieving known service request records - and more specifically, retrieving more than one in a single call to poll for updates."
}, {
"name": "_lastUpdated",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"documentation": "Allows filtering for only records that have changed since last query."
}, {
"name": "authored",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-authored",
"documentation": "Allows filtering orders based on when they were created."
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-category",
"documentation": "Allows retrieving only those referrals related to physical activity."
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "Allows retrieving only orders for particular types of interventions."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "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."
}, {
"name": "performer",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-performer",
"documentation": "Allows filtering to only retrieve orders targeted to a specific performer."
}, {
"name": "requester",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-requester",
"documentation": "Allows filtering to only retrieve orders solicited by a specific provider."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-status",
"documentation": "Allows filtering to only retrieve active or completed orders."
} ],
"referencePolicy": [ "literal" ],
"type": "ServiceRequest",
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows searching for orders or referrals for a particular patient or for updates to previously retrieved orders."
} ],
"documentation": "Allows retrieval of physical activity-related referrals from Care managers.",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-servicerequest" ],
"_searchInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"searchInclude": [ "ServiceRequest:patient", "ServiceRequest:requester" ],
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
}, {
"searchParam": [ {
"name": "topic",
"type": "uri",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/uv/subscriptions-backport/SearchParameter/Subscription-topic",
"documentation": "Allows filtering for just subscriptions for Task monitoring."
}, {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Allows retrieving known subscription records."
} ],
"referencePolicy": [ "literal" ],
"type": "Subscription",
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows retrieval of existing subscriptions prior to update."
} ],
"documentation": "Allows subscribing to Patient Tasks hosted on a CareManager.",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"supportedProfile": [ "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription" ],
"versioning": "versioned-update",
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
} ],
"documentation": "A 'full' Service Provider needs less client capabilities than a [light](CapabilityStatement-pa-service-provider-light.html) one, as it does not rely on the [care manager](CapabilityStatement-pa-care-manager.html) to store the Task or report. However, it might still need to access and sometimes manipulate observations, goals, plans and other resources stored on external systems."
}, {
"mode": "server",
"resource": [ {
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Allows retrieving known care plan records - and more specifically, retrieving more than one in a single call to check for updates."
}, {
"name": "_lastUpdated",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"documentation": "Allows filtering for only records that have changed since last query."
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-category",
"documentation": "Allows retrieving only those plans related to physical activity."
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "Allows filtering plans based on the time frame they apply(ied) to."
}, {
"name": "lifecycle-status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/CarePlan-status",
"documentation": "Allows filtering to only active or draft plans."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "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."
} ],
"referencePolicy": [ "literal" ],
"type": "CarePlan",
"interaction": [ {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Allows patients or service providers to modify a care plan. Allowing patients, care-givers, and service providers to help maintain care plans is a key aspect of a patient-centered care plan. However, not all care manager systems (or their organizations) yet have the technical mechanisms or policies in place to support this."
}, {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"documentation": "Allows patients or service providers to add additional physical activity related care plans. As with updates, this is a key part of a patient-centered care plan, but not all systems or organizations will be able to do this."
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows retrieval of care plans for a given patient."
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"documentation": "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."
} ],
"documentation": "Shares and, ideally, allows external systems to add and update care plans.",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-careplan" ],
"versioning": "versioned-update",
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
}, {
"type": "DocumentReference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows monitoring of previously-retrieved DocumentReferences in the event the image/document is amended, corrected, or updated."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Allows retrieving known document reference records - and more specifically, retrieving more than one in a single call to poll for updates."
}, {
"name": "_lastUpdated",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"documentation": "Allows filtering for only records that have changed since last query."
} ],
"documentation": "Allows exposing PDFs or similar content to be referenced by a Patient Task and retrieved by Patient Engagement systems.",
"referencePolicy": [ "literal" ],
"supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ],
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
}, {
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Allows retrieving known goal records - and more specifically, retrieving more than one in a single call to poll for updates."
}, {
"name": "_lastUpdated",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"documentation": "Allows filtering for only records that have changed since last query."
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Goal-category",
"documentation": "Allows retrieving only those goals related to physical activity."
}, {
"name": "lifecycle-status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Goal-lifecycle-status",
"documentation": "Allows filtering to only active, completed or other goal statuses."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "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."
}, {
"name": "target-date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Goal-target-date",
"documentation": "Allows filtering goals based on when they're to be achieved."
} ],
"referencePolicy": [ "literal" ],
"type": "Goal",
"interaction": [ {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Allows patients or service providers to modify a goal - for example shifting target values or dates, updating the status, etc. Allowing patients, care-givers, and service providers to help maintain goals is a key aspect of a patient-centered care plan. However, not all care manager systems (or their organizations) yet have the technical mechanisms or policies in place to support this."
}, {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Allows patients or service providers to add additional physical activity related goals. As with updates, this is a key part of a patient-centered care plan, but not all systems or organizations will be able to do this."
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows retrieval of goals for a given patient."
}, {
"code": "history-instance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"documentation": "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."
} ],
"documentation": "Shares and, ideally, allows external systems to add and update goals.",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-goal" ],
"versioning": "versioned-update",
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
}, {
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Allows retrieving known observation records - and more specifically, retrieving more than one in a single call to poll for updates."
}, {
"name": "_lastUpdated",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"documentation": "Allows filtering for only records that have changed since last query."
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Observation-category",
"documentation": "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."
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "Allows filtering to only retrieve a specific type of physical activity vital sign or supporting observation."
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "Allows filtering to only retrieve a observations from a particular time period."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "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."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Observation-status",
"documentation": "Allows excluding entered-in-error or non-final observations."
}, {
"name": "value-quantity",
"type": "quantity",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Observation-value-quantity",
"documentation": "Allows retrieval of only those observations that fall in a particular range. Particularly useful for cross-patient queries."
} ],
"referencePolicy": [ "literal" ],
"type": "Observation",
"interaction": [ {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Allows correction of or adding comments to previously recorded observations."
}, {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows other systems to record physical-activity related observations."
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows retrieval of observations for a given patient."
} ],
"documentation": "Exposes and allows manipulation of physical activity vital sign and supporting observations.",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-observation-evs-days-per-week", "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-observation-evs-min-per-day", "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-observation-evs-min-per-week", "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-observation-strength-days-per-week", "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-observation-activity-measure", "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-observation-activity-group", "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-observation-time-measure" ],
"versioning": "versioned-update",
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ]
}, {
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Allows retrieving known reports - and more specifically, retrieving more than one in a single call to poll for updates."
}, {
"name": "_lastUpdated",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"documentation": "Allows filtering for only records that have changed since last query."
}, {
"name": "basedOn",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Procedure-based-on",
"documentation": "Allows filtering to reports created in fulfillement of a particular order or referral."
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "Allows filtering to specific types of reports."
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "Allows filtering reports based on the period the cover."
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Procedure-category",
"documentation": "Allows retrieving only those reports related to physical activity."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "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."
}, {
"name": "performer",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-performer",
"documentation": "Allows filtering to only retrieve reports created by a specific performer."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-status",
"documentation": "Allows filtering to only retrieve active or completed reports."
} ],
"referencePolicy": [ "literal" ],
"type": "DiagnosticReport",
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows searching for reports for a particular patient or checking for updates to previously retrieved records."
} ],
"documentation": "Allows retrieval of the reports on physical activity-related interventions.",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-diagnosticreport" ],
"versioning": "versioned-update",
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
}, {
"type": "Questionnaire",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows retrieval of questionnaires to be completed."
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Allows retrieving known questionnaire records - and more specifically, retrieving more than one in a single call to poll for updates."
}, {
"name": "_lastUpdated",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"documentation": "Allows filtering for only records that have changed since last query."
}, {
"name": "url",
"type": "uri",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-url",
"documentation": "Allows retrieving a referenced Questionnaire."
}, {
"name": "version",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-version",
"documentation": "Allows retrieving a specific version of a referenced questionnaire."
} ],
"documentation": "Allows retrieval of Questionnaires to be filled in.",
"referencePolicy": [ "literal" ],
"supportedProfile": [ "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-pop-obsn", "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extr-obsn" ],
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ]
}, {
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Allows retrieving known questionnaire response records - and more specifically, retrieving more than one in a single call to poll for updates."
}, {
"name": "_lastUpdated",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"documentation": "Allows filtering for only records that have changed since last query."
}, {
"name": "author",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-author",
"documentation": "Allows filtering responses previously created by a particular individual."
}, {
"name": "authored",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-authored",
"documentation": "Allows filtering responses based on when they were completed."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "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."
}, {
"name": "questionnaire",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-questionnaire",
"documentation": "Allows retrieving a referenced Questionnaire."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-status",
"documentation": "Allows filtering to only retrieve completed questionnaire responses."
} ],
"referencePolicy": [ "literal" ],
"type": "QuestionnaireResponse",
"interaction": [ {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Allows correction of or continued editing of a previously recorded questionnaire response."
}, {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows other systems to record questionnaire responses."
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows retrieval of completed or in-progresss questionnaire responses."
} ],
"documentation": "Allows recording and retrieval of questionnaire responses.",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"supportedProfile": [ "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse" ],
"versioning": "versioned-update",
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
}, {
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Allows retrieving known service request records - and more specifically, retrieving more than one in a single call to poll for updates."
}, {
"name": "_lastUpdated",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"documentation": "Allows filtering for only records that have changed since last query."
}, {
"name": "authored",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-authored",
"documentation": "Allows filtering orders based on when they were created."
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-category",
"documentation": "Allows retrieving only those referrals related to physical activity."
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "Allows retrieving only orders for particular types of interventions."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "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."
}, {
"name": "performer",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-performer",
"documentation": "Allows filtering to only retrieve orders targeted to a specific performer."
}, {
"name": "requester",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-requester",
"documentation": "Allows filtering to only retrieve orders solicited by a specific provider."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-status",
"documentation": "Allows filtering to only retrieve active or completed orders."
} ],
"referencePolicy": [ "literal" ],
"type": "ServiceRequest",
"interaction": [ {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows searching for orders or referrals for a particular patient or for updates to previously retrieved orders."
} ],
"documentation": "Allows 'prescribing' physical activity for a patient - for retrieval by a Patient Engagement system.",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-servicerequest" ],
"_searchInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
}, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"searchInclude": [ "ServiceRequest:patient", "ServiceRequest:requester" ],
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
}, {
"searchParam": [ {
"name": "topic",
"type": "uri",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/uv/subscriptions-backport/SearchParameter/Subscription-topic",
"documentation": "Allows filtering for just subscriptions for Task monitoring."
}, {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Allows retrieving known subscription records."
} ],
"referencePolicy": [ "literal" ],
"type": "Subscription",
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows establishing a new subscription."
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows revising an existing subscription - to cancel it or change the email address or SMS number."
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows retrieval of existing subscriptions prior to update."
} ],
"documentation": "Allows establishing and maintaining subscriptions for Task notifications. Needed for both referral and patient tasks.",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"supportedProfile": [ "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription" ],
"versioning": "versioned-update",
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
}, {
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Allows retrieving known task records - and more specifically, retrieving more than one in a single call to poll for updates."
}, {
"name": "_lastUpdated",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"documentation": "Allows filtering for only records that have changed since last query."
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "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."
}, {
"name": "owner",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Task-owner",
"documentation": "Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned)."
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "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."
}, {
"name": "requester",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Task-requester",
"documentation": "Allows filtering to only retrieve tasks initiated by a specific provider."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/ServiceRequest-status",
"documentation": "Allows filtering to only retrieve active or completed orders."
}, {
"name": "focus",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Task-focus",
"documentation": "Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest."
}, {
"name": "output",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/us/sdoh-clinicalcare/SearchParameter/Task-output-reference",
"documentation": "Allows for the 'output' of a Task to be included when retrieving a Task."
} ],
"referencePolicy": [ "literal" ],
"type": "Task",
"interaction": [ {
"code": "create",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows a service provider to create a patient-assigned Task."
}, {
"code": "update",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"documentation": "Allows existing tasks to be updated - to change their status and/or to attach 'outputs' resulting from the Task."
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Allows polling multiple tasks simultaneously, as well as retrieving referenced resources as part of a single query."
} ],
"documentation": "Allows receipt of requests to fulfill referrals from a Service Provider, possible cancellations or notes on those requests, as well as surfacing the status of the referral back to the Care Manager and possibly Patient Engagement systems.",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"supportedProfile": [ "http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-task-for-referral-management", "http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForPatient" ],
"_searchInclude": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ]
} ],
"searchInclude": [ "Task:output" ],
"versioning": "versioned-update",
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
}, {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
} ],
"security": {
"service": [ {
"coding": [ {
"code": "OAuth",
"system": "http://terminology.hl7.org/CodeSystem/restful-security-service"
} ]
} ],
"description": "See additional guidance on the [security](security.html) page."
},
"documentation": "Unlike a [light Service Provider](CapabilityStatement-pa-service-provider-light.html), 'full' Service Providers expose a RESTful endpoint to allow submission of tasks as well as creation and/or manipulation of other resources by [Care Managers](CapabilityStatement-pa-care-manager.html) and [Patient Engagement systems](CapabilityStatement-pa-patient-engagement.html)."
} ]
}