HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE), v0.9.1

HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE), v0.9.1 FHIR Profiles - Local Development build (v0.9.1). See the Directory of published versions

CarePlan

 

The official URL for this profile is:

http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-CarePlan

Describes how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions. The Care Plan tracks the progress of activities associated with the plan.

This profile builds on http://fhir.org/guides/argonaut/StructureDefinition/argo-careplan.

This profile was published on Wed Oct 23 00:00:00 EDT 2019 as a draft by The MITRE Corporation.

Summary

Mandatory: 0 element (2 nested mandatory elements)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

obf.CarePlan maps to http://fhir.org/guides/argonaut/StructureDefinition/argo-careplan:
  Language maps to language
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.SourceSystem maps to meta.extension
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Narrative maps to text
  BasedOn maps to extension
  SubjectOfRecord maps to subject
  CareContext maps to context
  StatementDateTime maps to extension
  ReasonReference maps to addresses
  ReasonCode maps to extension
  Identifier maps to identifier
  CarePlanReplaces maps to extension
  CarePlanPartOf maps to extension
  Status maps to status
  RequestIntent maps to extension
  Category maps to category
  Title maps to extension
  CommentOrDescription maps to description
  ExpectedPerformanceTime maps to period
  Author maps to author
  Annotation maps to note

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan obf-CarePlan
... meta
.... extension Slice: Unordered, Open by value:url
.... obf-SourceSystem-extension 0..1uriSourceSystem
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-SourceSystem-extension
... extension 1..*Slice: Unordered, Open by value:url
... obf-BasedOn-extension 0..*Reference(Basic | ReferralRequest | obf-ProcedureRequest | obf-MedicationRequest | obf-CarePlan)BasedOn
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-BasedOn-extension
... obf-StatementDateTime-extension 0..1dateTimeStatementDateTime
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-StatementDateTime-extension
... obf-ReasonCode-extension 0..*CodeableConceptReasonCode
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-ReasonCode-extension
... obf-CarePlanReplaces-extension 0..*Reference(obf-CarePlan)CarePlanReplaces
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-CarePlanReplaces-extension
... obf-CarePlanPartOf-extension 0..*Reference(obf-CarePlan)CarePlanPartOf
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-CarePlanPartOf-extension
... obf-RequestIntent-extension 1..1CodeableConceptRequestIntent
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-RequestIntent-extension
... obf-datatype-Title-extension 0..1stringTitle
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-datatype-Title-extension
... subject Reference(obf-Patient)
... author 0..1Reference(obf-Patient | Practitioner | RelatedPerson | Organization)
... addresses Reference(obf-Condition)
... note Annotation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*obf-CarePlan
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... obf-SourceSystem-extension 0..1uriSourceSystem
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-SourceSystem-extension
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ0..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: (unbound) (example)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text SI1..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 1..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... obf-BasedOn-extension 0..*Reference(Basic | ReferralRequest | obf-ProcedureRequest | obf-MedicationRequest | obf-CarePlan)BasedOn
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-BasedOn-extension
... obf-StatementDateTime-extension 0..1dateTimeStatementDateTime
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-StatementDateTime-extension
... obf-ReasonCode-extension 0..*CodeableConceptReasonCode
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-ReasonCode-extension
... obf-CarePlanReplaces-extension 0..*Reference(obf-CarePlan)CarePlanReplaces
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-CarePlanReplaces-extension
... obf-CarePlanPartOf-extension 0..*Reference(obf-CarePlan)CarePlanPartOf
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-CarePlanPartOf-extension
... obf-RequestIntent-extension 1..1CodeableConceptRequestIntent
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-RequestIntent-extension
... obf-datatype-Title-extension 0..1stringTitle
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-datatype-Title-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this plan
... subject S1..1Reference(obf-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..1Reference(obf-Patient | Practitioner | RelatedPerson | Organization)Who is responsible for contents of the plan
... modified Σ0..1dateTimeWhen last updated
... category SI1..*CodeableConceptType of plan
Binding: Care Plan Category (example)
arg-1: Must have a category of 'careplan' and a code system 'http://argonaut.hl7.org'
... description Σ0..1stringSummary of nature of plan
... addresses Σ0..*Reference(obf-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..1idxml: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
... participant 0..*BackboneElementWho'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 0..1CodeableConceptType of involvement
Binding: Participant Roles (example)
.... member 0..1Reference(Practitioner | RelatedPerson | Patient | Organization)Who is involved
... goal 0..*Reference(Goal)Desired outcome of plan
... activity I0..*BackboneElementAction to occur as part of plan
cpl-3: Provide a reference or detail, not both
.... id 0..1idxml: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.
.... progress 0..*AnnotationComments about the activity status/progress
.... reference I0..1Reference(Appointment | CommunicationRequest | DeviceUseRequest | DiagnosticOrder | MedicationOrder | NutritionOrder | Order | ProcedureRequest | ProcessRequest | ReferralRequest | SupplyRequest | VisionPrescription)Activity details defined in specific resource
.... detail I0..1BackboneElementIn-line definition of activity
..... id 0..1idxml: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)
..... 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..1When activity is to occur
...... scheduledTimingTiming
...... scheduledPeriodPeriod
...... scheduledStringstring
..... location 0..1Reference(Location)Where it should happen
..... performer 0..*Reference(Practitioner | Organization | RelatedPerson | Patient)Who will be responsible?
..... product[x] 0..1What is to be administered/supplied
Binding: SNOMED CT Medication Codes (example)
...... productCodeableConceptCodeableConcept
...... productReferenceReference(Medication | Substance)
..... 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

Summary

Mandatory: 0 element (2 nested mandatory elements)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

obf.CarePlan maps to http://fhir.org/guides/argonaut/StructureDefinition/argo-careplan:
  Language maps to language
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.SourceSystem maps to meta.extension
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Narrative maps to text
  BasedOn maps to extension
  SubjectOfRecord maps to subject
  CareContext maps to context
  StatementDateTime maps to extension
  ReasonReference maps to addresses
  ReasonCode maps to extension
  Identifier maps to identifier
  CarePlanReplaces maps to extension
  CarePlanPartOf maps to extension
  Status maps to status
  RequestIntent maps to extension
  Category maps to category
  Title maps to extension
  CommentOrDescription maps to description
  ExpectedPerformanceTime maps to period
  Author maps to author
  Annotation maps to note

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan obf-CarePlan
... meta
.... extension Slice: Unordered, Open by value:url
.... obf-SourceSystem-extension 0..1uriSourceSystem
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-SourceSystem-extension
... extension 1..*Slice: Unordered, Open by value:url
... obf-BasedOn-extension 0..*Reference(Basic | ReferralRequest | obf-ProcedureRequest | obf-MedicationRequest | obf-CarePlan)BasedOn
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-BasedOn-extension
... obf-StatementDateTime-extension 0..1dateTimeStatementDateTime
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-StatementDateTime-extension
... obf-ReasonCode-extension 0..*CodeableConceptReasonCode
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-ReasonCode-extension
... obf-CarePlanReplaces-extension 0..*Reference(obf-CarePlan)CarePlanReplaces
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-CarePlanReplaces-extension
... obf-CarePlanPartOf-extension 0..*Reference(obf-CarePlan)CarePlanPartOf
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-CarePlanPartOf-extension
... obf-RequestIntent-extension 1..1CodeableConceptRequestIntent
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-RequestIntent-extension
... obf-datatype-Title-extension 0..1stringTitle
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-datatype-Title-extension
... subject Reference(obf-Patient)
... author 0..1Reference(obf-Patient | Practitioner | RelatedPerson | Organization)
... addresses Reference(obf-Condition)
... note Annotation

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*obf-CarePlan
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... obf-SourceSystem-extension 0..1uriSourceSystem
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-SourceSystem-extension
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ0..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: (unbound) (example)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text SI1..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 1..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... obf-BasedOn-extension 0..*Reference(Basic | ReferralRequest | obf-ProcedureRequest | obf-MedicationRequest | obf-CarePlan)BasedOn
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-BasedOn-extension
... obf-StatementDateTime-extension 0..1dateTimeStatementDateTime
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-StatementDateTime-extension
... obf-ReasonCode-extension 0..*CodeableConceptReasonCode
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-ReasonCode-extension
... obf-CarePlanReplaces-extension 0..*Reference(obf-CarePlan)CarePlanReplaces
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-CarePlanReplaces-extension
... obf-CarePlanPartOf-extension 0..*Reference(obf-CarePlan)CarePlanPartOf
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-CarePlanPartOf-extension
... obf-RequestIntent-extension 1..1CodeableConceptRequestIntent
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-RequestIntent-extension
... obf-datatype-Title-extension 0..1stringTitle
URL: http://mcodeinitiative.org/us/mcode/StructureDefinition/obf-datatype-Title-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this plan
... subject S1..1Reference(obf-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..1Reference(obf-Patient | Practitioner | RelatedPerson | Organization)Who is responsible for contents of the plan
... modified Σ0..1dateTimeWhen last updated
... category SI1..*CodeableConceptType of plan
Binding: Care Plan Category (example)
arg-1: Must have a category of 'careplan' and a code system 'http://argonaut.hl7.org'
... description Σ0..1stringSummary of nature of plan
... addresses Σ0..*Reference(obf-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..1idxml: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
... participant 0..*BackboneElementWho'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 0..1CodeableConceptType of involvement
Binding: Participant Roles (example)
.... member 0..1Reference(Practitioner | RelatedPerson | Patient | Organization)Who is involved
... goal 0..*Reference(Goal)Desired outcome of plan
... activity I0..*BackboneElementAction to occur as part of plan
cpl-3: Provide a reference or detail, not both
.... id 0..1idxml: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.
.... progress 0..*AnnotationComments about the activity status/progress
.... reference I0..1Reference(Appointment | CommunicationRequest | DeviceUseRequest | DiagnosticOrder | MedicationOrder | NutritionOrder | Order | ProcedureRequest | ProcessRequest | ReferralRequest | SupplyRequest | VisionPrescription)Activity details defined in specific resource
.... detail I0..1BackboneElementIn-line definition of activity
..... id 0..1idxml: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)
..... 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..1When activity is to occur
...... scheduledTimingTiming
...... scheduledPeriodPeriod
...... scheduledStringstring
..... location 0..1Reference(Location)Where it should happen
..... performer 0..*Reference(Practitioner | Organization | RelatedPerson | Patient)Who will be responsible?
..... product[x] 0..1What is to be administered/supplied
Binding: SNOMED CT Medication Codes (example)
...... productCodeableConceptCodeableConcept
...... productReferenceReference(Medication | Substance)
..... 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

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

 

Terminology Bindings

PathConformanceValueSet
CarePlan-argoprofile.meta.securityextensibleAll Security Labels
CarePlan-argoprofile.meta.tagexample
CarePlan-argoprofile.languagerequiredhttp://tools.ietf.org/html/bcp47
CarePlan-argoprofile.statusrequiredCarePlanStatus
CarePlan-argoprofile.categoryexampleCare Plan Category
CarePlan-argoprofile.relatedPlan.coderequiredCarePlanRelationship
CarePlan-argoprofile.participant.roleexampleParticipant Roles
CarePlan-argoprofile.activity.detail.categoryexampleCarePlanActivityCategory
CarePlan-argoprofile.activity.detail.codeexampleCare Plan Activity
CarePlan-argoprofile.activity.detail.reasonCodeexampleActivity Reason
CarePlan-argoprofile.activity.detail.statusrequiredCarePlanActivityStatus
CarePlan-argoprofile.activity.detail.statusReasonexampleGoalStatusReason
CarePlan-argoprofile.activity.detail.productxexampleSNOMED CT Medication Codes

 

Constraints

IdPathDetailsRequirements
arg-1CarePlan.categoryMust have a category of 'careplan' and a code system 'http://argonaut.hl7.org'
: where(coding.system='http://argonaut.hl7.org' and coding.code='assess-plan').exists()
cpl-3CarePlan.activityProvide a reference or detail, not both
: