Package | hl7.fhir.us.physical-activity |
Type | ExampleScenario |
Id | Scen1ExercisePrescriptionScenario |
FHIR Version | R4 |
Source | http://hl7.org/fhir/us/physical-activity/https://build.fhir.org/ig/HL7/physical-activity/ExampleScenario-Scen1ExercisePrescriptionScenario.html |
URL | http://hl7.org/fhir/us/physical-activity/ExampleScenario/Scen1ExercisePrescriptionScenario |
Version | 1.0.1 |
Status | draft |
Date | 2024-03-12T17:26:10+00:00 |
Name | ExercisePrescription |
Realm | us |
Authority | hl7 |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: ExampleScenario
Resource ExampleScenario "Scen1ExercisePrescriptionScenario"
wg: pc
url: http://hl7.org/fhir/us/physical-activity/ExampleScenario/Scen1ExercisePrescriptionScenario
version: 1.0.1
name: ExercisePrescription
status: draft
date: 2024-03-12 17:26:10+0000
publisher: HL7 International / Patient Care
contact: HL7 International / Patient Care: http://www.hl7.org/Special/committees/patientcare
jurisdiction: United States of America (ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code#US)
actor
actorId: patientApp
type: entity
name: Patient App
description: A patient app used to query resources related to the exercise plan
actor
actorId: goodHealth
type: entity
name: EHR
description: EHR that records patient's exercise plan
instance
resourceId: Scen1query1
resourceType: Binary
name: Query for patient physical activity care plans
description: Query for CarePlans for a patient: `GET https://goodhealth.example.org/fhir/CarePlan?patient=Patient/Scen1PatientKhatun&status=active,on-hold&category=http%3A//hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes|PhysicalActivity`
instance
resourceId: Scen1query2
resourceType: Binary
name: Query for patient physical activity goals
description: Query for Goals for a patient: `GET https://goodhealth.example.org/fhir/Goal?patient=Patient/Scen1PatientKhatun&status=active,on-hold,completed&category=http%3A//hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes|PhysicalActivity`
instance
resourceId: Scen1query3
resourceType: Binary
name: Query for patient exercise prescriptions and referrals
description: Query for ServiceRequests for a patient: `GET https://goodhealth.example.org/fhir/ServiceRequest?patient=Patient/Scen1PatientKhatun&status=active,on-hold&category=http%3A//hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes|PhysicalActivity`
instance
resourceId: Scen1CarePlan
resourceType: CarePlan
name: Patient physical activity care plan
description: CarePlan describing proposed exercise regime
version
Extension Definition for ExampleScenario.instance.version.title for Version 5.0: Initial CarePlan
Extension Definition for ExampleScenario.instance.version.content for Version 5.0: CarePlan/Scen1CarePlanV1
versionId: 1
description: Planning for jogging and stationary bike
version
Extension Definition for ExampleScenario.instance.version.title for Version 5.0: Updated CarePlan
Extension Definition for ExampleScenario.instance.version.content for Version 5.0: CarePlan/Scen1CarePlanV2
versionId: 2
description: Planning for increased stationary bike
instance
resourceId: Scen1Goal
resourceType: Goal
name: Physical Activity weekly target
description: Goal indicating target number of minutes/week of moderate-vigorous physical activity
version
Extension Definition for ExampleScenario.instance.version.title for Version 5.0: Initial goal
Extension Definition for ExampleScenario.instance.version.content for Version 5.0: Goal/Scen1GoalV1
versionId: 1
description: Initial value of 100 mins/week
version
Extension Definition for ExampleScenario.instance.version.title for Version 5.0: Initial goal
Extension Definition for ExampleScenario.instance.version.content for Version 5.0: Goal/Scen1GoalV2
versionId: 1
description: Initial value of 100 mins/week-completed
instance
Extension Definition for ExampleScenario.instance.content for Version 5.0: Goal/Scen1Goal2
resourceId: Scen1Goal2
resourceType: Bundle
name: Updated goal
description: Updated value of 150 mins/week
instance
Extension Definition for ExampleScenario.instance.content for Version 5.0: Bundle/Scen1CarePlanBundle1
resourceId: Scen1CarePlanBundle1
resourceType: Bundle
name: Initial care plan search response bundle
description: Only contains 1 plan, though in practice, more than one is possible
ContainedInstances
ResourceId VersionId Scen1CarePlan 1
instance
Extension Definition for ExampleScenario.instance.content for Version 5.0: Bundle/Scen1CarePlanBundle2
resourceId: Scen1CarePlanBundle2
resourceType: Bundle
name: Second care plan search response bundle
description: In a real system, the id would be the same as the original
ContainedInstances
ResourceId VersionId Scen1CarePlan 2
instance
Extension Definition for ExampleScenario.instance.content for Version 5.0: Bundle/Scen1GoalBundle1
resourceId: Scen1GoalBundle1
resourceType: Bundle
name: Initial goal search response bundle
description: There could be multiple goals, but in the scenario there's only one.
ContainedInstances
ResourceId VersionId Scen1Goal 1
instance
Extension Definition for ExampleScenario.instance.content for Version 5.0: Bundle/Scen1GoalBundle2
resourceId: Scen1GoalBundle2
resourceType: Bundle
name: Second goal search response bundle
description: In a real system, the id would be the same as the original
ContainedInstances
ResourceId Scen1Goal2
instance
Extension Definition for ExampleScenario.instance.content for Version 5.0: ServiceRequest/Scen1ExerciseRx
resourceId: Scen1ExerciseRx
resourceType: ServiceRequest
name: Prescription for exercise
description: Expressed as a ServiceRequest with performer of the patient
instance
Extension Definition for ExampleScenario.instance.content for Version 5.0: Bundle/Scen1ExerciseRxBundle
resourceId: Scen1ExerciseRxBundle
resourceType: Bundle
name: Search result of exercise prescriptions and referrals
description: There could be a mix of an exercise prescription plus referrals, but in this case there's only the prescription.
ContainedInstances
ResourceId Scen1ExerciseRx
instance
Extension Definition for ExampleScenario.instance.content for Version 5.0: Observation/Scen1ObservationDaysPerWeek
resourceId: Scen1ObservationDaysPerWeek
resourceType: Observation
name: Example physical activity days per week record
description: Average days per week of moderate-to-vigorous physical activity.
instance
Extension Definition for ExampleScenario.instance.content for Version 5.0: Observation/Scen1ObservationMinsPerDay
resourceId: Scen1ObservationMinsPerDay
resourceType: Observation
name: Example physical activity minutes per day record
description: Average minutes per day of moderate-to-vigorous physical activity.
instance
Extension Definition for ExampleScenario.instance.content for Version 5.0: Observation/Scen1ObservationMinsPerWeek
resourceId: Scen1ObservationMinsPerWeek
resourceType: Observation
name: Example physical activity minutes per week record
description: Average minutes per week of moderate-to-vigorous physical activity.
instance
Extension Definition for ExampleScenario.instance.content for Version 5.0: Observation/Scen1ObservationStrengthDaysPerWeek
resourceId: Scen1ObservationStrengthDaysPerWeek
resourceType: Observation
name: Example strength days per week record
description: Average days per week of muscle-strengthening physical activity.
process
title: Day after appointment
description: The patient accesses the care plan, goals and exercise prescription made available on the EHR
preConditions: Encounter (and other supporting) resources created
postConditions: Patient app has retrieved exercise plan related resources
step
operation
number: 1
type: search-type
name: Query CarePlan
initiator: patientApp
receiver: goodHealth
description: Patient app queries exercise CarePlan describing proposed exercise regime.
Requests
ResourceId Scen1query1 Responses
ResourceId Scen1CarePlanBundle1 step
operation
number: 2
type: search-type
name: Query Goal
initiator: patientApp
receiver: goodHealth
description: Patient app queries Goals (100 minutes/week).
Requests
ResourceId Scen1query2 Responses
ResourceId Scen1GoalBundle1 step
operation
number: 3
type: search-type
name: Query ServiceRequest
initiator: patientApp
receiver: goodHealth
description: Patient app queries ServiceRequest (order for ‘exercise’).
Requests
ResourceId Scen1query3 Responses
ResourceId Scen1ExerciseRxBundle
process
title: A couple of weeks later
description: The exchange noted here would actually occur many times (though not necessarily regularly). Only a single set of data is shown for simplicity.
preConditions: Patient app is able to write records to EHR
postConditions: EHR has weekly activity level observations
step
operation
number: 5
type: create
name: Post days/week
initiator: patientApp
receiver: goodHealth
description: Patient app posts average days per week of moderate-to-vigorous physical activity. `POST https://goodhealth.example.org/fhir/Observation`
Requests
ResourceId Scen1ObservationDaysPerWeek step
operation
number: 6
type: create
name: Post minutes/day
initiator: patientApp
receiver: goodHealth
description: Patient app posts average minutes per day of moderate-to-vigorous physical activity. `POST https://goodhealth.example.org/fhir/Observation`
Requests
ResourceId Scen1ObservationMinsPerDay step
operation
number: 7
type: create
name: Post minutes/week
initiator: patientApp
receiver: goodHealth
description: Patient app posts average minutes per week of moderate-to-vigorous physical activity. `POST https://goodhealth.example.org/fhir/Observation`
Requests
ResourceId Scen1ObservationMinsPerWeek step
operation
number: 8
type: create
name: Post stength days/week
initiator: patientApp
receiver: goodHealth
description: Patient app posts average days per week of muscle-strengthening physical activity. `POST https://goodhealth.example.org/fhir/Observation`
Requests
ResourceId Scen1ObservationStrengthDaysPerWeek
process
title: A little more than 6 months after first appointment
description: In practice, the patient app would likely check for new CarePlans and Goals each time it launches. However, this is the first time there'd be something new to retrieve.
preConditions: CarePlan and Goal have been updated in EHR
postConditions: Patient app retrieves updated CarePlan and Goal
step
operation
number: 9
type: search-type
name: Query revised CarePlan
initiator: patientApp
receiver: goodHealth
description: Patient app queries revised CarePlan with providers notes.
Requests
ResourceId Scen1query1 Responses
ResourceId Scen1CarePlanBundle2 step
operation
number: 10
type: search-type
name: Query revised Goal
initiator: patientApp
receiver: goodHealth
description: Patient app queries new Goals.
Requests
ResourceId Scen1query2 Responses
ResourceId Scen1GoalBundle2 step
operation
number: 11
type: search-type
name: Query ServiceRequest
initiator: patientApp
receiver: goodHealth
description: The results of this search are the same as the initial call because the exercise 'prescription' has not changed.
Requests
ResourceId Scen1query3 Responses
ResourceId Scen1ExerciseRxBundle
{ "resourceType": "ExampleScenario", "id": "Scen1ExercisePrescriptionScenario", "text": { "status": "extensions", "div": "<!-- snip (see above) -->" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pc" } ], "url": "http://hl7.org/fhir/us/physical-activity/ExampleScenario/Scen1ExercisePrescriptionScenario", "version": "1.0.1", "name": "ExercisePrescription", "status": "draft", "date": "2024-03-12T17:26:10+00:00", "publisher": "HL7 International / Patient Care", "contact": [ { "name": "HL7 International / Patient Care", "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/patientcare" } ] } ], "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "US" } ] } ], "actor": [ { "actorId": "patientApp", "type": "entity", "name": "Patient App", "description": "A patient app used to query resources related to the exercise plan" }, { "actorId": "goodHealth", "type": "entity", "name": "EHR", "description": "EHR that records patient's exercise plan" } ], "instance": [ { "resourceId": "Scen1query1", "resourceType": "Binary", "name": "Query for patient physical activity care plans", "description": "Query for CarePlans for a patient: `GET https://goodhealth.example.org/fhir/CarePlan?patient=Patient/Scen1PatientKhatun&status=active,on-hold&category=http%3A//hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes|PhysicalActivity`" }, { "resourceId": "Scen1query2", "resourceType": "Binary", "name": "Query for patient physical activity goals", "description": "Query for Goals for a patient: `GET https://goodhealth.example.org/fhir/Goal?patient=Patient/Scen1PatientKhatun&status=active,on-hold,completed&category=http%3A//hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes|PhysicalActivity`" }, { "resourceId": "Scen1query3", "resourceType": "Binary", "name": "Query for patient exercise prescriptions and referrals", "description": "Query for ServiceRequests for a patient: `GET https://goodhealth.example.org/fhir/ServiceRequest?patient=Patient/Scen1PatientKhatun&status=active,on-hold&category=http%3A//hl7.org/fhir/us/physical-activity/CodeSystem/pa-temporary-codes|PhysicalActivity`" }, { "resourceId": "Scen1CarePlan", "resourceType": "CarePlan", "name": "Patient physical activity care plan", "description": "CarePlan describing proposed exercise regime", "version": [ { "extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title", "valueString": "Initial CarePlan" }, { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content", "valueReference": { "reference": "CarePlan/Scen1CarePlanV1" } } ], "versionId": "1", "description": "Planning for jogging and stationary bike" }, { "extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title", "valueString": "Updated CarePlan" }, { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content", "valueReference": { "reference": "CarePlan/Scen1CarePlanV2" } } ], "versionId": "2", "description": "Planning for increased stationary bike" } ] }, { "resourceId": "Scen1Goal", "resourceType": "Goal", "name": "Physical Activity weekly target", "description": "Goal indicating target number of minutes/week of moderate-vigorous physical activity", "version": [ { "extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title", "valueString": "Initial goal" }, { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content", "valueReference": { "reference": "Goal/Scen1GoalV1" } } ], "versionId": "1", "description": "Initial value of 100 mins/week" }, { "extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title", "valueString": "Initial goal" }, { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content", "valueReference": { "reference": "Goal/Scen1GoalV2" } } ], "versionId": "1", "description": "Initial value of 100 mins/week-completed" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content", "valueReference": { "reference": "Goal/Scen1Goal2" } } ], "resourceId": "Scen1Goal2", "resourceType": "Bundle", "name": "Updated goal", "description": "Updated value of 150 mins/week" }, { "extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content", "valueReference": { "reference": "Bundle/Scen1CarePlanBundle1" } } ], "resourceId": "Scen1CarePlanBundle1", "resourceType": "Bundle", "name": "Initial care plan search response bundle", "description": "Only contains 1 plan, though in practice, more than one is possible", "containedInstance": [ { "resourceId": "Scen1CarePlan", "versionId": "1" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content", "valueReference": { "reference": "Bundle/Scen1CarePlanBundle2" } } ], "resourceId": "Scen1CarePlanBundle2", "resourceType": "Bundle", "name": "Second care plan search response bundle", "description": "In a real system, the id would be the same as the original", "containedInstance": [ { "resourceId": "Scen1CarePlan", "versionId": "2" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content", "valueReference": { "reference": "Bundle/Scen1GoalBundle1" } } ], "resourceId": "Scen1GoalBundle1", "resourceType": "Bundle", "name": "Initial goal search response bundle", "description": "There could be multiple goals, but in the scenario there's only one.", "containedInstance": [ { "resourceId": "Scen1Goal", "versionId": "1" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content", "valueReference": { "reference": "Bundle/Scen1GoalBundle2" } } ], "resourceId": "Scen1GoalBundle2", "resourceType": "Bundle", "name": "Second goal search response bundle", "description": "In a real system, the id would be the same as the original", "containedInstance": [ { "resourceId": "Scen1Goal2" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content", "valueReference": { "reference": "ServiceRequest/Scen1ExerciseRx" } } ], "resourceId": "Scen1ExerciseRx", "resourceType": "ServiceRequest", "name": "Prescription for exercise", "description": "Expressed as a ServiceRequest with performer of the patient" }, { "extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content", "valueReference": { "reference": "Bundle/Scen1ExerciseRxBundle" } } ], "resourceId": "Scen1ExerciseRxBundle", "resourceType": "Bundle", "name": "Search result of exercise prescriptions and referrals", "description": "There could be a mix of an exercise prescription plus referrals, but in this case there's only the prescription.", "containedInstance": [ { "resourceId": "Scen1ExerciseRx" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content", "valueReference": { "reference": "Observation/Scen1ObservationDaysPerWeek" } } ], "resourceId": "Scen1ObservationDaysPerWeek", "resourceType": "Observation", "name": "Example physical activity days per week record", "description": "Average days per week of moderate-to-vigorous physical activity." }, { "extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content", "valueReference": { "reference": "Observation/Scen1ObservationMinsPerDay" } } ], "resourceId": "Scen1ObservationMinsPerDay", "resourceType": "Observation", "name": "Example physical activity minutes per day record", "description": "Average minutes per day of moderate-to-vigorous physical activity." }, { "extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content", "valueReference": { "reference": "Observation/Scen1ObservationMinsPerWeek" } } ], "resourceId": "Scen1ObservationMinsPerWeek", "resourceType": "Observation", "name": "Example physical activity minutes per week record", "description": "Average minutes per week of moderate-to-vigorous physical activity." }, { "extension": [ { "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content", "valueReference": { "reference": "Observation/Scen1ObservationStrengthDaysPerWeek" } } ], "resourceId": "Scen1ObservationStrengthDaysPerWeek", "resourceType": "Observation", "name": "Example strength days per week record", "description": "Average days per week of muscle-strengthening physical activity." } ], "process": [ { "title": "Day after appointment", "description": "The patient accesses the care plan, goals and exercise prescription made available on the EHR", "preConditions": "Encounter (and other supporting) resources created", "postConditions": "Patient app has retrieved exercise plan related resources", "step": [ { "operation": { "number": "1", "type": "search-type", "name": "Query CarePlan", "initiator": "patientApp", "receiver": "goodHealth", "description": "Patient app queries exercise CarePlan describing proposed exercise regime.", "request": { "resourceId": "Scen1query1" }, "response": { "resourceId": "Scen1CarePlanBundle1" } } }, { "operation": { "number": "2", "type": "search-type", "name": "Query Goal", "initiator": "patientApp", "receiver": "goodHealth", "description": "Patient app queries Goals (100 minutes/week).", "request": { "resourceId": "Scen1query2" }, "response": { "resourceId": "Scen1GoalBundle1" } } }, { "operation": { "number": "3", "type": "search-type", "name": "Query ServiceRequest", "initiator": "patientApp", "receiver": "goodHealth", "description": "Patient app queries ServiceRequest (order for ‘exercise’).", "request": { "resourceId": "Scen1query3" }, "response": { "resourceId": "Scen1ExerciseRxBundle" } } } ] }, { "title": "A couple of weeks later", "description": "The exchange noted here would actually occur many times (though not necessarily regularly). Only a single set of data is shown for simplicity.", "preConditions": "Patient app is able to write records to EHR", "postConditions": "EHR has weekly activity level observations", "step": [ { "operation": { "number": "5", "type": "create", "name": "Post days/week", "initiator": "patientApp", "receiver": "goodHealth", "description": "Patient app posts average days per week of moderate-to-vigorous physical activity. `POST https://goodhealth.example.org/fhir/Observation`", "request": { "resourceId": "Scen1ObservationDaysPerWeek" } } }, { "operation": { "number": "6", "type": "create", "name": "Post minutes/day", "initiator": "patientApp", "receiver": "goodHealth", "description": "Patient app posts average minutes per day of moderate-to-vigorous physical activity. `POST https://goodhealth.example.org/fhir/Observation`", "request": { "resourceId": "Scen1ObservationMinsPerDay" } } }, { "operation": { "number": "7", "type": "create", "name": "Post minutes/week", "initiator": "patientApp", "receiver": "goodHealth", "description": "Patient app posts average minutes per week of moderate-to-vigorous physical activity. `POST https://goodhealth.example.org/fhir/Observation`", "request": { "resourceId": "Scen1ObservationMinsPerWeek" } } }, { "operation": { "number": "8", "type": "create", "name": "Post stength days/week", "initiator": "patientApp", "receiver": "goodHealth", "description": "Patient app posts average days per week of muscle-strengthening physical activity. `POST https://goodhealth.example.org/fhir/Observation`", "request": { "resourceId": "Scen1ObservationStrengthDaysPerWeek" } } } ] }, { "title": "A little more than 6 months after first appointment", "description": "In practice, the patient app would likely check for new CarePlans and Goals each time it launches. However, this is the first time there'd be something new to retrieve.", "preConditions": "CarePlan and Goal have been updated in EHR", "postConditions": "Patient app retrieves updated CarePlan and Goal", "step": [ { "operation": { "number": "9", "type": "search-type", "name": "Query revised CarePlan", "initiator": "patientApp", "receiver": "goodHealth", "description": "Patient app queries revised CarePlan with providers notes.", "request": { "resourceId": "Scen1query1" }, "response": { "resourceId": "Scen1CarePlanBundle2" } } }, { "operation": { "number": "10", "type": "search-type", "name": "Query revised Goal", "initiator": "patientApp", "receiver": "goodHealth", "description": "Patient app queries new Goals.", "request": { "resourceId": "Scen1query2" }, "response": { "resourceId": "Scen1GoalBundle2" } } }, { "operation": { "number": "11", "type": "search-type", "name": "Query ServiceRequest", "initiator": "patientApp", "receiver": "goodHealth", "description": "The results of this search are the same as the initial call because the exercise 'prescription' has not changed.", "request": { "resourceId": "Scen1query3" }, "response": { "resourceId": "Scen1ExerciseRxBundle" } } } ] } ] }