臺灣核心實作指引(TW Core IG)
0.3.1 - Ci-Build Trial Use

臺灣核心實作指引(TW Core IG), published by 衛生福利部. This guide is not an authorized publication; it is the continuous build for version 0.3.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/cctwFHIRterm/MOHW_TWCoreIG_Build/ and changes regularly. See the Directory of published versions

Resource Profile: TW Core CarePlan

Official URL: https://twcore.mohw.gov.tw/ig/twcore/StructureDefinition/CarePlan-twcore Version: 0.3.1
Active as of 2024-11-11 Computable Name: TWCoreCarePlan

此臺灣核心-照護計畫（TW Core CarePlan） Profile說明本IG如何進一步定義FHIR的CarePlan Resource以呈現照護計畫資料。

Usage:

Formal Views of Profile Content

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

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan CarePlan
... text S 0..1 Narrative CarePlan Resource之內容摘要以供人閱讀
.... status S 1..1 code generated | additional
Binding: 臺灣衛福部資訊處Narrative狀態值集 (required): Constrained value set of narrative statuses.

.... div S 1..1 xhtml Limited xhtml content
... basedOn 0..* Reference(TW Core CarePlan) Fulfills CarePlan
... replaces 0..* Reference(TW Core CarePlan) CarePlan replaced by this CarePlan
... status S 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

... intent S 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan

... Slices for category S 1..* CodeableConcept Type of plan
Slice: Unordered, Open by pattern:$this
.... category:AssessPlan S 1..1 CodeableConcept Type of plan
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/careplan-category-tw
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: assess-plan
... subject S 1..1 Reference(TW Core Patient S | Group) Who the care plan is for
... encounter 0..1 Reference(TW Core Encounter) Encounter created as part of
... author 0..1 Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | TW Core Implantable Device | TW Core RelatedPerson | TW Core Organization | TW Core CareTeam) Who is the designated responsible party
... contributor 0..* Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | TW Core Implantable Device | TW Core RelatedPerson | TW Core Organization | TW Core CareTeam) Who provided the content of the care plan
... careTeam 0..* Reference(TW Core CareTeam) Who's involved in plan?
... addresses 0..* Reference(TW Core Condition) Health issues this plan addresses
... activity
.... reference 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | TW Core MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
.... detail
..... reasonReference 0..* Reference(TW Core Condition | TW Core Observation Clinical Result | TW Core DiagnosticReport | TW Core DocumentReference) Why activity is needed
..... location 0..1 Reference(TW Core Location) Where it should happen
..... performer 0..* Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core RelatedPerson | TW Core Patient | TW Core CareTeam | HealthcareService | TW Core Implantable Device) Who will be responsible?
..... Slices for product[x] 0..1 CodeableConcept, Reference(Medication | Substance) What is to be administered/supplied
Slice: Unordered, Open by type:$this
...... product[x]:productReference 0..1 Reference(TW Core Medication | Substance) What is to be administered/supplied

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
CarePlan.text.statusrequiredTWNarrativeStatus
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/narrative-status
from this IG
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text S 0..1 Narrative CarePlan Resource之內容摘要以供人閱讀
.... status S 1..1 code generated | additional
Binding: 臺灣衛福部資訊處Narrative狀態值集 (required): Constrained value set of narrative statuses.

.... div SC 1..1 xhtml Limited xhtml content
txt-1: The narrative SHALL contain only the basic html formatting elements and 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-2: The narrative SHALL have some non-whitespace content
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... replaces Σ 0..* Reference(TW Core CarePlan) CarePlan replaced by this CarePlan
... partOf Σ 0..* Reference(TW Core CarePlan) Part of referenced CarePlan
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

... intent ?!SΣ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan

... Slices for category SΣ 1..* CodeableConcept Type of plan
Slice: Unordered, Open by pattern:$this
Binding: CarePlanCategory (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.


.... category:AssessPlan SΣ 1..1 CodeableConcept Type of plan
Binding: CarePlanCategory (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.



Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/careplan-category-tw
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: assess-plan
... subject SΣ 1..1 Reference(TW Core Patient) Who the care plan is for
... encounter Σ 0..1 Reference(TW Core Encounter) Encounter created as part of
... author Σ 0..1 Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | TW Core Implantable Device | TW Core RelatedPerson | TW Core Organization | TW Core CareTeam) Who is the designated responsible party
... contributor 0..* Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | TW Core Implantable Device | TW Core RelatedPerson | TW Core Organization | TW Core CareTeam) Who provided the content of the care plan
... careTeam 0..* Reference(TW Core CareTeam) Who's involved in plan?
... addresses Σ 0..* Reference(TW Core Condition) Health issues this plan addresses

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CarePlan.text.statusrequiredTWNarrativeStatus
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/narrative-status
from this IG
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent
from the FHIR Standard
CarePlan.categoryexampleCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard
CarePlan.category:AssessPlanexamplePattern: assess-plan
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCarePlanIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCarePlanIf 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-5errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCarePlanA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
txt-1errorCarePlan.text.divThe narrative SHALL contain only the basic html formatting elements and 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
: htmlChecks()
txt-2errorCarePlan.text.divThe narrative SHALL have some non-whitespace content
: htmlChecks()
NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text S 0..1 Narrative CarePlan Resource之內容摘要以供人閱讀
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... status S 1..1 code generated | additional
Binding: 臺灣衛福部資訊處Narrative狀態值集 (required): Constrained value set of narrative statuses.

.... div SC 1..1 xhtml Limited xhtml content
txt-1: The narrative SHALL contain only the basic html formatting elements and 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-2: The narrative SHALL have some non-whitespace content
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this plan
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(TW Core CarePlan) Fulfills CarePlan
... replaces Σ 0..* Reference(TW Core CarePlan) CarePlan replaced by this CarePlan
... partOf Σ 0..* Reference(TW Core CarePlan) Part of referenced CarePlan
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

... intent ?!SΣ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan

... Slices for category SΣ 1..* CodeableConcept Type of plan
Slice: Unordered, Open by pattern:$this
Binding: CarePlanCategory (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.


.... category:AssessPlan SΣ 1..1 CodeableConcept Type of plan
Binding: CarePlanCategory (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.



Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/careplan-category-tw
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: assess-plan
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... title Σ 0..1 string Human-friendly name for the care plan
... description Σ 0..1 string Summary of nature of plan
... subject SΣ 1..1 Reference(TW Core Patient S | Group) Who the care plan is for
... encounter Σ 0..1 Reference(TW Core Encounter) Encounter created as part of
... period Σ 0..1 Period Time period plan covers
... created Σ 0..1 dateTime Date record was first recorded
... author Σ 0..1 Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | TW Core Implantable Device | TW Core RelatedPerson | TW Core Organization | TW Core CareTeam) Who is the designated responsible party
... contributor 0..* Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | TW Core Implantable Device | TW Core RelatedPerson | TW Core Organization | TW Core CareTeam) Who provided the content of the care plan
... careTeam 0..* Reference(TW Core CareTeam) Who's involved in plan?
... addresses Σ 0..* Reference(TW Core 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 C 0..* BackboneElement Action to occur as part of plan
cpl-3: Provide a reference or detail, not both
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept 0..* CodeableConcept Results of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.


.... outcomeReference 0..* Reference(Resource) Appointment, Encounter, Procedure, etc.
.... progress 0..* Annotation Comments about the activity status/progress
.... reference C 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | TW Core MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
.... detail C 0..1 BackboneElement In-line definition of activity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... kind 0..1 code Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.

..... instantiatesCanonical 0..* canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) Instantiates FHIR protocol or definition
..... instantiatesUri 0..* uri Instantiates external protocol or definition
..... code 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

..... reasonCode 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (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.


..... reasonReference 0..* Reference(TW Core Condition | TW Core Observation Clinical Result | TW Core DiagnosticReport | TW Core DocumentReference) Why activity is needed
..... goal 0..* Reference(Goal) Goals this activity relates to
..... status ?! 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.

..... statusReason 0..1 CodeableConcept Reason for current status
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
..... scheduled[x] 0..1 When activity is to occur
...... scheduledTiming Timing
...... scheduledPeriod Period
...... scheduledString string
..... location 0..1 Reference(TW Core Location) Where it should happen
..... performer 0..* Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core RelatedPerson | TW Core Patient | TW Core CareTeam | HealthcareService | TW Core Implantable Device) Who will be responsible?
..... Slices for product[x] 0..1 What is to be administered/supplied
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.

...... productCodeableConcept CodeableConcept
...... productReference Reference(Medication | Substance)
...... product[x]:productReference 0..1 Reference(TW Core Medication | Substance) What is to be administered/supplied
..... dailyAmount 0..1 SimpleQuantity How to consume/day?
..... quantity 0..1 SimpleQuantity How much to administer/supply/consume
..... description 0..1 string Extra info describing activity to perform
... note 0..* Annotation Comments about the plan

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CarePlan.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
CarePlan.text.statusrequiredTWNarrativeStatus
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/narrative-status
from this IG
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent
from the FHIR Standard
CarePlan.categoryexampleCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard
CarePlan.category:AssessPlanexamplePattern: assess-plan
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
http://hl7.org/fhir/ValueSet/care-plan-activity-outcome
from the FHIR Standard
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1
from the FHIR Standard
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
from the FHIR Standard
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpl-3errorCarePlan.activityProvide a reference or detail, not both
: detail.empty() or reference.empty()
dom-2errorCarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCarePlanIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCarePlanIf 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-5errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCarePlanA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
txt-1errorCarePlan.text.divThe narrative SHALL contain only the basic html formatting elements and 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
: htmlChecks()
txt-2errorCarePlan.text.divThe narrative SHALL have some non-whitespace content
: htmlChecks()

This structure is derived from CarePlan

Summary

Mandatory: 2 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of CarePlan.category
  • The element 1 is sliced based on the value of CarePlan.activity.detail.product[x]

Differential View

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan CarePlan
... text S 0..1 Narrative CarePlan Resource之內容摘要以供人閱讀
.... status S 1..1 code generated | additional
Binding: 臺灣衛福部資訊處Narrative狀態值集 (required): Constrained value set of narrative statuses.

.... div S 1..1 xhtml Limited xhtml content
... basedOn 0..* Reference(TW Core CarePlan) Fulfills CarePlan
... replaces 0..* Reference(TW Core CarePlan) CarePlan replaced by this CarePlan
... status S 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

... intent S 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan

... Slices for category S 1..* CodeableConcept Type of plan
Slice: Unordered, Open by pattern:$this
.... category:AssessPlan S 1..1 CodeableConcept Type of plan
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/careplan-category-tw
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: assess-plan
... subject S 1..1 Reference(TW Core Patient S | Group) Who the care plan is for
... encounter 0..1 Reference(TW Core Encounter) Encounter created as part of
... author 0..1 Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | TW Core Implantable Device | TW Core RelatedPerson | TW Core Organization | TW Core CareTeam) Who is the designated responsible party
... contributor 0..* Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | TW Core Implantable Device | TW Core RelatedPerson | TW Core Organization | TW Core CareTeam) Who provided the content of the care plan
... careTeam 0..* Reference(TW Core CareTeam) Who's involved in plan?
... addresses 0..* Reference(TW Core Condition) Health issues this plan addresses
... activity
.... reference 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | TW Core MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
.... detail
..... reasonReference 0..* Reference(TW Core Condition | TW Core Observation Clinical Result | TW Core DiagnosticReport | TW Core DocumentReference) Why activity is needed
..... location 0..1 Reference(TW Core Location) Where it should happen
..... performer 0..* Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core RelatedPerson | TW Core Patient | TW Core CareTeam | HealthcareService | TW Core Implantable Device) Who will be responsible?
..... Slices for product[x] 0..1 CodeableConcept, Reference(Medication | Substance) What is to be administered/supplied
Slice: Unordered, Open by type:$this
...... product[x]:productReference 0..1 Reference(TW Core Medication | Substance) What is to be administered/supplied

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
CarePlan.text.statusrequiredTWNarrativeStatus
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/narrative-status
from this IG
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text S 0..1 Narrative CarePlan Resource之內容摘要以供人閱讀
.... status S 1..1 code generated | additional
Binding: 臺灣衛福部資訊處Narrative狀態值集 (required): Constrained value set of narrative statuses.

.... div SC 1..1 xhtml Limited xhtml content
txt-1: The narrative SHALL contain only the basic html formatting elements and 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-2: The narrative SHALL have some non-whitespace content
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... replaces Σ 0..* Reference(TW Core CarePlan) CarePlan replaced by this CarePlan
... partOf Σ 0..* Reference(TW Core CarePlan) Part of referenced CarePlan
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

... intent ?!SΣ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan

... Slices for category SΣ 1..* CodeableConcept Type of plan
Slice: Unordered, Open by pattern:$this
Binding: CarePlanCategory (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.


.... category:AssessPlan SΣ 1..1 CodeableConcept Type of plan
Binding: CarePlanCategory (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.



Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/careplan-category-tw
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: assess-plan
... subject SΣ 1..1 Reference(TW Core Patient) Who the care plan is for
... encounter Σ 0..1 Reference(TW Core Encounter) Encounter created as part of
... author Σ 0..1 Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | TW Core Implantable Device | TW Core RelatedPerson | TW Core Organization | TW Core CareTeam) Who is the designated responsible party
... contributor 0..* Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | TW Core Implantable Device | TW Core RelatedPerson | TW Core Organization | TW Core CareTeam) Who provided the content of the care plan
... careTeam 0..* Reference(TW Core CareTeam) Who's involved in plan?
... addresses Σ 0..* Reference(TW Core Condition) Health issues this plan addresses

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CarePlan.text.statusrequiredTWNarrativeStatus
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/narrative-status
from this IG
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent
from the FHIR Standard
CarePlan.categoryexampleCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard
CarePlan.category:AssessPlanexamplePattern: assess-plan
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCarePlanIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCarePlanIf 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-5errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCarePlanA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
txt-1errorCarePlan.text.divThe narrative SHALL contain only the basic html formatting elements and 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
: htmlChecks()
txt-2errorCarePlan.text.divThe narrative SHALL have some non-whitespace content
: htmlChecks()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text S 0..1 Narrative CarePlan Resource之內容摘要以供人閱讀
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... status S 1..1 code generated | additional
Binding: 臺灣衛福部資訊處Narrative狀態值集 (required): Constrained value set of narrative statuses.

.... div SC 1..1 xhtml Limited xhtml content
txt-1: The narrative SHALL contain only the basic html formatting elements and 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-2: The narrative SHALL have some non-whitespace content
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this plan
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(TW Core CarePlan) Fulfills CarePlan
... replaces Σ 0..* Reference(TW Core CarePlan) CarePlan replaced by this CarePlan
... partOf Σ 0..* Reference(TW Core CarePlan) Part of referenced CarePlan
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

... intent ?!SΣ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan

... Slices for category SΣ 1..* CodeableConcept Type of plan
Slice: Unordered, Open by pattern:$this
Binding: CarePlanCategory (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.


.... category:AssessPlan SΣ 1..1 CodeableConcept Type of plan
Binding: CarePlanCategory (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.



Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/careplan-category-tw
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: assess-plan
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... title Σ 0..1 string Human-friendly name for the care plan
... description Σ 0..1 string Summary of nature of plan
... subject SΣ 1..1 Reference(TW Core Patient S | Group) Who the care plan is for
... encounter Σ 0..1 Reference(TW Core Encounter) Encounter created as part of
... period Σ 0..1 Period Time period plan covers
... created Σ 0..1 dateTime Date record was first recorded
... author Σ 0..1 Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | TW Core Implantable Device | TW Core RelatedPerson | TW Core Organization | TW Core CareTeam) Who is the designated responsible party
... contributor 0..* Reference(TW Core Patient | TW Core Practitioner | TW Core PractitionerRole | TW Core Implantable Device | TW Core RelatedPerson | TW Core Organization | TW Core CareTeam) Who provided the content of the care plan
... careTeam 0..* Reference(TW Core CareTeam) Who's involved in plan?
... addresses Σ 0..* Reference(TW Core 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 C 0..* BackboneElement Action to occur as part of plan
cpl-3: Provide a reference or detail, not both
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept 0..* CodeableConcept Results of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.


.... outcomeReference 0..* Reference(Resource) Appointment, Encounter, Procedure, etc.
.... progress 0..* Annotation Comments about the activity status/progress
.... reference C 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | TW Core MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
.... detail C 0..1 BackboneElement In-line definition of activity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... kind 0..1 code Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.

..... instantiatesCanonical 0..* canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) Instantiates FHIR protocol or definition
..... instantiatesUri 0..* uri Instantiates external protocol or definition
..... code 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

..... reasonCode 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (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.


..... reasonReference 0..* Reference(TW Core Condition | TW Core Observation Clinical Result | TW Core DiagnosticReport | TW Core DocumentReference) Why activity is needed
..... goal 0..* Reference(Goal) Goals this activity relates to
..... status ?! 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.

..... statusReason 0..1 CodeableConcept Reason for current status
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
..... scheduled[x] 0..1 When activity is to occur
...... scheduledTiming Timing
...... scheduledPeriod Period
...... scheduledString string
..... location 0..1 Reference(TW Core Location) Where it should happen
..... performer 0..* Reference(TW Core Practitioner | TW Core PractitionerRole | TW Core Organization | TW Core RelatedPerson | TW Core Patient | TW Core CareTeam | HealthcareService | TW Core Implantable Device) Who will be responsible?
..... Slices for product[x] 0..1 What is to be administered/supplied
Slice: Unordered, Open by type:$this
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.

...... productCodeableConcept CodeableConcept
...... productReference Reference(Medication | Substance)
...... product[x]:productReference 0..1 Reference(TW Core Medication | Substance) What is to be administered/supplied
..... dailyAmount 0..1 SimpleQuantity How to consume/day?
..... quantity 0..1 SimpleQuantity How much to administer/supply/consume
..... description 0..1 string Extra info describing activity to perform
... note 0..* Annotation Comments about the plan

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CarePlan.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
CarePlan.text.statusrequiredTWNarrativeStatus
https://twcore.mohw.gov.tw/ig/twcore/ValueSet/narrative-status
from this IG
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent
from the FHIR Standard
CarePlan.categoryexampleCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard
CarePlan.category:AssessPlanexamplePattern: assess-plan
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
http://hl7.org/fhir/ValueSet/care-plan-activity-outcome
from the FHIR Standard
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1
from the FHIR Standard
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
from the FHIR Standard
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpl-3errorCarePlan.activityProvide a reference or detail, not both
: detail.empty() or reference.empty()
dom-2errorCarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCarePlanIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCarePlanIf 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-5errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCarePlanA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
txt-1errorCarePlan.text.divThe narrative SHALL contain only the basic html formatting elements and 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
: htmlChecks()
txt-2errorCarePlan.text.divThe narrative SHALL have some non-whitespace content
: htmlChecks()

This structure is derived from CarePlan

Summary

Mandatory: 2 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of CarePlan.category
  • The element 1 is sliced based on the value of CarePlan.activity.detail.product[x]

 

Other representations of profile: CSV, Excel, Schematron

Notes:

以下概述了此Profile所需的RESTful FHIR互動功能。有關TW Core IG支援的RESTful互動功能的完整清單，請參閱TW Core Server能力聲明。

必須支援以下查詢參數：

  1. 必須（SHALL） 支援透過查詢參數 patient 及 category 查詢所有CarePlan：
    (如何透過reference查詢)
    (如何透過token查詢)
    GET [base]/CarePlan?patient={Type/}[id]&category=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/careplan-category-twy|assess-plan

    例子：
    (1) GET [base]/CarePlan?patient=Patient/pat-example&category=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/careplan-category-tw|assess-plan

建議應該支援以下查詢參數：

  1. 建議應該（SHOULD） 支援透過查詢參數 patient 、 category 及 date 查詢所有CarePlan：
    (如何透過reference查詢)
    (如何透過token查詢)
    (如何透過date查詢)
    GET [base]/CarePlan?patient={Type/}[id]&category=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/careplan-category-twy|assess-plan&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    例子：
    (1) GET [base]/CarePlan?patient=Patient/pat-example&category=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/careplan-category-tw|assess-plan&date=ge2019-01-01T00:00:00Z
    (2) GET [base]/CarePlan?patient=Patient/pat-example&category=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/careplan-category-tw|assess-plan&date=ge2018-01-01T00:00:00Z&date=le2019-01-01T00:00:00Z

  2. 建議應該（SHOULD） 支援透過查詢參數 patient 、 category 及 status 查詢所有CarePlan：
    (如何透過reference查詢)
    (如何透過token查詢)
    GET [base]/CarePlan?patient={Type/}[id]&category=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/careplan-category-twy|assess-plan&status={system|}[code]{,{system|}[code],...}

    例子：
    (1) GET [base]/CarePlan?patient=Patient/pat-example&category=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/careplan-category-tw|assess-plan&status=active

  3. 建議應該（SHOULD） 支援透過查詢參數 patient 、 category 、 status 及 date 查詢所有CarePlan：
    (如何透過reference查詢)
    (如何透過token查詢)
    (如何透過date查詢)
    GET [base]/CarePlan?patient={Type/}[id]&category=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/careplan-category-twy|assess-plan&status={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    例子：
    (1) GET [base]/CarePlan?patient=Patient/pat-example&category=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/careplan-category-tw|assess-plan&status=active&date=ge2019-01-01T00:00:00Z
    (2) GET [base]/CarePlan?patient=Patient/pat-example&category=https://twcore.mohw.gov.tw/ig/twcore/CodeSystem/careplan-category-tw|assess-plan&status=active&date=ge2018-01-01T00:00:00Z&date=le2019-01-01T00:00:00Z