Guia de Implementação do Registro de Atendimento Clínico (RAC) da RNDS
0.1.0 - CI Build
Guia de Implementação do Registro de Atendimento Clínico (RAC) da RNDS - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Page standards status: Informative | Maturity Level: 1 |
Definitions for the BRAtestado resource profile.
Guidance on how to interpret the contents of this table can be found here
0. CarePlan | |
Short | Atestado médico/odontológico |
2. CarePlan.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..0 |
4. CarePlan.instantiatesCanonical | |
Control | 0..0 |
6. CarePlan.instantiatesUri | |
Control | 0..0 |
8. CarePlan.basedOn | |
Control | 0..0 |
10. CarePlan.replaces | |
Control | 0..0 |
12. CarePlan.partOf | |
Control | 0..0 |
14. CarePlan.status | |
Short | Estado do atestado. |
Binding | The codes SHALL be taken from Status do atestado (required to http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoAtestado )Estado do atestado. |
Fixed Value | active |
16. CarePlan.intent | |
Short | Intenção do atestado |
Binding | The codes SHALL be taken from Intenção do atestado (required to http://www.saude.gov.br/fhir/r4/ValueSet/BRIntencaoAtestado )Intenção do atestado médico/odontológico |
Fixed Value | plan |
18. CarePlan.category | |
Definition | Determina se é um atestado médico ou odontológico. |
Short | Tipo do atestado |
Control | 1..1 |
Binding | The codes SHALL be taken from Tipo de atestado (required to http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoAtestado )Tipo do atestado. |
20. CarePlan.category.coding | |
Control | 1..1 |
22. CarePlan.category.coding.system | |
Control | 1..? |
24. CarePlan.category.coding.code | |
Control | 1..? |
26. CarePlan.category.coding.userSelected | |
Control | 0..0 |
28. CarePlan.category.text | |
Control | 0..0 |
30. CarePlan.title | |
Control | 0..0 |
32. CarePlan.description | |
Control | 0..0 |
34. CarePlan.subject | |
Definition | Identifica o indivíduo o qual se refere este atestado. |
Short | Identificação do Indivíduo |
Type | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0 ) |
36. CarePlan.subject.extension | |
Control | 0..? |
Slicing | This element introduces a set of slices on CarePlan.subject.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
38. CarePlan.subject.extension:unidentifiedPatient | |
Slice Name | unidentifiedPatient |
Short | Dados do Indivíduo Não Identificado |
Control | 0..? |
Type | Extension(Informações Complementares de Indivíduos Não Identificados) (Complex Extension) |
Must Support | true |
40. CarePlan.subject.extension:unidentifiedPatient.extension | |
Control | 3..? |
Slicing | This element introduces a set of slices on CarePlan.subject.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
42. CarePlan.subject.extension:unidentifiedPatient.extension:gender | |
Slice Name | gender |
Control | 1..? |
Must Support | true |
44. CarePlan.subject.extension:unidentifiedPatient.extension:birthYear | |
Slice Name | birthYear |
Control | 1..? |
Must Support | true |
46. CarePlan.subject.extension:unidentifiedPatient.extension:reason | |
Slice Name | reason |
Control | 1..? |
Must Support | true |
48. CarePlan.subject.reference | |
Control | 0..0 |
50. CarePlan.subject.type | |
Control | 0..0 |
52. CarePlan.subject.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..? |
54. CarePlan.subject.identifier.use | |
Control | 0..0 |
56. CarePlan.subject.identifier.type | |
Control | 0..0 |
58. CarePlan.subject.identifier.system | |
Control | 1..? |
60. CarePlan.subject.identifier.value | |
Control | 1..? |
62. CarePlan.subject.identifier.period | |
Control | 0..0 |
64. CarePlan.subject.identifier.assigner | |
Control | 0..0 |
66. CarePlan.subject.display | |
Control | 0..0 |
68. CarePlan.encounter | |
Control | 0..0 |
70. CarePlan.period | |
Control | 0..0 |
72. CarePlan.created | |
Control | 0..0 |
74. CarePlan.author | |
Control | 0..0 |
76. CarePlan.contributor | |
Control | 0..0 |
78. CarePlan.careTeam | |
Control | 0..0 |
80. CarePlan.addresses | |
Control | 0..1 |
Type | Reference(CID10 Avaliado) |
82. CarePlan.addresses.reference | |
Control | 1..? |
84. CarePlan.addresses.type | |
Control | 0..0 |
86. CarePlan.addresses.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..0 |
94. CarePlan.addresses.display | |
Control | 0..0 |
96. CarePlan.supportingInfo | |
Control | 0..0 |
98. CarePlan.goal | |
Control | 0..0 |
100. CarePlan.activity | |
Control | 1..1 |
102. CarePlan.activity.id | |
Control | 0..0 |
104. CarePlan.activity.outcomeCodeableConcept | |
Control | 0..0 |
106. CarePlan.activity.outcomeReference | |
Control | 0..0 |
108. CarePlan.activity.progress | |
Control | 0..0 |
110. CarePlan.activity.reference | |
Control | 0..0 |
112. CarePlan.activity.detail | |
Control | 1..? |
114. CarePlan.activity.detail.id | |
Control | 0..0 |
116. CarePlan.activity.detail.kind | |
Control | 0..0 |
118. CarePlan.activity.detail.instantiatesCanonical | |
Control | 0..0 |
120. CarePlan.activity.detail.instantiatesUri | |
Control | 0..0 |
122. CarePlan.activity.detail.code | |
Control | 0..0 |
124. CarePlan.activity.detail.reasonCode | |
Control | 0..0 |
126. CarePlan.activity.detail.reasonReference | |
Control | 0..0 |
128. CarePlan.activity.detail.goal | |
Control | 0..0 |
130. CarePlan.activity.detail.status | |
Binding | The codes SHALL be taken from Status do afastamento descrito no atestado (required to http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoAfastamentoAtestado )Estado do afastamento |
Fixed Value | unknown |
132. CarePlan.activity.detail.statusReason | |
Control | 0..0 |
134. CarePlan.activity.detail.doNotPerform | |
Control | 0..0 |
136. CarePlan.activity.detail.scheduled[x] | |
Control | 1..? |
Type | Timing, string, Period |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
138. CarePlan.activity.detail.scheduled[x].event | |
Short | Data de início do afastamento |
Control | 1..1 |
140. CarePlan.activity.detail.scheduled[x].repeat | |
Control | 1..? |
142. CarePlan.activity.detail.scheduled[x].repeat.id | |
Control | 0..0 |
144. CarePlan.activity.detail.scheduled[x].repeat.bounds[x] | |
Control | 0..0 |
146. CarePlan.activity.detail.scheduled[x].repeat.count | |
Definition | Tempo do afastamento quantificado em dias. |
Short | Tempo de afastamento |
Control | 1..? |
148. CarePlan.activity.detail.scheduled[x].repeat.countMax | |
Control | 0..0 |
150. CarePlan.activity.detail.scheduled[x].repeat.duration | |
Control | 0..0 |
152. CarePlan.activity.detail.scheduled[x].repeat.durationMax | |
Control | 0..0 |
154. CarePlan.activity.detail.scheduled[x].repeat.durationUnit | |
Control | 0..0 |
156. CarePlan.activity.detail.scheduled[x].repeat.frequency | |
Control | 0..0 |
158. CarePlan.activity.detail.scheduled[x].repeat.frequencyMax | |
Control | 0..0 |
160. CarePlan.activity.detail.scheduled[x].repeat.period | |
Control | 0..0 |
162. CarePlan.activity.detail.scheduled[x].repeat.periodMax | |
Control | 0..0 |
164. CarePlan.activity.detail.scheduled[x].repeat.periodUnit | |
Control | 0..0 |
166. CarePlan.activity.detail.scheduled[x].repeat.dayOfWeek | |
Control | 0..0 |
168. CarePlan.activity.detail.scheduled[x].repeat.timeOfDay | |
Control | 0..0 |
170. CarePlan.activity.detail.scheduled[x].repeat.when | |
Control | 0..0 |
172. CarePlan.activity.detail.scheduled[x].repeat.offset | |
Control | 0..0 |
174. CarePlan.activity.detail.scheduled[x].code | |
Control | 0..0 |
176. CarePlan.activity.detail.location | |
Control | 0..0 |
178. CarePlan.activity.detail.performer | |
Control | 0..0 |
180. CarePlan.activity.detail.product[x] | |
Control | 0..0 |
182. CarePlan.activity.detail.dailyAmount | |
Control | 0..0 |
184. CarePlan.activity.detail.quantity | |
Control | 0..0 |
186. CarePlan.activity.detail.description | |
Definition | Informações adicionais sobre o afastamento. |
Short | Informações adicionais |
188. CarePlan.note | |
Control | 0..0 |
Guidance on how to interpret the contents of this table can be found here
0. CarePlan | |
Definition | Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions. |
Short | Atestado médico/odontológicoHealthcare plan for patient or group |
Control | 0..* |
Is Modifier | false |
Summary | false |
Alternate Names | Care Team |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) |
2. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Short | A set of rules under which this content was created |
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Summary | false |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
6. CarePlan.identifier | |
Definition | Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
Short | External Ids for this plan |
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..0* |
Type | Identifier |
Is Modifier | false |
Summary | true |
Requirements | Allows identification of the care plan as it is known by various participating systems and in a way that remains consistent across servers. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
8. CarePlan.instantiatesCanonical | |
Definition | The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan. |
Short | Instantiates FHIR protocol or definition |
Control | 0..0* |
Type | canonical(PlanDefinition, Questionnaire, Measure, ActivityDefinition, OperationDefinition) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
10. CarePlan.instantiatesUri | |
Definition | The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan. |
Short | Instantiates external protocol or definition |
Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. |
Control | 0..0* |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
12. CarePlan.basedOn | |
Definition | A care plan that is fulfilled in whole or in part by this care plan. |
Short | Fulfills CarePlan |
Control | 0..0* |
Type | Reference(CarePlan) |
Is Modifier | false |
Summary | true |
Requirements | Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon. |
Alternate Names | fulfills |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
14. CarePlan.replaces | |
Definition | Completed or terminated care plan whose function is taken by this new care plan. |
Short | CarePlan replaced by this CarePlan |
Comments | The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing. |
Control | 0..0* |
Type | Reference(CarePlan) |
Is Modifier | false |
Summary | true |
Requirements | Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans. |
Alternate Names | supersedes |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
16. CarePlan.partOf | |
Definition | A larger care plan of which this particular care plan is a component or step. |
Short | Part of referenced CarePlan |
Comments | Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed. |
Control | 0..0* |
Type | Reference(CarePlan) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. CarePlan.status | |
Definition | Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. |
Short | Estado do atestado.draft | active | on-hold | revoked | completed | entered-in-error | unknown |
Comments | The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan. This element is labeled as a modifier because the status contains the code entered-in-error that marks the plan as not currently valid. |
Control | 1..1 |
Binding | The codes SHALL be taken from Status do atestadohttp://hl7.org/fhir/ValueSet/request-status|4.0.1 (required to http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoAtestado )Estado do atestado. Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. |
Type | code |
Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows clinicians to determine whether the plan is actionable or not. |
Fixed Value | active |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
20. CarePlan.intent | |
Definition | Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain. |
Short | Intenção do atestadoproposal | plan | order | option |
Comments | This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. |
Control | 1..1 |
Binding | The codes SHALL be taken from Intenção do atestadohttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 (required to http://www.saude.gov.br/fhir/r4/ValueSet/BRIntencaoAtestado )Intenção do atestado médico/odontológico Codes indicating the degree of authority/intentionality associated with a care plan. |
Type | code |
Is Modifier | true because This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request" |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain. |
Fixed Value | plan |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. CarePlan.category | |
Definition | Determina se é um atestado médico ou odontológico. Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc. |
Short | Tipo do atestadoType of plan |
Comments | There may be multiple axes of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern. |
Control | 10..1* |
Binding | The codes SHALL be taken from For example codes, see Tipo de atestadohttp://hl7.org/fhir/ValueSet/care-plan-category (required to http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoAtestado )Tipo do atestado. Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Requirements | Used for filtering what plan(s) are retrieved and displayed to different types of users. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
24. CarePlan.category.coding | |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
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 labeled as UserSelected = true. |
Control | 10..1* |
Type | Coding |
Is Modifier | false |
Summary | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
26. CarePlan.category.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Short | Identity of the terminology system |
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 reference to some definition that establishes the system clearly and unambiguously. |
Control | 10..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
28. CarePlan.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). |
Short | Symbol in syntax defined by the system |
Control | 10..1 |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
30. CarePlan.category.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Short | If this coding was chosen directly by the user |
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. |
Control | 0..01 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
32. 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. |
Short | Plain text representation of the concept |
Comments | Very often the text is the same as a displayName of one of the codings. |
Control | 0..01 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
34. CarePlan.title | |
Definition | Human-friendly name for the care plan. |
Short | Human-friendly name for the care plan |
Control | 0..01 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
36. CarePlan.description | |
Definition | A description of the scope and nature of the plan. |
Short | Summary of nature of plan |
Control | 0..01 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Provides more detail than conveyed by category. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
38. CarePlan.subject | |
Definition | Identifica o indivíduo o qual se refere este atestado. Identifies the patient or group whose intended care is described by the plan. |
Short | Identificação do IndivíduoWho the care plan is for |
Control | 1..1 |
Type | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0 , Patient, Group) |
Is Modifier | false |
Summary | true |
Alternate Names | patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
40. CarePlan.subject.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ExtensionAdditional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on CarePlan.subject.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
42. CarePlan.subject.extension:unidentifiedPatient | |
Slice Name | unidentifiedPatient |
Definition | Informações demográficas básicas e justificativa dos indivíduos que não podem ser identificados por razões clínicas ou sociais, conforme legislação brasileira, com finalidade estatística. |
Short | Dados do Indivíduo Não Identificado |
Control | 0..* |
Type | Extension(Informações Complementares de Indivíduos Não Identificados) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
44. CarePlan.subject.extension:unidentifiedPatient.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ExtensionAdditional content defined by implementations |
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. |
Control | 30..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on CarePlan.subject.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
46. CarePlan.subject.extension:unidentifiedPatient.extension:gender | |
Slice Name | gender |
Definition | An Extension |
Short | ExtensionAdditional content defined by implementations |
Control | 10..1* |
Type | Extension |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
48. CarePlan.subject.extension:unidentifiedPatient.extension:gender.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | gender |
50. CarePlan.subject.extension:unidentifiedPatient.extension:gender.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 10..1 |
Type | code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
52. CarePlan.subject.extension:unidentifiedPatient.extension:birthYear | |
Slice Name | birthYear |
Definition | An Extension |
Short | ExtensionAdditional content defined by implementations |
Control | 10..1* |
Type | Extension |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
54. CarePlan.subject.extension:unidentifiedPatient.extension:birthYear.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | birthYear |
56. CarePlan.subject.extension:unidentifiedPatient.extension:birthYear.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 10..1 |
Type | date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
58. CarePlan.subject.extension:unidentifiedPatient.extension:reason | |
Slice Name | reason |
Definition | An Extension |
Short | ExtensionAdditional content defined by implementations |
Control | 10..1* |
Type | Extension |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
60. CarePlan.subject.extension:unidentifiedPatient.extension:reason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | reason |
62. CarePlan.subject.extension:unidentifiedPatient.extension:reason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 10..1 |
Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
64. CarePlan.subject.extension:unidentifiedPatient.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
Fixed Value | http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuoNaoIdentificado-1.0 |
66. CarePlan.subject.extension:unidentifiedPatient.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 0..01 |
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
68. CarePlan.subject.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. |
Short | Literal reference, Relative, internal or absolute URL |
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. |
Control | 0..01 This element is affected by the following invariants: ref-1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
70. CarePlan.subject.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Short | Type the reference refers to (e.g. "Patient") |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Control | 0..01 |
Binding | Unless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types (extensible to http://hl7.org/fhir/ValueSet/resource-types )Aa resource (or, for logical models, the URI of the logical model). |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
72. CarePlan.subject.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Short | Logical reference, when literal reference is not known |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 10..1 |
Type | Identifier |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
74. CarePlan.subject.identifier.use | |
Definition | The purpose of this identifier. |
Short | usual | official | temp | secondary | old (If known) |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Control | 0..01 |
Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
76. CarePlan.subject.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Short | Description of identifier |
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. |
Control | 0..01 |
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type (extensible to http://hl7.org/fhir/ValueSet/identifier-type )A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
78. CarePlan.subject.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Short | The namespace for the identifier value |
Comments | Identifier.system is always case sensitive. |
Control | 10..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
80. CarePlan.subject.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Short | The value that is unique |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Control | 10..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Example | <br/><b>General</b>:123456 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
82. CarePlan.subject.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Short | Time period when id is/was valid for use |
Control | 0..01 |
Type | Period |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
84. CarePlan.subject.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Short | Organization that issued id (may be just text) |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Control | 0..01 |
Type | Reference(Organization) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
86. CarePlan.subject.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Short | Text alternative for the resource |
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. |
Control | 0..01 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
88. CarePlan.encounter | |
Definition | The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated. |
Short | Encounter created as part of |
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters. |
Control | 0..01 |
Type | Reference(Encounter) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
90. CarePlan.period | |
Definition | Indicates when the plan did (or is intended to) come into effect and end. |
Short | Time period plan covers |
Comments | Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition). |
Control | 0..01 |
Type | Period |
Is Modifier | false |
Summary | true |
Requirements | Allows tracking what plan(s) are in effect at a particular time. |
Alternate Names | timing |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
92. CarePlan.created | |
Definition | Represents when this particular CarePlan record was created in the system, which is often a system-generated date. |
Short | Date record was first recorded |
Control | 0..01 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | authoredOn |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
94. CarePlan.author | |
Definition | When populated, the author is responsible for the care plan. The care plan is attributed to the author. |
Short | Who is the designated responsible party |
Comments | The author may also be a contributor. For example, an organization can be an author, but not listed as a contributor. |
Control | 0..01 |
Type | Reference(Patient, Practitioner, PractitionerRole, Device, RelatedPerson, Organization, CareTeam) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
96. CarePlan.contributor | |
Definition | Identifies the individual(s) or organization who provided the contents of the care plan. |
Short | Who provided the content of the care plan |
Comments | Collaborative care plans may have multiple contributors. |
Control | 0..0* |
Type | Reference(Patient, Practitioner, PractitionerRole, Device, RelatedPerson, Organization, CareTeam) |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
98. CarePlan.careTeam | |
Definition | Identifies all people and organizations who are expected to be involved in the care envisioned by this plan. |
Short | Who's involved in plan? |
Control | 0..0* |
Type | Reference(CareTeam) |
Is Modifier | false |
Summary | false |
Requirements | Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
100. CarePlan.addresses | |
Definition | Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan. |
Short | Health issues this plan addresses |
Comments | When the diagnosis is related to an allergy or intolerance, the Condition and AllergyIntolerance resources can both be used. However, to be actionable for decision support, using Condition alone is not sufficient as the allergy or intolerance condition needs to be represented as an AllergyIntolerance. |
Control | 0..1* |
Type | Reference(CID10 Avaliado, Condition) |
Is Modifier | false |
Summary | true |
Requirements | Links plan to the conditions it manages. The element can identify risks addressed by the plan as well as active conditions. (The Condition resource can include things like "at risk for hypertension" or "fall risk".) Also scopes plans - multiple plans may exist addressing different concerns. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
102. 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. |
Short | Literal reference, Relative, internal or absolute URL |
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. |
Control | 10..1 This element is affected by the following invariants: ref-1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
104. CarePlan.addresses.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Short | Type the reference refers to (e.g. "Patient") |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Control | 0..01 |
Binding | Unless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types (extensible to http://hl7.org/fhir/ValueSet/resource-types )Aa resource (or, for logical models, the URI of the logical model). |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
106. CarePlan.addresses.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Short | Logical reference, when literal reference is not known |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..01 |
Type | Identifier |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
114. CarePlan.addresses.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Short | Text alternative for the resource |
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. |
Control | 0..01 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
116. CarePlan.supportingInfo | |
Definition | Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc. |
Short | Information considered as part of plan |
Comments | Use "concern" to identify specific conditions addressed by the care plan. |
Control | 0..0* |
Type | Reference(Resource) |
Is Modifier | false |
Summary | false |
Requirements | Identifies barriers and other considerations associated with the care plan. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
118. CarePlan.goal | |
Definition | Describes the intended objective(s) of carrying out the care plan. |
Short | Desired outcome of plan |
Comments | Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline. |
Control | 0..0* |
Type | Reference(Goal) |
Is Modifier | false |
Summary | false |
Requirements | Provides context for plan. Allows plan effectiveness to be evaluated by clinicians. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
120. 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. |
Short | Action to occur as part of plan |
Control | 10..1* |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Requirements | Allows systems to prompt for performance of planned activities, and validate plans against best practice. |
Invariants | cpl-3: Provide a reference or detail, not both (detail.empty() or reference.empty() )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) cpl-3: Provide a reference or detail, not both (detail.empty() or reference.empty()) |
122. CarePlan.activity.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..01 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
124. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
126. CarePlan.activity.outcomeCodeableConcept | |
Definition | Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not). |
Short | Results of the activity |
Comments | Note that this should not duplicate the activity status (e.g. completed or in progress). |
Control | 0..0* |
Binding | For example codes, see CarePlanActivityOutcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcome (example to http://hl7.org/fhir/ValueSet/care-plan-activity-outcome )Identifies the results of the activity. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
128. CarePlan.activity.outcomeReference | |
Definition | Details of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource). |
Short | Appointment, Encounter, Procedure, etc. |
Comments | The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured. |
Control | 0..0* |
Type | Reference(Resource) |
Is Modifier | false |
Summary | false |
Requirements | Links plan to resulting actions. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
130. CarePlan.activity.progress | |
Definition | Notes about the adherence/status/progress of the activity. |
Short | Comments about the activity status/progress |
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. |
Control | 0..0* |
Type | Annotation |
Is Modifier | false |
Summary | false |
Requirements | Can be used to capture information about adherence, progress, concerns, etc. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
132. CarePlan.activity.reference | |
Definition | The details of the proposed activity represented in a specific resource. |
Short | Activity details defined in specific resource |
Comments | Standard extension exists (resource-pertainsToGoal) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference. |
Control | 0..01 This element is affected by the following invariants: cpl-3 |
Type | Reference(Appointment, CommunicationRequest, DeviceRequest, MedicationRequest, NutritionOrder, Task, ServiceRequest, VisionPrescription, RequestGroup) |
Is Modifier | false |
Summary | false |
Requirements | Details in a form consistent with other applications and contexts of use. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
134. 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. |
Short | In-line definition of activity |
Control | 10..1 This element is affected by the following invariants: cpl-3 |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Requirements | Details in a simple form for generic care plan systems. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
136. CarePlan.activity.detail.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..01 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
138. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
140. CarePlan.activity.detail.kind | |
Definition | A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. |
Short | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription |
Control | 0..01 |
Binding | The codes SHALL be taken from CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1 (required to http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1 )Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | May determine what types of extensions are permitted. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
142. CarePlan.activity.detail.instantiatesCanonical | |
Definition | The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity. |
Short | Instantiates FHIR protocol or definition |
Control | 0..0* |
Type | canonical(PlanDefinition, ActivityDefinition, Questionnaire, Measure, OperationDefinition) |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
144. CarePlan.activity.detail.instantiatesUri | |
Definition | The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity. |
Short | Instantiates external protocol or definition |
Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. |
Control | 0..0* |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
146. CarePlan.activity.detail.code | |
Definition | Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter. |
Short | Detail type of activity |
Comments | Tends to be less relevant for activities involving particular products. Codes should not convey negation - use "prohibited" instead. |
Control | 0..01 |
Binding | For example codes, see ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code (example to http://hl7.org/fhir/ValueSet/procedure-code )Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | Allows matching performed to planned as well as validation against protocols. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
148. CarePlan.activity.detail.reasonCode | |
Definition | Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited. |
Short | Why activity should be done or why activity was prohibited |
Comments | This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead. |
Control | 0..0* |
Binding | For example codes, see SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings (example to http://hl7.org/fhir/ValueSet/clinical-findings )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. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
150. CarePlan.activity.detail.reasonReference | |
Definition | Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan. |
Short | Why activity is needed |
Comments | Conditions can be identified at the activity level that are not identified as reasons for the overall plan. |
Control | 0..0* |
Type | Reference(Condition, Observation, DiagnosticReport, DocumentReference) |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
152. CarePlan.activity.detail.goal | |
Definition | Internal reference that identifies the goals that this activity is intended to contribute towards meeting. |
Short | Goals this activity relates to |
Control | 0..0* |
Type | Reference(Goal) |
Is Modifier | false |
Summary | false |
Requirements | So that participants know the link explicitly. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
154. CarePlan.activity.detail.status | |
Definition | Identifies what progress is being made for the specific activity. |
Short | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error |
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. |
Control | 1..1 |
Binding | The codes SHALL be taken from Status do afastamento descrito no atestadohttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1 (required to http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoAfastamentoAtestado )Estado do afastamento Codes that reflect the current state of a care plan activity within its overall life cycle. |
Type | code |
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the activity should not be treated as valid |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Indicates progress against the plan, whether the activity is still relevant for the plan. |
Fixed Value | unknown |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
156. CarePlan.activity.detail.statusReason | |
Definition | Provides reason why the activity isn't yet started, is on hold, was cancelled, etc. |
Short | Reason for current status |
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. |
Control | 0..01 |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
158. CarePlan.activity.detail.doNotPerform | |
Definition | If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan. |
Short | If true, activity is prohibiting action |
Comments | This element is labeled as a modifier because it marks an activity as an activity that is not to be performed. |
Control | 0..01 |
Type | boolean |
Is Modifier | true because If true this element negates the specified action. For example, instead of a request for a procedure, it is a request for the procedure to not occur. |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Captures intention to not do something that may have been previously typical. |
Meaning if Missing | If missing indicates that the described activity is one that should be engaged in when following the plan. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
160. CarePlan.activity.detail.scheduled[x] | |
Definition | The period, timing or frequency upon which the described activity is to occur. |
Short | When activity is to occur |
Control | 10..1 |
Type | Timing, string, Period |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Requirements | Allows prompting for activities and detection of missed planned activities. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
162. CarePlan.activity.detail.scheduled[x].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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
164. CarePlan.activity.detail.scheduled[x].event | |
Definition | Identifies specific times when the event occurs. |
Short | Data de início do afastamentoWhen the event occurs |
Control | 10..1* |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
166. CarePlan.activity.detail.scheduled[x].repeat | |
Definition | A set of rules that describe when the event is scheduled. |
Short | When the event is to occur |
Control | 10..1 |
Type | Element |
Is Modifier | false |
Summary | true |
Requirements | Many timing schedules are determined by regular repetitions. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) tim-1: if there's a duration, there needs to be duration units ( duration.empty() or durationUnit.exists() )tim-2: if there's a period, there needs to be period units ( period.empty() or periodUnit.exists() )tim-4: duration SHALL be a non-negative value ( duration.exists() implies duration >= 0 )tim-5: period SHALL be a non-negative value ( period.exists() implies period >= 0 )tim-6: If there's a periodMax, there must be a period ( periodMax.empty() or period.exists() )tim-7: If there's a durationMax, there must be a duration ( durationMax.empty() or duration.exists() )tim-8: If there's a countMax, there must be a count ( countMax.empty() or count.exists() )tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) ( offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) )tim-10: If there's a timeOfDay, there cannot be a when, or vice versa ( timeOfDay.empty() or when.empty() )tim-1: if there's a duration, there needs to be duration units (duration.empty() or durationUnit.exists()) tim-2: if there's a period, there needs to be period units (period.empty() or periodUnit.exists()) tim-4: duration SHALL be a non-negative value (duration.exists() implies duration >= 0) tim-5: period SHALL be a non-negative value (period.exists() implies period >= 0) tim-6: If there's a periodMax, there must be a period (periodMax.empty() or period.exists()) tim-7: If there's a durationMax, there must be a duration (durationMax.empty() or duration.exists()) tim-8: If there's a countMax, there must be a count (countMax.empty() or count.exists()) tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) (offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa (timeOfDay.empty() or when.empty()) |
168. CarePlan.activity.detail.scheduled[x].repeat.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..01 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
170. CarePlan.activity.detail.scheduled[x].repeat.bounds[x] | |
Definition | Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. |
Short | Length/Range of lengths, or (Start and/or end) limits |
Control | 0..01 |
Type | Choice of: Duration, Range, Period |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
172. CarePlan.activity.detail.scheduled[x].repeat.count | |
Definition | Tempo do afastamento quantificado em dias. A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values. |
Short | Tempo de afastamentoNumber of times to repeat |
Comments | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens. |
Control | 10..1 |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Repetitions may be limited by end time or total occurrences. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
174. CarePlan.activity.detail.scheduled[x].repeat.countMax | |
Definition | If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times. |
Short | Maximum number of times to repeat |
Control | 0..01 |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
176. CarePlan.activity.detail.scheduled[x].repeat.duration | |
Definition | How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration. |
Short | How long when it happens |
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). |
Control | 0..01 |
Type | decimal |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
178. CarePlan.activity.detail.scheduled[x].repeat.durationMax | |
Definition | If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. |
Short | How long when it happens (Max) |
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). |
Control | 0..01 |
Type | decimal |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
180. CarePlan.activity.detail.scheduled[x].repeat.durationUnit | |
Definition | The units of time for the duration, in UCUM units. |
Short | s | min | h | d | wk | mo | a - unit of time (UCUM) |
Control | 0..01 |
Binding | The codes SHALL be taken from UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 (required to http://hl7.org/fhir/ValueSet/units-of-time|4.0.1 )A unit of time (units from UCUM). |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
182. CarePlan.activity.detail.scheduled[x].repeat.frequency | |
Definition | The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency. |
Short | Event occurs frequency times per period |
Control | 0..01 |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Meaning if Missing | If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
184. CarePlan.activity.detail.scheduled[x].repeat.frequencyMax | |
Definition | If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. |
Short | Event occurs up to frequencyMax times per period |
Control | 0..01 |
Type | positiveInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
186. CarePlan.activity.detail.scheduled[x].repeat.period | |
Definition | Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length. |
Short | Event occurs frequency times per period |
Control | 0..01 |
Type | decimal |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
188. CarePlan.activity.detail.scheduled[x].repeat.periodMax | |
Definition | If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. |
Short | Upper limit of period (3-4 hours) |
Control | 0..01 |
Type | decimal |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
190. CarePlan.activity.detail.scheduled[x].repeat.periodUnit | |
Definition | The units of time for the period in UCUM units. |
Short | s | min | h | d | wk | mo | a - unit of time (UCUM) |
Control | 0..01 |
Binding | The codes SHALL be taken from UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 (required to http://hl7.org/fhir/ValueSet/units-of-time|4.0.1 )A unit of time (units from UCUM). |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
192. CarePlan.activity.detail.scheduled[x].repeat.dayOfWeek | |
Definition | If one or more days of week is provided, then the action happens only on the specified day(s). |
Short | mon | tue | wed | thu | fri | sat | sun |
Comments | If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek. |
Control | 0..0* |
Binding | The codes SHALL be taken from DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 (required to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 ) |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
194. CarePlan.activity.detail.scheduled[x].repeat.timeOfDay | |
Definition | Specified time of day for action to take place. |
Short | Time of day for action |
Comments | When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay. |
Control | 0..0* |
Type | time |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
196. CarePlan.activity.detail.scheduled[x].repeat.when | |
Definition | An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. |
Short | Code for time period of occurrence |
Comments | When more than one event is listed, the event is tied to the union of the specified events. |
Control | 0..0* |
Binding | The codes SHALL be taken from EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1 (required to http://hl7.org/fhir/ValueSet/event-timing|4.0.1 )Real world event relating to the schedule. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
198. CarePlan.activity.detail.scheduled[x].repeat.offset | |
Definition | The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event. |
Short | Minutes from event (before or after) |
Control | 0..01 |
Type | unsignedInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
200. CarePlan.activity.detail.scheduled[x].code | |
Definition | A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). |
Short | BID | TID | QID | AM | PM | QD | QOD | + |
Comments | BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times). |
Control | 0..01 |
Binding | The codes SHOULD be taken from TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviation (preferred to http://hl7.org/fhir/ValueSet/timing-abbreviation )Code for a known / defined timing pattern. |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
202. CarePlan.activity.detail.location | |
Definition | Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. |
Short | Where it should happen |
Comments | May reference a specific clinical location or may identify a type of location. |
Control | 0..01 |
Type | Reference(Location) |
Is Modifier | false |
Summary | false |
Requirements | Helps in planning of activity. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
204. CarePlan.activity.detail.performer | |
Definition | Identifies who's expected to be involved in the activity. |
Short | Who will be responsible? |
Comments | A performer MAY also be a participant in the care plan. |
Control | 0..0* |
Type | Reference(Practitioner, PractitionerRole, Organization, RelatedPerson, Patient, CareTeam, HealthcareService, Device) |
Is Modifier | false |
Summary | false |
Requirements | Helps in planning of activity. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
206. CarePlan.activity.detail.product[x] | |
Definition | Identifies the food, drug or other product to be consumed or supplied in the activity. |
Short | What is to be administered/supplied |
Control | 0..01 |
Binding | For example codes, see SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes (example to http://hl7.org/fhir/ValueSet/medication-codes )A product supplied or administered as part of a care plan activity. |
Type | Choice of: CodeableConcept, Reference(Medication, Substance) |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
208. CarePlan.activity.detail.dailyAmount | |
Definition | Identifies the quantity expected to be consumed in a given day. |
Short | How to consume/day? |
Control | 0..01 |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Summary | false |
Requirements | Allows rough dose checking. |
Alternate Names | daily dose |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
210. CarePlan.activity.detail.quantity | |
Definition | Identifies the quantity expected to be supplied, administered or consumed by the subject. |
Short | How much to administer/supply/consume |
Control | 0..01 |
Type | Quantity(SimpleQuantity) |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
212. CarePlan.activity.detail.description | |
Definition | Informações adicionais sobre o afastamento. 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. |
Short | Informações adicionaisExtra info describing activity to perform |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
214. CarePlan.note | |
Definition | General notes about the care plan not covered elsewhere. |
Short | Comments about the plan |
Control | 0..0* |
Type | Annotation |
Is Modifier | false |
Summary | false |
Requirements | Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. CarePlan | |||||
Definition | Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions. | ||||
Short | Atestado médico/odontológico | ||||
Control | 0..* | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | Care Team | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() )dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() )dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.exists() ) | ||||
2. CarePlan.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical id of this artifact | ||||
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. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Summary | true | ||||
4. CarePlan.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
6. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
Short | A set of rules under which this content was created | ||||
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
8. CarePlan.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
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). | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
10. CarePlan.text | |||||
Definition | A human-readable narrative that contains a summary of the resource and can 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. | ||||
Short | Text summary of the resource, for human interpretation | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
12. 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. | ||||
Short | Contained, inline 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. CarePlan.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
16. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
Summary | false | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
18. CarePlan.identifier | |||||
Definition | Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server. | ||||
Short | External Ids for this plan | ||||
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..0 | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows identification of the care plan as it is known by various participating systems and in a way that remains consistent across servers. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
20. CarePlan.instantiatesCanonical | |||||
Definition | The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan. | ||||
Short | Instantiates FHIR protocol or definition | ||||
Control | 0..0 | ||||
Type | canonical(PlanDefinition, Questionnaire, Measure, ActivityDefinition, OperationDefinition) | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
22. CarePlan.instantiatesUri | |||||
Definition | The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan. | ||||
Short | Instantiates external protocol or definition | ||||
Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. | ||||
Control | 0..0 | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
24. CarePlan.basedOn | |||||
Definition | A care plan that is fulfilled in whole or in part by this care plan. | ||||
Short | Fulfills CarePlan | ||||
Control | 0..0 | ||||
Type | Reference(CarePlan) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon. | ||||
Alternate Names | fulfills | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
26. CarePlan.replaces | |||||
Definition | Completed or terminated care plan whose function is taken by this new care plan. | ||||
Short | CarePlan replaced by this CarePlan | ||||
Comments | The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing. | ||||
Control | 0..0 | ||||
Type | Reference(CarePlan) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans. | ||||
Alternate Names | supersedes | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
28. CarePlan.partOf | |||||
Definition | A larger care plan of which this particular care plan is a component or step. | ||||
Short | Part of referenced CarePlan | ||||
Comments | Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed. | ||||
Control | 0..0 | ||||
Type | Reference(CarePlan) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
30. CarePlan.status | |||||
Definition | Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | ||||
Short | Estado do atestado. | ||||
Comments | The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan. This element is labeled as a modifier because the status contains the code entered-in-error that marks the plan as not currently valid. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from Status do atestado (required to http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoAtestado )Estado do atestado. | ||||
Type | code | ||||
Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows clinicians to determine whether the plan is actionable or not. | ||||
Fixed Value | active | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
32. CarePlan.intent | |||||
Definition | Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain. | ||||
Short | Intenção do atestado | ||||
Comments | This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from Intenção do atestado (required to http://www.saude.gov.br/fhir/r4/ValueSet/BRIntencaoAtestado )Intenção do atestado médico/odontológico | ||||
Type | code | ||||
Is Modifier | true because This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request" | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain. | ||||
Fixed Value | plan | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
34. CarePlan.category | |||||
Definition | Determina se é um atestado médico ou odontológico. | ||||
Short | Tipo do atestado | ||||
Comments | There may be multiple axes of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from Tipo de atestado (required to http://www.saude.gov.br/fhir/r4/ValueSet/BRTipoAtestado )Tipo do atestado. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Used for filtering what plan(s) are retrieved and displayed to different types of users. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
36. CarePlan.category.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
38. CarePlan.category.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CarePlan.category.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
40. CarePlan.category.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | Code defined by a terminology system | ||||
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 labeled as UserSelected = true. | ||||
Control | 1..1 | ||||
Type | Coding | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
42. CarePlan.category.coding.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
44. CarePlan.category.coding.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CarePlan.category.coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
46. CarePlan.category.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Short | Identity of the terminology system | ||||
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 reference to some definition that establishes the system clearly and unambiguously. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
48. 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. | ||||
Short | Version of the system - if relevant | ||||
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. | ||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
50. CarePlan.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). | ||||
Short | Symbol in syntax defined by the system | ||||
Control | 1..1 | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
52. CarePlan.category.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Short | Representation defined by the system | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
54. CarePlan.category.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Short | If this coding was chosen directly by the user | ||||
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. | ||||
Control | 0..0 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
56. 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. | ||||
Short | Plain text representation of the concept | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Control | 0..0 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
58. CarePlan.title | |||||
Definition | Human-friendly name for the care plan. | ||||
Short | Human-friendly name for the care plan | ||||
Control | 0..0 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
60. CarePlan.description | |||||
Definition | A description of the scope and nature of the plan. | ||||
Short | Summary of nature of plan | ||||
Control | 0..0 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Provides more detail than conveyed by category. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
62. CarePlan.subject | |||||
Definition | Identifica o indivíduo o qual se refere este atestado. | ||||
Short | Identificação do Indivíduo | ||||
Control | 1..1 | ||||
Type | Reference(http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuo-1.0 ) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Alternate Names | patient | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
64. CarePlan.subject.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
66. CarePlan.subject.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CarePlan.subject.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
68. CarePlan.subject.extension:unidentifiedPatient | |||||
Slice Name | unidentifiedPatient | ||||
Definition | Informações demográficas básicas e justificativa dos indivíduos que não podem ser identificados por razões clínicas ou sociais, conforme legislação brasileira, com finalidade estatística. | ||||
Short | Dados do Indivíduo Não Identificado | ||||
Control | 0..* | ||||
Type | Extension(Informações Complementares de Indivíduos Não Identificados) (Complex Extension) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
70. CarePlan.subject.extension:unidentifiedPatient.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
72. CarePlan.subject.extension:unidentifiedPatient.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 3..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CarePlan.subject.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
74. CarePlan.subject.extension:unidentifiedPatient.extension:gender | |||||
Slice Name | gender | ||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 1..1 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
76. CarePlan.subject.extension:unidentifiedPatient.extension:gender.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
78. CarePlan.subject.extension:unidentifiedPatient.extension:gender.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CarePlan.subject.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
80. CarePlan.subject.extension:unidentifiedPatient.extension:gender.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | gender | ||||
82. CarePlan.subject.extension:unidentifiedPatient.extension:gender.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 1..1 | ||||
Type | code | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
84. CarePlan.subject.extension:unidentifiedPatient.extension:birthYear | |||||
Slice Name | birthYear | ||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 1..1 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
86. CarePlan.subject.extension:unidentifiedPatient.extension:birthYear.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
88. CarePlan.subject.extension:unidentifiedPatient.extension:birthYear.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CarePlan.subject.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
90. CarePlan.subject.extension:unidentifiedPatient.extension:birthYear.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | birthYear | ||||
92. CarePlan.subject.extension:unidentifiedPatient.extension:birthYear.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 1..1 | ||||
Type | date | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
94. CarePlan.subject.extension:unidentifiedPatient.extension:reason | |||||
Slice Name | reason | ||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 1..1 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
96. CarePlan.subject.extension:unidentifiedPatient.extension:reason.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
98. CarePlan.subject.extension:unidentifiedPatient.extension:reason.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CarePlan.subject.extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
100. CarePlan.subject.extension:unidentifiedPatient.extension:reason.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | reason | ||||
102. CarePlan.subject.extension:unidentifiedPatient.extension:reason.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 1..1 | ||||
Type | CodeableConcept | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
104. CarePlan.subject.extension:unidentifiedPatient.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
Fixed Value | http://www.saude.gov.br/fhir/r4/StructureDefinition/BRIndividuoNaoIdentificado-1.0 | ||||
106. CarePlan.subject.extension:unidentifiedPatient.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Short | Value of extension | ||||
Control | 0..0 | ||||
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
108. CarePlan.subject.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. | ||||
Short | Literal reference, Relative, internal or absolute URL | ||||
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. | ||||
Control | 0..0 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
110. CarePlan.subject.type | |||||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||
Short | Type the reference refers to (e.g. "Patient") | ||||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||
Control | 0..0 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types )Aa resource (or, for logical models, the URI of the logical model). | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
112. CarePlan.subject.identifier | |||||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Short | Logical reference, when literal reference is not known | ||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 1..1 | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
114. CarePlan.subject.identifier.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
116. CarePlan.subject.identifier.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CarePlan.subject.identifier.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
118. CarePlan.subject.identifier.use | |||||
Definition | The purpose of this identifier. | ||||
Short | usual | official | temp | secondary | old (If known) | ||||
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
Control | 0..0 | ||||
Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . | ||||
Type | code | ||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
120. CarePlan.subject.identifier.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Short | Description of identifier | ||||
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. | ||||
Control | 0..0 | ||||
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type )A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
122. CarePlan.subject.identifier.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Short | The namespace for the identifier value | ||||
Comments | Identifier.system is always case sensitive. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
124. CarePlan.subject.identifier.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Short | The value that is unique | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
Control | 1..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Example | <br/><b>General</b>:123456 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
126. CarePlan.subject.identifier.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Short | Time period when id is/was valid for use | ||||
Control | 0..0 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
128. CarePlan.subject.identifier.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Short | Organization that issued id (may be just text) | ||||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
Control | 0..0 | ||||
Type | Reference(Organization) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
130. CarePlan.subject.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Short | Text alternative for the resource | ||||
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. | ||||
Control | 0..0 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
132. CarePlan.encounter | |||||
Definition | The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated. | ||||
Short | Encounter created as part of | ||||
Comments | This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters. | ||||
Control | 0..0 | ||||
Type | Reference(Encounter) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
134. CarePlan.period | |||||
Definition | Indicates when the plan did (or is intended to) come into effect and end. | ||||
Short | Time period plan covers | ||||
Comments | Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition). | ||||
Control | 0..0 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows tracking what plan(s) are in effect at a particular time. | ||||
Alternate Names | timing | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
136. CarePlan.created | |||||
Definition | Represents when this particular CarePlan record was created in the system, which is often a system-generated date. | ||||
Short | Date record was first recorded | ||||
Control | 0..0 | ||||
Type | dateTime | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | authoredOn | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
138. CarePlan.author | |||||
Definition | When populated, the author is responsible for the care plan. The care plan is attributed to the author. | ||||
Short | Who is the designated responsible party | ||||
Comments | The author may also be a contributor. For example, an organization can be an author, but not listed as a contributor. | ||||
Control | 0..0 | ||||
Type | Reference(Patient, Practitioner, PractitionerRole, Device, RelatedPerson, Organization, CareTeam) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
140. CarePlan.contributor | |||||
Definition | Identifies the individual(s) or organization who provided the contents of the care plan. | ||||
Short | Who provided the content of the care plan | ||||
Comments | Collaborative care plans may have multiple contributors. | ||||
Control | 0..0 | ||||
Type | Reference(Patient, Practitioner, PractitionerRole, Device, RelatedPerson, Organization, CareTeam) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
142. CarePlan.careTeam | |||||
Definition | Identifies all people and organizations who are expected to be involved in the care envisioned by this plan. | ||||
Short | Who's involved in plan? | ||||
Control | 0..0 | ||||
Type | Reference(CareTeam) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
144. CarePlan.addresses | |||||
Definition | Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan. | ||||
Short | Health issues this plan addresses | ||||
Comments | When the diagnosis is related to an allergy or intolerance, the Condition and AllergyIntolerance resources can both be used. However, to be actionable for decision support, using Condition alone is not sufficient as the allergy or intolerance condition needs to be represented as an AllergyIntolerance. | ||||
Control | 0..1 | ||||
Type | Reference(CID10 Avaliado) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Links plan to the conditions it manages. The element can identify risks addressed by the plan as well as active conditions. (The Condition resource can include things like "at risk for hypertension" or "fall risk".) Also scopes plans - multiple plans may exist addressing different concerns. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
146. CarePlan.addresses.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
148. CarePlan.addresses.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CarePlan.addresses.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
150. 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. | ||||
Short | Literal reference, Relative, internal or absolute URL | ||||
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. | ||||
Control | 1..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
152. CarePlan.addresses.type | |||||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||
Short | Type the reference refers to (e.g. "Patient") | ||||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||
Control | 0..0 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types )Aa resource (or, for logical models, the URI of the logical model). | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
154. CarePlan.addresses.identifier | |||||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Short | Logical reference, when literal reference is not known | ||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..0 | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
164. CarePlan.addresses.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Short | Text alternative for the resource | ||||
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. | ||||
Control | 0..0 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
166. CarePlan.supportingInfo | |||||
Definition | Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc. | ||||
Short | Information considered as part of plan | ||||
Comments | Use "concern" to identify specific conditions addressed by the care plan. | ||||
Control | 0..0 | ||||
Type | Reference(Resource) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Identifies barriers and other considerations associated with the care plan. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
168. CarePlan.goal | |||||
Definition | Describes the intended objective(s) of carrying out the care plan. | ||||
Short | Desired outcome of plan | ||||
Comments | Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline. | ||||
Control | 0..0 | ||||
Type | Reference(Goal) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Provides context for plan. Allows plan effectiveness to be evaluated by clinicians. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
170. 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. | ||||
Short | Action to occur as part of plan | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Allows systems to prompt for performance of planned activities, and validate plans against best practice. | ||||
Invariants | cpl-3: Provide a reference or detail, not both (detail.empty() or reference.empty() )ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) ) | ||||
172. CarePlan.activity.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..0 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
174. CarePlan.activity.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
176. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
178. CarePlan.activity.outcomeCodeableConcept | |||||
Definition | Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not). | ||||
Short | Results of the activity | ||||
Comments | Note that this should not duplicate the activity status (e.g. completed or in progress). | ||||
Control | 0..0 | ||||
Binding | For example codes, see CarePlanActivityOutcome (example to http://hl7.org/fhir/ValueSet/care-plan-activity-outcome )Identifies the results of the activity. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
180. CarePlan.activity.outcomeReference | |||||
Definition | Details of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource). | ||||
Short | Appointment, Encounter, Procedure, etc. | ||||
Comments | The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured. | ||||
Control | 0..0 | ||||
Type | Reference(Resource) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Links plan to resulting actions. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
182. CarePlan.activity.progress | |||||
Definition | Notes about the adherence/status/progress of the activity. | ||||
Short | Comments about the activity status/progress | ||||
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. | ||||
Control | 0..0 | ||||
Type | Annotation | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Can be used to capture information about adherence, progress, concerns, etc. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
184. CarePlan.activity.reference | |||||
Definition | The details of the proposed activity represented in a specific resource. | ||||
Short | Activity details defined in specific resource | ||||
Comments | Standard extension exists (resource-pertainsToGoal) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference. | ||||
Control | 0..0 This element is affected by the following invariants: cpl-3 | ||||
Type | Reference(Appointment, CommunicationRequest, DeviceRequest, MedicationRequest, NutritionOrder, Task, ServiceRequest, VisionPrescription, RequestGroup) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Details in a form consistent with other applications and contexts of use. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
186. 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. | ||||
Short | In-line definition of activity | ||||
Control | 1..1 This element is affected by the following invariants: cpl-3 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Details in a simple form for generic care plan systems. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
188. CarePlan.activity.detail.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..0 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
190. CarePlan.activity.detail.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
192. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
194. CarePlan.activity.detail.kind | |||||
Definition | A description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. | ||||
Short | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | ||||
Control | 0..0 | ||||
Binding | The codes SHALL be taken from CarePlanActivityKind (required to http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1 )Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | May determine what types of extensions are permitted. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
196. CarePlan.activity.detail.instantiatesCanonical | |||||
Definition | The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity. | ||||
Short | Instantiates FHIR protocol or definition | ||||
Control | 0..0 | ||||
Type | canonical(PlanDefinition, ActivityDefinition, Questionnaire, Measure, OperationDefinition) | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
198. CarePlan.activity.detail.instantiatesUri | |||||
Definition | The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity. | ||||
Short | Instantiates external protocol or definition | ||||
Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. | ||||
Control | 0..0 | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
200. CarePlan.activity.detail.code | |||||
Definition | Detailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter. | ||||
Short | Detail type of activity | ||||
Comments | Tends to be less relevant for activities involving particular products. Codes should not convey negation - use "prohibited" instead. | ||||
Control | 0..0 | ||||
Binding | For example codes, see ProcedureCodes(SNOMEDCT) (example to http://hl7.org/fhir/ValueSet/procedure-code )Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Allows matching performed to planned as well as validation against protocols. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
202. CarePlan.activity.detail.reasonCode | |||||
Definition | Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited. | ||||
Short | Why activity should be done or why activity was prohibited | ||||
Comments | This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead. | ||||
Control | 0..0 | ||||
Binding | For example codes, see SNOMEDCTClinicalFindings (example to http://hl7.org/fhir/ValueSet/clinical-findings )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. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
204. CarePlan.activity.detail.reasonReference | |||||
Definition | Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan. | ||||
Short | Why activity is needed | ||||
Comments | Conditions can be identified at the activity level that are not identified as reasons for the overall plan. | ||||
Control | 0..0 | ||||
Type | Reference(Condition, Observation, DiagnosticReport, DocumentReference) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
206. CarePlan.activity.detail.goal | |||||
Definition | Internal reference that identifies the goals that this activity is intended to contribute towards meeting. | ||||
Short | Goals this activity relates to | ||||
Control | 0..0 | ||||
Type | Reference(Goal) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | So that participants know the link explicitly. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
208. CarePlan.activity.detail.status | |||||
Definition | Identifies what progress is being made for the specific activity. | ||||
Short | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error | ||||
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. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from Status do afastamento descrito no atestado (required to http://www.saude.gov.br/fhir/r4/ValueSet/BREstadoAfastamentoAtestado )Estado do afastamento | ||||
Type | code | ||||
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the activity should not be treated as valid | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Indicates progress against the plan, whether the activity is still relevant for the plan. | ||||
Fixed Value | unknown | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
210. CarePlan.activity.detail.statusReason | |||||
Definition | Provides reason why the activity isn't yet started, is on hold, was cancelled, etc. | ||||
Short | Reason for current status | ||||
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. | ||||
Control | 0..0 | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
212. CarePlan.activity.detail.doNotPerform | |||||
Definition | If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan. | ||||
Short | If true, activity is prohibiting action | ||||
Comments | This element is labeled as a modifier because it marks an activity as an activity that is not to be performed. | ||||
Control | 0..0 | ||||
Type | boolean | ||||
Is Modifier | true because If true this element negates the specified action. For example, instead of a request for a procedure, it is a request for the procedure to not occur. | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Captures intention to not do something that may have been previously typical. | ||||
Meaning if Missing | If missing indicates that the described activity is one that should be engaged in when following the plan. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
214. CarePlan.activity.detail.scheduled[x] | |||||
Definition | The period, timing or frequency upon which the described activity is to occur. | ||||
Short | When activity is to occur | ||||
Control | 1..1 | ||||
Type | Timing | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Allows prompting for activities and detection of missed planned activities. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
216. CarePlan.activity.detail.scheduled[x].id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
218. CarePlan.activity.detail.scheduled[x].extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CarePlan.activity.detail.scheduled[x].extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
220. CarePlan.activity.detail.scheduled[x].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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
222. CarePlan.activity.detail.scheduled[x].event | |||||
Definition | Identifies specific times when the event occurs. | ||||
Short | Data de início do afastamento | ||||
Control | 1..1 | ||||
Type | dateTime | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
224. CarePlan.activity.detail.scheduled[x].repeat | |||||
Definition | A set of rules that describe when the event is scheduled. | ||||
Short | When the event is to occur | ||||
Control | 1..1 | ||||
Type | Element | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Many timing schedules are determined by regular repetitions. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )tim-1: if there's a duration, there needs to be duration units ( duration.empty() or durationUnit.exists() )tim-2: if there's a period, there needs to be period units ( period.empty() or periodUnit.exists() )tim-4: duration SHALL be a non-negative value ( duration.exists() implies duration >= 0 )tim-5: period SHALL be a non-negative value ( period.exists() implies period >= 0 )tim-6: If there's a periodMax, there must be a period ( periodMax.empty() or period.exists() )tim-7: If there's a durationMax, there must be a duration ( durationMax.empty() or duration.exists() )tim-8: If there's a countMax, there must be a count ( countMax.empty() or count.exists() )tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) ( offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) )tim-10: If there's a timeOfDay, there cannot be a when, or vice versa ( timeOfDay.empty() or when.empty() ) | ||||
226. CarePlan.activity.detail.scheduled[x].repeat.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..0 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
228. CarePlan.activity.detail.scheduled[x].repeat.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on CarePlan.activity.detail.scheduled[x].repeat.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
230. CarePlan.activity.detail.scheduled[x].repeat.bounds[x] | |||||
Definition | Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. | ||||
Short | Length/Range of lengths, or (Start and/or end) limits | ||||
Control | 0..0 | ||||
Type | Choice of: Duration, Range, Period | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
232. CarePlan.activity.detail.scheduled[x].repeat.count | |||||
Definition | Tempo do afastamento quantificado em dias. | ||||
Short | Tempo de afastamento | ||||
Comments | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens. | ||||
Control | 1..1 | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Repetitions may be limited by end time or total occurrences. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
234. CarePlan.activity.detail.scheduled[x].repeat.countMax | |||||
Definition | If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times. | ||||
Short | Maximum number of times to repeat | ||||
Control | 0..0 | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
236. CarePlan.activity.detail.scheduled[x].repeat.duration | |||||
Definition | How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration. | ||||
Short | How long when it happens | ||||
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). | ||||
Control | 0..0 | ||||
Type | decimal | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
238. CarePlan.activity.detail.scheduled[x].repeat.durationMax | |||||
Definition | If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. | ||||
Short | How long when it happens (Max) | ||||
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). | ||||
Control | 0..0 | ||||
Type | decimal | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
240. CarePlan.activity.detail.scheduled[x].repeat.durationUnit | |||||
Definition | The units of time for the duration, in UCUM units. | ||||
Short | s | min | h | d | wk | mo | a - unit of time (UCUM) | ||||
Control | 0..0 | ||||
Binding | The codes SHALL be taken from UnitsOfTime (required to http://hl7.org/fhir/ValueSet/units-of-time|4.0.1 )A unit of time (units from UCUM). | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
242. CarePlan.activity.detail.scheduled[x].repeat.frequency | |||||
Definition | The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency. | ||||
Short | Event occurs frequency times per period | ||||
Control | 0..0 | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Meaning if Missing | If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
244. CarePlan.activity.detail.scheduled[x].repeat.frequencyMax | |||||
Definition | If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. | ||||
Short | Event occurs up to frequencyMax times per period | ||||
Control | 0..0 | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
246. CarePlan.activity.detail.scheduled[x].repeat.period | |||||
Definition | Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length. | ||||
Short | Event occurs frequency times per period | ||||
Control | 0..0 | ||||
Type | decimal | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
248. CarePlan.activity.detail.scheduled[x].repeat.periodMax | |||||
Definition | If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. | ||||
Short | Upper limit of period (3-4 hours) | ||||
Control | 0..0 | ||||
Type | decimal | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
250. CarePlan.activity.detail.scheduled[x].repeat.periodUnit | |||||
Definition | The units of time for the period in UCUM units. | ||||
Short | s | min | h | d | wk | mo | a - unit of time (UCUM) | ||||
Control | 0..0 | ||||
Binding | The codes SHALL be taken from UnitsOfTime (required to http://hl7.org/fhir/ValueSet/units-of-time|4.0.1 )A unit of time (units from UCUM). | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
252. CarePlan.activity.detail.scheduled[x].repeat.dayOfWeek | |||||
Definition | If one or more days of week is provided, then the action happens only on the specified day(s). | ||||
Short | mon | tue | wed | thu | fri | sat | sun | ||||
Comments | If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek. | ||||
Control | 0..0 | ||||
Binding | The codes SHALL be taken from DaysOfWeek (required to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 ) | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
254. CarePlan.activity.detail.scheduled[x].repeat.timeOfDay | |||||
Definition | Specified time of day for action to take place. | ||||
Short | Time of day for action | ||||
Comments | When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay. | ||||
Control | 0..0 | ||||
Type | time | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
256. CarePlan.activity.detail.scheduled[x].repeat.when | |||||
Definition | An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. | ||||
Short | Code for time period of occurrence | ||||
Comments | When more than one event is listed, the event is tied to the union of the specified events. | ||||
Control | 0..0 | ||||
Binding | The codes SHALL be taken from EventTiming (required to http://hl7.org/fhir/ValueSet/event-timing|4.0.1 )Real world event relating to the schedule. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
258. CarePlan.activity.detail.scheduled[x].repeat.offset | |||||
Definition | The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event. | ||||
Short | Minutes from event (before or after) | ||||
Control | 0..0 | ||||
Type | unsignedInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
260. CarePlan.activity.detail.scheduled[x].code | |||||
Definition | A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). | ||||
Short | BID | TID | QID | AM | PM | QD | QOD | + | ||||
Comments | BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times). | ||||
Control | 0..0 | ||||
Binding | The codes SHOULD be taken from TimingAbbreviation (preferred to http://hl7.org/fhir/ValueSet/timing-abbreviation )Code for a known / defined timing pattern. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
262. CarePlan.activity.detail.location | |||||
Definition | Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. | ||||
Short | Where it should happen | ||||
Comments | May reference a specific clinical location or may identify a type of location. | ||||
Control | 0..0 | ||||
Type | Reference(Location) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Helps in planning of activity. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
264. CarePlan.activity.detail.performer | |||||
Definition | Identifies who's expected to be involved in the activity. | ||||
Short | Who will be responsible? | ||||
Comments | A performer MAY also be a participant in the care plan. | ||||
Control | 0..0 | ||||
Type | Reference(Practitioner, PractitionerRole, Organization, RelatedPerson, Patient, CareTeam, HealthcareService, Device) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Helps in planning of activity. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
266. CarePlan.activity.detail.product[x] | |||||
Definition | Identifies the food, drug or other product to be consumed or supplied in the activity. | ||||
Short | What is to be administered/supplied | ||||
Control | 0..0 | ||||
Binding | For example codes, see SNOMEDCTMedicationCodes (example to http://hl7.org/fhir/ValueSet/medication-codes )A product supplied or administered as part of a care plan activity. | ||||
Type | Choice of: CodeableConcept, Reference(Medication, Substance) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
268. CarePlan.activity.detail.dailyAmount | |||||
Definition | Identifies the quantity expected to be consumed in a given day. | ||||
Short | How to consume/day? | ||||
Control | 0..0 | ||||
Type | Quantity(SimpleQuantity) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Allows rough dose checking. | ||||
Alternate Names | daily dose | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
270. CarePlan.activity.detail.quantity | |||||
Definition | Identifies the quantity expected to be supplied, administered or consumed by the subject. | ||||
Short | How much to administer/supply/consume | ||||
Control | 0..0 | ||||
Type | Quantity(SimpleQuantity) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
272. CarePlan.activity.detail.description | |||||
Definition | Informações adicionais sobre o afastamento. | ||||
Short | Informações adicionais | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
274. CarePlan.note | |||||
Definition | General notes about the care plan not covered elsewhere. | ||||
Short | Comments about the plan | ||||
Control | 0..0 | ||||
Type | Annotation | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |