Finnish Base Profiles
0.2.0 - ci-build
Finnish Base Profiles - Local Development build (v0.2.0). See the Directory of published versions
Official URL: http://phr.kanta.fi/StructureDefinition/fiphr-sd-selfcareplan-r4 | Version: 0.2.0 | |||
Draft as of 2020-02-04 | Computable Name: FIPHRSDCarePlan |
StructureDefinition for FinnishPHR SelfCarePlan resource.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CarePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Self-care plan for patient | |
meta | ||||
Slices for profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | |
profile:fiphrProfile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-selfcareplan-r4 | |
language | 1..1 | code | Language of the resource content Binding: CommonLanguages (required): Finnish PHR: A code of human language. | |
text | 1..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..0 | |||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
creatingApplication | 0..1 | (Complex) | Additional Content defined by implementations URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication | |
identifier | 1..* | Identifier | External Ids for this plan | |
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
assigner | 0..0 | |||
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
basedOn | 0..0 | |||
replaces | 0..0 | |||
partOf | 0..0 | |||
status | 1..1 | code | In Finnish PHR completed is the only accepted value. Fixed Value: completed | |
intent | 1..1 | code | proposal | plan | order | option Fixed Value: plan | |
category | 1..1 | CodeableConcept | Type of plan Binding: Finnish PHR CarePlan Category value set (extensible): Identifies what "kind" of self-care plan this is to support differentiation between multiple co-existing plans. | |
Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:fiphrCoding | 1..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-careplancategory | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
title | 1..1 | string | Human-friendly name for the care plan | |
description | 1..1 | string | Summary of nature of plan | |
subject | 1..1 | Reference(Finnish PHR Patient profile) {r} | Who the care plan is for | |
reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
identifier | ||||
assigner | 0..0 | |||
encounter | 0..0 | |||
author | 1..1 | Reference(Finnish PHR Patient profile) {r} | Who is the designated responsible party | |
reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
identifier | ||||
assigner | 0..0 | |||
contributor | 0..0 | |||
careTeam | 0..0 | |||
addresses | 0..0 | |||
supportingInfo | 0..* | Reference(Finnish PHR QuestionnaireResponse profile) | Information considered as part of plan | |
reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
identifier | ||||
assigner | 0..0 | |||
goal | 0..0 | |||
activity | 0..0 | |||
note | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet |
CarePlan.language | required | CommonLanguages |
CarePlan.category | extensible | fiphr-vs-careplancategory |
CarePlan.activity.detail.code | required | http://phr.kanta.fi/ValueSet/fiphr-vs-activitycode |
CarePlan.activity.detail.reasonCode | required | http://phr.kanta.fi/ValueSet/fiphr-vs-reminderid |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Self-care plan for patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 1..1 | code | Language of the resource content Binding: CommonLanguages (required): Finnish PHR: A code of human language. | |
text | 1..1 | Narrative | Text summary of the resource, for human interpretation | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
creatingApplication | 0..1 | (Complex) | Additional Content defined by implementations URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..* | Identifier | External Ids for this plan |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!Σ | 1..1 | code | In Finnish PHR completed is the only accepted value. Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. Fixed Value: completed |
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 |
category | Σ | 1..1 | CodeableConcept | Type of plan Binding: Finnish PHR CarePlan Category value set (extensible): Identifies what "kind" of self-care plan this is to support differentiation between multiple co-existing plans. |
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:fiphrCoding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-careplancategory |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
title | Σ | 1..1 | string | Human-friendly name for the care plan |
description | Σ | 1..1 | string | Summary of nature of plan |
subject | Σ | 1..1 | Reference(Finnish PHR Patient profile) {r} | Who the care plan is for |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
author | Σ | 1..1 | Reference(Finnish PHR Patient profile) {r} | Who is the designated responsible party |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
supportingInfo | 0..* | Reference(Finnish PHR QuestionnaireResponse profile) | Information considered as part of plan | |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
Documentation for this format |
Path | Conformance | ValueSet / Code |
CarePlan.language | required | CommonLanguages |
CarePlan.identifier.use | required | IdentifierUse |
CarePlan.status | required | Fixed Value: completed |
CarePlan.intent | required | Fixed Value: plan |
CarePlan.category | extensible | fiphr-vs-careplancategory |
CarePlan.activity.detail.kind | required | CarePlanActivityKind |
CarePlan.activity.detail.code | required | http://phr.kanta.fi/ValueSet/fiphr-vs-activitycode |
CarePlan.activity.detail.reasonCode | required | http://phr.kanta.fi/ValueSet/fiphr-vs-reminderid |
CarePlan.activity.detail.status | required | CarePlanActivityStatus |
Id | Grade | Path(s) | Details | Requirements |
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() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Self-care plan for patient | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the 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 | |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
source | Σ | 0..1 | uri | Identifies where the resource comes from |
Slices for profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this |
profile:fiphrProfile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-selfcareplan-r4 |
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 1..1 | code | Language of the resource content Binding: CommonLanguages (required): Finnish PHR: A code of human language. | |
text | 1..1 | Narrative | Text summary of the resource, for human interpretation | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
creatingApplication | 0..1 | (Complex) | Additional Content defined by implementations URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..* | Identifier | External Ids for this plan |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
status | ?!Σ | 1..1 | code | In Finnish PHR completed is the only accepted value. Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. Fixed Value: completed |
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 |
category | Σ | 1..1 | CodeableConcept | Type of plan Binding: Finnish PHR CarePlan Category value set (extensible): Identifies what "kind" of self-care plan this is to support differentiation between multiple co-existing plans. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:fiphrCoding | Σ | 1..1 | 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 | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-careplancategory |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..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 | Σ | 1..1 | string | Human-friendly name for the care plan |
description | Σ | 1..1 | string | Summary of nature of plan |
subject | Σ | 1..1 | Reference(Finnish PHR Patient profile) {r} | Who the care plan is for |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
display | Σ | 0..1 | string | Text alternative for the resource |
period | Σ | 0..1 | Period | Time period plan covers |
created | Σ | 0..1 | dateTime | Date record was first recorded |
author | Σ | 1..1 | Reference(Finnish PHR Patient profile) {r} | Who is the designated responsible party |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
display | Σ | 0..1 | string | Text alternative for the resource |
supportingInfo | 0..* | Reference(Finnish PHR QuestionnaireResponse profile) | Information considered as part of plan | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
display | Σ | 0..1 | string | Text alternative for the resource |
Documentation for this format |
Path | Conformance | ValueSet / Code |
CarePlan.meta.security | extensible | All Security Labels |
CarePlan.meta.tag | example | CommonTags |
CarePlan.language | required | CommonLanguages |
CarePlan.identifier.use | required | IdentifierUse |
CarePlan.identifier.type | extensible | Identifier Type Codes |
CarePlan.status | required | Fixed Value: completed |
CarePlan.intent | required | Fixed Value: plan |
CarePlan.category | extensible | fiphr-vs-careplancategory |
CarePlan.subject.type | extensible | ResourceType |
CarePlan.subject.identifier.use | required | IdentifierUse |
CarePlan.subject.identifier.type | extensible | Identifier Type Codes |
CarePlan.author.type | extensible | ResourceType |
CarePlan.author.identifier.use | required | IdentifierUse |
CarePlan.author.identifier.type | extensible | Identifier Type Codes |
CarePlan.supportingInfo.type | extensible | ResourceType |
CarePlan.supportingInfo.identifier.use | required | IdentifierUse |
CarePlan.supportingInfo.identifier.type | extensible | Identifier Type Codes |
CarePlan.goal.type | extensible | ResourceType |
CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcome |
CarePlan.activity.detail.kind | required | CarePlanActivityKind |
CarePlan.activity.detail.code | required | http://phr.kanta.fi/ValueSet/fiphr-vs-activitycode |
CarePlan.activity.detail.reasonCode | required | http://phr.kanta.fi/ValueSet/fiphr-vs-reminderid |
CarePlan.activity.detail.status | required | CarePlanActivityStatus |
Id | Grade | Path(s) | Details | Requirements |
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
Mandatory: 16 elements (15 nested mandatory elements)
Fixed Value: 4 elements
Prohibited: 31 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CarePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Self-care plan for patient | |
meta | ||||
Slices for profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | |
profile:fiphrProfile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-selfcareplan-r4 | |
language | 1..1 | code | Language of the resource content Binding: CommonLanguages (required): Finnish PHR: A code of human language. | |
text | 1..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..0 | |||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
creatingApplication | 0..1 | (Complex) | Additional Content defined by implementations URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication | |
identifier | 1..* | Identifier | External Ids for this plan | |
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
assigner | 0..0 | |||
instantiatesCanonical | 0..0 | |||
instantiatesUri | 0..0 | |||
basedOn | 0..0 | |||
replaces | 0..0 | |||
partOf | 0..0 | |||
status | 1..1 | code | In Finnish PHR completed is the only accepted value. Fixed Value: completed | |
intent | 1..1 | code | proposal | plan | order | option Fixed Value: plan | |
category | 1..1 | CodeableConcept | Type of plan Binding: Finnish PHR CarePlan Category value set (extensible): Identifies what "kind" of self-care plan this is to support differentiation between multiple co-existing plans. | |
Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:fiphrCoding | 1..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-careplancategory | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
title | 1..1 | string | Human-friendly name for the care plan | |
description | 1..1 | string | Summary of nature of plan | |
subject | 1..1 | Reference(Finnish PHR Patient profile) {r} | Who the care plan is for | |
reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
identifier | ||||
assigner | 0..0 | |||
encounter | 0..0 | |||
author | 1..1 | Reference(Finnish PHR Patient profile) {r} | Who is the designated responsible party | |
reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
identifier | ||||
assigner | 0..0 | |||
contributor | 0..0 | |||
careTeam | 0..0 | |||
addresses | 0..0 | |||
supportingInfo | 0..* | Reference(Finnish PHR QuestionnaireResponse profile) | Information considered as part of plan | |
reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |
identifier | ||||
assigner | 0..0 | |||
goal | 0..0 | |||
activity | 0..0 | |||
note | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet |
CarePlan.language | required | CommonLanguages |
CarePlan.category | extensible | fiphr-vs-careplancategory |
CarePlan.activity.detail.code | required | http://phr.kanta.fi/ValueSet/fiphr-vs-activitycode |
CarePlan.activity.detail.reasonCode | required | http://phr.kanta.fi/ValueSet/fiphr-vs-reminderid |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Self-care plan for patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 1..1 | code | Language of the resource content Binding: CommonLanguages (required): Finnish PHR: A code of human language. | |
text | 1..1 | Narrative | Text summary of the resource, for human interpretation | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
creatingApplication | 0..1 | (Complex) | Additional Content defined by implementations URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..* | Identifier | External Ids for this plan |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!Σ | 1..1 | code | In Finnish PHR completed is the only accepted value. Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. Fixed Value: completed |
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 |
category | Σ | 1..1 | CodeableConcept | Type of plan Binding: Finnish PHR CarePlan Category value set (extensible): Identifies what "kind" of self-care plan this is to support differentiation between multiple co-existing plans. |
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:fiphrCoding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-careplancategory |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
title | Σ | 1..1 | string | Human-friendly name for the care plan |
description | Σ | 1..1 | string | Summary of nature of plan |
subject | Σ | 1..1 | Reference(Finnish PHR Patient profile) {r} | Who the care plan is for |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
author | Σ | 1..1 | Reference(Finnish PHR Patient profile) {r} | Who is the designated responsible party |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
supportingInfo | 0..* | Reference(Finnish PHR QuestionnaireResponse profile) | Information considered as part of plan | |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
Documentation for this format |
Path | Conformance | ValueSet / Code |
CarePlan.language | required | CommonLanguages |
CarePlan.identifier.use | required | IdentifierUse |
CarePlan.status | required | Fixed Value: completed |
CarePlan.intent | required | Fixed Value: plan |
CarePlan.category | extensible | fiphr-vs-careplancategory |
CarePlan.activity.detail.kind | required | CarePlanActivityKind |
CarePlan.activity.detail.code | required | http://phr.kanta.fi/ValueSet/fiphr-vs-activitycode |
CarePlan.activity.detail.reasonCode | required | http://phr.kanta.fi/ValueSet/fiphr-vs-reminderid |
CarePlan.activity.detail.status | required | CarePlanActivityStatus |
Id | Grade | Path(s) | Details | Requirements |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Self-care plan for patient | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the 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 | |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
source | Σ | 0..1 | uri | Identifies where the resource comes from |
Slices for profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this |
profile:fiphrProfile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-selfcareplan-r4 |
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 1..1 | code | Language of the resource content Binding: CommonLanguages (required): Finnish PHR: A code of human language. | |
text | 1..1 | Narrative | Text summary of the resource, for human interpretation | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
creatingApplication | 0..1 | (Complex) | Additional Content defined by implementations URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..* | Identifier | External Ids for this plan |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
status | ?!Σ | 1..1 | code | In Finnish PHR completed is the only accepted value. Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. Fixed Value: completed |
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 |
category | Σ | 1..1 | CodeableConcept | Type of plan Binding: Finnish PHR CarePlan Category value set (extensible): Identifies what "kind" of self-care plan this is to support differentiation between multiple co-existing plans. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:fiphrCoding | Σ | 1..1 | 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 | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-careplancategory |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..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 | Σ | 1..1 | string | Human-friendly name for the care plan |
description | Σ | 1..1 | string | Summary of nature of plan |
subject | Σ | 1..1 | Reference(Finnish PHR Patient profile) {r} | Who the care plan is for |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
display | Σ | 0..1 | string | Text alternative for the resource |
period | Σ | 0..1 | Period | Time period plan covers |
created | Σ | 0..1 | dateTime | Date record was first recorded |
author | Σ | 1..1 | Reference(Finnish PHR Patient profile) {r} | Who is the designated responsible party |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
display | Σ | 0..1 | string | Text alternative for the resource |
supportingInfo | 0..* | Reference(Finnish PHR QuestionnaireResponse profile) | Information considered as part of plan | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
display | Σ | 0..1 | string | Text alternative for the resource |
Documentation for this format |
Path | Conformance | ValueSet / Code |
CarePlan.meta.security | extensible | All Security Labels |
CarePlan.meta.tag | example | CommonTags |
CarePlan.language | required | CommonLanguages |
CarePlan.identifier.use | required | IdentifierUse |
CarePlan.identifier.type | extensible | Identifier Type Codes |
CarePlan.status | required | Fixed Value: completed |
CarePlan.intent | required | Fixed Value: plan |
CarePlan.category | extensible | fiphr-vs-careplancategory |
CarePlan.subject.type | extensible | ResourceType |
CarePlan.subject.identifier.use | required | IdentifierUse |
CarePlan.subject.identifier.type | extensible | Identifier Type Codes |
CarePlan.author.type | extensible | ResourceType |
CarePlan.author.identifier.use | required | IdentifierUse |
CarePlan.author.identifier.type | extensible | Identifier Type Codes |
CarePlan.supportingInfo.type | extensible | ResourceType |
CarePlan.supportingInfo.identifier.use | required | IdentifierUse |
CarePlan.supportingInfo.identifier.type | extensible | Identifier Type Codes |
CarePlan.goal.type | extensible | ResourceType |
CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcome |
CarePlan.activity.detail.kind | required | CarePlanActivityKind |
CarePlan.activity.detail.code | required | http://phr.kanta.fi/ValueSet/fiphr-vs-activitycode |
CarePlan.activity.detail.reasonCode | required | http://phr.kanta.fi/ValueSet/fiphr-vs-reminderid |
CarePlan.activity.detail.status | required | CarePlanActivityStatus |
Id | Grade | Path(s) | Details | Requirements |
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
Mandatory: 16 elements (15 nested mandatory elements)
Fixed Value: 4 elements
Prohibited: 31 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron