STU 2 Ballot

This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: DAF-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 DAF-CarePlan profile:

  • Query for a careplan for a Patient
Mandatory Data Elements and Terminology

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 an example 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 patient
  3. a status
  4. a category code of “assess-plan”

Profile specific implementation guidance:

  • none
Example: CarePlan Example: example

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-careplan

This profile was published on Mon Aug 01 00:00:00 AEST 2016 as a draft by Health Level Seven International (FHIR-Infrastructure).

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from CarePlan

Complete Summary of the Mandatory Requirements

  1. A narrative summary in CarePlan.text
  2. One reference to a patient in CarePlan.subject
  3. One status in CarePlan.status
  4. One category in Careplan.category which must have:

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*
... text S1..1Narrative
.... status S1..1codeBinding: Narrative Status (required)
... subject S1..1Reference(Profile daf-core-patient)
... status S1..1codeBinding: CarePlanStatus (required)
... category S1..1CodeableConceptRequired Pattern: {"coding":[{"system":"http://hl7.org/fhir/us/daf/CodeSystem/daf-core-extension-codes","code":"assess-plan"}]}

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan I0..*Healthcare plan for patient or group
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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)
... text SI1..1NarrativeText summary of the resource, for human interpretation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... status S1..1codegenerated | extensions | additional | empty
Binding: Narrative Status (required)
.... div I1..1xhtmlLimited xhtml content
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
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-2: The narrative SHALL have some non-whitespace content
... 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
... subject S1..1Reference(Profile daf-core-patient)Who care plan is for
... status ?!S1..1codeproposed | draft | active | completed | cancelled
Binding: CarePlanStatus (required)
... context 0..1Reference(Encounter | EpisodeOfCare)Created in context of
... period 0..1PeriodTime period plan covers
... author 0..*Reference(Patient | Practitioner | RelatedPerson | Organization)Who is responsible for contents of the plan
... modified 0..1dateTimeWhen last updated
... category S1..1CodeableConceptType of plan
Binding: Care Plan Category (example)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/us/daf/CodeSystem/daf-core-extension-codes","code":"assess-plan"}]}
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding 0..*CodingCode defined by a terminology system
.... text 0..1stringPlain text representation of the concept
... description 0..1stringSummary 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..*BackboneElementPlans related to this one
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... code 0..1codeincludes | replaces | fulfills
Binding: CarePlanRelationship (required)
.... plan 1..1Reference(CarePlan)Plan relationship exists with
... careTeam 0..*Reference(CareTeam)Who's involved in plan?
... goal 0..*Reference(Goal)Desired outcome of plan
... activity I0..*BackboneElementAction to occur as part of plan
ctm-3: Provide a reference or detail, not both
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... actionResulting 0..*Reference(Resource)Appointments, orders, etc.
.... outcome 0..1CodeableConceptResults of the activity
Binding: (unbound) (example)
.... progress 0..*AnnotationComments about the activity status/progress
.... reference I0..1Reference(Appointment | CommunicationRequest | DeviceUseRequest | DiagnosticRequest | MedicationOrder | NutritionRequest | ProcedureRequest | ProcessRequest | ReferralRequest | SupplyRequest | VisionPrescription)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 | Questionnaire)Protocol or definition
..... code 0..1CodeableConceptDetail type of activity
Binding: Care Plan Activity (example)
..... reasonCode 0..*CodeableConceptWhy 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..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled
Binding: CarePlanActivityStatus (required)
..... statusReason 0..1CodeableConceptReason for current status
Binding: GoalStatusReason (example)
..... prohibited ?!1..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)Who will be responsible?
..... product[x] 0..1CodeableConcept, Reference(Medication), Reference(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..1AnnotationComments about the plan

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

This structure is derived from CarePlan

Summary

Mandatory: 4 elements (+2 nested mandatory elements)
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*
... text S1..1Narrative
.... status S1..1codeBinding: Narrative Status (required)
... subject S1..1Reference(Profile daf-core-patient)
... status S1..1codeBinding: CarePlanStatus (required)
... category S1..1CodeableConceptRequired Pattern: {"coding":[{"system":"http://hl7.org/fhir/us/daf/CodeSystem/daf-core-extension-codes","code":"assess-plan"}]}

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan I0..*Healthcare plan for patient or group
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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)
... text SI1..1NarrativeText summary of the resource, for human interpretation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... status S1..1codegenerated | extensions | additional | empty
Binding: Narrative Status (required)
.... div I1..1xhtmlLimited xhtml content
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
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-2: The narrative SHALL have some non-whitespace content
... 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
... subject S1..1Reference(Profile daf-core-patient)Who care plan is for
... status ?!S1..1codeproposed | draft | active | completed | cancelled
Binding: CarePlanStatus (required)
... context 0..1Reference(Encounter | EpisodeOfCare)Created in context of
... period 0..1PeriodTime period plan covers
... author 0..*Reference(Patient | Practitioner | RelatedPerson | Organization)Who is responsible for contents of the plan
... modified 0..1dateTimeWhen last updated
... category S1..1CodeableConceptType of plan
Binding: Care Plan Category (example)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/us/daf/CodeSystem/daf-core-extension-codes","code":"assess-plan"}]}
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding 0..*CodingCode defined by a terminology system
.... text 0..1stringPlain text representation of the concept
... description 0..1stringSummary 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..*BackboneElementPlans related to this one
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... code 0..1codeincludes | replaces | fulfills
Binding: CarePlanRelationship (required)
.... plan 1..1Reference(CarePlan)Plan relationship exists with
... careTeam 0..*Reference(CareTeam)Who's involved in plan?
... goal 0..*Reference(Goal)Desired outcome of plan
... activity I0..*BackboneElementAction to occur as part of plan
ctm-3: Provide a reference or detail, not both
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... actionResulting 0..*Reference(Resource)Appointments, orders, etc.
.... outcome 0..1CodeableConceptResults of the activity
Binding: (unbound) (example)
.... progress 0..*AnnotationComments about the activity status/progress
.... reference I0..1Reference(Appointment | CommunicationRequest | DeviceUseRequest | DiagnosticRequest | MedicationOrder | NutritionRequest | ProcedureRequest | ProcessRequest | ReferralRequest | SupplyRequest | VisionPrescription)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 | Questionnaire)Protocol or definition
..... code 0..1CodeableConceptDetail type of activity
Binding: Care Plan Activity (example)
..... reasonCode 0..*CodeableConceptWhy 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..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled
Binding: CarePlanActivityStatus (required)
..... statusReason 0..1CodeableConceptReason for current status
Binding: GoalStatusReason (example)
..... prohibited ?!1..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)Who will be responsible?
..... product[x] 0..1CodeableConcept, Reference(Medication), Reference(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..1AnnotationComments about the plan

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

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

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
CarePlan.languageCommon LanguagesextensibleCommon Languages
CarePlan.text.statusNarrative StatusrequiredNarrative Status
CarePlan.statusCarePlanStatusrequiredCarePlanStatus
CarePlan.categoryCare Plan CategoryexampleCare Plan Category
CarePlan.relatedPlan.codeCarePlanRelationshiprequiredCarePlanRelationship
CarePlan.activity.outcome?extexample
CarePlan.activity.detail.categoryCarePlanActivityCategoryexampleCarePlanActivityCategory
CarePlan.activity.detail.codeCare Plan ActivityexampleCare Plan Activity
CarePlan.activity.detail.reasonCodeActivity ReasonexampleActivity Reason
CarePlan.activity.detail.statusCarePlanActivityStatusrequiredCarePlanActivityStatus
CarePlan.activity.detail.statusReasonGoalStatusReasonexampleGoalStatusReason
CarePlan.activity.detail.product[x]SNOMED CT Medication CodesexampleSNOMED 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
XPath: not(parent::f:contained and f:contained)
dom-1CarePlanIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4CarePlanIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3CarePlanIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
txt-3CarePlan.text.divThe 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
XPath: not(descendant-or-self::*/@*[not(name(.)=('abbr', 'accesskey', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellhalign', 'cellpadding', 'cellspacing', 'cellvalign', 'char', 'charoff', 'charset', 'cite', 'class', 'colspan', 'compact', 'coords', 'dir', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', 'id', 'lang', 'longdesc', 'name', 'nowrap', 'rel', 'rev', 'rowspan', 'rules', 'scope', 'shape', 'span', 'src', 'start', 'style', 'summary', 'tabindex', 'title', 'type', 'valign', 'value', 'vspace', 'width'))])
txt-1CarePlan.text.divThe 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
XPath: not(descendant-or-self::*[not(local-name(.)=('a', 'abbr', 'acronym', 'b', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'col', 'colgroup', 'dd', 'dfn', 'div', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var'))])
txt-2CarePlan.text.divThe narrative SHALL have some non-whitespace content
XPath: descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]
ctm-3CarePlan.activityProvide a reference or detail, not both
XPath: not(exists(f:detail)) or not(exists(f:reference))
.