Opioid Prescribing Support Implementation Guide, published by Centers for Disease Control and Prevention (CDC). This is not an authorized publication; it is the continuous build for version 1.2.3). This version is based on the current content of https://github.com/cqframework/opioid-cds/ and changes regularly. See the Directory of published versions
The official URL for this profile is:
http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-careplan
Profile of CarePlan for use with CDC Opioid Prescribing Guidelines
This profile builds on CarePlan.
This profile was published on 2017-04-21 as a draft by Centers for Disease Control and Prevention.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from CarePlan
This structure is derived from CarePlan
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | CarePlan | Healthcare plan for patient or group | |
![]() ![]() ![]() | S | 0..* | BackboneElement | Action to occur as part of plan |
![]() ![]() ![]() ![]() | S | 1..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | CarePlan | Healthcare plan for patient or group | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 0..* | Identifier | External Ids for this plan | ||||
![]() ![]() ![]() | Σ | 0..* | Reference(PlanDefinition | Questionnaire) | Protocol or definition | ||||
![]() ![]() ![]() | Σ | 0..* | Reference(CarePlan) | Fulfills care plan | ||||
![]() ![]() ![]() | Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | ||||
![]() ![]() ![]() | Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | ||||
![]() ![]() ![]() | ?!Σ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled | unknown Binding: CarePlanStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | ||||
![]() ![]() ![]() | ?!Σ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan | ||||
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Type of plan Binding: Care Plan Category (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | ||||
![]() ![]() ![]() | Σ | 0..1 | string | Human-friendly name for the CarePlan | ||||
![]() ![]() ![]() | Σ | 0..1 | string | Summary of nature of plan | ||||
![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | Group) | Who care plan is for | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Created in context of | ||||
![]() ![]() ![]() | Σ | 0..1 | Period | Time period plan covers | ||||
![]() ![]() ![]() | Σ | 0..* | Reference(Patient | Practitioner | RelatedPerson | Organization | CareTeam) | Who is responsible for contents of the plan | ||||
![]() ![]() ![]() | 0..* | Reference(CareTeam) | Who's involved in plan? | |||||
![]() ![]() ![]() | Σ | 0..* | Reference(Condition) | Health issues this plan addresses | ||||
![]() ![]() ![]() | 0..* | Reference(Resource) | Information considered as part of plan | |||||
![]() ![]() ![]() | 0..* | Reference(Goal) | Desired outcome of plan | |||||
![]() ![]() ![]() | SI | 0..* | BackboneElement | Action to occur as part of plan | ||||
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Results of the activity Binding: Care Plan Activity Outcome (example): Identifies the results of the activity | |||||
![]() ![]() ![]() ![]() | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
![]() ![]() ![]() ![]() | 0..* | Annotation | Comments about the activity status/progress | |||||
![]() ![]() ![]() ![]() | SI | 1..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
![]() ![]() ![]() ![]() | I | 0..1 | BackboneElement | In-line definition of activity | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | diet | drug | encounter | observation | procedure | supply | other Binding: CarePlanActivityCategory (example): High-level categorization of the type of activity in a care plan. | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Reference(PlanDefinition | ActivityDefinition | Questionnaire) | Protocol or definition | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Detail type of activity Binding: Care Plan Activity (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: Activity Reason (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Reference(Condition) | Condition triggering need for activity | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Reference(Goal) | Goals this activity relates to | |||||
![]() ![]() ![]() ![]() ![]() | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown Binding: CarePlanActivityStatus (required): Indicates where the activity is at in its overall life cycle. | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Reason for current status | |||||
![]() ![]() ![]() ![]() ![]() | ?! | 0..1 | boolean | Do NOT do | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | When activity is to occur | ||||||
![]() ![]() ![]() ![]() ![]() ![]() | Timing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | Period | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | string | |||||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Reference(Location) | Where it should happen | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Reference(Practitioner | Organization | RelatedPerson | Patient | CareTeam) | Who will be responsible? | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | What is to be administered/supplied Binding: SNOMED CT Medication Codes (example): A product supplied or administered as part of a care plan activity. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() | CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | Reference(Medication | Substance) | |||||||
![]() ![]() ![]() ![]() ![]() | 0..1 | SimpleQuantity | How to consume/day? | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Extra info describing activity to perform | |||||
![]() ![]() ![]() | 0..* | Annotation | Comments about the plan | |||||
![]() |
This structure is derived from http://hl7.org/fhir/STU3/careplan.html.
Differential View
This structure is derived from http://hl7.org/fhir/STU3/careplan.html.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | CarePlan | Healthcare plan for patient or group | |
![]() ![]() ![]() | S | 0..* | BackboneElement | Action to occur as part of plan |
![]() ![]() ![]() ![]() | S | 1..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | CarePlan | Healthcare plan for patient or group | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 0..* | Identifier | External Ids for this plan | ||||
![]() ![]() ![]() | Σ | 0..* | Reference(PlanDefinition | Questionnaire) | Protocol or definition | ||||
![]() ![]() ![]() | Σ | 0..* | Reference(CarePlan) | Fulfills care plan | ||||
![]() ![]() ![]() | Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | ||||
![]() ![]() ![]() | Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | ||||
![]() ![]() ![]() | ?!Σ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled | unknown Binding: CarePlanStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | ||||
![]() ![]() ![]() | ?!Σ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan | ||||
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Type of plan Binding: Care Plan Category (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | ||||
![]() ![]() ![]() | Σ | 0..1 | string | Human-friendly name for the CarePlan | ||||
![]() ![]() ![]() | Σ | 0..1 | string | Summary of nature of plan | ||||
![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | Group) | Who care plan is for | ||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Created in context of | ||||
![]() ![]() ![]() | Σ | 0..1 | Period | Time period plan covers | ||||
![]() ![]() ![]() | Σ | 0..* | Reference(Patient | Practitioner | RelatedPerson | Organization | CareTeam) | Who is responsible for contents of the plan | ||||
![]() ![]() ![]() | 0..* | Reference(CareTeam) | Who's involved in plan? | |||||
![]() ![]() ![]() | Σ | 0..* | Reference(Condition) | Health issues this plan addresses | ||||
![]() ![]() ![]() | 0..* | Reference(Resource) | Information considered as part of plan | |||||
![]() ![]() ![]() | 0..* | Reference(Goal) | Desired outcome of plan | |||||
![]() ![]() ![]() | SI | 0..* | BackboneElement | Action to occur as part of plan | ||||
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Results of the activity Binding: Care Plan Activity Outcome (example): Identifies the results of the activity | |||||
![]() ![]() ![]() ![]() | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
![]() ![]() ![]() ![]() | 0..* | Annotation | Comments about the activity status/progress | |||||
![]() ![]() ![]() ![]() | SI | 1..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
![]() ![]() ![]() ![]() | I | 0..1 | BackboneElement | In-line definition of activity | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | diet | drug | encounter | observation | procedure | supply | other Binding: CarePlanActivityCategory (example): High-level categorization of the type of activity in a care plan. | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Reference(PlanDefinition | ActivityDefinition | Questionnaire) | Protocol or definition | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Detail type of activity Binding: Care Plan Activity (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: Activity Reason (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Reference(Condition) | Condition triggering need for activity | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Reference(Goal) | Goals this activity relates to | |||||
![]() ![]() ![]() ![]() ![]() | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown Binding: CarePlanActivityStatus (required): Indicates where the activity is at in its overall life cycle. | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Reason for current status | |||||
![]() ![]() ![]() ![]() ![]() | ?! | 0..1 | boolean | Do NOT do | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | When activity is to occur | ||||||
![]() ![]() ![]() ![]() ![]() ![]() | Timing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | Period | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | string | |||||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Reference(Location) | Where it should happen | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Reference(Practitioner | Organization | RelatedPerson | Patient | CareTeam) | Who will be responsible? | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | What is to be administered/supplied Binding: SNOMED CT Medication Codes (example): A product supplied or administered as part of a care plan activity. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() | CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() ![]() | Reference(Medication | Substance) | |||||||
![]() ![]() ![]() ![]() ![]() | 0..1 | SimpleQuantity | How to consume/day? | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Extra info describing activity to perform | |||||
![]() ![]() ![]() | 0..* | Annotation | Comments about the plan | |||||
![]() |
Path | Conformance | ValueSet |
CarePlan.language | extensible | Common Languages Max Binding: All Languages |
CarePlan.status | required | CarePlanStatus |
CarePlan.intent | required | CarePlanIntent |
CarePlan.category | example | Care Plan Category |
CarePlan.activity.outcomeCodeableConcept | example | Care Plan Activity Outcome |
CarePlan.activity.detail.category | example | CarePlanActivityCategory |
CarePlan.activity.detail.code | example | Care Plan Activity |
CarePlan.activity.detail.reasonCode | example | Activity Reason |
CarePlan.activity.detail.status | required | CarePlanActivityStatus |
CarePlan.activity.detail.product[x] | example | SNOMED CT Medication Codes |
Id | Grade | Path | Details | Requirements |
dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-3 | error | CarePlan | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
ele-1 | error | CarePlan.activity | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
ele-1 | error | CarePlan.activity.detail | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |