This page is part of the US Core (v3.0.1: STU3 Ballot 3) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

• Narrative Content
• Detailed Descriptions
• XML
• JSON

StructureDefinition-us-core-careplan

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 US Core-CarePlan profile:

• Query for a care plan belonging to a Patient
• Record or update an existing care plan

Mandatory and Must Support Data Elements

The following data-elements are mandatory (i.e data MUST be present) or must be supported if the data is present in the sending system (Must Support definition). They 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:

1. a narrative summary of the patient assessment and plan of treatment
2. a status
3. an intent
4. a category code of “assess-plan”
5. a patient

Profile specific implementation guidance:

• Additional considerations for systems aligning with HL7 Consolidated (C-CDA) Care Plan requirements:
  • US Core Goal SHOULD be present in CarePlan.goal
  • US Core Condition SHOULD be present in CarePlan.addresses
  • Assement and Plan MAY be included as narrative text

Examples

• CarePlan-colonoscopy

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplanCopy

Published on Thu Aug 29 00:00:00 EDT 2019 as active by the HL7 US Realm Steering Committee.

This profile builds on CarePlan

---

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

• See the General Guidance section for additional rules and expectations when a server requires status parameters.
• See the General Guidance section for additional guidance on searching for multiple patients.

Mandatory Search Parameters:

The following search parameters, search parameter combinations SHALL be supported. Any listed search parameter modifiers, comparators, chains and composites SHALL also be supported UNLESS they are listed as “optional” in which case they SHOULD be supported.:

1. SHALL support searching using the combination of the patient and category search parameters:

   GET [base]/CarePlan?patient=[reference]&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan

   Example:

   1. GET [base]/CarePlan?patient=1137192&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan

   Implementation Notes: Fetches a bundle of all CarePlan resources for the specified patient and category=assess-plan (how to search by reference and how to search by token)

Optional Search Parameters:

The following search parameters, search parameter combinations and search parameter modifiers, comparators, chains and composites SHOULD be supported.

1. SHOULD support searching using the combination of the patient and category and date search parameters:
   • including support for these date comparators: gt,lt,ge,le
   • including optional support for composite AND search on date (e.g.date=[date]&date=[date]]&...)

   GET [base]/CarePlan?patient=[reference]&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

   Example:

   1. GET [base]/CarePlan?patient=1137192&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&date=ge2019
   2. GET [base]/CarePlan?patient=1137192&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&date=ge2018&date=le2018

   Implementation Notes: Fetches a bundle of all CarePlan resources for the specified patient and category=assess-plan and date (how to search by reference and how to search by token and how to search by date)

2. SHOULD support searching using the combination of the patient and category and status search parameters:
   • including support for composite OR search on status (e.g.status={[system]}|[code],{[system]}|[code],...)

   GET [base]/CarePlan?patient=[reference]&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&status={[system]}|[code]{,{[system]}|[code],...}

   Example:

   1. GET [base]/CarePlan?patient=1137192&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&status=active

   Implementation Notes: Fetches a bundle of all CarePlan resources for the specified patient and category=assess-plan and status=active (how to search by reference and how to search by token)

3. SHOULD support searching using the combination of the patient and category and status and date search parameters:
   • including support for composite OR search on status (e.g.status={[system]}|[code],{[system]}|[code],...)
   • including support for these date comparators: gt,lt,ge,le
   • including optional support for composite AND search on date (e.g.date=[date]&date=[date]]&...)

   GET [base]/CarePlan?patient=[reference]&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&status={[system]}|[code]{,{[system]}|[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

   Example:

   1. GET [base]/CarePlan?patient=1137192&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&status=active&date=ge2019
   2. GET [base]/CarePlan?patient=1137192&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&status=active&date=ge2018&date=le2019

   Implementation Notes: Fetches a bundle of all CarePlan resources for the specified patient and category=assess-plan and status=active and date (how to search by reference and how to search by token and how to search by date)