CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: CarePlanSe
| Official URL: https://fhir.cambio.se/StructureDefinition/CarePlanSe | Version: 1.0.0 | |||
| Active as of 2023-08-23 | Computable Name: CarePlanSe | |||
Introduction
The CarePlanSe profile is used to retrieve data about care plans in COSMIC.
Intended Use
The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API.
Must Support
The MustSupport-flag indicates which attributes are supported by Cambio, meaning that those can be returned as part of the care plan.
Specific Rules and Limitations
| Type | Description |
|---|---|
| Rule | The consumer of the API is responsible for making sure data retrieved is filtered in compliance with laws and regulations prior to presenting it to any end-users. |
| Rule | For reading careplans, the external system needs to be able to evaluate PDL. This means whether the information can be displayed for a healthcare professional with a specific assignment. PDL data needed (HSA care unit and HSA care provider) is retrieved by including the organization referenced from Careplan.author.PractitionerRoleLiteSe(PractitionerRole.organization.OrganizationSEVendorLite). |
| Limitation | This API can be used to find active care plans. Care plans that are completed or entered in error will not be returned. |
Versions
| COS version | Profile version | Required COSMIC version | Date | Description |
|---|---|---|---|---|
| 3.9.0 | 1.0.0 | 3.9.0 | September 2023 | Initial version, support for GET and search. |
APIs & Supported Operations
| HTTP Method | Description |
|---|---|
| GET | Used to retrieve a care plan. |
Search Parameters
| Parameter | Format | Mandatory | Comment |
|---|---|---|---|
subject |
string | Mandatory | The subject that the care plan is about. |
_profile |
string | Optional | Canonical url for specific profile (https://fhir.cambio.se/StructureDefinition/CarePlanSe) |
category |
string | Optional | The care plan's category. |
Supported Queries
GET [baseURL]/CarePlanSe?subject.identifier=[patientIdentifier]
Supported _include params
CarePlan:supportingInfoCarePlan:contributorCarePlan:subjectCarePlan:author.organizationCarePlan:author.practitioner
Error Codes
| Code | Description | Comment |
|---|---|---|
| 400 | Invalid payloads |
Usages:
- CapabilityStatements using this Profile: Cambio Open Services
- This Profile is not used by any profiles in this Implementation Guide
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  CarePlan |
0..* | CarePlanCore | Healthcare plan for patient or group | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | Indicates whether the plan is currently being acted upon or is now a historical record. Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. |
| intent |
?!Σ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. Fixed Value: plan |
  Slices for category |
Σ | 1..1 | CodeableConcept | Type of plan. Can be standardized or individual. Slice: Unordered, Open by value:coding.code Binding: CarePlanCategory (required): Identifies what "kind" of plan this is. |
   category:standardized |
Σ | 0..1 | CodeableConcept | Type of plan Binding: CarePlanCategory (required) |
 category:individual |
Σ | 0..1 | CodeableConcept | Type of plan Binding: CarePlanCategory (required) |
| title |
SΣ | 0..1 | string | Human-friendly name for the care plan |
 subject |
Σ | 1..1 | Reference(Patient) | Who the care plan is for |
| encounter |
SΣ | 0..1 | Reference(Encounter) | Encounter created as part of |
| created |
SΣ | 0..1 | dateTime | Date record was first recorded |
| author |
Σ | 0..1 | Reference(PractitionerRoleLiteSe) | Who is the designated responsible party |
| addresses |
SΣ | 0..* | Reference(Condition) | Health issues this plan addresses |
| goal |
S | 0..* | Reference(Goal) | Desired outcome of plan |
  activity |
SC | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 outcomeReference |
S | 0..* | Reference(Procedure) | Clinical information recorded for the activity. |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| CarePlan.intent | required | Fixed Value: planhttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1From the FHIR Standard | |
| CarePlan.category | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG | |
| CarePlan.category:standardized | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG | |
| CarePlan.category:individual | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG | |
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1From 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 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-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() | |
| 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 CarePlanCore
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlanCore | Healthcare plan for patient or group | |
 identifier |
0..0 | |||
| instantiatesCanonical |
0..0 | |||
| instantiatesUri |
0..0 | |||
| basedOn |
0..0 | |||
| replaces |
0..0 | |||
| partOf |
0..0 | |||
| status |
1..1 | code | Indicates whether the plan is currently being acted upon or is now a historical record. | |
| intent |
1..1 | code | proposal | plan | order | option Fixed Value: plan | |
| Slices for category |
1..1 | CodeableConcept | Type of plan. Can be standardized or individual. Slice: Unordered, Open by value:coding.code Binding: CarePlanCategory (required): Identifies what "kind" of plan this is. | |
 category:standardized |
0..1 | CodeableConcept | Type of plan Binding: CarePlanCategory (required) | |
  coding |
||||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/care-plan-category | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: SVP | |
 category:individual |
0..1 | CodeableConcept | Type of plan Binding: CarePlanCategory (required) | |
| coding |
||||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/care-plan-category | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IP | |
| title |
S | 0..1 | string | Human-friendly name for the care plan |
| description |
0..0 | |||
| subject |
1..1 | Reference(Patient) | Who the care plan is for | |
| encounter |
S | 0..1 | Reference(Encounter) | Encounter created as part of |
| created |
S | 0..1 | dateTime | Date record was first recorded |
| author |
0..1 | Reference(PractitionerRoleLiteSe) | Who is the designated responsible party | |
| contributor |
0..0 | |||
| careTeam |
0..0 | |||
| addresses |
S | 0..* | Reference(Condition) | Health issues this plan addresses |
| supportingInfo |
0..0 | |||
| goal |
S | 0..* | Reference(Goal) | Desired outcome of plan |
| activity |
S | 0..* | BackboneElement | Action to occur as part of plan |
| outcomeCodeableConcept |
0..0 | |||
| outcomeReference |
S | 0..* | Reference(Procedure) | Clinical information recorded for the activity. |
| progress |
0..0 | |||
| reference |
0..0 | |||
| detail |
0..0 | |||
| note |
0..0 | |||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| CarePlan.category | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG | |
| CarePlan.category:standardized | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG | |
| CarePlan.category:individual | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| CarePlan |
0..* | CarePlanCore | 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| status |
?!Σ | 1..1 | code | Indicates whether the plan is currently being acted upon or is now a historical record. Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | ||||
| intent |
?!Σ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. Fixed Value: plan | ||||
| Slices for category |
Σ | 1..1 | CodeableConcept | Type of plan. Can be standardized or individual. Slice: Unordered, Open by value:coding.code Binding: CarePlanCategory (required): Identifies what "kind" of plan this is. | ||||
| category:standardized |
Σ | 0..1 | CodeableConcept | Type of plan Binding: CarePlanCategory (required) | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
 coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/care-plan-category | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SVP | ||||
| 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 | ||||
| category:individual |
Σ | 0..1 | CodeableConcept | Type of plan Binding: CarePlanCategory (required) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/care-plan-category | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: IP | ||||
| 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 |
SΣ | 0..1 | string | Human-friendly name for the care plan | ||||
| subject |
Σ | 1..1 | Reference(Patient) | Who the care plan is for | ||||
| encounter |
SΣ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| created |
SΣ | 0..1 | dateTime | Date record was first recorded | ||||
| author |
Σ | 0..1 | Reference(PractitionerRoleLiteSe) | Who is the designated responsible party | ||||
| addresses |
SΣ | 0..* | Reference(Condition) | Health issues this plan addresses | ||||
| goal |
S | 0..* | Reference(Goal) | Desired outcome of plan | ||||
| activity |
SC | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 | ||||
| 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 | ||||
| outcomeReference |
S | 0..* | Reference(Procedure) | Clinical information recorded for the activity. | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| CarePlan.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | ||||
| CarePlan.intent | required | Fixed Value: planhttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1From the FHIR Standard | ||||
| CarePlan.category | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG | ||||
| CarePlan.category:standardized | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG | ||||
| CarePlan.category:individual | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG | ||||
| CarePlan.activity.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1From the FHIR Standard | ||||
| CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codeFrom the FHIR Standard | ||||
| CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsFrom the FHIR Standard | ||||
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1From the FHIR Standard | ||||
| CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesFrom 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 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-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() | |
| 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 CarePlanCore
Summary
Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 7 elements
Fixed: 5 elements
Prohibited: 15 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlanCore | Healthcare plan for patient or group | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | Indicates whether the plan is currently being acted upon or is now a historical record. Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. |
| intent |
?!Σ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. Fixed Value: plan |
| Slices for category |
Σ | 1..1 | CodeableConcept | Type of plan. Can be standardized or individual. Slice: Unordered, Open by value:coding.code Binding: CarePlanCategory (required): Identifies what "kind" of plan this is. |
| category:standardized |
Σ | 0..1 | CodeableConcept | Type of plan Binding: CarePlanCategory (required) |
| category:individual |
Σ | 0..1 | CodeableConcept | Type of plan Binding: CarePlanCategory (required) |
| title |
SΣ | 0..1 | string | Human-friendly name for the care plan |
| subject |
Σ | 1..1 | Reference(Patient) | Who the care plan is for |
| encounter |
SΣ | 0..1 | Reference(Encounter) | Encounter created as part of |
| created |
SΣ | 0..1 | dateTime | Date record was first recorded |
| author |
Σ | 0..1 | Reference(PractitionerRoleLiteSe) | Who is the designated responsible party |
| addresses |
SΣ | 0..* | Reference(Condition) | Health issues this plan addresses |
| goal |
S | 0..* | Reference(Goal) | Desired outcome of plan |
| activity |
SC | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| outcomeReference |
S | 0..* | Reference(Procedure) | Clinical information recorded for the activity. |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | |
| CarePlan.intent | required | Fixed Value: planhttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1From the FHIR Standard | |
| CarePlan.category | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG | |
| CarePlan.category:standardized | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG | |
| CarePlan.category:individual | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG | |
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1From 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 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-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() | |
| 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() |
Differential View
This structure is derived from CarePlanCore
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlanCore | Healthcare plan for patient or group | |
| identifier |
0..0 | |||
| instantiatesCanonical |
0..0 | |||
| instantiatesUri |
0..0 | |||
| basedOn |
0..0 | |||
| replaces |
0..0 | |||
| partOf |
0..0 | |||
| status |
1..1 | code | Indicates whether the plan is currently being acted upon or is now a historical record. | |
| intent |
1..1 | code | proposal | plan | order | option Fixed Value: plan | |
| Slices for category |
1..1 | CodeableConcept | Type of plan. Can be standardized or individual. Slice: Unordered, Open by value:coding.code Binding: CarePlanCategory (required): Identifies what "kind" of plan this is. | |
| category:standardized |
0..1 | CodeableConcept | Type of plan Binding: CarePlanCategory (required) | |
| coding |
||||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/care-plan-category | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: SVP | |
| category:individual |
0..1 | CodeableConcept | Type of plan Binding: CarePlanCategory (required) | |
| coding |
||||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/care-plan-category | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IP | |
| title |
S | 0..1 | string | Human-friendly name for the care plan |
| description |
0..0 | |||
| subject |
1..1 | Reference(Patient) | Who the care plan is for | |
| encounter |
S | 0..1 | Reference(Encounter) | Encounter created as part of |
| created |
S | 0..1 | dateTime | Date record was first recorded |
| author |
0..1 | Reference(PractitionerRoleLiteSe) | Who is the designated responsible party | |
| contributor |
0..0 | |||
| careTeam |
0..0 | |||
| addresses |
S | 0..* | Reference(Condition) | Health issues this plan addresses |
| supportingInfo |
0..0 | |||
| goal |
S | 0..* | Reference(Goal) | Desired outcome of plan |
| activity |
S | 0..* | BackboneElement | Action to occur as part of plan |
| outcomeCodeableConcept |
0..0 | |||
| outcomeReference |
S | 0..* | Reference(Procedure) | Clinical information recorded for the activity. |
| progress |
0..0 | |||
| reference |
0..0 | |||
| detail |
0..0 | |||
| note |
0..0 | |||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet | URI |
| CarePlan.category | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG | |
| CarePlan.category:standardized | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG | |
| CarePlan.category:individual | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| CarePlan |
0..* | CarePlanCore | 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| status |
?!Σ | 1..1 | code | Indicates whether the plan is currently being acted upon or is now a historical record. Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | ||||
| intent |
?!Σ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. Fixed Value: plan | ||||
| Slices for category |
Σ | 1..1 | CodeableConcept | Type of plan. Can be standardized or individual. Slice: Unordered, Open by value:coding.code Binding: CarePlanCategory (required): Identifies what "kind" of plan this is. | ||||
| category:standardized |
Σ | 0..1 | CodeableConcept | Type of plan Binding: CarePlanCategory (required) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/care-plan-category | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SVP | ||||
| 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 | ||||
| category:individual |
Σ | 0..1 | CodeableConcept | Type of plan Binding: CarePlanCategory (required) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: https://cambio.codes/cs/care-plan-category | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: IP | ||||
| 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 |
SΣ | 0..1 | string | Human-friendly name for the care plan | ||||
| subject |
Σ | 1..1 | Reference(Patient) | Who the care plan is for | ||||
| encounter |
SΣ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| created |
SΣ | 0..1 | dateTime | Date record was first recorded | ||||
| author |
Σ | 0..1 | Reference(PractitionerRoleLiteSe) | Who is the designated responsible party | ||||
| addresses |
SΣ | 0..* | Reference(Condition) | Health issues this plan addresses | ||||
| goal |
S | 0..* | Reference(Goal) | Desired outcome of plan | ||||
| activity |
SC | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 | ||||
| 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 | ||||
| outcomeReference |
S | 0..* | Reference(Procedure) | Clinical information recorded for the activity. | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| CarePlan.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1From the FHIR Standard | ||||
| CarePlan.intent | required | Fixed Value: planhttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1From the FHIR Standard | ||||
| CarePlan.category | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG | ||||
| CarePlan.category:standardized | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG | ||||
| CarePlan.category:individual | required | CarePlanCategoryhttps://fhir.cambio.se/ValueSet/CarePlanCategoryFrom this IG | ||||
| CarePlan.activity.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1From the FHIR Standard | ||||
| CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codeFrom the FHIR Standard | ||||
| CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsFrom the FHIR Standard | ||||
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1From the FHIR Standard | ||||
| CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesFrom 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 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-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() | |
| 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 CarePlanCore
Summary
Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 7 elements
Fixed: 5 elements
Prohibited: 15 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
Other representations of profile: CSV, Excel, Schematron