2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile: cqf-careplan

The official URL for this profile is: 

http://hl7.org/fhir/Profile/cqf-careplan-cqf-careplan

. Profile of Careplan for decision support/quality metrics. Indicates which elements must be supported by CQF rules and measure engines. : Clinical Quality Framework (CQF) Careplan Profile

This profile was published on Tue, Dec 2, 2014 00:00+1100 as a draft by Health Level Seven, Inc. - CQI WG.

Summary

Required/Prohibited Elements

  • The element CarePlan is required
  • The element CarePlan.status is required
  • The element CarePlan.participant.member is required
  • The element CarePlan.activity.prohibited is required
  • The element CarePlan.activity.simple.category is required

Formal Views of Profile Content

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 1..1Healthcare plan for patient
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... 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
... patient S0..1PatientWho care plan is for
... status M S1..1codeplanned | active | completed
Binding: CarePlanStatus (required, not extensible)
... period S0..1PeriodTime period plan covers
... modified 0..1dateTimeWhen last updated
... concern S0..*ConditionHealth issues this plan addresses
... participant S0..*Who's involved in plan?
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... role S0..1CodeableConceptType of involvement
Binding: CarePlanParticipantRole (preferred, extensible)
.... member S1..1Practitioner, RelatedPerson, Patient, OrganizationWho is involved
... goal S0..*Desired outcome of plan
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringWhat's the desired outcome?
.... status S0..1codein-progress | achieved | sustaining | cancelled
Binding: CarePlanGoalStatus (required, not extensible)
.... notes 0..1stringComments about the goal
.... concern S0..*ConditionHealth issues this goal addresses
... activity S0..*Action to occur as part of plan
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... goal 0..*uriGoals this activity relates to
.... status S0..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled
Binding: CarePlanActivityStatus (required, not extensible)
.... prohibited M S1..1booleanDo NOT do
.... actionResulting S0..*AnyAppointments, orders, etc.
.... notes 0..1stringComments about the activity
.... detail S I0..1Procedure, MedicationPrescription, DiagnosticOrder, Encounter, SupplyActivity details defined in specific resource
.... simple S I0..1Activity details summarised here
cpl-1: DailyDose can only be specified if activity category is drug or food
cpl-2: Quantity can only be specified if activity category is supply
cpl-3: Only provide a detail reference, or a simple detail summary
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension 0..*ExtensionExtensions that cannot be ignored
..... category S1..1codediet | drug | encounter | observation | procedure | supply | other
Binding: CarePlanActivityCategory (required, not extensible)
..... code S0..1CodeableConceptDetail type of activity
Binding: CarePlanActivityType (preferred, extensible)
..... scheduled[x] S0..1Timing, Period, stringWhen activity is to occur
..... location 0..1LocationWhere it should happen
..... performer S0..*Practitioner, Organization, RelatedPerson, PatientWho's responsible?
..... product S0..1Medication, SubstanceWhat's administered/supplied
..... dailyAmount S I0..1QuantityHow much consumed/day?
..... quantity S I0..1QuantityHow much is administered/supplied/consumed
..... details 0..1stringExtra info on activity occurrence
... notes 0..1stringComments about the plan

XML Template

JSON Template

todo

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 1..1Healthcare plan for patient
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... 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
... patient S0..1PatientWho care plan is for
... status M S1..1codeplanned | active | completed
Binding: CarePlanStatus (required, not extensible)
... period S0..1PeriodTime period plan covers
... modified 0..1dateTimeWhen last updated
... concern S0..*ConditionHealth issues this plan addresses
... participant S0..*Who's involved in plan?
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... role S0..1CodeableConceptType of involvement
Binding: CarePlanParticipantRole (preferred, extensible)
.... member S1..1Practitioner, RelatedPerson, Patient, OrganizationWho is involved
... goal S0..*Desired outcome of plan
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... description 1..1stringWhat's the desired outcome?
.... status S0..1codein-progress | achieved | sustaining | cancelled
Binding: CarePlanGoalStatus (required, not extensible)
.... notes 0..1stringComments about the goal
.... concern S0..*ConditionHealth issues this goal addresses
... activity S0..*Action to occur as part of plan
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... goal 0..*uriGoals this activity relates to
.... status S0..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled
Binding: CarePlanActivityStatus (required, not extensible)
.... prohibited M S1..1booleanDo NOT do
.... actionResulting S0..*AnyAppointments, orders, etc.
.... notes 0..1stringComments about the activity
.... detail S I0..1Procedure, MedicationPrescription, DiagnosticOrder, Encounter, SupplyActivity details defined in specific resource
.... simple S I0..1Activity details summarised here
cpl-1: DailyDose can only be specified if activity category is drug or food
cpl-2: Quantity can only be specified if activity category is supply
cpl-3: Only provide a detail reference, or a simple detail summary
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension 0..*ExtensionExtensions that cannot be ignored
..... category S1..1codediet | drug | encounter | observation | procedure | supply | other
Binding: CarePlanActivityCategory (required, not extensible)
..... code S0..1CodeableConceptDetail type of activity
Binding: CarePlanActivityType (preferred, extensible)
..... scheduled[x] S0..1Timing, Period, stringWhen activity is to occur
..... location 0..1LocationWhere it should happen
..... performer S0..*Practitioner, Organization, RelatedPerson, PatientWho's responsible?
..... product S0..1Medication, SubstanceWhat's administered/supplied
..... dailyAmount S I0..1QuantityHow much consumed/day?
..... quantity S I0..1QuantityHow much is administered/supplied/consumed
..... details 0..1stringExtra info on activity occurrence
... notes 0..1stringComments about the plan

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
CarePlan.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
CarePlan.statusCarePlanStatusrequiredCarePlanStatus
CarePlan.participant.roleCarePlanParticipantRolepreferred (extensible)
CarePlan.goal.statusCarePlanGoalStatusrequiredCarePlanGoalStatus
CarePlan.activity.statusCarePlanActivityStatusrequiredCarePlanActivityStatus
CarePlan.activity.simple.categoryCarePlanActivityCategoryrequiredCarePlanActivityCategory
CarePlan.activity.simple.codeCarePlanActivityTypepreferred (extensible)

Constraints

IdPathNameDetails
cpl-1CarePlan.activity.simpledose for food or drugDailyDose can only be specified if activity category is drug or food
XPath: (f:category/@value=('drug','diet')) = exists(f:dailyAmount)
cpl-2CarePlan.activity.simplequantity for supplyQuantity can only be specified if activity category is supply
XPath: (f:category/@value=('supply')) = exists(f:quantity)
cpl-3CarePlan.activity.simpledetails by reference, or simple detailsOnly provide a detail reference, or a simple detail summary
XPath: not(exists(f:detail)) or not(exists(f:simple))
.