Finnish Base Profiles
0.2.0 - ci-build Finland flag

Finnish Base Profiles - Local Development build (v0.2.0). See the Directory of published versions

Resource Profile: fiphr-sd-selfcareplan-r4

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:

Formal Views of Profile Content

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

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanSelf-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..1canonical(StructureDefinition)Profiles this resource claims to conform to
Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-selfcareplan-r4
... language 1..1codeLanguage of the resource content
Binding: CommonLanguages (required): Finnish PHR: A code of human language.

... text 1..1NarrativeText summary of the resource, for human interpretation
... contained 0..0
... Slices for extension 0..*ExtensionExtension
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..*IdentifierExternal Ids for this plan
.... use 0..1codeusual | official | temp | secondary | old (If known)
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringThe value that is unique
.... assigner 0..0
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... basedOn 0..0
... replaces 0..0
... partOf 0..0
... status 1..1codeIn Finnish PHR completed is the only accepted value.
Fixed Value: completed
... intent 1..1codeproposal | plan | order | option
Fixed Value: plan
... category 1..1CodeableConceptType 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..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:fiphrCoding 1..1CodingCode defined by a terminology system
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-careplancategory
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
... title 1..1stringHuman-friendly name for the care plan
... description 1..1stringSummary of nature of plan
... subject 1..1Reference(Finnish PHR Patient profile) {r}Who the care plan is for
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
.... identifier
..... assigner 0..0
... encounter 0..0
... author 1..1Reference(Finnish PHR Patient profile) {r}Who is the designated responsible party
.... reference 1..1stringLiteral 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..1stringLiteral reference, Relative, internal or absolute URL
.... identifier
..... assigner 0..0
... goal 0..0
... activity 0..0
... note 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
CarePlan.languagerequiredCommonLanguages
CarePlan.categoryextensiblefiphr-vs-careplancategory
CarePlan.activity.detail.coderequiredhttp://phr.kanta.fi/ValueSet/fiphr-vs-activitycode
CarePlan.activity.detail.reasonCoderequiredhttp://phr.kanta.fi/ValueSet/fiphr-vs-reminderid
NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanSelf-care plan for patient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 1..1codeLanguage of the resource content
Binding: CommonLanguages (required): Finnish PHR: A code of human language.

... text 1..1NarrativeText summary of the resource, for human interpretation
... creatingApplication 0..1(Complex)Additional Content defined by implementations
URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierExternal Ids for this plan
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
... status ?!Σ1..1codeIn 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..1codeproposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.


Fixed Value: plan
... category Σ1..1CodeableConceptType 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..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:fiphrCoding Σ1..1CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-careplancategory
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
... title Σ1..1stringHuman-friendly name for the care plan
... description Σ1..1stringSummary of nature of plan
... subject Σ1..1Reference(Finnish PHR Patient profile) {r}Who the care plan is for
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... author Σ1..1Reference(Finnish PHR Patient profile) {r}Who is the designated responsible party
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... supportingInfo 0..*Reference(Finnish PHR QuestionnaireResponse profile)Information considered as part of plan
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
CarePlan.languagerequiredCommonLanguages
CarePlan.identifier.userequiredIdentifierUse
CarePlan.statusrequiredFixed Value: completed
CarePlan.intentrequiredFixed Value: plan
CarePlan.categoryextensiblefiphr-vs-careplancategory
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
CarePlan.activity.detail.coderequiredhttp://phr.kanta.fi/ValueSet/fiphr-vs-activitycode
CarePlan.activity.detail.reasonCoderequiredhttp://phr.kanta.fi/ValueSet/fiphr-vs-reminderid
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCarePlanIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCarePlanA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanSelf-care plan for patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies 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..1canonical(StructureDefinition)Profiles this resource claims to conform to

Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-selfcareplan-r4
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... text 1..1NarrativeText summary of the resource, for human interpretation
... Slices for extension 0..*ExtensionExtension
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..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierExternal Ids for this plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
... status ?!Σ1..1codeIn 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..1codeproposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.


Fixed Value: plan
... category Σ1..1CodeableConceptType 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:fiphrCoding Σ1..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-careplancategory
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... title Σ1..1stringHuman-friendly name for the care plan
... description Σ1..1stringSummary of nature of plan
... subject Σ1..1Reference(Finnish PHR Patient profile) {r}Who the care plan is for
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
.... display Σ0..1stringText alternative for the resource
... period Σ0..1PeriodTime period plan covers
... created Σ0..1dateTimeDate record was first recorded
... author Σ1..1Reference(Finnish PHR Patient profile) {r}Who is the designated responsible party
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
.... display Σ0..1stringText alternative for the resource
... supportingInfo 0..*Reference(Finnish PHR QuestionnaireResponse profile)Information considered as part of plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
.... display Σ0..1stringText alternative for the resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
CarePlan.meta.securityextensibleAll Security Labels
CarePlan.meta.tagexampleCommonTags
CarePlan.languagerequiredCommonLanguages
CarePlan.identifier.userequiredIdentifierUse
CarePlan.identifier.typeextensibleIdentifier Type Codes
CarePlan.statusrequiredFixed Value: completed
CarePlan.intentrequiredFixed Value: plan
CarePlan.categoryextensiblefiphr-vs-careplancategory
CarePlan.subject.typeextensibleResourceType
CarePlan.subject.identifier.userequiredIdentifierUse
CarePlan.subject.identifier.typeextensibleIdentifier Type Codes
CarePlan.author.typeextensibleResourceType
CarePlan.author.identifier.userequiredIdentifierUse
CarePlan.author.identifier.typeextensibleIdentifier Type Codes
CarePlan.supportingInfo.typeextensibleResourceType
CarePlan.supportingInfo.identifier.userequiredIdentifierUse
CarePlan.supportingInfo.identifier.typeextensibleIdentifier Type Codes
CarePlan.goal.typeextensibleResourceType
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
CarePlan.activity.detail.coderequiredhttp://phr.kanta.fi/ValueSet/fiphr-vs-activitycode
CarePlan.activity.detail.reasonCoderequiredhttp://phr.kanta.fi/ValueSet/fiphr-vs-reminderid
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

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:

  • The element CarePlan.meta.profile is sliced based on the value of value:$this
  • The element CarePlan.category.coding is sliced based on the value of value:system

Differential View

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanSelf-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..1canonical(StructureDefinition)Profiles this resource claims to conform to
Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-selfcareplan-r4
... language 1..1codeLanguage of the resource content
Binding: CommonLanguages (required): Finnish PHR: A code of human language.

... text 1..1NarrativeText summary of the resource, for human interpretation
... contained 0..0
... Slices for extension 0..*ExtensionExtension
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..*IdentifierExternal Ids for this plan
.... use 0..1codeusual | official | temp | secondary | old (If known)
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringThe value that is unique
.... assigner 0..0
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... basedOn 0..0
... replaces 0..0
... partOf 0..0
... status 1..1codeIn Finnish PHR completed is the only accepted value.
Fixed Value: completed
... intent 1..1codeproposal | plan | order | option
Fixed Value: plan
... category 1..1CodeableConceptType 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..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:fiphrCoding 1..1CodingCode defined by a terminology system
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-careplancategory
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
... title 1..1stringHuman-friendly name for the care plan
... description 1..1stringSummary of nature of plan
... subject 1..1Reference(Finnish PHR Patient profile) {r}Who the care plan is for
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
.... identifier
..... assigner 0..0
... encounter 0..0
... author 1..1Reference(Finnish PHR Patient profile) {r}Who is the designated responsible party
.... reference 1..1stringLiteral 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..1stringLiteral reference, Relative, internal or absolute URL
.... identifier
..... assigner 0..0
... goal 0..0
... activity 0..0
... note 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
CarePlan.languagerequiredCommonLanguages
CarePlan.categoryextensiblefiphr-vs-careplancategory
CarePlan.activity.detail.coderequiredhttp://phr.kanta.fi/ValueSet/fiphr-vs-activitycode
CarePlan.activity.detail.reasonCoderequiredhttp://phr.kanta.fi/ValueSet/fiphr-vs-reminderid

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanSelf-care plan for patient
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 1..1codeLanguage of the resource content
Binding: CommonLanguages (required): Finnish PHR: A code of human language.

... text 1..1NarrativeText summary of the resource, for human interpretation
... creatingApplication 0..1(Complex)Additional Content defined by implementations
URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierExternal Ids for this plan
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
... status ?!Σ1..1codeIn 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..1codeproposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.


Fixed Value: plan
... category Σ1..1CodeableConceptType 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..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:fiphrCoding Σ1..1CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-careplancategory
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
... title Σ1..1stringHuman-friendly name for the care plan
... description Σ1..1stringSummary of nature of plan
... subject Σ1..1Reference(Finnish PHR Patient profile) {r}Who the care plan is for
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... author Σ1..1Reference(Finnish PHR Patient profile) {r}Who is the designated responsible party
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... supportingInfo 0..*Reference(Finnish PHR QuestionnaireResponse profile)Information considered as part of plan
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
CarePlan.languagerequiredCommonLanguages
CarePlan.identifier.userequiredIdentifierUse
CarePlan.statusrequiredFixed Value: completed
CarePlan.intentrequiredFixed Value: plan
CarePlan.categoryextensiblefiphr-vs-careplancategory
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
CarePlan.activity.detail.coderequiredhttp://phr.kanta.fi/ValueSet/fiphr-vs-activitycode
CarePlan.activity.detail.reasonCoderequiredhttp://phr.kanta.fi/ValueSet/fiphr-vs-reminderid
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus

Constraints

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanSelf-care plan for patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies 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..1canonical(StructureDefinition)Profiles this resource claims to conform to

Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-selfcareplan-r4
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... text 1..1NarrativeText summary of the resource, for human interpretation
... Slices for extension 0..*ExtensionExtension
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..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierExternal Ids for this plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
... status ?!Σ1..1codeIn 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..1codeproposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.


Fixed Value: plan
... category Σ1..1CodeableConceptType 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:fiphrCoding Σ1..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://phr.kanta.fi/CodeSystem/fiphr-cs-careplancategory
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... title Σ1..1stringHuman-friendly name for the care plan
... description Σ1..1stringSummary of nature of plan
... subject Σ1..1Reference(Finnish PHR Patient profile) {r}Who the care plan is for
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
.... display Σ0..1stringText alternative for the resource
... period Σ0..1PeriodTime period plan covers
... created Σ0..1dateTimeDate record was first recorded
... author Σ1..1Reference(Finnish PHR Patient profile) {r}Who is the designated responsible party
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
.... display Σ0..1stringText alternative for the resource
... supportingInfo 0..*Reference(Finnish PHR QuestionnaireResponse profile)Information considered as part of plan
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
.... display Σ0..1stringText alternative for the resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
CarePlan.meta.securityextensibleAll Security Labels
CarePlan.meta.tagexampleCommonTags
CarePlan.languagerequiredCommonLanguages
CarePlan.identifier.userequiredIdentifierUse
CarePlan.identifier.typeextensibleIdentifier Type Codes
CarePlan.statusrequiredFixed Value: completed
CarePlan.intentrequiredFixed Value: plan
CarePlan.categoryextensiblefiphr-vs-careplancategory
CarePlan.subject.typeextensibleResourceType
CarePlan.subject.identifier.userequiredIdentifierUse
CarePlan.subject.identifier.typeextensibleIdentifier Type Codes
CarePlan.author.typeextensibleResourceType
CarePlan.author.identifier.userequiredIdentifierUse
CarePlan.author.identifier.typeextensibleIdentifier Type Codes
CarePlan.supportingInfo.typeextensibleResourceType
CarePlan.supportingInfo.identifier.userequiredIdentifierUse
CarePlan.supportingInfo.identifier.typeextensibleIdentifier Type Codes
CarePlan.goal.typeextensibleResourceType
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
CarePlan.activity.detail.coderequiredhttp://phr.kanta.fi/ValueSet/fiphr-vs-activitycode
CarePlan.activity.detail.reasonCoderequiredhttp://phr.kanta.fi/ValueSet/fiphr-vs-reminderid
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

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:

  • The element CarePlan.meta.profile is sliced based on the value of value:$this
  • The element CarePlan.category.coding is sliced based on the value of value:system

 

Other representations of profile: CSV, Excel, Schematron