D.4.1 StructureDefinition: cdc-careplan

D.4.1.1 Formal Views of Profile Content

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 Fri Apr 21 00:00:00 UTC 2017 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

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 2 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan I0..*Healthcare plan for patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this plan
... definition Σ0..*Reference(PlanDefinition | Questionnaire)Protocol or definition
... basedOn Σ0..*Reference(CarePlan)Fulfills care plan
... replaces Σ0..*Reference(CarePlan)CarePlan replaced by this CarePlan
... partOf Σ0..*Reference(CarePlan)Part of referenced CarePlan
... status ?!Σ1..1codedraft | active | suspended | completed | entered-in-error | cancelled | unknown
Binding: CarePlanStatus (required)
... intent ?!Σ1..1codeproposal | plan | order | option
Binding: CarePlanIntent (required)
... category Σ0..*CodeableConceptType of plan
Binding: Care Plan Category (example)
... title Σ0..1stringHuman-friendly name for the CarePlan
... description Σ0..1stringSummary of nature of plan
... subject Σ1..1Reference(Patient | Group)Who care plan is for
... context Σ0..1Reference(Encounter | EpisodeOfCare)Created in context of
... period Σ0..1PeriodTime period plan covers
... author Σ0..*Reference(Patient | Practitioner | RelatedPerson | Organization | CareTeam)Who is responsible for contents of the plan
... careTeam 0..*Reference(CareTeam)Who's involved in plan?
... addresses Σ0..*Reference(Condition)Health issues this plan addresses
... supportingInfo 0..*Reference(Resource)Information considered as part of plan
... goal 0..*Reference(Goal)Desired outcome of plan
... activity SI0..*BackboneElementAction to occur as part of plan
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... outcomeCodeableConcept 0..*CodeableConceptResults of the activity
Binding: Care Plan Activity Outcome (example)
.... outcomeReference 0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... progress 0..*AnnotationComments about the activity status/progress
.... reference SI1..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup)Activity details defined in specific resource
.... detail I0..1BackboneElementIn-line definition of activity
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... category 0..1CodeableConceptdiet | drug | encounter | observation | procedure | supply | other
Binding: CarePlanActivityCategory (example)
..... definition 0..1Reference(PlanDefinition | ActivityDefinition | Questionnaire)Protocol or definition
..... code 0..1CodeableConceptDetail type of activity
Binding: Care Plan Activity (example)
..... reasonCode 0..*CodeableConceptWhy activity should be done or why activity was prohibited
Binding: Activity Reason (example)
..... reasonReference 0..*Reference(Condition)Condition triggering need for activity
..... goal 0..*Reference(Goal)Goals this activity relates to
..... status ?!1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | unknown
Binding: CarePlanActivityStatus (required)
..... statusReason 0..1stringReason for current status
..... prohibited ?!0..1booleanDo NOT do
..... scheduled[x] 0..1Timing, Period, stringWhen activity is to occur
..... location 0..1Reference(Location)Where it should happen
..... performer 0..*Reference(Practitioner | Organization | RelatedPerson | Patient | CareTeam)Who will be responsible?
..... product[x] 0..1CodeableConcept, Reference(Medication | Substance)What is to be administered/supplied
Binding: SNOMED CT Medication Codes (example)
..... dailyAmount 0..1SimpleQuantityHow to consume/day?
..... quantity 0..1SimpleQuantityHow much to administer/supply/consume
..... description 0..1stringExtra info describing activity to perform
... note 0..*AnnotationComments about the plan

doco Documentation for this format

This structure is derived from http://hl7.org/fhir/STU3/careplan.html.

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 2 elements

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan I0..*Healthcare plan for patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this plan
... definition Σ0..*Reference(PlanDefinition | Questionnaire)Protocol or definition
... basedOn Σ0..*Reference(CarePlan)Fulfills care plan
... replaces Σ0..*Reference(CarePlan)CarePlan replaced by this CarePlan
... partOf Σ0..*Reference(CarePlan)Part of referenced CarePlan
... status ?!Σ1..1codedraft | active | suspended | completed | entered-in-error | cancelled | unknown
Binding: CarePlanStatus (required)
... intent ?!Σ1..1codeproposal | plan | order | option
Binding: CarePlanIntent (required)
... category Σ0..*CodeableConceptType of plan
Binding: Care Plan Category (example)
... title Σ0..1stringHuman-friendly name for the CarePlan
... description Σ0..1stringSummary of nature of plan
... subject Σ1..1Reference(Patient | Group)Who care plan is for
... context Σ0..1Reference(Encounter | EpisodeOfCare)Created in context of
... period Σ0..1PeriodTime period plan covers
... author Σ0..*Reference(Patient | Practitioner | RelatedPerson | Organization | CareTeam)Who is responsible for contents of the plan
... careTeam 0..*Reference(CareTeam)Who's involved in plan?
... addresses Σ0..*Reference(Condition)Health issues this plan addresses
... supportingInfo 0..*Reference(Resource)Information considered as part of plan
... goal 0..*Reference(Goal)Desired outcome of plan
... activity SI0..*BackboneElementAction to occur as part of plan
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... outcomeCodeableConcept 0..*CodeableConceptResults of the activity
Binding: Care Plan Activity Outcome (example)
.... outcomeReference 0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... progress 0..*AnnotationComments about the activity status/progress
.... reference SI1..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup)Activity details defined in specific resource
.... detail I0..1BackboneElementIn-line definition of activity
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... category 0..1CodeableConceptdiet | drug | encounter | observation | procedure | supply | other
Binding: CarePlanActivityCategory (example)
..... definition 0..1Reference(PlanDefinition | ActivityDefinition | Questionnaire)Protocol or definition
..... code 0..1CodeableConceptDetail type of activity
Binding: Care Plan Activity (example)
..... reasonCode 0..*CodeableConceptWhy activity should be done or why activity was prohibited
Binding: Activity Reason (example)
..... reasonReference 0..*Reference(Condition)Condition triggering need for activity
..... goal 0..*Reference(Goal)Goals this activity relates to
..... status ?!1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | unknown
Binding: CarePlanActivityStatus (required)
..... statusReason 0..1stringReason for current status
..... prohibited ?!0..1booleanDo NOT do
..... scheduled[x] 0..1Timing, Period, stringWhen activity is to occur
..... location 0..1Reference(Location)Where it should happen
..... performer 0..*Reference(Practitioner | Organization | RelatedPerson | Patient | CareTeam)Who will be responsible?
..... product[x] 0..1CodeableConcept, Reference(Medication | Substance)What is to be administered/supplied
Binding: SNOMED CT Medication Codes (example)
..... dailyAmount 0..1SimpleQuantityHow to consume/day?
..... quantity 0..1SimpleQuantityHow much to administer/supply/consume
..... description 0..1stringExtra info describing activity to perform
... note 0..*AnnotationComments about the plan

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
CarePlan.languageextensibleCommon Languages
Max Binding: All Languages
CarePlan.statusrequiredCarePlanStatus
CarePlan.intentrequiredCarePlanIntent
CarePlan.categoryexampleCare Plan Category
CarePlan.activity.outcomeCodeableConceptexampleCare Plan Activity Outcome
CarePlan.activity.detail.categoryexampleCarePlanActivityCategory
CarePlan.activity.detail.codeexampleCare Plan Activity
CarePlan.activity.detail.reasonCodeexampleActivity Reason
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
CarePlan.activity.detail.product[x]exampleSNOMED CT Medication Codes

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2CarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1CarePlanIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4CarePlanIf 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-3CarePlanIf 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-1CarePlan.activityAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
cpl-3CarePlan.activityProvide a reference or detail, not both
: detail.empty() or reference.empty()
ele-1CarePlan.activity.detailAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
.

s