US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 8.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan | Version: 8.0.0 | |||
Standards status: Trial-use | Computable Name: USCoreCarePlanProfile | |||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.15 | ||||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
The US Core CarePlan Profile inherits from the FHIR CarePlan resource; refer to it for scope and usage definitions. 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 specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.
Example Usage Scenarios:
The following are example usage scenarios for this profile:
The following data elements must always be present (Mandatory definition) 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 Views below provides the formal summary, definitions, and terminology requirements.
Each CarePlan Must Have:
Each CarePlan Must Support:
*see guidance below
Profile Specific Implementation Guidance:
CarePlan.goal
CarePlan.addresses
CarePlan.text
Usage:
Changes since version 7.0.0:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.
Servers providing access to care plan data SHALL support these US Core SMART Scopes:
<patient|user|system>/CarePlan.rs
The following search parameters and search parameter combinations SHALL be supported:
SHALL support searching using the combination of the patient
and category
search parameters:
GET [base]/CarePlan?patient={Type/}[id]&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan
Example:
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)
The following search parameter combinations SHOULD be supported:
patient
and category
and date
search parameters:
date
comparators: gt,lt,ge,le
date
(e.g.date=[date]&date=[date]]&...
)GET [base]/CarePlan?patient={Type/}[id]&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:
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)
patient
and category
and status
search parameters:
status
(e.g.status={system|}[code],{system|}[code],...
)GET [base]/CarePlan?patient={Type/}[id]&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan&status={system|}[code]{,{system|}[code],...}
Example:
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)
patient
and category
and status
and date
search parameters:
status
(e.g.status={system|}[code],{system|}[code],...
)date
comparators: gt,lt,ge,le
date
(e.g.date=[date]&date=[date]]&...
)GET [base]/CarePlan?patient={Type/}[id]&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:
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)