Physical Activity Implementation Guide
1.0.0 - STU Release 1
Physical Activity Implementation Guide
1.0.0 - STU Release 1
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 
| Page standards status: Trial-use | Maturity Level: 2 |
{
"resourceType" : "CapabilityStatement",
"id" : "pa-patient-engagement",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">Placeholder</div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/physical-activity/ImplementationGuide/physical-activity"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/physical-activity/ImplementationGuide/physical-activity"
}
]
}
}
],
"url" : "http://hl7.org/fhir/us/physical-activity/CapabilityStatement/pa-patient-engagement",
"version" : "1.0.0",
"name" : "PAPatientEngagement",
"title" : "PA Patient Engagement",
"status" : "active",
"date" : "2022-06-18",
"publisher" : "HL7 International - Patient Care WG",
"contact" : [
{
"name" : "HL7 International - Patient Care WG",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/patientcare"
}
]
}
],
"description" : "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.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"kind" : "requirements",
"imports" : [
"http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client"
],
"fhirVersion" : "4.0.1",
"format" : [
"json",
"xml"
],
"rest" : [
{
"mode" : "client",
"documentation" : "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.",
"resource" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "CarePlan",
"supportedProfile" : [
"http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-careplan"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Allows accessing and manipulating Care Plans.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update",
"documentation" : "Allows a patient system to make updates to a plan."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows retrieval of care plans for a given patient."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance",
"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."
}
],
"versioning" : "versioned-update",
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known care plan records - and more specifically, retrieving more than one in a single call to check for updates."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-category",
"type" : "token",
"documentation" : "Allows retrieving only those plans related to physical activity."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Allows filtering plans based on the time frame they apply(ied) to."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/CarePlan-status",
"type" : "token",
"documentation" : "Allows filtering to only active or draft plans."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"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."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "DiagnosticReport",
"supportedProfile" : [
"http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-diagnosticreport"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Allows viewiong of the reports summarizing the results of a referral.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows searching for recorded reports."
}
],
"versioning" : "versioned-update",
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known reports - and more specifically, retrieving more than one in a single call to poll for updates."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "basedOn",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-based-on",
"type" : "reference",
"documentation" : "Allows filtering to reports created in fulfillement of a particular order or referral."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Allows filtering to specific types of reports."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Allows filtering reports based on the period the cover."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Procedure-category",
"type" : "token",
"documentation" : "Allows retrieving only those reports related to physical activity."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"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."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-performer",
"type" : "reference",
"documentation" : "Allows filtering to only retrieve reports created by a specific performer."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-status",
"type" : "token",
"documentation" : "Allows filtering to only retrieve active or completed reports."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "DocumentReference",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Allows retrieving PDFs or similar content referenced by a Patient Task. These generally will not be patient-specific resources.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create",
"documentation" : "Allows a ServiceProvider to add additional images/documents for later retrieval."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update",
"documentation" : "Allows a ServiceProvider to replace an existing image/document with a newer version."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows monitoring of previously-retrieved DocumentReferences in the event the image/document is amended, corrected, or updated."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known document-reference records - and more specifically, retrieving more than one in a single call to poll for updates."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "contenttype",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-contenttype",
"type" : "token",
"documentation" : "Allows filtering for only PDFs, images, etc."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
"type" : "token",
"documentation" : "Allows filtering for only records tied to a particular category (e.g. physical-activity)."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-description",
"type" : "string",
"documentation" : "Allows filtering based on words found in the description - i.e. with a 'contains' search."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Goal",
"supportedProfile" : [
"http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-goal"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Allows accessing and potentially updating patient goals.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update",
"documentation" : "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."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows retrieval of goals for a given patient."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance",
"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."
}
],
"versioning" : "versioned-update",
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known goal records - and more specifically, retrieving more than one in a single call to poll for updates."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-category",
"type" : "token",
"documentation" : "Allows retrieving only those goals related to physical activity."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "lifecycle-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-lifecycle-status",
"type" : "token",
"documentation" : "Allows filtering to only active, completed or other goal statuses."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"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."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "target-date",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-target-date",
"type" : "date",
"documentation" : "Allows filtering goals based on when they're to be achieved."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Observation",
"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"
],
"_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"
}
]
}
],
"documentation" : "Allows recording and viewing patient physical activity observations.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "create",
"documentation" : "Allows recording new observations"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update",
"documentation" : "Allows correcting a previous observation or revising the status"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows viewing of previously recorded observations - e.g. to help calculate primary measures and/or to view trends."
}
],
"versioning" : "versioned-update",
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known observation records - and more specifically, retrieving more than one in a single call to poll for updates."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-category",
"type" : "token",
"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."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Allows filtering to only retrieve a specific type of physical activity vital sign or supporting observation."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Allows filtering to only retrieve a observations from a particular time period."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"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."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-status",
"type" : "token",
"documentation" : "Allows excluding entered-in-error or non-final observations."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "value-quantity",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-value-quantity",
"type" : "quantity",
"documentation" : "Allows retrieval of only those observations that fall in a particular range. Particularly useful for cross-patient queries."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Patient",
"documentation" : "Allows searching of the patients.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows searching of the patients."
}
],
"versioning" : "versioned-update",
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known reports - and more specifically, retrieving more than one in a single call to poll for updates."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "birthdate",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-birthdate",
"type" : "date",
"documentation" : "Allows filtering of individuals based on their date of birth."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "family",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-family",
"type" : "string",
"documentation" : "Allows filtering of individuals based on their family name."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "gender",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-gender",
"type" : "token",
"documentation" : "Allows filtering of individuals based on their gender."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "given",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-given",
"type" : "string",
"documentation" : "Allows filtering of individuals based on their given name."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-identifier",
"type" : "token",
"documentation" : "Enables filtering of patients based on their unique identifiers."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-name",
"type" : "string",
"documentation" : "Enables filtering of patients based on their full name."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Practitioner",
"documentation" : "Allows searching of the practitioners.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows searching of the practitioners."
}
],
"versioning" : "versioned-update",
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known reports - and more specifically, retrieving more than one in a single call to poll for updates."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Practitioner-identifier",
"type" : "token",
"documentation" : "Enables filtering of practitioners based on their unique identifiers."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Practitioner-name",
"type" : "string",
"documentation" : "Enables filtering of practitioners based on their full name."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "PractitionerRole",
"documentation" : "Allows searching of the practitioner roles.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows searching of the practitioner roles."
}
],
"versioning" : "versioned-update",
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known reports - and more specifically, retrieving more than one in a single call to poll for updates."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "specialty",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-specialty",
"type" : "token",
"documentation" : "Allows filtering of practitioner specialty."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "practitioner",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner",
"type" : "reference",
"documentation" : "Enables filtering of practitioner roles based on the associated practitioner."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "Questionnaire",
"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"
}
]
}
],
"documentation" : "Allows retrieval of Questionnaires referenced by a patient Task.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows retrieval of questionnaires to be completed."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known questionnaire records - and more specifically, retrieving more than one in a single call to poll for updates."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-url",
"type" : "uri",
"documentation" : "Allows retrieving a referenced Questionnaire."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-version",
"type" : "token",
"documentation" : "Allows retrieving a specific version of a referenced questionnaire."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "context-type-value",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-context-type-value",
"type" : "composite",
"documentation" : "Allows filtering for Questionnaires that are phyical activity-related."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-identifier",
"type" : "token",
"documentation" : "Allows retrieving Questionnaires with a known identifier."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-publisher",
"type" : "string",
"documentation" : "Allows retrieving Questionnaires based on who is responsible for having defined the form."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-status",
"type" : "token",
"documentation" : "Allows filtering to only retrieve active questionnaires."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "subject-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-subject-type",
"type" : "token",
"documentation" : "Allows retrieving Questionnaires that are intended to provide information about patients - as opposed to practitioners, organizations, etc."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-title",
"type" : "string",
"documentation" : "Allows searching for forms by name."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "QuestionnaireResponse",
"supportedProfile" : [
"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Allows recording and updating of questionnaire responses in response to patient tasks.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "update",
"documentation" : "Allows correction of or continued editing of a previously recorded questionnaire response."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "create",
"documentation" : "Allows other systems to record questionnaire responses."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows retrieval of completed or in-progresss questionnaire responses."
}
],
"versioning" : "versioned-update",
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known questionnaire response records - and more specifically, retrieving more than one in a single call to poll for updates."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "author",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-author",
"type" : "reference",
"documentation" : "Allows filtering responses previously created by a particular individual."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "authored",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-authored",
"type" : "date",
"documentation" : "Allows filtering responses based on when they were completed."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"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."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "questionnaire",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-questionnaire",
"type" : "reference",
"documentation" : "Allows retrieving a referenced Questionnaire."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-status",
"type" : "token",
"documentation" : "Allows filtering to only retrieve completed questionnaire responses."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "ServiceRequest",
"supportedProfile" : [
"http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-servicerequest"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Allows retrieval 'execise prescriptions' - referrals addressed to the patient themselves - as well as monitoring of referrals assigned to others.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows searching for orders or referrals for a particular patient or for updates to previously retrieved orders."
}
],
"referencePolicy" : [
"literal"
],
"searchInclude" : [
"ServiceRequest:patient",
"ServiceRequest:requester"
],
"_searchInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known service request records - and more specifically, retrieving more than one in a single call to poll for updates."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "authored",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-authored",
"type" : "date",
"documentation" : "Allows filtering orders based on when they were created."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-category",
"type" : "token",
"documentation" : "Allows retrieving only those referrals related to physical activity."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Allows retrieving only orders for particular types of interventions."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"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."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-performer",
"type" : "reference",
"documentation" : "Allows filtering to only retrieve orders targeted to a specific performer."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "requester",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-requester",
"type" : "reference",
"documentation" : "Allows filtering to only retrieve orders solicited by a specific provider."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-status",
"type" : "token",
"documentation" : "Allows filtering to only retrieve active or completed orders."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "Subscription",
"supportedProfile" : [
"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Allows establishing and maintaining subscriptions for Task notifications. Only needed if not handled manually.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "create",
"documentation" : "Allows establishing a new subscription."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "update",
"documentation" : "Allows revising an existing subscription - to cancel it or change the email address or SMS number."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows retrieval of existing subscriptions prior to update."
}
],
"versioning" : "versioned-update",
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "topic",
"definition" : "http://hl7.org/fhir/uv/subscriptions-backport/SearchParameter/Subscription-topic",
"type" : "uri",
"documentation" : "Allows filtering for just subscriptions for Task monitoring."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known subscription records."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/Subscription-url",
"type" : "uri",
"documentation" : "Allows filtering only for subscriptions that notify a specific endpoint. Substituting for the 'owner' search parameter, which doesn't exist in R4."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "Task",
"supportedProfile" : [
"http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-task-for-referral-management",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForPatient"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Allows creation of tasks assigned to the patient, as well as potentially monitoring Tasks assigned to a service provider.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "create",
"documentation" : "Allows a creation of Task on a Full Service Provider system."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "update",
"documentation" : "Allows updating the status and/or specifying outputs for patient tasks."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows retrieval of existing tasks to check for changes or prior to making updates. This will typically be prompted by a subscription notification."
}
],
"versioning" : "versioned-update",
"referencePolicy" : [
"literal"
],
"searchInclude" : [
"Task:focus",
"Task:output",
"Task:patient",
"ServiceRequest:requester"
],
"_searchInclude" : [
{
"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" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known task records - and more specifically, retrieving more than one in a single call to poll for updates."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"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."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "owner",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-owner",
"type" : "reference",
"documentation" : "Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned)."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"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."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "requester",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-requester",
"type" : "reference",
"documentation" : "Allows filtering to only retrieve tasks initiated by a specific provider."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-status",
"type" : "token",
"documentation" : "Allows filtering to only retrieve active or completed orders."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "focus",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-focus",
"type" : "reference",
"documentation" : "Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "output",
"definition" : "http://hl7.org/fhir/us/sdoh-clinicalcare/SearchParameter/Task-output-reference",
"type" : "reference",
"documentation" : "Allows for the 'output' of a Task to be included when retrieving a Task."
}
]
}
]
}
]
}
IG © 2022+ HL7 International - Patient Care WG. Package hl7.fhir.us.physical-activity#1.0.0 based on FHIR 4.0.1. Generated 2023-08-25
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change