HL7 FHIR JP Core ImplementationGuide
2.0.0-dev - ci-build
HL7 FHIR JP Core ImplementationGuide - Local Development build (v2.0.0-dev) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
項目 | 内容 |
定義URL | http://jpfhir.jp/fhir/core/StructureDefinition/JP_CarePlan |
Version | 2.0.0-dev |
Name | JP_CarePlan |
Title | JP Core CarePlan Profile |
Status | Draft ( 2022-10-24 ) |
Copyright | Copyright FHIR Japanese implementation research working group in Japan Association of Medical Informatics (JAMI) 一般社団法人日本医療情報学会NeXEHRS課題研究会FHIR日本実装検討WG |
このプロファイルはJP Core CarePlanリソースに対する共通の制約と拡張を定めたものである。
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CarePlan
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CarePlan | Healthcare plan for patient or group dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
Σ | 0..* | Reference(JP Core CarePlan Profile) | Fulfills CarePlan ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..* | Reference(JP Core CarePlan Profile) | CarePlan replaced by this CarePlan ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..* | Reference(JP Core CarePlan Profile) | Part of referenced CarePlan ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Reference(JP Core Patient Profile) | Who the care plan is for ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..1 | Reference(JP Core Encounter Profile) | Encounter created as part of ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..1 | Reference(Device | RelatedPerson | CareTeam | JP Core Patient Profile | JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile) | Who is the designated responsible party ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Reference(Device | RelatedPerson | CareTeam | JP Core Patient Profile | JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile) | Who provided the content of the care plan ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
Σ | 0..* | Reference(JP Core Condition Profile) | Health issues this plan addresses ele-1: All FHIR elements must have a @value or children |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | CarePlan | Healthcare plan for patient or group | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External Ids for this plan | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(JP Core CarePlan Profile) | Fulfills CarePlan | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(JP Core CarePlan Profile) | CarePlan replaced by this CarePlan | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(JP Core CarePlan Profile) | Part of referenced CarePlan | ||||
![]() ![]() ![]() |
?!Σ | 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. | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||
![]() ![]() ![]() |
Σ | 0..* | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Human-friendly name for the care plan | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Summary of nature of plan | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(JP Core Patient Profile) | Who the care plan is for | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(JP Core Encounter Profile) | Encounter created as part of | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period plan covers | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date record was first recorded | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Device | RelatedPerson | CareTeam | JP Core Patient Profile | JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile) | Who is the designated responsible party | ||||
![]() ![]() ![]() |
0..* | Reference(Device | RelatedPerson | CareTeam | JP Core Patient Profile | JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile) | Who provided the content of the care plan | |||||
![]() ![]() ![]() |
0..* | Reference(CareTeam) | Who's involved in plan? | |||||
![]() ![]() ![]() |
Σ | 0..* | Reference(JP Core Condition Profile) | Health issues this plan addresses | ||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Information considered as part of plan | |||||
![]() ![]() ![]() |
0..* | Reference(Goal) | Desired outcome of plan | |||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
![]() ![]() ![]() ![]() |
0..* | Annotation | Comments about the activity status/progress | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup | JP Core MedicationRequest Profile) | Activity details defined in specific resource | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | In-line definition of activity | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | uri | Instantiates external protocol or definition | |||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Reference(DocumentReference | JP Core Condition Profile | JP Core Observation Common Profile | JP Core DiagnosticReport Common Profile) | Why activity is needed | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Reference(Goal) | Goals this activity relates to | |||||
![]() ![]() ![]() ![]() ![]() |
?! | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Reason for current status | |||||
![]() ![]() ![]() ![]() ![]() |
?! | 0..1 | boolean | If true, activity is prohibiting action | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | When activity is to occur | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Location) | Where it should happen | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Reference(RelatedPerson | CareTeam | HealthcareService | Device | JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile | JP Core Patient Profile) | Who will be responsible? | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Substance | JP Core Medication Profile) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | How to consume/day? | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Extra info describing activity to perform | |||||
![]() ![]() ![]() |
0..* | Annotation | Comments about the plan | |||||
![]() |
Terminology Bindings
Path | Conformance | ValueSet | URI | |||
CarePlan.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.3.0 from the FHIR Standard | ||||
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.3.0 from the FHIR Standard | ||||
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard | ||||
CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcome from the FHIR Standard | ||||
CarePlan.activity.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.3.0 from the FHIR Standard | ||||
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | ||||
CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.3.0 from the FHIR Standard | ||||
CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard |
Constraints
Id | Grade | Path(s) | Details | Requirements |
cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CarePlan | If 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CarePlan | If 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-5 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CarePlan | A resource should have narrative for robust management : text.`div`.exists() | |
dom-r4b | warning | CarePlan.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CarePlan
Summary
Structures
This structure refers to these other structures:
Differential View
This structure is derived from CarePlan
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CarePlan | Healthcare plan for patient or group dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
Σ | 0..* | Reference(JP Core CarePlan Profile) | Fulfills CarePlan ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..* | Reference(JP Core CarePlan Profile) | CarePlan replaced by this CarePlan ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..* | Reference(JP Core CarePlan Profile) | Part of referenced CarePlan ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Reference(JP Core Patient Profile) | Who the care plan is for ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..1 | Reference(JP Core Encounter Profile) | Encounter created as part of ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 0..1 | Reference(Device | RelatedPerson | CareTeam | JP Core Patient Profile | JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile) | Who is the designated responsible party ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Reference(Device | RelatedPerson | CareTeam | JP Core Patient Profile | JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile) | Who provided the content of the care plan ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
Σ | 0..* | Reference(JP Core Condition Profile) | Health issues this plan addresses ele-1: All FHIR elements must have a @value or children |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | CarePlan | Healthcare plan for patient or group | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External Ids for this plan | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(JP Core CarePlan Profile) | Fulfills CarePlan | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(JP Core CarePlan Profile) | CarePlan replaced by this CarePlan | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(JP Core CarePlan Profile) | Part of referenced CarePlan | ||||
![]() ![]() ![]() |
?!Σ | 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. | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||
![]() ![]() ![]() |
Σ | 0..* | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Human-friendly name for the care plan | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Summary of nature of plan | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(JP Core Patient Profile) | Who the care plan is for | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(JP Core Encounter Profile) | Encounter created as part of | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period plan covers | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date record was first recorded | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Device | RelatedPerson | CareTeam | JP Core Patient Profile | JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile) | Who is the designated responsible party | ||||
![]() ![]() ![]() |
0..* | Reference(Device | RelatedPerson | CareTeam | JP Core Patient Profile | JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile) | Who provided the content of the care plan | |||||
![]() ![]() ![]() |
0..* | Reference(CareTeam) | Who's involved in plan? | |||||
![]() ![]() ![]() |
Σ | 0..* | Reference(JP Core Condition Profile) | Health issues this plan addresses | ||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Information considered as part of plan | |||||
![]() ![]() ![]() |
0..* | Reference(Goal) | Desired outcome of plan | |||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
![]() ![]() ![]() ![]() |
0..* | Annotation | Comments about the activity status/progress | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup | JP Core MedicationRequest Profile) | Activity details defined in specific resource | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | BackboneElement | In-line definition of activity | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | uri | Instantiates external protocol or definition | |||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Reference(DocumentReference | JP Core Condition Profile | JP Core Observation Common Profile | JP Core DiagnosticReport Common Profile) | Why activity is needed | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Reference(Goal) | Goals this activity relates to | |||||
![]() ![]() ![]() ![]() ![]() |
?! | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Reason for current status | |||||
![]() ![]() ![]() ![]() ![]() |
?! | 0..1 | boolean | If true, activity is prohibiting action | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | When activity is to occur | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Location) | Where it should happen | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Reference(RelatedPerson | CareTeam | HealthcareService | Device | JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile | JP Core Patient Profile) | Who will be responsible? | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Substance | JP Core Medication Profile) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | How to consume/day? | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Extra info describing activity to perform | |||||
![]() ![]() ![]() |
0..* | Annotation | Comments about the plan | |||||
![]() |
Terminology Bindings
Path | Conformance | ValueSet | URI | |||
CarePlan.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.3.0 from the FHIR Standard | ||||
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.3.0 from the FHIR Standard | ||||
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard | ||||
CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcome from the FHIR Standard | ||||
CarePlan.activity.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.3.0 from the FHIR Standard | ||||
CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | ||||
CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.3.0 from the FHIR Standard | ||||
CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard |
Constraints
Id | Grade | Path(s) | Details | Requirements |
cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CarePlan | If 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CarePlan | If 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-5 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CarePlan | A resource should have narrative for robust management : text.`div`.exists() | |
dom-r4b | warning | CarePlan.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CarePlan
Summary
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron