DCH-ChildProtection-CarePlan-1
CarePlan | |
Definition | |
Control | 0..* |
Comments | |
CarePlan.id | |
Definition |
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 ? |
Type | Id |
Comments |
The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID. |
CarePlan.meta | |
Definition |
The 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. |
Control | 0..1 ? |
Type | Meta |
Comments | |
CarePlan.implicitRules | |
Definition |
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 ? |
Type | Uri |
Is Modifier | True |
Comments |
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible. |
CarePlan.language | |
Definition |
The base language in which the resource is written. |
Control | 0..1 ? |
Binding |
A human language. The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | Code |
Comments |
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). |
CarePlan.text | |
Definition |
A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 ? |
Type | Narrative |
Aliases | narrative, html, xhtml, display |
Comments |
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. |
CarePlan.contained | |
Definition |
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Aliases | inline resources, anonymous resources, contained resources |
Comments |
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
CarePlan.extension | |
Definition |
May 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.modifierExtension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.identifier | |
Definition |
This 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). |
Control | 0..* ? |
Type | Identifier |
Requirements |
Need to allow connection to a wider workflow. |
Comments | |
CarePlan.identifier.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.identifier.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.identifier.use | |
Definition |
The purpose of this identifier. |
Control | 0..1 ? |
Binding |
Identifies the purpose for this identifier, if known . The codes SHALL be taken from http://hl7.org/fhir/ValueSet/identifier-use |
Type | Code |
Is Modifier | True |
Requirements |
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments |
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. |
CarePlan.identifier.type | |
Definition |
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Control | 0..1 ? |
Binding |
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. The codes SHALL be taken from the following if appropriate, otherwise an alternate coding may be included instead. http://hl7.org/fhir/ValueSet/identifier-type |
Type | CodeableConcept |
Requirements |
Allows users to make use of identifiers when the identifier system is not known. |
Comments |
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. |
CarePlan.identifier.type.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.identifier.type.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.identifier.type.coding | |
Definition |
A reference to a code defined by a terminology system. |
Control | 0..* ? |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments |
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 labelled as UserSelected = true. |
CarePlan.identifier.type.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.identifier.type.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.identifier.type.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 0..1 ? |
Type | Uri |
Requirements |
Need to be unambiguous about the source of the definition of the symbol. |
Comments |
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. |
CarePlan.identifier.type.coding.version | |
Definition |
The 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.identifier.type.coding.code | |
Definition |
A 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). |
Control | 0..1 ? |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.identifier.type.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 ? |
Type | String |
Requirements |
Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.identifier.type.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
Requirements |
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. |
Comments |
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. |
CarePlan.identifier.type.text | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Requirements |
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. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
CarePlan.identifier.system | |
Definition |
Establishes the namespace in which set of possible id values is unique. |
Control | 0..1 ? |
Type | Uri |
Requirements |
There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers. |
Comments |
see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Example | http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
CarePlan.identifier.value | |
Definition |
The portion of the identifier typically displayed to the user and which is unique within the context of the system. |
Control | 0..1 ? |
Type | String |
Comments |
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. |
Example | 123456 |
CarePlan.identifier.period | |
Definition |
Time period during which identifier is/was valid for use. |
Control | 0..1 ? |
Type | Period |
Comments |
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. |
CarePlan.identifier.period.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.identifier.period.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.identifier.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 0..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
CarePlan.identifier.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
CarePlan.identifier.assigner | |
Definition |
Organization that issued/manages the identifier. |
Control | 0..1 ? |
Type | Organization |
Comments |
The reference may be just a text description of the assigner. |
CarePlan.identifier.assigner.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.identifier.assigner.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.identifier.assigner.reference | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.identifier.assigner.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.subject | |
Definition | |
Control | 1..* |
Type | https://fhir.nhs.uk/StructureDefinition/CareConnect-DCH-Patient-1 |
Comments | |
CarePlan.subject.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.subject.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.subject.reference | |
Definition | |
Control | 1..* |
Comments | |
CarePlan.subject.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.status | |
Definition |
Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. |
Control | 1..1 ? |
Binding |
Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/care-plan-status |
Type | Code |
Is Modifier | True |
Requirements |
Allows clinicians to determine whether the plan is actionable or not. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.context | |
Definition | |
Control | 0..* |
Type | Choice of: |
Comments | |
CarePlan.context.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.context.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.context.reference | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.context.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.period | |
Definition |
Indicates when the plan did (or is intended to) come into effect and end. |
Control | 0..1 ? |
Type | Period |
Requirements |
Allows tracking what plan(s) are in effect at a particular time. |
Comments |
Any activities scheduled as part of the plan should be constrained to the specified period. |
CarePlan.period.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.period.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 0..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
CarePlan.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
CarePlan.author | |
Definition | |
Control | 0..* |
Type | Choice of: |
Comments | |
CarePlan.author.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.author.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.author.reference | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.author.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.modified | |
Definition |
Identifies the most recent date on which the plan has been revised. |
Control | 0..1 ? |
Type | DateTime |
Requirements |
Indicates how current the plan is. |
Comments | |
CarePlan.category | |
Definition | |
Control | 1..1 |
Comments | |
CarePlan.category.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.category.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.category.coding | |
Definition | |
Control | 1..1 |
Comments | |
CarePlan.category.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.category.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.category.coding.system | |
Definition | |
Control | 1..* |
Comments | |
Fixed Value | http://snomed.info/sct |
CarePlan.category.coding.version | |
Definition |
The 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.category.coding.code | |
Definition | |
Control | 1..* |
Comments | |
Fixed Value | 1064311000000109 |
CarePlan.category.coding.display | |
Definition | |
Control | 1..* |
Comments | |
Fixed Value | Child protection plan (record artifact) |
CarePlan.category.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
Requirements |
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. |
Comments |
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. |
CarePlan.category.text | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Requirements |
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. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
CarePlan.description | |
Definition |
A description of the scope and nature of the plan. |
Control | 0..1 ? |
Type | String |
Requirements |
Provides more detail than conveyed by category. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.addresses | |
Definition |
Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan. |
Control | 0..* ? |
Type | Condition |
Requirements |
Links plan to the conditions it manages. Also scopes plans - multiple plans may exist addressing different concerns. |
Comments | |
CarePlan.addresses.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.addresses.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.addresses.reference | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.addresses.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.support | |
Definition |
Identifies 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. |
Control | 0..* ? |
Type | Resource |
Requirements |
Identifies barriers and other considerations associated with the care plan. |
Comments |
Use "concern" to identify specific conditions addressed by the care plan. |
CarePlan.support.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.support.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.support.reference | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.support.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.relatedPlan | |
Definition |
Identifies CarePlans with some sort of formal relationship to the current plan. |
Control | 0..* ? |
Type | BackboneElement |
Comments |
Relationships are uni-directional with the "newer" plan pointing to the older one. |
CarePlan.relatedPlan.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.relatedPlan.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.relatedPlan.modifierExtension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
Comments |
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. |
CarePlan.relatedPlan.code | |
Definition |
Identifies the type of relationship this plan has to the target plan. |
Control | 0..1 ? |
Binding |
Codes identifying the types of relationships between two plans. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/care-plan-relationship |
Type | Code |
Comments |
Read the relationship as "this plan" [relatedPlan.code] "relatedPlan.plan"; e.g. This plan includes Plan B. Additional relationship types can be proposed for future releases or handled as extensions. |
CarePlan.relatedPlan.plan | |
Definition |
A reference to the plan to which a relationship is asserted. |
Control | 1..1 ? |
Type | CarePlan |
Comments | |
CarePlan.relatedPlan.plan.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.relatedPlan.plan.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.relatedPlan.plan.reference | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.relatedPlan.plan.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.participant | |
Definition |
Identifies all people and organizations who are expected to be involved in the care envisioned by this plan. |
Control | 0..* ? |
Type | BackboneElement |
Requirements |
Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions. |
Aliases | Care Team |
Comments | |
CarePlan.participant.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.participant.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.participant.modifierExtension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
Comments |
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. |
CarePlan.participant.role | |
Definition |
Indicates specific responsibility of an individual within the care plan; e.g. "Primary physician", "Team coordinator", "Caregiver", etc. |
Control | 0..1 ? |
Binding |
Indicates specific responsibility of an individual within the care plan; e.g. "Primary physician", "Team coordinator", "Caregiver", etc. For example codes, see http://hl7.org/fhir/ValueSet/participant-role ; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Comments |
Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care plan. General relationships should be handled as properties of the Patient resource directly. |
CarePlan.participant.role.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.participant.role.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.participant.role.coding | |
Definition |
A reference to a code defined by a terminology system. |
Control | 0..* ? |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments |
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 labelled as UserSelected = true. |
CarePlan.participant.role.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.participant.role.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.participant.role.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 0..1 ? |
Type | Uri |
Requirements |
Need to be unambiguous about the source of the definition of the symbol. |
Comments |
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. |
CarePlan.participant.role.coding.version | |
Definition |
The 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.participant.role.coding.code | |
Definition |
A 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). |
Control | 0..1 ? |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.participant.role.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 ? |
Type | String |
Requirements |
Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.participant.role.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
Requirements |
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. |
Comments |
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. |
CarePlan.participant.role.text | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Requirements |
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. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
CarePlan.participant.member | |
Definition | |
Control | 0..* |
Type | Choice of: |
Comments | |
CarePlan.participant.member.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.participant.member.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.participant.member.reference | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.participant.member.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.goal | |
Definition |
Describes the intended objective(s) of carrying out the care plan. |
Control | 0..* ? |
Type | Goal |
Requirements |
Provides context for plan. Allows plan effectiveness to be evaluated by clinicians. |
Comments |
Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline. |
CarePlan.goal.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.goal.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.goal.reference | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.goal.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.activity | |
Definition |
Identifies 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. |
Control | 0..* ? |
Type | BackboneElement |
Requirements |
Allows systems to prompt for performance of planned activities, and validate plans against best practice. |
Comments | |
CarePlan.activity.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.modifierExtension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
Comments |
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. |
CarePlan.activity.actionResulting | |
Definition |
Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc. |
Control | 0..* ? |
Type | Resource |
Requirements |
Links plan to resulting actions. |
Comments | |
CarePlan.activity.actionResulting.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.actionResulting.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.actionResulting.reference | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.activity.actionResulting.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.activity.progress | |
Definition |
Notes about the adherence/status/progress of the activity. |
Control | 0..* ? |
Type | Annotation |
Requirements |
Can be used to capture information about adherence, progress, concerns, etc. |
Comments |
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. |
CarePlan.activity.progress.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.progress.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.progress.author[x] | |
Definition |
The individual responsible for making the annotation. |
Control | 0..1 ? |
Type | Choice of: |
Comments | |
CarePlan.activity.progress.time | |
Definition |
Indicates when this particular annotation was made. |
Control | 0..1 ? |
Type | DateTime |
Comments | |
CarePlan.activity.progress.text | |
Definition |
The text of the annotation. |
Control | 1..1 ? |
Type | String |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.activity.reference | |
Definition |
The details of the proposed activity represented in a specific resource. |
Control | 0..1 ? |
Type | Choice of: |
Requirements |
Details in a form consistent with other applications and contexts of use. |
Comments | |
CarePlan.activity.reference.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.reference.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.reference.reference | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.activity.reference.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.activity.detail | |
Definition |
A 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. |
Control | 0..1 ? |
Type | BackboneElement |
Requirements |
Details in a simple form for generic care plan systems. |
Comments | |
CarePlan.activity.detail.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.detail.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.detail.modifierExtension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
Comments |
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. |
CarePlan.activity.detail.category | |
Definition |
High-level categorization of the type of activity in a care plan. |
Control | 0..1 ? |
Binding |
High-level categorization of the type of activity in a care plan. For example codes, see http://hl7.org/fhir/ValueSet/care-plan-activity-category ; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements |
May determine what types of extensions are permitted. |
Comments |
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. |
CarePlan.activity.detail.category.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.detail.category.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.detail.category.coding | |
Definition |
A reference to a code defined by a terminology system. |
Control | 0..* ? |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments |
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 labelled as UserSelected = true. |
CarePlan.activity.detail.category.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.detail.category.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.detail.category.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 0..1 ? |
Type | Uri |
Requirements |
Need to be unambiguous about the source of the definition of the symbol. |
Comments |
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. |
CarePlan.activity.detail.category.coding.version | |
Definition |
The 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.activity.detail.category.coding.code | |
Definition |
A 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). |
Control | 0..1 ? |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.activity.detail.category.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 ? |
Type | String |
Requirements |
Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.activity.detail.category.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
Requirements |
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. |
Comments |
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. |
CarePlan.activity.detail.category.text | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Requirements |
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. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
CarePlan.activity.detail.code | |
Definition |
Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter. |
Control | 0..1 ? |
Binding |
Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. For example codes, see http://hl7.org/fhir/ValueSet/care-plan-activity ; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Requirements |
Allows matching performed to planned as well as validation against protocols. |
Comments |
Tends to be less relevant for activities involving particular products. Codes should not convey negation - use "prohibited" instead. |
CarePlan.activity.detail.code.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.detail.code.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.detail.code.coding | |
Definition |
A reference to a code defined by a terminology system. |
Control | 0..* ? |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments |
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 labelled as UserSelected = true. |
CarePlan.activity.detail.code.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.detail.code.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.detail.code.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 0..1 ? |
Type | Uri |
Requirements |
Need to be unambiguous about the source of the definition of the symbol. |
Comments |
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. |
CarePlan.activity.detail.code.coding.version | |
Definition |
The 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.activity.detail.code.coding.code | |
Definition |
A 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). |
Control | 0..1 ? |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.activity.detail.code.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 ? |
Type | String |
Requirements |
Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.activity.detail.code.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
Requirements |
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. |
Comments |
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. |
CarePlan.activity.detail.code.text | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Requirements |
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. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
CarePlan.activity.detail.reasonCode | |
Definition |
Provides the rationale that drove the inclusion of this particular activity as part of the plan. |
Control | 0..* ? |
Binding |
Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. For example codes, see http://hl7.org/fhir/ValueSet/activity-reason ; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Comments |
This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead. |
CarePlan.activity.detail.reasonCode.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.detail.reasonCode.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.detail.reasonCode.coding | |
Definition |
A reference to a code defined by a terminology system. |
Control | 0..* ? |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments |
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 labelled as UserSelected = true. |
CarePlan.activity.detail.reasonCode.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.detail.reasonCode.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.detail.reasonCode.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 0..1 ? |
Type | Uri |
Requirements |
Need to be unambiguous about the source of the definition of the symbol. |
Comments |
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. |
CarePlan.activity.detail.reasonCode.coding.version | |
Definition |
The 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.activity.detail.reasonCode.coding.code | |
Definition |
A 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). |
Control | 0..1 ? |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.activity.detail.reasonCode.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 ? |
Type | String |
Requirements |
Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.activity.detail.reasonCode.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
Requirements |
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. |
Comments |
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. |
CarePlan.activity.detail.reasonCode.text | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Requirements |
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. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
CarePlan.activity.detail.reasonReference | |
Definition |
Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan. |
Control | 0..* ? |
Type | Condition |
Comments |
Conditions can be identified at the activity level that are not identified as reasons for the overall plan. |
CarePlan.activity.detail.reasonReference.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.detail.reasonReference.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.detail.reasonReference.reference | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.activity.detail.reasonReference.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.activity.detail.goal | |
Definition |
Internal reference that identifies the goals that this activity is intended to contribute towards meeting. |
Control | 0..* ? |
Type | Goal |
Requirements |
So that participants know the link explicitly. |
Comments | |
CarePlan.activity.detail.goal.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.detail.goal.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.detail.goal.reference | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.activity.detail.goal.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.activity.detail.status | |
Definition |
Identifies what progress is being made for the specific activity. |
Control | 0..1 ? |
Binding |
Indicates where the activity is at in its overall life cycle. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/care-plan-activity-status |
Type | Code |
Is Modifier | True |
Requirements |
Indicates progress against the plan, whether the activity is still relevant for the plan. |
Comments |
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. |
CarePlan.activity.detail.statusReason | |
Definition |
Provides reason why the activity isn't yet started, is on hold, was cancelled, etc. |
Control | 0..1 ? |
Binding |
Describes why the current activity has the status it does; e.g. "Recovering from injury" as a reason for non-started or on-hold, "Patient does not enjoy activity" as a reason for cancelling a planned activity. For example codes, see http://hl7.org/fhir/ValueSet/goal-status-reason ; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Comments |
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. |
CarePlan.activity.detail.statusReason.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.detail.statusReason.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.detail.statusReason.coding | |
Definition |
A reference to a code defined by a terminology system. |
Control | 0..* ? |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments |
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 labelled as UserSelected = true. |
CarePlan.activity.detail.statusReason.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.detail.statusReason.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.detail.statusReason.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 0..1 ? |
Type | Uri |
Requirements |
Need to be unambiguous about the source of the definition of the symbol. |
Comments |
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. |
CarePlan.activity.detail.statusReason.coding.version | |
Definition |
The 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.activity.detail.statusReason.coding.code | |
Definition |
A 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). |
Control | 0..1 ? |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.activity.detail.statusReason.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 ? |
Type | String |
Requirements |
Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.activity.detail.statusReason.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
Requirements |
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. |
Comments |
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. |
CarePlan.activity.detail.statusReason.text | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Requirements |
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. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
CarePlan.activity.detail.prohibited | |
Definition |
If true, indicates that the described activity is one that must NOT be engaged in when following the plan. |
Control | 1..1 ? |
Type | Boolean |
Is Modifier | True |
Requirements |
Captures intention to not do something that may have been previously typical. |
Comments | |
CarePlan.activity.detail.scheduled[x] | |
Definition |
The period, timing or frequency upon which the described activity is to occur. |
Control | 0..1 ? |
Type | Choice of: |
Requirements |
Allows prompting for activities and detection of missed planned activities. |
Comments |
A timing schedule can be either a list of events - intervals on which the event occurs, or a single event with repeating criteria or just repeating criteria with no actual event. When both event and a repeating specification are provided, the list of events should be understood as an interpretation of the information in the repeat structure. |
CarePlan.activity.detail.location | |
Definition |
Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. |
Control | 0..1 ? |
Type | Location |
Requirements |
Helps in planning of activity. |
Comments |
May reference a specific clinical location or may identify a type of location. |
CarePlan.activity.detail.location.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.detail.location.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.detail.location.reference | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.activity.detail.location.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.activity.detail.performer | |
Definition |
Identifies who's expected to be involved in the activity. |
Control | 0..* ? |
Type | Choice of: |
Requirements |
Helps in planning of activity. |
Comments |
A performer MAY also be a participant in the care plan. |
CarePlan.activity.detail.performer.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.detail.performer.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.detail.performer.reference | |
Definition |
A 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. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.activity.detail.performer.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
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. |
CarePlan.activity.detail.product[x] | |
Definition |
Identifies the food, drug or other product to be consumed or supplied in the activity. |
Control | 0..1 ? |
Binding |
A product supplied or administered as part of a care plan activity. For example codes, see http://hl7.org/fhir/ValueSet/medication-codes ; other codes may be used where these codes are not suitable |
Type | Choice of: |
Comments |
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. |
CarePlan.activity.detail.dailyAmount(SimpleQuantity) | |
Definition |
Identifies the quantity expected to be consumed in a given day. |
Control | 0..1 ? |
Type | Quantity |
Requirements |
Allows rough dose checking. |
Aliases | daily dose |
Comments |
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. |
CarePlan.activity.detail.dailyAmount.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.detail.dailyAmount.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.detail.dailyAmount.value | |
Definition |
The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Control | 0..1 ? |
Type | Decimal |
Requirements |
Precision is handled implicitly in almost all cases of measurement. |
Comments |
The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
CarePlan.activity.detail.dailyAmount.comparator | |
Definition |
Not allowed to be used in this context |
Control | 0..0 ? |
Binding |
How the Quantity should be understood and represented. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/quantity-comparator |
Type | Code |
Is Modifier | True |
Requirements |
Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Comments |
This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
CarePlan.activity.detail.dailyAmount.unit | |
Definition |
A human-readable form of the unit. |
Control | 0..1 ? |
Type | String |
Requirements |
There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.activity.detail.dailyAmount.system | |
Definition |
The identification of the system that provides the coded form of the unit. |
Control | 0..1 ? |
Type | Uri |
Requirements |
Need to know the system that defines the coded form of the unit. |
Comments |
see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
CarePlan.activity.detail.dailyAmount.code | |
Definition |
A computer processable form of the unit in some unit representation system. |
Control | 0..1 ? |
Type | Code |
Requirements |
Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments |
The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
CarePlan.activity.detail.quantity(SimpleQuantity) | |
Definition |
Identifies the quantity expected to be supplied, administered or consumed by the subject. |
Control | 0..1 ? |
Type | Quantity |
Comments |
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. |
CarePlan.activity.detail.quantity.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.activity.detail.quantity.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.activity.detail.quantity.value | |
Definition |
The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Control | 0..1 ? |
Type | Decimal |
Requirements |
Precision is handled implicitly in almost all cases of measurement. |
Comments |
The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
CarePlan.activity.detail.quantity.comparator | |
Definition |
Not allowed to be used in this context |
Control | 0..0 ? |
Binding |
How the Quantity should be understood and represented. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/quantity-comparator |
Type | Code |
Is Modifier | True |
Requirements |
Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Comments |
This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
CarePlan.activity.detail.quantity.unit | |
Definition |
A human-readable form of the unit. |
Control | 0..1 ? |
Type | String |
Requirements |
There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.activity.detail.quantity.system | |
Definition |
The identification of the system that provides the coded form of the unit. |
Control | 0..1 ? |
Type | Uri |
Requirements |
Need to know the system that defines the coded form of the unit. |
Comments |
see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
CarePlan.activity.detail.quantity.code | |
Definition |
A computer processable form of the unit in some unit representation system. |
Control | 0..1 ? |
Type | Code |
Requirements |
Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments |
The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
CarePlan.activity.detail.description | |
Definition |
This 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. |
Control | 0..1 ? |
Type | String |
Comments |
Note that FHIR strings may not exceed 1MB in size |
CarePlan.note | |
Definition |
General notes about the care plan not covered elsewhere. |
Control | 0..1 ? |
Type | Annotation |
Requirements |
Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements. |
Comments |
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). |
CarePlan.note.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
CarePlan.note.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. 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. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
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. |
CarePlan.note.author[x] | |
Definition |
The individual responsible for making the annotation. |
Control | 0..1 ? |
Type | Choice of: |
Comments | |
CarePlan.note.time | |
Definition |
Indicates when this particular annotation was made. |
Control | 0..1 ? |
Type | DateTime |
Comments | |
CarePlan.note.text | |
Definition |
The text of the annotation. |
Control | 1..1 ? |
Type | String |
Comments |
Note that FHIR strings may not exceed 1MB in size |