Finnish PHR SelfCarePlan Profile Overview
CarePlan | I | CarePlan | Element IdCarePlan Self-care plan for patient Alternate namesCare Team DefinitionDescribes how the patient himself/herself or the authorized person is planning to care patient's condition or symptoms and what kind of actions is planned to be taken in order to work towards the goal. CarePlan Constraints
| |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element IdCarePlan.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. Meta Constraints
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element IdCarePlan.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. id Constraints
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdCarePlan.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. instant Constraints
|
profile | Σ | 1..1 | uriFixed Value | Element IdCarePlan.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. uri Constraints
http://phr.kanta.fi/StructureDefinition/fiphr-sd-selfcareplan-stu3
|
security | Σ | 0..1 | CodingBinding | Element IdCarePlan.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Coding BindingFinnish PHR: Security Labels from the Healthcare Privacy and Security Classification System. ?? (required)Constraints
|
system | Σ | 1..1 | uriFixed Value | Element IdCarePlan.meta.security.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
http://hl7.org/fhir/v3/Confidentiality
|
version | Σ | 0..0 | string | There are no (further) constraints on this element Element IdCarePlan.meta.security.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. string Constraints
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdCarePlan.meta.security.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size code Constraints
|
display | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCarePlan.meta.security.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element IdCarePlan.meta.security.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. boolean Constraints
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdCarePlan.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Coding BindingCodes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" ?? (example)Constraints
|
language | 1..1 | codeBinding | Element IdCarePlan.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). code BindingFinnish PHR: A code of human language. ?? (required)Constraints
| |
text | I | 1..1 | Narrative | Element IdCarePlan.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionNarrative contains clinically relevant information of the resource in a human-readable format. The following fields are used: CarePlan.title, CarePlan.status, CarePlan.period, CarePlan.category, CarePlan.goal, CarePlan.description. If available, a text representation of SelfCareGoal resource is included in the narrative. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. Narrative Constraints
|
contained | I | 0..* | Finnish PHR SelfCareGoal profile | Element IdCarePlan.contained Describes the intended objective(s) for a patient, group or organization Alternate namesinline resources, anonymous resources, contained resources DefinitionDescribes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc. Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline. Finnish PHR SelfCareGoal profile Constraints
|
extension | I | 0..* | Extension | Element IdCarePlan.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension Sliced:Unordered, Open, by url(Value) Constraints
|
creatingApplication | I | 0..1 | Extension | Element IdCarePlan.extension:creatingApplication Additional Content defined by implementations Alternate namesextensions, user content DefinitionApplication identification information. SHALL have same values that has been registered for application in PHR application catalog. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension Extension URLhttp://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication Constraints
|
url | 1..1 | uriFixed Value | Element IdCarePlan.extension:creatingApplication.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. uri Constraints
http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication
| |
value[x] | 0..1 | There are no (further) constraints on this element Element IdCarePlan.extension:creatingApplication.value[x] Value of extension DefinitionValue of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
| ||
valueBase64Binary | base64Binary | There are no (further) constraints on this element Data Type base64Binary | ||
valueBoolean | boolean | There are no (further) constraints on this element Data Type boolean | ||
valueCode | code | There are no (further) constraints on this element Data Type code | ||
valueDate | date | There are no (further) constraints on this element Data Type date | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data Type dateTime | ||
valueDecimal | decimal | There are no (further) constraints on this element Data Type decimal | ||
valueId | id | There are no (further) constraints on this element Data Type id | ||
valueInstant | instant | There are no (further) constraints on this element Data Type instant | ||
valueInteger | integer | There are no (further) constraints on this element Data Type integer | ||
valueMarkdown | markdown | There are no (further) constraints on this element Data Type markdown | ||
valueOid | oid | There are no (further) constraints on this element Data Type oid | ||
valuePositiveInt | positiveInt | There are no (further) constraints on this element Data Type positiveInt | ||
valueString | string | There are no (further) constraints on this element Data Type string | ||
valueTime | time | There are no (further) constraints on this element Data Type time | ||
valueUnsignedInt | unsignedInt | There are no (further) constraints on this element Data Type unsignedInt | ||
valueUri | uri | There are no (further) constraints on this element Data Type uri | ||
valueAddress | Address | There are no (further) constraints on this element Data Type Address | ||
valueAge | Age | There are no (further) constraints on this element Data Type Age | ||
valueAnnotation | Annotation | There are no (further) constraints on this element Data Type Annotation | ||
valueAttachment | Attachment | There are no (further) constraints on this element Data Type Attachment | ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type CodeableConcept | ||
valueCoding | Coding | There are no (further) constraints on this element Data Type Coding | ||
valueContactPoint | ContactPoint | There are no (further) constraints on this element Data Type ContactPoint | ||
valueCount | Count | There are no (further) constraints on this element Data Type Count | ||
valueDistance | Distance | There are no (further) constraints on this element Data Type Distance | ||
valueDuration | Duration | There are no (further) constraints on this element Data Type Duration | ||
valueHumanName | HumanName | There are no (further) constraints on this element Data Type HumanName | ||
valueIdentifier | Identifier | There are no (further) constraints on this element Data Type Identifier | ||
valueMoney | Money | There are no (further) constraints on this element Data Type Money | ||
valuePeriod | Period | There are no (further) constraints on this element Data Type Period | ||
valueQuantity | Quantity | There are no (further) constraints on this element Data Type Quantity | ||
valueRange | Range | There are no (further) constraints on this element Data Type Range | ||
valueRatio | Ratio | There are no (further) constraints on this element Data Type Ratio | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data Type SampledData | ||
valueSignature | Signature | There are no (further) constraints on this element Data Type Signature | ||
valueTiming | Timing | There are no (further) constraints on this element Data Type Timing | ||
valueMeta | Meta | There are no (further) constraints on this element Data Type Meta | ||
valueReference | Reference() | There are no (further) constraints on this element Data Type Reference() | ||
identifier | Σ | 1..* | Identifier | Element IdCarePlan.identifier External Ids for this plan DefinitionThis records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). Need to allow connection to a wider workflow. Identifier Sliced:Unordered, Closed, by use(Exists) Constraints
|
FinnishPHRIdentifier | Σ | 1..1 | Identifier | There are no (further) constraints on this element Element IdCarePlan.identifier:FinnishPHRIdentifier External Ids for this plan DefinitionThis records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). Need to allow connection to a wider workflow. Identifier Constraints
|
use | Σ ?! | 1..1 | codeBindingFixed Value | Element IdCarePlan.identifier:FinnishPHRIdentifier.use usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. code BindingIdentifies the purpose for this identifier, if known . ?? (required)Constraints
official
|
type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element IdCarePlan.identifier:FinnishPHRIdentifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. CodeableConcept BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ?? (extensible)Constraints
|
system | Σ | 1..1 | uriFixed Value | Element IdCarePlan.identifier:FinnishPHRIdentifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier uri Constraints
urn:ietf:rfc:3986
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCarePlan.identifier:FinnishPHRIdentifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. string Constraints
General 123456 Mappings
|
period | Σ I | 0..0 | Period | There are no (further) constraints on this element Element IdCarePlan.identifier:FinnishPHRIdentifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. Period Constraints
|
assigner | Σ I | 0..0 | Reference(http://hl7.org/fhir/StructureDefinition/Organization) | There are no (further) constraints on this element Element IdCarePlan.identifier:FinnishPHRIdentifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(http://hl7.org/fhir/StructureDefinition/Organization) Constraints
|
otherIdentifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdCarePlan.identifier:otherIdentifier External Ids for this plan DefinitionThis records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). Need to allow connection to a wider workflow. Identifier Constraints
|
use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element IdCarePlan.identifier:otherIdentifier.use usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. code BindingIdentifies the purpose for this identifier, if known . ?? (required)Constraints
|
type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element IdCarePlan.identifier:otherIdentifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. CodeableConcept BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ?? (extensible)Constraints
|
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdCarePlan.identifier:otherIdentifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier uri Constraints
General http://www.acme.com/identifiers/patient Mappings
|
value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCarePlan.identifier:otherIdentifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. string Constraints
General 123456 Mappings
|
period | Σ I | 0..0 | Period | There are no (further) constraints on this element Element IdCarePlan.identifier:otherIdentifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. Period Constraints
|
assigner | Σ I | 0..0 | Reference(http://hl7.org/fhir/StructureDefinition/Organization) | There are no (further) constraints on this element Element IdCarePlan.identifier:otherIdentifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(http://hl7.org/fhir/StructureDefinition/Organization) Constraints
|
definition | Σ I | 0..0 | Reference(http://hl7.org/fhir/StructureDefinition/PlanDefinition | http://hl7.org/fhir/StructureDefinition/Questionnaire) | There are no (further) constraints on this element Element IdCarePlan.definition Protocol or definition DefinitionIdentifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(http://hl7.org/fhir/StructureDefinition/PlanDefinition | http://hl7.org/fhir/StructureDefinition/Questionnaire) Constraints
|
basedOn | Σ I | 0..0 | Reference(http://hl7.org/fhir/StructureDefinition/CarePlan) | There are no (further) constraints on this element Element IdCarePlan.basedOn Fulfills care plan Alternate namesfulfills DefinitionA care plan that is fulfilled in whole or in part by this care plan. Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(http://hl7.org/fhir/StructureDefinition/CarePlan) Constraints
|
replaces | Σ I | 0..0 | Reference(http://hl7.org/fhir/StructureDefinition/CarePlan) | There are no (further) constraints on this element Element IdCarePlan.replaces CarePlan replaced by this CarePlan Alternate namessupersedes DefinitionCompleted or terminated care plan whose function is taken by this new care plan. Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans. The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing. Reference(http://hl7.org/fhir/StructureDefinition/CarePlan) Constraints
|
partOf | Σ I | 0..0 | Reference(http://hl7.org/fhir/StructureDefinition/CarePlan) | There are no (further) constraints on this element Element IdCarePlan.partOf Part of referenced CarePlan DefinitionA larger care plan of which this particular care plan is a component or step. Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed. Reference(http://hl7.org/fhir/StructureDefinition/CarePlan) Constraints
|
status | Σ ?! | 1..1 | codeBinding | Element IdCarePlan.status draft | active | completed | cancelled DefinitionIndicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. Allows clinicians to determine whether the plan is actionable or not. The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan. This element is labeled as a modifier because the status contains the code entered-in-error] that marks the plan as not currently valid. code BindingIndicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. ?? (required)Constraints
|
intent | Σ ?! | 1..1 | codeBindingFixed Value | Element IdCarePlan.intent proposal | plan | order | option DefinitionIndicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain. Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain. This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. code BindingCodes indicating the degree of authority/intentionality associated with a care plan ?? (required)Constraints
plan
|
category | Σ | 1..1 | CodeableConceptBinding | Element IdCarePlan.category Type of plan DefinitionIdentifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc. Used for filtering what plan(s) are retrieved and displayed to different types of users. There may be multiple axis of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern. CodeableConcept BindingIdentifies what "kind" of self-care plan this is to support differentiation between multiple co-existing plans. fiphr-vs-careplancategory (required)Constraints
|
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element IdCarePlan.category.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Coding Constraints
|
system | Σ | 1..1 | uriFixed Value | Element IdCarePlan.category.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
http://phr.kanta.fi/CodeSystem/fiphr-cs-careplancategory
|
version | Σ | 0..0 | string | There are no (further) constraints on this element Element IdCarePlan.category.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. string Constraints
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdCarePlan.category.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size code Constraints
|
display | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCarePlan.category.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element IdCarePlan.category.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. boolean Constraints
|
text | Σ | 0..0 | string | There are no (further) constraints on this element Element IdCarePlan.category.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. string Constraints
|
title | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCarePlan.title Human-friendly name for the CarePlan DefinitionHuman-friendly name for the CarePlan. Note that FHIR strings may not exceed 1MB in size string Constraints
|
description | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCarePlan.description Summary of nature of plan DefinitionA description of the scope and nature of the plan. Provides more detail than conveyed by category. Note that FHIR strings may not exceed 1MB in size string Constraints
|
subject | Σ I | 1..1 | Reference(http://phr.kanta.fi/StructureDefinition/fiphr-patient-stu3) | Element IdCarePlan.subject Who care plan is for Alternate namespatient DefinitionIdentifies the patient or group whose intended care is described by the plan. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(http://phr.kanta.fi/StructureDefinition/fiphr-patient-stu3) Allowed aggregation: referenced Constraints
|
id | 0..0 | string | There are no (further) constraints on this element Element IdCarePlan.subject.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
reference | Σ I | 1..1 | string | There are no (further) constraints on this element Element IdCarePlan.subject.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. string Constraints
|
identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element IdCarePlan.subject.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Identifier Constraints
|
display | Σ | 0..0 | string | There are no (further) constraints on this element Element IdCarePlan.subject.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. string Constraints
|
context | Σ I | 0..0 | Reference(http://hl7.org/fhir/StructureDefinition/Encounter | http://hl7.org/fhir/StructureDefinition/EpisodeOfCare) | There are no (further) constraints on this element Element IdCarePlan.context Created in context of Alternate namesencounter DefinitionIdentifies the original context in which this particular CarePlan was created. Activities conducted as a result of the care plan may well occur as part of other encounters/episodes. Reference(http://hl7.org/fhir/StructureDefinition/Encounter | http://hl7.org/fhir/StructureDefinition/EpisodeOfCare) Constraints
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdCarePlan.period Time period plan covers Alternate namestiming DefinitionIndicates when the plan did (or is intended to) come into effect and end. Allows tracking what plan(s) are in effect at a particular time. Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition). Period Constraints
|
author | Σ I | 1..1 | Reference(http://phr.kanta.fi/StructureDefinition/fiphr-patient-stu3) | Element IdCarePlan.author Who is responsible for contents of the plan DefinitionIdentifies the individual(s) or ogranization who is responsible for the content of the care plan. Collaborative care plans may have multiple authors. Reference(http://phr.kanta.fi/StructureDefinition/fiphr-patient-stu3) Constraints
|
reference | Σ I | 1..1 | string | There are no (further) constraints on this element Element IdCarePlan.author.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. string Constraints
|
identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element IdCarePlan.author.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Identifier Constraints
|
display | Σ | 0..0 | string | There are no (further) constraints on this element Element IdCarePlan.author.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. string Constraints
|
careTeam | I | 0..0 | Reference(http://hl7.org/fhir/StructureDefinition/CareTeam) | There are no (further) constraints on this element Element IdCarePlan.careTeam Who's involved in plan? DefinitionIdentifies all people and organizations who are expected to be involved in the care envisioned by this plan. Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(http://hl7.org/fhir/StructureDefinition/CareTeam) Constraints
|
addresses | Σ I | 0..0 | Reference(http://hl7.org/fhir/StructureDefinition/Condition) | There are no (further) constraints on this element Element IdCarePlan.addresses Health issues this plan addresses DefinitionIdentifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan. Links plan to the conditions it manages. The element can identify risks addressed by the plan as well as active conditions. (The Condition resource can include things like "at risk for hypertension" or "fall risk".) Also scopes plans - multiple plans may exist addressing different concerns. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(http://hl7.org/fhir/StructureDefinition/Condition) Constraints
|
supportingInfo | I | 0..* | Reference(http://phr.kanta.fi/StructureDefinition/fiphr-sd-questionnaireresponse-stu3) | Element IdCarePlan.supportingInfo Information considered as part of plan DefinitionIdentifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc. Links also symptom check questionnaire responses to the careplan Identifies barriers and other considerations associated with the care plan. Use "concern" to identify specific conditions addressed by the care plan. Reference(http://phr.kanta.fi/StructureDefinition/fiphr-sd-questionnaireresponse-stu3) Constraints
|
reference | Σ I | 1..1 | string | There are no (further) constraints on this element Element IdCarePlan.supportingInfo.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. string Constraints
|
identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element IdCarePlan.supportingInfo.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Identifier Constraints
|
display | Σ | 0..0 | string | There are no (further) constraints on this element Element IdCarePlan.supportingInfo.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. string Constraints
|
goal | I | 0..1 | Reference(Finnish PHR SelfCareGoal profile) | Element IdCarePlan.goal Desired outcome of plan DefinitionDescribes the intended objective(s) of carrying out the care plan. Provides context for plan. Allows plan effectiveness to be evaluated by clinicians. Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline. Reference(Finnish PHR SelfCareGoal profile) Allowed aggregation: contained Constraints
|
reference | Σ I | 1..1 | string | There are no (further) constraints on this element Element IdCarePlan.goal.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. string Constraints
|
identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element IdCarePlan.goal.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Identifier Constraints
|
display | Σ | 0..0 | string | There are no (further) constraints on this element Element IdCarePlan.goal.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. string Constraints
|
activity | I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdCarePlan.activity Action to occur as part of plan DefinitionIdentifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc. Allows systems to prompt for performance of planned activities, and validate plans against best practice. BackboneElement Constraints
|
outcomeCodeableConcept | 0..0 | CodeableConcept | There are no (further) constraints on this element Element IdCarePlan.activity.outcomeCodeableConcept Results of the activity DefinitionIdentifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not). Note that this should not duplicate the activity status (e.g. completed or in progress). CodeableConcept BindingIdentifies the results of the activity ?? (example)Constraints
| |
outcomeReference | I | 0..0 | Reference(http://hl7.org/fhir/StructureDefinition/Resource) | There are no (further) constraints on this element Element IdCarePlan.activity.outcomeReference Appointment, Encounter, Procedure, etc. DefinitionDetails of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource). Links plan to resulting actions. The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lb and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured. Reference(http://hl7.org/fhir/StructureDefinition/Resource) Constraints
|
progress | 0..0 | Annotation | There are no (further) constraints on this element Element IdCarePlan.activity.progress Comments about the activity status/progress DefinitionNotes about the adherence/status/progress of the activity. Can be used to capture information about adherence, progress, concerns, etc. This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description. Annotation Constraints
| |
reference | I | 0..0 | Reference(http://hl7.org/fhir/StructureDefinition/Appointment | http://hl7.org/fhir/StructureDefinition/CommunicationRequest | http://hl7.org/fhir/StructureDefinition/DeviceRequest | http://hl7.org/fhir/StructureDefinition/MedicationRequest | http://hl7.org/fhir/StructureDefinition/NutritionOrder | http://hl7.org/fhir/StructureDefinition/Task | http://hl7.org/fhir/StructureDefinition/ProcedureRequest | http://hl7.org/fhir/StructureDefinition/ReferralRequest | http://hl7.org/fhir/StructureDefinition/VisionPrescription | http://hl7.org/fhir/StructureDefinition/RequestGroup) | There are no (further) constraints on this element Element IdCarePlan.activity.reference Activity details defined in specific resource DefinitionThe details of the proposed activity represented in a specific resource. Details in a form consistent with other applications and contexts of use. Standard extension exists (goal-pertainstogoal) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference. Reference(http://hl7.org/fhir/StructureDefinition/Appointment | http://hl7.org/fhir/StructureDefinition/CommunicationRequest | http://hl7.org/fhir/StructureDefinition/DeviceRequest | http://hl7.org/fhir/StructureDefinition/MedicationRequest | http://hl7.org/fhir/StructureDefinition/NutritionOrder | http://hl7.org/fhir/StructureDefinition/Task | http://hl7.org/fhir/StructureDefinition/ProcedureRequest | http://hl7.org/fhir/StructureDefinition/ReferralRequest | http://hl7.org/fhir/StructureDefinition/VisionPrescription | http://hl7.org/fhir/StructureDefinition/RequestGroup) Constraints
|
detail | I | 1..1 | BackboneElement | There are no (further) constraints on this element Element IdCarePlan.activity.detail In-line definition of activity DefinitionA simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc. Details in a simple form for generic care plan systems. BackboneElement Constraints
|
category | 0..1 | CodeableConceptBinding | Element IdCarePlan.activity.detail.category diet | drug | encounter | observation | procedure | supply | other DefinitionHigh-level categorization of the type of activity in a self-care plan. May determine what types of extensions are permitted. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. CodeableConcept BindingHigh-level categorization of the type of activity in a self-care plan. fiphr-vs-activitycategory (required)Constraints
| |
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element IdCarePlan.activity.detail.category.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Coding Constraints
|
system | Σ | 1..1 | uriFixed Value | Element IdCarePlan.activity.detail.category.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
http://phr.kanta.fi/CodeSystem/fiphr-cs-activitycategory
|
version | Σ | 0..0 | string | There are no (further) constraints on this element Element IdCarePlan.activity.detail.category.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. string Constraints
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdCarePlan.activity.detail.category.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size code Constraints
|
display | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCarePlan.activity.detail.category.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element IdCarePlan.activity.detail.category.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. boolean Constraints
|
text | Σ | 0..0 | string | There are no (further) constraints on this element Element IdCarePlan.activity.detail.category.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. string Constraints
|
definition | I | 0..0 | Reference(https://duodecim.fi/fhir/stu3/StructureDefinition/SelfCareActivityDefinition) | Element IdCarePlan.activity.detail.definition Protocol or definition DefinitionIdentifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with. Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(https://duodecim.fi/fhir/stu3/StructureDefinition/SelfCareActivityDefinition) Allowed aggregation: contained Constraints
|
code | 0..1 | CodeableConceptBinding | Element IdCarePlan.activity.detail.code Detail type of activity DefinitionDetailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter. Allows matching performed to planned as well as validation against protocols. Tends to be less relevant for activities involving particular products. Codes should not convey negation - use "prohibited" instead. CodeableConcept BindingDetailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. fiphr-vs-activitycode (required)Constraints
| |
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element IdCarePlan.activity.detail.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Coding Constraints
|
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdCarePlan.activity.detail.code.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
|
version | Σ | 0..0 | string | There are no (further) constraints on this element Element IdCarePlan.activity.detail.code.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. string Constraints
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdCarePlan.activity.detail.code.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size code Constraints
|
display | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCarePlan.activity.detail.code.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element IdCarePlan.activity.detail.code.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. boolean Constraints
|
text | Σ | 0..0 | string | There are no (further) constraints on this element Element IdCarePlan.activity.detail.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. string Constraints
|
reasonCode | 0..* | CodeableConceptBinding | Element IdCarePlan.activity.detail.reasonCode Why activity should be done or why activity was prohibited DefinitionProvides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited. This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead. CodeableConcept BindingIdentifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. fiphr-vs-reminderid (required)Constraints
| |
coding | Σ | 1..* | Coding | There are no (further) constraints on this element Element IdCarePlan.activity.detail.reasonCode.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Coding Constraints
|
system | Σ | 1..1 | uri | There are no (further) constraints on this element Element IdCarePlan.activity.detail.reasonCode.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
|
version | Σ | 0..0 | string | There are no (further) constraints on this element Element IdCarePlan.activity.detail.reasonCode.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. string Constraints
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element IdCarePlan.activity.detail.reasonCode.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size code Constraints
|
display | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCarePlan.activity.detail.reasonCode.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element IdCarePlan.activity.detail.reasonCode.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. boolean Constraints
|
text | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCarePlan.activity.detail.reasonCode.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. string Constraints
|
reasonReference | I | 0..0 | Reference(http://hl7.org/fhir/StructureDefinition/Condition) | There are no (further) constraints on this element Element IdCarePlan.activity.detail.reasonReference Condition triggering need for activity DefinitionProvides the health condition(s) that drove the inclusion of this particular activity as part of the plan. Conditions can be identified at the activity level that are not identified as reasons for the overall plan. Reference(http://hl7.org/fhir/StructureDefinition/Condition) Constraints
|
goal | I | 0..0 | Reference(http://hl7.org/fhir/StructureDefinition/Goal) | There are no (further) constraints on this element Element IdCarePlan.activity.detail.goal Goals this activity relates to DefinitionInternal reference that identifies the goals that this activity is intended to contribute towards meeting. So that participants know the link explicitly. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(http://hl7.org/fhir/StructureDefinition/Goal) Constraints
|
status | ?! | 1..1 | codeBinding | Element IdCarePlan.activity.detail.status not-started | in-progress | completed | cancelled DefinitionIdentifies what progress is being made for the specific activity. Indicates progress against the plan, whether the activity is still relevant for the plan. Some aspects of status can be inferred based on the resources linked in actionTaken. Note that "status" is only as current as the plan was most recently updated. code BindingIndicates where the activity is at in its overall life cycle. ?? (required)Constraints
|
statusReason | 0..0 | string | There are no (further) constraints on this element Element IdCarePlan.activity.detail.statusReason Reason for current status DefinitionProvides reason why the activity isn't yet started, is on hold, was cancelled, etc. Will generally not be present if status is "complete". Be sure to prompt to update this (or at least remove the existing value) if the status is changed. string Constraints
| |
prohibited | ?! | 0..1 | boolean | There are no (further) constraints on this element Element IdCarePlan.activity.detail.prohibited Do NOT do DefinitionIf true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, indicates that the described activity is one that should be engaged in when following the plan. Captures intention to not do something that may have been previously typical. This element is labeled as a modifier because it marks an activity as an activity that is not to be performed. boolean Constraints
false
|
scheduled[x] | 0..1 | There are no (further) constraints on this element Element IdCarePlan.activity.detail.scheduled[x] When activity is to occur DefinitionThe period, timing or frequency upon which the described activity is to occur. Allows prompting for activities and detection of missed planned activities.
| ||
scheduledTiming | Timing | There are no (further) constraints on this element Data Type Timing | ||
scheduledPeriod | Period | There are no (further) constraints on this element Data Type Period | ||
scheduledString | string | There are no (further) constraints on this element Data Type string | ||
location | I | 0..0 | Reference(http://hl7.org/fhir/StructureDefinition/Location) | There are no (further) constraints on this element Element IdCarePlan.activity.detail.location Where it should happen DefinitionIdentifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. Helps in planning of activity. May reference a specific clinical location or may identify a type of location. Reference(http://hl7.org/fhir/StructureDefinition/Location) Constraints
|
performer | I | 0..1 | Reference(http://phr.kanta.fi/StructureDefinition/fiphr-patient-stu3) | Element IdCarePlan.activity.detail.performer Who will be responsible? DefinitionIdentifies who's expected to be involved in the activity. Helps in planning of activity. A performer MAY also be a participant in the care plan. Reference(http://phr.kanta.fi/StructureDefinition/fiphr-patient-stu3) Allowed aggregation: referenced Constraints
|
reference | Σ I | 1..1 | string | There are no (further) constraints on this element Element IdCarePlan.activity.detail.performer.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. string Constraints
|
identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element IdCarePlan.activity.detail.performer.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Identifier Constraints
|
display | Σ | 0..0 | string | There are no (further) constraints on this element Element IdCarePlan.activity.detail.performer.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. string Constraints
|
product[x] | 0..0 | There are no (further) constraints on this element Element IdCarePlan.activity.detail.product[x] What is to be administered/supplied DefinitionIdentifies the food, drug or other product to be consumed or supplied in the activity. A product supplied or administered as part of a care plan activity. ?? (example)Constraints
| ||
dailyAmount | I | 0..0 | http://hl7.org/fhir/StructureDefinition/SimpleQuantity | There are no (further) constraints on this element Element IdCarePlan.activity.detail.dailyAmount How to consume/day? Alternate namesdaily dose DefinitionIdentifies the quantity expected to be consumed in a given day. Allows rough dose checking. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. http://hl7.org/fhir/StructureDefinition/SimpleQuantity Constraints
|
quantity | I | 0..0 | http://hl7.org/fhir/StructureDefinition/SimpleQuantity | There are no (further) constraints on this element Element IdCarePlan.activity.detail.quantity How much to administer/supply/consume DefinitionIdentifies the quantity expected to be supplied, administered or consumed by the subject. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. http://hl7.org/fhir/StructureDefinition/SimpleQuantity Constraints
|
description | 0..1 | string | There are no (further) constraints on this element Element IdCarePlan.activity.detail.description Extra info describing activity to perform DefinitionThis provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
note | 0..0 | Annotation | There are no (further) constraints on this element Element IdCarePlan.note Comments about the plan DefinitionGeneral notes about the care plan not covered elsewhere. Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). Annotation Constraints
|