This page is part of the Argonaut Data Query Implementation Guide (v1.0.0: Release) based on FHIR R2. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
This profile sets minimum expectations for the CarePlan resource to record search and fetch assessment and plan of treatment data associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.
Example Usage Scenarios:
The following are example usage scenarios for the Argonaut CarePlan profile:
The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each CarePlan must have:
Profile specific implementation guidance:
The official URL for this profile is:
http://fhir.org/guides/argonaut/StructureDefinition/argo-careplan
This profile builds on CarePlan.
This profile was published on Tue Oct 18 00:00:00 AEDT 2016 as a draft by Argonaut Project.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
#### Complete Summary of the Mandatory Requirements
CarePlan.text
CarePlan.subject
CarePlan.status
Careplan.category
which must have:
Careplan.category.coding.system
= http://argonaut.hl7.orgName | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | Argonaut CarePlan Profile | ||
text | S | 1..1 | Narrative | |
status | S | 1..1 | code | Binding: Narrative Status (required) |
subject | S | 1..1 | Reference(Argonaut Patient Profile) | |
status | S | 1..1 | code | Binding: CarePlanStatus (required) |
category | SI | 1..* | CodeableConcept | arg-1: Must have a category of 'careplan' and a code system 'http://argonaut.hl7.org' |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | Argonaut CarePlan Profile | ||
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
text | SI | 1..1 | Narrative | Text summary of the resource, for human interpretation |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
status | S | 1..1 | code | generated | extensions | additional | empty Binding: Narrative Status (required) |
div | I | 1..1 | xhtml | Limited xhtml content txt-2: The narrative SHALL have some non-whitespace content txt-1: The narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-3: The narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External Ids for this plan |
subject | S | 1..1 | Reference(Argonaut Patient Profile) | Who care plan is for |
status | ?!S | 1..1 | code | proposed | draft | active | completed | cancelled Binding: CarePlanStatus (required) |
context | Σ | 0..1 | Reference(Encounter), Reference(EpisodeOfCare) | Created in context of |
period | Σ | 0..1 | Period | Time period plan covers |
author | Σ | 0..* | Reference(Patient), Reference(Practitioner), Reference(RelatedPerson), Reference(Organization) | Who is responsible for contents of the plan |
modified | Σ | 0..1 | dateTime | When last updated |
category | SI | 1..* | CodeableConcept | Type of plan Binding: Care Plan Category (example) arg-1: Must have a category of 'careplan' and a code system 'http://argonaut.hl7.org' |
description | Σ | 0..1 | string | Summary of nature of plan |
addresses | Σ | 0..* | Reference(Condition) | Health issues this plan addresses |
support | 0..* | Reference(Resource) | Information considered as part of plan | |
relatedPlan | 0..* | BackboneElement | Plans related to this one | |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
code | 0..1 | code | includes | replaces | fulfills Binding: CarePlanRelationship (required) | |
plan | 1..1 | Reference(CarePlan) | Plan relationship exists with | |
participant | 0..* | BackboneElement | Who's involved in plan? | |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
role | 0..1 | CodeableConcept | Type of involvement Binding: Participant Roles (example) | |
member | 0..1 | Reference(Practitioner), Reference(RelatedPerson), Reference(Patient), Reference(Organization) | Who is involved | |
goal | 0..* | Reference(Goal) | Desired outcome of plan | |
activity | I | 0..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
actionResulting | 0..* | Reference(Resource) | Appointments, orders, etc. | |
progress | 0..* | Annotation | Comments about the activity status/progress | |
reference | I | 0..1 | Reference(Appointment), Reference(CommunicationRequest), Reference(DeviceUseRequest), Reference(DiagnosticOrder), Reference(MedicationOrder), Reference(NutritionOrder), Reference(Order), Reference(ProcedureRequest), Reference(ProcessRequest), Reference(ReferralRequest), Reference(SupplyRequest), Reference(VisionPrescription) | Activity details defined in specific resource |
detail | I | 0..1 | BackboneElement | In-line definition of activity |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
category | 0..1 | CodeableConcept | diet | drug | encounter | observation | procedure | supply | other Binding: CarePlanActivityCategory (example) | |
code | 0..1 | CodeableConcept | Detail type of activity Binding: Care Plan Activity (example) | |
reasonCode | 0..* | CodeableConcept | Why activity should be done Binding: Activity Reason (example) | |
reasonReference | 0..* | Reference(Condition) | Condition triggering need for activity | |
goal | 0..* | Reference(Goal) | Goals this activity relates to | |
status | ?! | 0..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled Binding: CarePlanActivityStatus (required) |
statusReason | 0..1 | CodeableConcept | Reason for current status Binding: GoalStatusReason (example) | |
prohibited | ?! | 1..1 | boolean | Do NOT do |
scheduled[x] | 0..1 | Timing, Period, string | When activity is to occur | |
location | 0..1 | Reference(Location) | Where it should happen | |
performer | 0..* | Reference(Practitioner), Reference(Organization), Reference(RelatedPerson), Reference(Patient) | Who will be responsible? | |
product[x] | 0..1 | CodeableConcept, Reference(Medication), Reference(Substance) | What is to be administered/supplied Binding: SNOMED CT Medication Codes (example) | |
dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |
quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |
description | 0..1 | string | Extra info describing activity to perform | |
note | 0..1 | Annotation | Comments about the plan | |
Documentation for this format |
#### Complete Summary of the Mandatory Requirements
CarePlan.text
CarePlan.subject
CarePlan.status
Careplan.category
which must have:
Careplan.category.coding.system
= http://argonaut.hl7.orgDifferential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | Argonaut CarePlan Profile | ||
text | S | 1..1 | Narrative | |
status | S | 1..1 | code | Binding: Narrative Status (required) |
subject | S | 1..1 | Reference(Argonaut Patient Profile) | |
status | S | 1..1 | code | Binding: CarePlanStatus (required) |
category | SI | 1..* | CodeableConcept | arg-1: Must have a category of 'careplan' and a code system 'http://argonaut.hl7.org' |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | Argonaut CarePlan Profile | ||
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
text | SI | 1..1 | Narrative | Text summary of the resource, for human interpretation |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
status | S | 1..1 | code | generated | extensions | additional | empty Binding: Narrative Status (required) |
div | I | 1..1 | xhtml | Limited xhtml content txt-2: The narrative SHALL have some non-whitespace content txt-1: The narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-3: The narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External Ids for this plan |
subject | S | 1..1 | Reference(Argonaut Patient Profile) | Who care plan is for |
status | ?!S | 1..1 | code | proposed | draft | active | completed | cancelled Binding: CarePlanStatus (required) |
context | Σ | 0..1 | Reference(Encounter), Reference(EpisodeOfCare) | Created in context of |
period | Σ | 0..1 | Period | Time period plan covers |
author | Σ | 0..* | Reference(Patient), Reference(Practitioner), Reference(RelatedPerson), Reference(Organization) | Who is responsible for contents of the plan |
modified | Σ | 0..1 | dateTime | When last updated |
category | SI | 1..* | CodeableConcept | Type of plan Binding: Care Plan Category (example) arg-1: Must have a category of 'careplan' and a code system 'http://argonaut.hl7.org' |
description | Σ | 0..1 | string | Summary of nature of plan |
addresses | Σ | 0..* | Reference(Condition) | Health issues this plan addresses |
support | 0..* | Reference(Resource) | Information considered as part of plan | |
relatedPlan | 0..* | BackboneElement | Plans related to this one | |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
code | 0..1 | code | includes | replaces | fulfills Binding: CarePlanRelationship (required) | |
plan | 1..1 | Reference(CarePlan) | Plan relationship exists with | |
participant | 0..* | BackboneElement | Who's involved in plan? | |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
role | 0..1 | CodeableConcept | Type of involvement Binding: Participant Roles (example) | |
member | 0..1 | Reference(Practitioner), Reference(RelatedPerson), Reference(Patient), Reference(Organization) | Who is involved | |
goal | 0..* | Reference(Goal) | Desired outcome of plan | |
activity | I | 0..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
actionResulting | 0..* | Reference(Resource) | Appointments, orders, etc. | |
progress | 0..* | Annotation | Comments about the activity status/progress | |
reference | I | 0..1 | Reference(Appointment), Reference(CommunicationRequest), Reference(DeviceUseRequest), Reference(DiagnosticOrder), Reference(MedicationOrder), Reference(NutritionOrder), Reference(Order), Reference(ProcedureRequest), Reference(ProcessRequest), Reference(ReferralRequest), Reference(SupplyRequest), Reference(VisionPrescription) | Activity details defined in specific resource |
detail | I | 0..1 | BackboneElement | In-line definition of activity |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
category | 0..1 | CodeableConcept | diet | drug | encounter | observation | procedure | supply | other Binding: CarePlanActivityCategory (example) | |
code | 0..1 | CodeableConcept | Detail type of activity Binding: Care Plan Activity (example) | |
reasonCode | 0..* | CodeableConcept | Why activity should be done Binding: Activity Reason (example) | |
reasonReference | 0..* | Reference(Condition) | Condition triggering need for activity | |
goal | 0..* | Reference(Goal) | Goals this activity relates to | |
status | ?! | 0..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled Binding: CarePlanActivityStatus (required) |
statusReason | 0..1 | CodeableConcept | Reason for current status Binding: GoalStatusReason (example) | |
prohibited | ?! | 1..1 | boolean | Do NOT do |
scheduled[x] | 0..1 | Timing, Period, string | When activity is to occur | |
location | 0..1 | Reference(Location) | Where it should happen | |
performer | 0..* | Reference(Practitioner), Reference(Organization), Reference(RelatedPerson), Reference(Patient) | Who will be responsible? | |
product[x] | 0..1 | CodeableConcept, Reference(Medication), Reference(Substance) | What is to be administered/supplied Binding: SNOMED CT Medication Codes (example) | |
dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |
quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |
description | 0..1 | string | Extra info describing activity to perform | |
note | 0..1 | Annotation | Comments about the plan | |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron
Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the Argonaut Data Query implementation guide server for a complete list of supported RESTful operations and search parameters for this IG.
GET /CarePlan?patient=[id]&category=assess-plan
Example:
GET https://fhir-open-api-dstu2.smarthealthit.org/CarePlan?patient=1137192&category=assess-plan
Support: Mandatory to support search by patient.
Implementation Notes: Search for all patient assessments and plans of treatment for a patient. Fetches a bundle of all CarePlan resources for the specified patient (how to search by reference) and (how to search by token).
Response Class:
GET /CarePlan?patient=[id]&category=assess-plan&date=[date]
Example:
Support: SHOULD to support search by date
Implementation Notes: Search for all assessment and plan of treatment for a patient within a time period. Fetches a bundle of all CarePlan resources for the specified patient for a specified time period. (how to search by reference), (how to search by token) and (how to search by date).
Response Class:
GET /CarePlan?patient=[id]&category=assess-plan&status=active
Example:
GET https://fhir-open-api-dstu2.smarthealthit.org/CarePlan?patient=1137192&status=active
Support: SHOULD support search by patient and status = ‘active’.
Implementation Notes: SHOULD support search by reference and status. (how to search by reference), (how to search by token).
Response Class:
GET /CarePlan?patient=[id]&category=assess-plan&status=active&date=[date]
Example:
Support: SHOULD support search by patient and status = ‘active’ and date.
Implementation Notes: Search for all active assessment and plan of treatment for a patient within a time period. Fetches a bundle of all active (careplan = “active”) CarePlan resources for the specified patient for a specified time period. (how to search by reference), (how to search by token) and (how to search by date).
Response Class: