This page is part of the Evidence Based Medicine on FHIR Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
Page standards status: Draft | Maturity Level: 1 |
Definitions for the evidence-report-subject resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Group | |
2. Group.extension:combinationMethod | |
Slice Name | combinationMethod |
4. Group.extension:combinationMethod.value[x] | |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Pattern Value | all-of |
6. Group.characteristic | |
Slicing | This element introduces a set of slices on Group.characteristic . The slices are unordered and Open, and can be differentiated using the following discriminators: |
8. Group.characteristic:population | |
Slice Name | population |
Control | 0..1 |
Must Support | true |
10. Group.characteristic:population.extension:valueUri | |
Slice Name | valueUri |
12. Group.characteristic:population.extension:valueExpression | |
Slice Name | valueExpression |
14. Group.characteristic:population.extension:description | |
Slice Name | description |
16. Group.characteristic:population.extension:method | |
Slice Name | method |
18. Group.characteristic:population.extension:determinedByReference | |
Slice Name | determinedByReference |
20. Group.characteristic:population.extension:determinedByExpression | |
Slice Name | determinedByExpression |
22. Group.characteristic:population.extension:offset | |
Slice Name | offset |
24. Group.characteristic:population.extension:instancesQuantity | |
Slice Name | instancesQuantity |
26. Group.characteristic:population.extension:instancesRange | |
Slice Name | instancesRange |
28. Group.characteristic:population.extension:durationDuration | |
Slice Name | durationDuration |
30. Group.characteristic:population.extension:durationRange | |
Slice Name | durationRange |
32. Group.characteristic:population.extension:timing | |
Slice Name | timing |
34. Group.characteristic:population.code | |
36. Group.characteristic:population.code.text | |
Control | 1..? |
Pattern Value | Population |
38. Group.characteristic:population.value[x] | |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Slicing | This element introduces a set of slices on Group.characteristic.value[x] . The slices are unordered and Open, and can be differentiated using the following discriminators: |
40. Group.characteristic:population.value[x]:valueReference | |
Slice Name | valueReference |
Control | 0..1 |
Type | Reference(Group) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
42. Group.characteristic:population.exclude | |
Pattern Value | false |
44. Group.characteristic:intervention | |
Slice Name | intervention |
Control | 0..1 |
Must Support | true |
46. Group.characteristic:intervention.extension:valueUri | |
Slice Name | valueUri |
48. Group.characteristic:intervention.extension:valueExpression | |
Slice Name | valueExpression |
50. Group.characteristic:intervention.extension:description | |
Slice Name | description |
52. Group.characteristic:intervention.extension:method | |
Slice Name | method |
54. Group.characteristic:intervention.extension:determinedByReference | |
Slice Name | determinedByReference |
56. Group.characteristic:intervention.extension:determinedByExpression | |
Slice Name | determinedByExpression |
58. Group.characteristic:intervention.extension:offset | |
Slice Name | offset |
60. Group.characteristic:intervention.extension:instancesQuantity | |
Slice Name | instancesQuantity |
62. Group.characteristic:intervention.extension:instancesRange | |
Slice Name | instancesRange |
64. Group.characteristic:intervention.extension:durationDuration | |
Slice Name | durationDuration |
66. Group.characteristic:intervention.extension:durationRange | |
Slice Name | durationRange |
68. Group.characteristic:intervention.extension:timing | |
Slice Name | timing |
70. Group.characteristic:intervention.code | |
72. Group.characteristic:intervention.code.text | |
Control | 1..? |
Pattern Value | Intervention or Exposure |
74. Group.characteristic:intervention.value[x] | |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Slicing | This element introduces a set of slices on Group.characteristic.value[x] . The slices are unordered and Open, and can be differentiated using the following discriminators: |
76. Group.characteristic:intervention.value[x]:valueReference | |
Slice Name | valueReference |
Control | 0..1 |
Type | Reference(EvidenceVariable, Group) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
78. Group.characteristic:intervention.exclude | |
Pattern Value | false |
80. Group.characteristic:comparator | |
Slice Name | comparator |
Control | 0..1 |
Must Support | true |
82. Group.characteristic:comparator.extension:valueUri | |
Slice Name | valueUri |
84. Group.characteristic:comparator.extension:valueExpression | |
Slice Name | valueExpression |
86. Group.characteristic:comparator.extension:description | |
Slice Name | description |
88. Group.characteristic:comparator.extension:method | |
Slice Name | method |
90. Group.characteristic:comparator.extension:determinedByReference | |
Slice Name | determinedByReference |
92. Group.characteristic:comparator.extension:determinedByExpression | |
Slice Name | determinedByExpression |
94. Group.characteristic:comparator.extension:offset | |
Slice Name | offset |
96. Group.characteristic:comparator.extension:instancesQuantity | |
Slice Name | instancesQuantity |
98. Group.characteristic:comparator.extension:instancesRange | |
Slice Name | instancesRange |
100. Group.characteristic:comparator.extension:durationDuration | |
Slice Name | durationDuration |
102. Group.characteristic:comparator.extension:durationRange | |
Slice Name | durationRange |
104. Group.characteristic:comparator.extension:timing | |
Slice Name | timing |
106. Group.characteristic:comparator.code | |
108. Group.characteristic:comparator.code.text | |
Control | 1..? |
Pattern Value | Comparator |
110. Group.characteristic:comparator.value[x] | |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Slicing | This element introduces a set of slices on Group.characteristic.value[x] . The slices are unordered and Open, and can be differentiated using the following discriminators: |
112. Group.characteristic:comparator.value[x]:valueReference | |
Slice Name | valueReference |
Control | 0..1 |
Type | Reference(EvidenceVariable, Group) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
114. Group.characteristic:comparator.exclude | |
Pattern Value | false |
116. Group.characteristic:outcomes | |
Slice Name | outcomes |
Control | 0..1 |
Must Support | true |
118. Group.characteristic:outcomes.extension:valueUri | |
Slice Name | valueUri |
120. Group.characteristic:outcomes.extension:valueExpression | |
Slice Name | valueExpression |
122. Group.characteristic:outcomes.extension:description | |
Slice Name | description |
124. Group.characteristic:outcomes.extension:method | |
Slice Name | method |
126. Group.characteristic:outcomes.extension:determinedByReference | |
Slice Name | determinedByReference |
128. Group.characteristic:outcomes.extension:determinedByExpression | |
Slice Name | determinedByExpression |
130. Group.characteristic:outcomes.extension:offset | |
Slice Name | offset |
132. Group.characteristic:outcomes.extension:instancesQuantity | |
Slice Name | instancesQuantity |
134. Group.characteristic:outcomes.extension:instancesRange | |
Slice Name | instancesRange |
136. Group.characteristic:outcomes.extension:durationDuration | |
Slice Name | durationDuration |
138. Group.characteristic:outcomes.extension:durationRange | |
Slice Name | durationRange |
140. Group.characteristic:outcomes.extension:timing | |
Slice Name | timing |
142. Group.characteristic:outcomes.code | |
144. Group.characteristic:outcomes.code.text | |
Control | 1..? |
Pattern Value | Outcomes |
146. Group.characteristic:outcomes.value[x] | |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Slicing | This element introduces a set of slices on Group.characteristic.value[x] . The slices are unordered and Open, and can be differentiated using the following discriminators: |
148. Group.characteristic:outcomes.value[x]:valueReference | |
Slice Name | valueReference |
Control | 0..1 |
Type | Reference(OutcomeList) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
150. Group.characteristic:outcomes.exclude | |
Pattern Value | false |
Guidance on how to interpret the contents of this table can be found here
0. Group | |
Definition | Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization. |
Short | Group of multiple entities |
Comments | If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics. |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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. Group.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 its 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 its meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. Group.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
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..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
6. Group.extension:url | |
Slice Name | url |
Definition | An absolute URI that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers. |
Short | Canonical identifier for this {{title}}, represented as a URI (globally unique) |
Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. |
Control | 0..1 |
Type | Extension(Artifact URL) (Extension Type: uri) |
Is Modifier | false |
Must Support | 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()) |
8. Group.extension:version | |
Slice Name | version |
Definition | The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. |
Short | Business version of the {{title}} |
Control | 0..1 |
Type | Extension(ArtifactVersion) (Extension Type: string) |
Is Modifier | false |
Must Support | 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()) |
10. Group.extension:versionAlgorithmString | |
Slice Name | versionAlgorithmString |
Definition | Indicates the mechanism used to compare versions to determine which is more current. |
Short | How to compare versions |
Comments | If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. |
Control | 0..1 |
Type | Extension(Artifact Version Algorithm) (Extension Type: string) |
Is Modifier | false |
Must Support | 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()) |
12. Group.extension:title | |
Slice Name | title |
Definition | A short, descriptive, user-friendly title for the {{title}}. |
Short | Name for this {{title}} (human friendly) |
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
Control | 0..1 |
Type | Extension(Artifact Title) (Extension Type: string) |
Is Modifier | false |
Must Support | 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()) |
14. Group.extension:experimental | |
Slice Name | experimental |
Definition | A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. |
Short | For testing purposes, not real usage |
Control | 0..1 |
Type | Extension(Artifact Experimental) (Extension Type: boolean) |
Is Modifier | false |
Must Support | 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()) |
16. Group.extension:date | |
Slice Name | date |
Definition | The date (and optionally time) when the {{title}} was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the {{title}} changes. |
Short | Date last changed |
Comments | The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the {{title}}. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. |
Control | 0..1 |
Type | Extension(Artifact Date) (Extension Type: dateTime) |
Is Modifier | false |
Must Support | 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()) |
18. Group.extension:publisher | |
Slice Name | publisher |
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the {{title}}. |
Short | Name of the publisher/steward (organization or individual) |
Comments | Usually an organization but may be an individual. The publisher (or steward) of the {{title}} is the organization or individual primarily responsible for the maintenance and upkeep of the {{title}}. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the {{title}}. This item SHOULD be populated unless the information is available from context. |
Control | 0..1 |
Type | Extension(Artifact Publisher) (Extension Type: string) |
Is Modifier | false |
Must Support | 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()) |
20. Group.extension:contact | |
Slice Name | contact |
Definition | Contact details to assist a user in finding and communicating with the publisher. |
Short | Contact details for the publisher |
Comments | May be a web site, an email address, a telephone number, etc. |
Control | 0..* |
Type | Extension(Artifact Contact) (Extension Type: ContactDetail) |
Is Modifier | false |
Must Support | 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()) |
22. Group.extension:useContext | |
Slice Name | useContext |
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate {{title}} instances. |
Short | The context that the content is intended to support |
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
Control | 0..* |
Type | Extension(Artifact use context) (Extension Type: UsageContext) |
Is Modifier | false |
Must Support | 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()) |
24. Group.extension:purpose | |
Slice Name | purpose |
Definition | Explanation of why this {{title}} is needed and why it has been designed as it has. |
Short | Why this {{title}} is defined |
Comments | This element does not describe the usage of the {{title}}. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this {{title}}. |
Control | 0..1 |
Type | Extension(Artifact Purpose) (Extension Type: markdown) |
Is Modifier | false |
Must Support | 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()) |
26. Group.extension:copyright | |
Slice Name | copyright |
Definition | A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}. |
Short | Use and/or publishing restrictions |
Comments | The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element. |
Control | 0..1 |
Type | Extension(Artifact Copyright) (Extension Type: markdown) |
Is Modifier | false |
Must Support | 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()) |
28. Group.extension:copyrightLabel | |
Slice Name | copyrightLabel |
Definition | A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). |
Short | Copyright holder and year(s) |
Comments | Defines the content expected to be rendered in all representations of the artifact. The (c) symbol should NOT be included in this string. It is expected to be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element. |
Control | 0..1 |
Type | Extension(Artifact Copyright Label) (Extension Type: string) |
Is Modifier | false |
Must Support | 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()) |
30. Group.extension:author | |
Slice Name | author |
Definition | An individiual or organization primarily involved in the creation and maintenance of the {{title}}. |
Short | Who authored the {{title}} |
Control | 0..* |
Type | Extension(Artifact Author) (Extension Type: ContactDetail) |
Is Modifier | false |
Must Support | 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()) |
32. Group.extension:relatedArtifact | |
Slice Name | relatedArtifact |
Definition | Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. |
Short | Additional documentation, citations, etc. |
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. |
Control | 0..* |
Type | Extension(Artifact related artifact) (Extension Type: RelatedArtifact) |
Is Modifier | false |
Must Support | 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()) |
34. Group.extension:characteristicExpression | |
Slice Name | characteristicExpression |
Definition | An expression that defines the criteria for group membership. This extension can only be used on a Group resource with a membership of |
Short | Criteria for group membership |
Control | 0..1 |
Type | Extension(Characteristic Expression) (Extension Type: Expression) |
Is Modifier | false |
Must Support | 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()) |
36. Group.extension:combinationMethod | |
Slice Name | combinationMethod |
Definition | Used to specify how two or more characteristics are combined. |
Short | all-of | any-of | at-least | at-most | except-subset |
Control | 0..1 |
Type | Extension(CombinationMethod) (Extension Type: code) |
Is Modifier | false |
Must Support | 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()) |
38. Group.extension:combinationMethod.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 managable, 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..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 Group.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
40. Group.extension:combinationMethod.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://hl7.org/fhir/uv/ebm/StructureDefinition/combination-method |
42. Group.extension:combinationMethod.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..1 This element is affected by the following invariants: ext-1 |
Type | code, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for 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 |
Pattern Value | all-of |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
44. Group.extension:combinationThreshold | |
Slice Name | combinationThreshold |
Definition | Provides the value of n when at-least or at-most codes are used for combinationMethod. |
Short | Provides the value of n when at-least or at-most codes are used |
Control | 0..1 |
Type | Extension(CombinationThreshold) (Extension Type: positiveInt) |
Is Modifier | false |
Must Support | 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()) |
46. Group.modifierExtension | |
Definition | An Extension 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 managable, 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 | ExtensionExtensions 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 |
Must Support | false |
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 |
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 Group.modifierExtension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
48. Group.modifierExtension:status | |
Slice Name | status |
Definition | The status of this {{title}}. Enables tracking the life-cycle of the content. |
Short | draft | active | retired | unknown |
Control | 0..1 |
Type | Extension(Artifact Status) (Extension Type: code) |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired CodeSystem without due consideration |
Must Support | 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()) |
50. Group.active | |
Definition | Indicates whether the record for the group is available for use or is merely being retained for historical purposes. |
Short | Whether this group's record is in active use |
Control | 0..1 |
Type | boolean |
Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Need to be able to mark a group record as not to be used because it was created in error or is otherwise no longer available (e.g. a herd that no longer exists). |
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
52. Group.type | |
Definition | Identifies the broad classification of the kind of resources the group includes. |
Short | person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen |
Comments | Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, PractitionerRole, Device, CareTeam, HealthcareService, Location, Organization, RelatedPerson, or Specimen for the other types.), or a Group of the resources of the appropriate type. |
Control | 1..1 |
Binding | The codes SHALL be taken from GroupTypehttp://hl7.org/fhir/ValueSet/group-type|5.0.0 Types of resources that are part of group. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Identifies what type of resources the group is made up of. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
54. Group.membership | |
Definition | Basis for membership in the Group:
|
Short | definitional | enumerated |
Control | 1..1 |
Binding | The codes SHALL be taken from GroupMembershipBasishttp://hl7.org/fhir/ValueSet/group-membership-basis|5.0.0 The basis for membership in a group |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | There are use-cases for groups that define specific collections of individuals, and other groups that define "types" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this element. |
Pattern Value | definitional |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
56. Group.quantity | |
Definition | A count of the number of resource instances that are part of the group. |
Short | Number of members |
Comments | Note that the quantity may be less than the number of members if some of the members are not active. |
Control | 0..01 |
Type | unsignedInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Group size is a common defining characteristic. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
58. Group.characteristic | |
Definition | Identifies traits whose presence r absence is shared by members of the group. |
Short | Include / Exclude group members by Trait |
Comments | All the identified characteristics must be true for an entity to a member of the group. |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Needs to be a generic mechanism for identifying what individuals can be part of a group. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Group.characteristic . The slices are unordered and Open, and can be differentiated using the following discriminators: |
60. Group.characteristic.extension:valueUri | |
Slice Name | valueUri |
Definition | The value of the trait that holds for members of the group, held by uri. |
Short | Value held by uri |
Control | 0..1 |
Type | Extension(CharacteristicValueUri) (Extension Type: uri) |
Is Modifier | 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()) |
62. Group.characteristic.extension:valueExpression | |
Slice Name | valueExpression |
Definition | The value of the trait that holds for members of the group, held by Expression. |
Short | Value held by Expression |
Control | 0..1 |
Type | Extension(CharacteristicValueExpression) (Extension Type: Expression) |
Is Modifier | 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()) |
64. Group.characteristic.extension:description | |
Slice Name | description |
Definition | A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user. |
Short | Natural language description of the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicDescription) (Extension Type: markdown) |
Is Modifier | 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()) |
66. Group.characteristic.extension:method | |
Slice Name | method |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..* |
Type | Extension(CharacteristicMethod) (Extension Type: CodeableConcept) |
Is Modifier | 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()) |
68. Group.characteristic.extension:determinedByReference | |
Slice Name | determinedByReference |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByReference) (Extension Type: Reference(Device, DeviceDefinition, DeviceMetric)) |
Is Modifier | 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()) |
70. Group.characteristic.extension:determinedByExpression | |
Slice Name | determinedByExpression |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByExpression) (Extension Type: Expression) |
Is Modifier | 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()) |
72. Group.characteristic.extension:offset | |
Slice Name | offset |
Definition | Defines the reference point for comparison when other than 0. |
Short | Reference point for comparison |
Control | 0..1 |
Type | Extension(CharacteristicOffset) (Extension Type: CodeableConcept) |
Is Modifier | 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()) |
74. Group.characteristic.extension:instancesQuantity | |
Slice Name | instancesQuantity |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesQuantity) (Extension Type: Quantity) |
Is Modifier | 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. Group.characteristic.extension:instancesRange | |
Slice Name | instancesRange |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesRange) (Extension Type: Range) |
Is Modifier | 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()) |
78. Group.characteristic.extension:durationDuration | |
Slice Name | durationDuration |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationDuration) (Extension Type: Duration) |
Is Modifier | 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()) |
80. Group.characteristic.extension:durationRange | |
Slice Name | durationRange |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationRange) (Extension Type: Range) |
Is Modifier | 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()) |
82. Group.characteristic.extension:timing | |
Slice Name | timing |
Definition | Timing in which the characteristic is determined. |
Short | Timing in which the characteristic is determined |
Control | 0..* |
Type | Extension(CharacteristicTiming) (Complex Extension) |
Is Modifier | 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() ) |
84. Group.characteristic.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 managable, 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()) |
86. Group.characteristic.code | |
Definition | A code that identifies the kind of trait being asserted. |
Short | Kind of characteristic |
Control | 1..1 |
Binding | List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Need a formal way of identifying the characteristic being described. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
88. Group.characteristic.value[x] | |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 1..1 |
Binding | Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. |
Type | Choice of: CodeableConcept, boolean, Quantity, Range, Reference |
[x] Note | See Choice of Data Types for 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 |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
90. Group.characteristic.exclude | |
Definition | If true, indicates the characteristic is one that is NOT held by members of the group. |
Short | Group includes or excludes |
Comments | This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa. |
Control | 1..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Sometimes group membership is determined by characteristics not possessed. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
92. Group.characteristic:population | |
Slice Name | population |
Definition | Identifies traits whose presence r absence is shared by members of the group. |
Short | Include / Exclude group members by Trait |
Comments | All the identified characteristics must be true for an entity to a member of the group. |
Control | 0..1* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Needs to be a generic mechanism for identifying what individuals can be part of a group. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
94. Group.characteristic:population.extension:valueUri | |
Slice Name | valueUri |
Definition | The value of the trait that holds for members of the group, held by uri. |
Short | Value held by uri |
Control | 0..1 |
Type | Extension(CharacteristicValueUri) (Extension Type: uri) |
Is Modifier | 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. Group.characteristic:population.extension:valueExpression | |
Slice Name | valueExpression |
Definition | The value of the trait that holds for members of the group, held by Expression. |
Short | Value held by Expression |
Control | 0..1 |
Type | Extension(CharacteristicValueExpression) (Extension Type: Expression) |
Is Modifier | 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()) |
98. Group.characteristic:population.extension:description | |
Slice Name | description |
Definition | A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user. |
Short | Natural language description of the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicDescription) (Extension Type: markdown) |
Is Modifier | 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()) |
100. Group.characteristic:population.extension:method | |
Slice Name | method |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..* |
Type | Extension(CharacteristicMethod) (Extension Type: CodeableConcept) |
Is Modifier | 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()) |
102. Group.characteristic:population.extension:determinedByReference | |
Slice Name | determinedByReference |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByReference) (Extension Type: Reference(Device, DeviceDefinition, DeviceMetric)) |
Is Modifier | 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()) |
104. Group.characteristic:population.extension:determinedByExpression | |
Slice Name | determinedByExpression |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByExpression) (Extension Type: Expression) |
Is Modifier | 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()) |
106. Group.characteristic:population.extension:offset | |
Slice Name | offset |
Definition | Defines the reference point for comparison when other than 0. |
Short | Reference point for comparison |
Control | 0..1 |
Type | Extension(CharacteristicOffset) (Extension Type: CodeableConcept) |
Is Modifier | 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()) |
108. Group.characteristic:population.extension:instancesQuantity | |
Slice Name | instancesQuantity |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesQuantity) (Extension Type: Quantity) |
Is Modifier | 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()) |
110. Group.characteristic:population.extension:instancesRange | |
Slice Name | instancesRange |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesRange) (Extension Type: Range) |
Is Modifier | 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()) |
112. Group.characteristic:population.extension:durationDuration | |
Slice Name | durationDuration |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationDuration) (Extension Type: Duration) |
Is Modifier | 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()) |
114. Group.characteristic:population.extension:durationRange | |
Slice Name | durationRange |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationRange) (Extension Type: Range) |
Is Modifier | 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()) |
116. Group.characteristic:population.extension:timing | |
Slice Name | timing |
Definition | Timing in which the characteristic is determined. |
Short | Timing in which the characteristic is determined |
Control | 0..* |
Type | Extension(CharacteristicTiming) (Complex Extension) |
Is Modifier | 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() ) |
118. Group.characteristic:population.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 managable, 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()) |
120. Group.characteristic:population.code | |
Definition | A code that identifies the kind of trait being asserted. |
Short | Kind of characteristic |
Control | 1..1 |
Binding | List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Need a formal way of identifying the characteristic being described. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
122. Group.characteristic:population.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Short | Plain text representation of the concept |
Comments | Very often the text is the same as a displayName of one of the codings. |
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 |
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. |
Pattern Value | Population |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
124. Group.characteristic:population.value[x] | |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 1..1 |
Binding | Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. |
Type | Choice of: CodeableConcept, boolean, Quantity, Range, Reference |
[x] Note | See Choice of Data Types for 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 |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Group.characteristic.value[x] . The slices are unordered and Open, and can be differentiated using the following discriminators: |
126. Group.characteristic:population.value[x]:valueReference | |
Slice Name | valueReference |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 01..1 |
Type | Reference(Group), boolean, Quantity, Range, CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
128. Group.characteristic:population.exclude | |
Definition | If true, indicates the characteristic is one that is NOT held by members of the group. |
Short | Group includes or excludes |
Comments | This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa. |
Control | 1..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Sometimes group membership is determined by characteristics not possessed. |
Pattern Value | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
130. Group.characteristic:intervention | |
Slice Name | intervention |
Definition | Identifies traits whose presence r absence is shared by members of the group. |
Short | Include / Exclude group members by Trait |
Comments | All the identified characteristics must be true for an entity to a member of the group. |
Control | 0..1* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Needs to be a generic mechanism for identifying what individuals can be part of a group. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
132. Group.characteristic:intervention.extension:valueUri | |
Slice Name | valueUri |
Definition | The value of the trait that holds for members of the group, held by uri. |
Short | Value held by uri |
Control | 0..1 |
Type | Extension(CharacteristicValueUri) (Extension Type: uri) |
Is Modifier | 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()) |
134. Group.characteristic:intervention.extension:valueExpression | |
Slice Name | valueExpression |
Definition | The value of the trait that holds for members of the group, held by Expression. |
Short | Value held by Expression |
Control | 0..1 |
Type | Extension(CharacteristicValueExpression) (Extension Type: Expression) |
Is Modifier | 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()) |
136. Group.characteristic:intervention.extension:description | |
Slice Name | description |
Definition | A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user. |
Short | Natural language description of the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicDescription) (Extension Type: markdown) |
Is Modifier | 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()) |
138. Group.characteristic:intervention.extension:method | |
Slice Name | method |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..* |
Type | Extension(CharacteristicMethod) (Extension Type: CodeableConcept) |
Is Modifier | 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()) |
140. Group.characteristic:intervention.extension:determinedByReference | |
Slice Name | determinedByReference |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByReference) (Extension Type: Reference(Device, DeviceDefinition, DeviceMetric)) |
Is Modifier | 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()) |
142. Group.characteristic:intervention.extension:determinedByExpression | |
Slice Name | determinedByExpression |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByExpression) (Extension Type: Expression) |
Is Modifier | 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()) |
144. Group.characteristic:intervention.extension:offset | |
Slice Name | offset |
Definition | Defines the reference point for comparison when other than 0. |
Short | Reference point for comparison |
Control | 0..1 |
Type | Extension(CharacteristicOffset) (Extension Type: CodeableConcept) |
Is Modifier | 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()) |
146. Group.characteristic:intervention.extension:instancesQuantity | |
Slice Name | instancesQuantity |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesQuantity) (Extension Type: Quantity) |
Is Modifier | 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()) |
148. Group.characteristic:intervention.extension:instancesRange | |
Slice Name | instancesRange |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesRange) (Extension Type: Range) |
Is Modifier | 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()) |
150. Group.characteristic:intervention.extension:durationDuration | |
Slice Name | durationDuration |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationDuration) (Extension Type: Duration) |
Is Modifier | 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()) |
152. Group.characteristic:intervention.extension:durationRange | |
Slice Name | durationRange |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationRange) (Extension Type: Range) |
Is Modifier | 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()) |
154. Group.characteristic:intervention.extension:timing | |
Slice Name | timing |
Definition | Timing in which the characteristic is determined. |
Short | Timing in which the characteristic is determined |
Control | 0..* |
Type | Extension(CharacteristicTiming) (Complex Extension) |
Is Modifier | 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() ) |
156. Group.characteristic:intervention.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 managable, 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()) |
158. Group.characteristic:intervention.code | |
Definition | A code that identifies the kind of trait being asserted. |
Short | Kind of characteristic |
Control | 1..1 |
Binding | List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Need a formal way of identifying the characteristic being described. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
160. Group.characteristic:intervention.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Short | Plain text representation of the concept |
Comments | Very often the text is the same as a displayName of one of the codings. |
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 |
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. |
Pattern Value | Intervention or Exposure |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
162. Group.characteristic:intervention.value[x] | |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 1..1 |
Binding | Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. |
Type | Choice of: CodeableConcept, boolean, Quantity, Range, Reference |
[x] Note | See Choice of Data Types for 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 |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Group.characteristic.value[x] . The slices are unordered and Open, and can be differentiated using the following discriminators: |
164. Group.characteristic:intervention.value[x]:valueReference | |
Slice Name | valueReference |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 01..1 |
Type | Reference(EvidenceVariable, Group), boolean, Quantity, Range, CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
166. Group.characteristic:intervention.exclude | |
Definition | If true, indicates the characteristic is one that is NOT held by members of the group. |
Short | Group includes or excludes |
Comments | This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa. |
Control | 1..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Sometimes group membership is determined by characteristics not possessed. |
Pattern Value | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
168. Group.characteristic:comparator | |
Slice Name | comparator |
Definition | Identifies traits whose presence r absence is shared by members of the group. |
Short | Include / Exclude group members by Trait |
Comments | All the identified characteristics must be true for an entity to a member of the group. |
Control | 0..1* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Needs to be a generic mechanism for identifying what individuals can be part of a group. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
170. Group.characteristic:comparator.extension:valueUri | |
Slice Name | valueUri |
Definition | The value of the trait that holds for members of the group, held by uri. |
Short | Value held by uri |
Control | 0..1 |
Type | Extension(CharacteristicValueUri) (Extension Type: uri) |
Is Modifier | 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()) |
172. Group.characteristic:comparator.extension:valueExpression | |
Slice Name | valueExpression |
Definition | The value of the trait that holds for members of the group, held by Expression. |
Short | Value held by Expression |
Control | 0..1 |
Type | Extension(CharacteristicValueExpression) (Extension Type: Expression) |
Is Modifier | 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()) |
174. Group.characteristic:comparator.extension:description | |
Slice Name | description |
Definition | A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user. |
Short | Natural language description of the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicDescription) (Extension Type: markdown) |
Is Modifier | 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()) |
176. Group.characteristic:comparator.extension:method | |
Slice Name | method |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..* |
Type | Extension(CharacteristicMethod) (Extension Type: CodeableConcept) |
Is Modifier | 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()) |
178. Group.characteristic:comparator.extension:determinedByReference | |
Slice Name | determinedByReference |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByReference) (Extension Type: Reference(Device, DeviceDefinition, DeviceMetric)) |
Is Modifier | 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()) |
180. Group.characteristic:comparator.extension:determinedByExpression | |
Slice Name | determinedByExpression |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByExpression) (Extension Type: Expression) |
Is Modifier | 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()) |
182. Group.characteristic:comparator.extension:offset | |
Slice Name | offset |
Definition | Defines the reference point for comparison when other than 0. |
Short | Reference point for comparison |
Control | 0..1 |
Type | Extension(CharacteristicOffset) (Extension Type: CodeableConcept) |
Is Modifier | 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()) |
184. Group.characteristic:comparator.extension:instancesQuantity | |
Slice Name | instancesQuantity |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesQuantity) (Extension Type: Quantity) |
Is Modifier | 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()) |
186. Group.characteristic:comparator.extension:instancesRange | |
Slice Name | instancesRange |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesRange) (Extension Type: Range) |
Is Modifier | 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()) |
188. Group.characteristic:comparator.extension:durationDuration | |
Slice Name | durationDuration |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationDuration) (Extension Type: Duration) |
Is Modifier | 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()) |
190. Group.characteristic:comparator.extension:durationRange | |
Slice Name | durationRange |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationRange) (Extension Type: Range) |
Is Modifier | 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()) |
192. Group.characteristic:comparator.extension:timing | |
Slice Name | timing |
Definition | Timing in which the characteristic is determined. |
Short | Timing in which the characteristic is determined |
Control | 0..* |
Type | Extension(CharacteristicTiming) (Complex Extension) |
Is Modifier | 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() ) |
194. Group.characteristic:comparator.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 managable, 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()) |
196. Group.characteristic:comparator.code | |
Definition | A code that identifies the kind of trait being asserted. |
Short | Kind of characteristic |
Control | 1..1 |
Binding | List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Need a formal way of identifying the characteristic being described. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
198. Group.characteristic:comparator.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Short | Plain text representation of the concept |
Comments | Very often the text is the same as a displayName of one of the codings. |
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 |
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. |
Pattern Value | Comparator |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
200. Group.characteristic:comparator.value[x] | |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 1..1 |
Binding | Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. |
Type | Choice of: CodeableConcept, boolean, Quantity, Range, Reference |
[x] Note | See Choice of Data Types for 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 |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Group.characteristic.value[x] . The slices are unordered and Open, and can be differentiated using the following discriminators: |
202. Group.characteristic:comparator.value[x]:valueReference | |
Slice Name | valueReference |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 01..1 |
Type | Reference(EvidenceVariable, Group), boolean, Quantity, Range, CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
204. Group.characteristic:comparator.exclude | |
Definition | If true, indicates the characteristic is one that is NOT held by members of the group. |
Short | Group includes or excludes |
Comments | This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa. |
Control | 1..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Sometimes group membership is determined by characteristics not possessed. |
Pattern Value | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
206. Group.characteristic:outcomes | |
Slice Name | outcomes |
Definition | Identifies traits whose presence r absence is shared by members of the group. |
Short | Include / Exclude group members by Trait |
Comments | All the identified characteristics must be true for an entity to a member of the group. |
Control | 0..1* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Needs to be a generic mechanism for identifying what individuals can be part of a group. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
208. Group.characteristic:outcomes.extension:valueUri | |
Slice Name | valueUri |
Definition | The value of the trait that holds for members of the group, held by uri. |
Short | Value held by uri |
Control | 0..1 |
Type | Extension(CharacteristicValueUri) (Extension Type: uri) |
Is Modifier | 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()) |
210. Group.characteristic:outcomes.extension:valueExpression | |
Slice Name | valueExpression |
Definition | The value of the trait that holds for members of the group, held by Expression. |
Short | Value held by Expression |
Control | 0..1 |
Type | Extension(CharacteristicValueExpression) (Extension Type: Expression) |
Is Modifier | 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()) |
212. Group.characteristic:outcomes.extension:description | |
Slice Name | description |
Definition | A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user. |
Short | Natural language description of the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicDescription) (Extension Type: markdown) |
Is Modifier | 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()) |
214. Group.characteristic:outcomes.extension:method | |
Slice Name | method |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..* |
Type | Extension(CharacteristicMethod) (Extension Type: CodeableConcept) |
Is Modifier | 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()) |
216. Group.characteristic:outcomes.extension:determinedByReference | |
Slice Name | determinedByReference |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByReference) (Extension Type: Reference(Device, DeviceDefinition, DeviceMetric)) |
Is Modifier | 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()) |
218. Group.characteristic:outcomes.extension:determinedByExpression | |
Slice Name | determinedByExpression |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByExpression) (Extension Type: Expression) |
Is Modifier | 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()) |
220. Group.characteristic:outcomes.extension:offset | |
Slice Name | offset |
Definition | Defines the reference point for comparison when other than 0. |
Short | Reference point for comparison |
Control | 0..1 |
Type | Extension(CharacteristicOffset) (Extension Type: CodeableConcept) |
Is Modifier | 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()) |
222. Group.characteristic:outcomes.extension:instancesQuantity | |
Slice Name | instancesQuantity |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesQuantity) (Extension Type: Quantity) |
Is Modifier | 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()) |
224. Group.characteristic:outcomes.extension:instancesRange | |
Slice Name | instancesRange |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesRange) (Extension Type: Range) |
Is Modifier | 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()) |
226. Group.characteristic:outcomes.extension:durationDuration | |
Slice Name | durationDuration |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationDuration) (Extension Type: Duration) |
Is Modifier | 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()) |
228. Group.characteristic:outcomes.extension:durationRange | |
Slice Name | durationRange |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationRange) (Extension Type: Range) |
Is Modifier | 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()) |
230. Group.characteristic:outcomes.extension:timing | |
Slice Name | timing |
Definition | Timing in which the characteristic is determined. |
Short | Timing in which the characteristic is determined |
Control | 0..* |
Type | Extension(CharacteristicTiming) (Complex Extension) |
Is Modifier | 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() ) |
232. Group.characteristic:outcomes.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 managable, 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()) |
234. Group.characteristic:outcomes.code | |
Definition | A code that identifies the kind of trait being asserted. |
Short | Kind of characteristic |
Control | 1..1 |
Binding | List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Need a formal way of identifying the characteristic being described. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
236. Group.characteristic:outcomes.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Short | Plain text representation of the concept |
Comments | Very often the text is the same as a displayName of one of the codings. |
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 |
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. |
Pattern Value | Outcomes |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
238. Group.characteristic:outcomes.value[x] | |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 1..1 |
Binding | Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. |
Type | Choice of: CodeableConcept, boolean, Quantity, Range, Reference |
[x] Note | See Choice of Data Types for 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 |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Group.characteristic.value[x] . The slices are unordered and Open, and can be differentiated using the following discriminators: |
240. Group.characteristic:outcomes.value[x]:valueReference | |
Slice Name | valueReference |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 01..1 |
Type | Reference(OutcomeList), boolean, Quantity, Range, CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
242. Group.characteristic:outcomes.exclude | |
Definition | If true, indicates the characteristic is one that is NOT held by members of the group. |
Short | Group includes or excludes |
Comments | This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa. |
Control | 1..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Sometimes group membership is determined by characteristics not possessed. |
Pattern Value | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
244. Group.member | |
Definition | Identifies the resource instances that are members of the group. |
Short | Who or what is in group |
Control | 0..0* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Often the only thing of interest about a group is "who's in it". |
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. Group | |
Definition | Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization. |
Short | Group of multiple entities |
Comments | If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics. |
Control | 0..* |
Is Modifier | false |
Must Support | false |
Summary | false |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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. Group.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 | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
Control | 0..1 |
Type | id |
Is Modifier | false |
Must Support | false |
Summary | true |
4. Group.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 |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
6. Group.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 its 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 its meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
8. Group.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 SHALL be taken from AllLanguages IETF language tag for a human language |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
10. Group.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 a 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 This element is affected by the following invariants: dom-6 |
Type | Narrative |
Is Modifier | false |
Must Support | 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. Group.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
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..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Is Modifier | false |
Must Support | false |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
14. Group.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Must Support | 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 Group.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
16. Group.extension:url | |
Slice Name | url |
Definition | An absolute URI that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers. |
Short | Canonical identifier for this {{title}}, represented as a URI (globally unique) |
Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. |
Control | 0..1 |
Type | Extension(Artifact URL) (Extension Type: uri) |
Is Modifier | false |
Must Support | 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() ) |
18. Group.extension:version | |
Slice Name | version |
Definition | The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. |
Short | Business version of the {{title}} |
Control | 0..1 |
Type | Extension(ArtifactVersion) (Extension Type: string) |
Is Modifier | false |
Must Support | 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() ) |
20. Group.extension:versionAlgorithmString | |
Slice Name | versionAlgorithmString |
Definition | Indicates the mechanism used to compare versions to determine which is more current. |
Short | How to compare versions |
Comments | If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. |
Control | 0..1 |
Type | Extension(Artifact Version Algorithm) (Extension Type: string) |
Is Modifier | false |
Must Support | 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() ) |
22. Group.extension:title | |
Slice Name | title |
Definition | A short, descriptive, user-friendly title for the {{title}}. |
Short | Name for this {{title}} (human friendly) |
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
Control | 0..1 |
Type | Extension(Artifact Title) (Extension Type: string) |
Is Modifier | false |
Must Support | 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() ) |
24. Group.extension:experimental | |
Slice Name | experimental |
Definition | A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. |
Short | For testing purposes, not real usage |
Control | 0..1 |
Type | Extension(Artifact Experimental) (Extension Type: boolean) |
Is Modifier | false |
Must Support | 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() ) |
26. Group.extension:date | |
Slice Name | date |
Definition | The date (and optionally time) when the {{title}} was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the {{title}} changes. |
Short | Date last changed |
Comments | The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the {{title}}. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. |
Control | 0..1 |
Type | Extension(Artifact Date) (Extension Type: dateTime) |
Is Modifier | false |
Must Support | 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() ) |
28. Group.extension:publisher | |
Slice Name | publisher |
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the {{title}}. |
Short | Name of the publisher/steward (organization or individual) |
Comments | Usually an organization but may be an individual. The publisher (or steward) of the {{title}} is the organization or individual primarily responsible for the maintenance and upkeep of the {{title}}. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the {{title}}. This item SHOULD be populated unless the information is available from context. |
Control | 0..1 |
Type | Extension(Artifact Publisher) (Extension Type: string) |
Is Modifier | false |
Must Support | 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() ) |
30. Group.extension:contact | |
Slice Name | contact |
Definition | Contact details to assist a user in finding and communicating with the publisher. |
Short | Contact details for the publisher |
Comments | May be a web site, an email address, a telephone number, etc. |
Control | 0..* |
Type | Extension(Artifact Contact) (Extension Type: ContactDetail) |
Is Modifier | false |
Must Support | 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() ) |
32. Group.extension:useContext | |
Slice Name | useContext |
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate {{title}} instances. |
Short | The context that the content is intended to support |
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
Control | 0..* |
Type | Extension(Artifact use context) (Extension Type: UsageContext) |
Is Modifier | false |
Must Support | 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() ) |
34. Group.extension:purpose | |
Slice Name | purpose |
Definition | Explanation of why this {{title}} is needed and why it has been designed as it has. |
Short | Why this {{title}} is defined |
Comments | This element does not describe the usage of the {{title}}. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this {{title}}. |
Control | 0..1 |
Type | Extension(Artifact Purpose) (Extension Type: markdown) |
Is Modifier | false |
Must Support | 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() ) |
36. Group.extension:copyright | |
Slice Name | copyright |
Definition | A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}. |
Short | Use and/or publishing restrictions |
Comments | The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element. |
Control | 0..1 |
Type | Extension(Artifact Copyright) (Extension Type: markdown) |
Is Modifier | false |
Must Support | 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() ) |
38. Group.extension:copyrightLabel | |
Slice Name | copyrightLabel |
Definition | A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). |
Short | Copyright holder and year(s) |
Comments | Defines the content expected to be rendered in all representations of the artifact. The (c) symbol should NOT be included in this string. It is expected to be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element. |
Control | 0..1 |
Type | Extension(Artifact Copyright Label) (Extension Type: string) |
Is Modifier | false |
Must Support | 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() ) |
40. Group.extension:author | |
Slice Name | author |
Definition | An individiual or organization primarily involved in the creation and maintenance of the {{title}}. |
Short | Who authored the {{title}} |
Control | 0..* |
Type | Extension(Artifact Author) (Extension Type: ContactDetail) |
Is Modifier | false |
Must Support | 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() ) |
42. Group.extension:relatedArtifact | |
Slice Name | relatedArtifact |
Definition | Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. |
Short | Additional documentation, citations, etc. |
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. |
Control | 0..* |
Type | Extension(Artifact related artifact) (Extension Type: RelatedArtifact) |
Is Modifier | false |
Must Support | 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() ) |
44. Group.extension:characteristicExpression | |
Slice Name | characteristicExpression |
Definition | An expression that defines the criteria for group membership. This extension can only be used on a Group resource with a membership of |
Short | Criteria for group membership |
Control | 0..1 |
Type | Extension(Characteristic Expression) (Extension Type: Expression) |
Is Modifier | false |
Must Support | 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() ) |
46. Group.extension:combinationMethod | |
Slice Name | combinationMethod |
Definition | Used to specify how two or more characteristics are combined. |
Short | all-of | any-of | at-least | at-most | except-subset |
Control | 0..1 |
Type | Extension(CombinationMethod) (Extension Type: code) |
Is Modifier | false |
Must Support | 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. Group.extension:combinationMethod.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 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
50. Group.extension:combinationMethod.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..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 Group.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
52. Group.extension:combinationMethod.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://hl7.org/fhir/uv/ebm/StructureDefinition/combination-method |
54. Group.extension:combinationMethod.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..1 This element is affected by the following invariants: ext-1 |
Type | code |
[x] Note | See Choice of Data Types for 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 |
Pattern Value | all-of |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
56. Group.extension:combinationThreshold | |
Slice Name | combinationThreshold |
Definition | Provides the value of n when at-least or at-most codes are used for combinationMethod. |
Short | Provides the value of n when at-least or at-most codes are used |
Control | 0..1 |
Type | Extension(CombinationThreshold) (Extension Type: positiveInt) |
Is Modifier | false |
Must Support | 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() ) |
58. Group.modifierExtension | |
Definition | An Extension |
Short | Extension |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Must Support | false |
Summary | 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() ) |
Slicing | This element introduces a set of slices on Group.modifierExtension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
60. Group.modifierExtension:status | |
Slice Name | status |
Definition | The status of this {{title}}. Enables tracking the life-cycle of the content. |
Short | draft | active | retired | unknown |
Control | 0..1 |
Type | Extension(Artifact Status) (Extension Type: code) |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired CodeSystem without due consideration |
Must Support | 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() ) |
62. Group.identifier | |
Definition | Business identifiers assigned to this participant by one of the applications involved. These identifiers remain constant as the resource is updated and propagates from server to server. |
Short | Business Identifier for this Group |
Comments | Note: 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. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Allows identification of the group 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()) ) |
64. Group.active | |
Definition | Indicates whether the record for the group is available for use or is merely being retained for historical purposes. |
Short | Whether this group's record is in active use |
Control | 0..1 |
Type | boolean |
Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Need to be able to mark a group record as not to be used because it was created in error or is otherwise no longer available (e.g. a herd that no longer exists). |
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
66. Group.type | |
Definition | Identifies the broad classification of the kind of resources the group includes. |
Short | person | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen |
Comments | Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, PractitionerRole, Device, CareTeam, HealthcareService, Location, Organization, RelatedPerson, or Specimen for the other types.), or a Group of the resources of the appropriate type. |
Control | 1..1 |
Binding | The codes SHALL be taken from GroupType Types of resources that are part of group. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Identifies what type of resources the group is made up of. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
68. Group.membership | |
Definition | Basis for membership in the Group:
|
Short | definitional | enumerated |
Control | 1..1 |
Binding | The codes SHALL be taken from GroupMembershipBasis The basis for membership in a group |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | There are use-cases for groups that define specific collections of individuals, and other groups that define "types" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this element. |
Pattern Value | definitional |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
70. Group.code | |
Definition | Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc. |
Short | Kind of Group members |
Comments | This would generally be omitted for Person resources. |
Control | 0..1 |
Binding | Kind of particular resource; e.g. cow, syringe, lake, etc. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
72. Group.name | |
Definition | A label assigned to the group for human identification and communication. |
Short | Label for Group |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Used to identify the group in human communication. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
74. Group.description | |
Definition | Explanation of what the group represents and how it is intended to be used. |
Short | Natural language description of the group |
Control | 0..1 |
Type | markdown |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
76. Group.quantity | |
Definition | A count of the number of resource instances that are part of the group. |
Short | Number of members |
Comments | Note that the quantity may be less than the number of members if some of the members are not active. |
Control | 0..0 |
Type | unsignedInt |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Group size is a common defining characteristic. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
78. Group.managingEntity | |
Definition | Entity responsible for defining and maintaining Group characteristics and/or registered members. |
Short | Entity that is the custodian of the Group's definition |
Comments | This does not strictly align with ownership of a herd or flock, but may suffice to represent that relationship in simple cases. More complex cases will require an extension. |
Control | 0..1 |
Type | Reference(Organization, RelatedPerson, Practitioner, PractitionerRole) |
Is Modifier | false |
Must Support | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
80. Group.characteristic | |
Definition | Identifies traits whose presence r absence is shared by members of the group. |
Short | Include / Exclude group members by Trait |
Comments | All the identified characteristics must be true for an entity to a member of the group. |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Needs to be a generic mechanism for identifying what individuals can be part of a group. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
Slicing | This element introduces a set of slices on Group.characteristic . The slices are unordered and Open, and can be differentiated using the following discriminators: |
82. Group.characteristic.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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
84. Group.characteristic.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 Group.characteristic.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
86. Group.characteristic.extension:valueUri | |
Slice Name | valueUri |
Definition | The value of the trait that holds for members of the group, held by uri. |
Short | Value held by uri |
Control | 0..1 |
Type | Extension(CharacteristicValueUri) (Extension Type: uri) |
Is Modifier | 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() ) |
88. Group.characteristic.extension:valueExpression | |
Slice Name | valueExpression |
Definition | The value of the trait that holds for members of the group, held by Expression. |
Short | Value held by Expression |
Control | 0..1 |
Type | Extension(CharacteristicValueExpression) (Extension Type: Expression) |
Is Modifier | 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() ) |
90. Group.characteristic.extension:description | |
Slice Name | description |
Definition | A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user. |
Short | Natural language description of the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicDescription) (Extension Type: markdown) |
Is Modifier | 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() ) |
92. Group.characteristic.extension:method | |
Slice Name | method |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..* |
Type | Extension(CharacteristicMethod) (Extension Type: CodeableConcept) |
Is Modifier | 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() ) |
94. Group.characteristic.extension:determinedByReference | |
Slice Name | determinedByReference |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByReference) (Extension Type: Reference(Device, DeviceDefinition, DeviceMetric)) |
Is Modifier | 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. Group.characteristic.extension:determinedByExpression | |
Slice Name | determinedByExpression |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByExpression) (Extension Type: Expression) |
Is Modifier | 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() ) |
98. Group.characteristic.extension:offset | |
Slice Name | offset |
Definition | Defines the reference point for comparison when other than 0. |
Short | Reference point for comparison |
Control | 0..1 |
Type | Extension(CharacteristicOffset) (Extension Type: CodeableConcept) |
Is Modifier | 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() ) |
100. Group.characteristic.extension:instancesQuantity | |
Slice Name | instancesQuantity |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesQuantity) (Extension Type: Quantity) |
Is Modifier | 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() ) |
102. Group.characteristic.extension:instancesRange | |
Slice Name | instancesRange |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesRange) (Extension Type: Range) |
Is Modifier | 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() ) |
104. Group.characteristic.extension:durationDuration | |
Slice Name | durationDuration |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationDuration) (Extension Type: Duration) |
Is Modifier | 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() ) |
106. Group.characteristic.extension:durationRange | |
Slice Name | durationRange |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationRange) (Extension Type: Range) |
Is Modifier | 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() ) |
108. Group.characteristic.extension:timing | |
Slice Name | timing |
Definition | Timing in which the characteristic is determined. |
Short | Timing in which the characteristic is determined |
Control | 0..* |
Type | Extension(CharacteristicTiming) (Complex Extension) |
Is Modifier | 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() ) |
110. Group.characteristic.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 managable, 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() ) |
112. Group.characteristic.code | |
Definition | A code that identifies the kind of trait being asserted. |
Short | Kind of characteristic |
Control | 1..1 |
Binding | List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Need a formal way of identifying the characteristic being described. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
114. Group.characteristic.value[x] | |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 1..1 |
Binding | Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. |
Type | Choice of: CodeableConcept, boolean, Quantity, Range, Reference |
[x] Note | See Choice of Data Types for 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 |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
116. Group.characteristic.exclude | |
Definition | If true, indicates the characteristic is one that is NOT held by members of the group. |
Short | Group includes or excludes |
Comments | This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa. |
Control | 1..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Sometimes group membership is determined by characteristics not possessed. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
118. Group.characteristic.period | |
Definition | The period over which the characteristic is tested; e.g. the patient had an operation during the month of June. |
Short | Period over which characteristic is tested |
Control | 0..1 |
Type | Period |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
120. Group.characteristic:population | |
Slice Name | population |
Definition | Identifies traits whose presence r absence is shared by members of the group. |
Short | Include / Exclude group members by Trait |
Comments | All the identified characteristics must be true for an entity to a member of the group. |
Control | 0..1 |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Needs to be a generic mechanism for identifying what individuals can be part of a group. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
122. Group.characteristic:population.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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
124. Group.characteristic:population.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 Group.characteristic.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
126. Group.characteristic:population.extension:valueUri | |
Slice Name | valueUri |
Definition | The value of the trait that holds for members of the group, held by uri. |
Short | Value held by uri |
Control | 0..1 |
Type | Extension(CharacteristicValueUri) (Extension Type: uri) |
Is Modifier | 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() ) |
128. Group.characteristic:population.extension:valueExpression | |
Slice Name | valueExpression |
Definition | The value of the trait that holds for members of the group, held by Expression. |
Short | Value held by Expression |
Control | 0..1 |
Type | Extension(CharacteristicValueExpression) (Extension Type: Expression) |
Is Modifier | 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() ) |
130. Group.characteristic:population.extension:description | |
Slice Name | description |
Definition | A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user. |
Short | Natural language description of the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicDescription) (Extension Type: markdown) |
Is Modifier | 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() ) |
132. Group.characteristic:population.extension:method | |
Slice Name | method |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..* |
Type | Extension(CharacteristicMethod) (Extension Type: CodeableConcept) |
Is Modifier | 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() ) |
134. Group.characteristic:population.extension:determinedByReference | |
Slice Name | determinedByReference |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByReference) (Extension Type: Reference(Device, DeviceDefinition, DeviceMetric)) |
Is Modifier | 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() ) |
136. Group.characteristic:population.extension:determinedByExpression | |
Slice Name | determinedByExpression |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByExpression) (Extension Type: Expression) |
Is Modifier | 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() ) |
138. Group.characteristic:population.extension:offset | |
Slice Name | offset |
Definition | Defines the reference point for comparison when other than 0. |
Short | Reference point for comparison |
Control | 0..1 |
Type | Extension(CharacteristicOffset) (Extension Type: CodeableConcept) |
Is Modifier | 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() ) |
140. Group.characteristic:population.extension:instancesQuantity | |
Slice Name | instancesQuantity |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesQuantity) (Extension Type: Quantity) |
Is Modifier | 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() ) |
142. Group.characteristic:population.extension:instancesRange | |
Slice Name | instancesRange |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesRange) (Extension Type: Range) |
Is Modifier | 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() ) |
144. Group.characteristic:population.extension:durationDuration | |
Slice Name | durationDuration |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationDuration) (Extension Type: Duration) |
Is Modifier | 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() ) |
146. Group.characteristic:population.extension:durationRange | |
Slice Name | durationRange |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationRange) (Extension Type: Range) |
Is Modifier | 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() ) |
148. Group.characteristic:population.extension:timing | |
Slice Name | timing |
Definition | Timing in which the characteristic is determined. |
Short | Timing in which the characteristic is determined |
Control | 0..* |
Type | Extension(CharacteristicTiming) (Complex Extension) |
Is Modifier | 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() ) |
150. Group.characteristic:population.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 managable, 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() ) |
152. Group.characteristic:population.code | |
Definition | A code that identifies the kind of trait being asserted. |
Short | Kind of characteristic |
Control | 1..1 |
Binding | List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Need a formal way of identifying the characteristic being described. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
154. Group.characteristic:population.code.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 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
156. Group.characteristic:population.code.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 managable, 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 Group.characteristic.code.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
158. Group.characteristic:population.code.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 | 0..* |
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()) ) |
160. Group.characteristic:population.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Short | Plain text representation of the concept |
Comments | Very often the text is the same as a displayName of one of the codings. |
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 |
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. |
Pattern Value | Population |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
162. Group.characteristic:population.value[x] | |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 1..1 |
Binding | Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. |
Type | Choice of: CodeableConcept, boolean, Quantity, Range, Reference |
[x] Note | See Choice of Data Types for 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 |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
Slicing | This element introduces a set of slices on Group.characteristic.value[x] . The slices are unordered and Open, and can be differentiated using the following discriminators: |
164. Group.characteristic:population.value[x]:valueReference | |
Slice Name | valueReference |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 0..1 |
Type | Reference(Group) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
166. Group.characteristic:population.exclude | |
Definition | If true, indicates the characteristic is one that is NOT held by members of the group. |
Short | Group includes or excludes |
Comments | This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa. |
Control | 1..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Sometimes group membership is determined by characteristics not possessed. |
Pattern Value | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
168. Group.characteristic:population.period | |
Definition | The period over which the characteristic is tested; e.g. the patient had an operation during the month of June. |
Short | Period over which characteristic is tested |
Control | 0..1 |
Type | Period |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
170. Group.characteristic:intervention | |
Slice Name | intervention |
Definition | Identifies traits whose presence r absence is shared by members of the group. |
Short | Include / Exclude group members by Trait |
Comments | All the identified characteristics must be true for an entity to a member of the group. |
Control | 0..1 |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Needs to be a generic mechanism for identifying what individuals can be part of a group. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
172. Group.characteristic:intervention.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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
174. Group.characteristic:intervention.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 Group.characteristic.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
176. Group.characteristic:intervention.extension:valueUri | |
Slice Name | valueUri |
Definition | The value of the trait that holds for members of the group, held by uri. |
Short | Value held by uri |
Control | 0..1 |
Type | Extension(CharacteristicValueUri) (Extension Type: uri) |
Is Modifier | 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() ) |
178. Group.characteristic:intervention.extension:valueExpression | |
Slice Name | valueExpression |
Definition | The value of the trait that holds for members of the group, held by Expression. |
Short | Value held by Expression |
Control | 0..1 |
Type | Extension(CharacteristicValueExpression) (Extension Type: Expression) |
Is Modifier | 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() ) |
180. Group.characteristic:intervention.extension:description | |
Slice Name | description |
Definition | A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user. |
Short | Natural language description of the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicDescription) (Extension Type: markdown) |
Is Modifier | 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() ) |
182. Group.characteristic:intervention.extension:method | |
Slice Name | method |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..* |
Type | Extension(CharacteristicMethod) (Extension Type: CodeableConcept) |
Is Modifier | 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() ) |
184. Group.characteristic:intervention.extension:determinedByReference | |
Slice Name | determinedByReference |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByReference) (Extension Type: Reference(Device, DeviceDefinition, DeviceMetric)) |
Is Modifier | 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() ) |
186. Group.characteristic:intervention.extension:determinedByExpression | |
Slice Name | determinedByExpression |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByExpression) (Extension Type: Expression) |
Is Modifier | 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() ) |
188. Group.characteristic:intervention.extension:offset | |
Slice Name | offset |
Definition | Defines the reference point for comparison when other than 0. |
Short | Reference point for comparison |
Control | 0..1 |
Type | Extension(CharacteristicOffset) (Extension Type: CodeableConcept) |
Is Modifier | 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() ) |
190. Group.characteristic:intervention.extension:instancesQuantity | |
Slice Name | instancesQuantity |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesQuantity) (Extension Type: Quantity) |
Is Modifier | 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() ) |
192. Group.characteristic:intervention.extension:instancesRange | |
Slice Name | instancesRange |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesRange) (Extension Type: Range) |
Is Modifier | 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() ) |
194. Group.characteristic:intervention.extension:durationDuration | |
Slice Name | durationDuration |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationDuration) (Extension Type: Duration) |
Is Modifier | 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() ) |
196. Group.characteristic:intervention.extension:durationRange | |
Slice Name | durationRange |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationRange) (Extension Type: Range) |
Is Modifier | 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() ) |
198. Group.characteristic:intervention.extension:timing | |
Slice Name | timing |
Definition | Timing in which the characteristic is determined. |
Short | Timing in which the characteristic is determined |
Control | 0..* |
Type | Extension(CharacteristicTiming) (Complex Extension) |
Is Modifier | 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() ) |
200. Group.characteristic:intervention.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 managable, 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() ) |
202. Group.characteristic:intervention.code | |
Definition | A code that identifies the kind of trait being asserted. |
Short | Kind of characteristic |
Control | 1..1 |
Binding | List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Need a formal way of identifying the characteristic being described. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
204. Group.characteristic:intervention.code.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 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
206. Group.characteristic:intervention.code.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 managable, 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 Group.characteristic.code.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
208. Group.characteristic:intervention.code.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 | 0..* |
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()) ) |
210. Group.characteristic:intervention.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Short | Plain text representation of the concept |
Comments | Very often the text is the same as a displayName of one of the codings. |
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 |
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. |
Pattern Value | Intervention or Exposure |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
212. Group.characteristic:intervention.value[x] | |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 1..1 |
Binding | Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. |
Type | Choice of: CodeableConcept, boolean, Quantity, Range, Reference |
[x] Note | See Choice of Data Types for 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 |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
Slicing | This element introduces a set of slices on Group.characteristic.value[x] . The slices are unordered and Open, and can be differentiated using the following discriminators: |
214. Group.characteristic:intervention.value[x]:valueReference | |
Slice Name | valueReference |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 0..1 |
Type | Reference(EvidenceVariable, Group) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
216. Group.characteristic:intervention.exclude | |
Definition | If true, indicates the characteristic is one that is NOT held by members of the group. |
Short | Group includes or excludes |
Comments | This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa. |
Control | 1..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Sometimes group membership is determined by characteristics not possessed. |
Pattern Value | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
218. Group.characteristic:intervention.period | |
Definition | The period over which the characteristic is tested; e.g. the patient had an operation during the month of June. |
Short | Period over which characteristic is tested |
Control | 0..1 |
Type | Period |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
220. Group.characteristic:comparator | |
Slice Name | comparator |
Definition | Identifies traits whose presence r absence is shared by members of the group. |
Short | Include / Exclude group members by Trait |
Comments | All the identified characteristics must be true for an entity to a member of the group. |
Control | 0..1 |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Needs to be a generic mechanism for identifying what individuals can be part of a group. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
222. Group.characteristic:comparator.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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
224. Group.characteristic:comparator.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 Group.characteristic.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
226. Group.characteristic:comparator.extension:valueUri | |
Slice Name | valueUri |
Definition | The value of the trait that holds for members of the group, held by uri. |
Short | Value held by uri |
Control | 0..1 |
Type | Extension(CharacteristicValueUri) (Extension Type: uri) |
Is Modifier | 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() ) |
228. Group.characteristic:comparator.extension:valueExpression | |
Slice Name | valueExpression |
Definition | The value of the trait that holds for members of the group, held by Expression. |
Short | Value held by Expression |
Control | 0..1 |
Type | Extension(CharacteristicValueExpression) (Extension Type: Expression) |
Is Modifier | 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() ) |
230. Group.characteristic:comparator.extension:description | |
Slice Name | description |
Definition | A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user. |
Short | Natural language description of the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicDescription) (Extension Type: markdown) |
Is Modifier | 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() ) |
232. Group.characteristic:comparator.extension:method | |
Slice Name | method |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..* |
Type | Extension(CharacteristicMethod) (Extension Type: CodeableConcept) |
Is Modifier | 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() ) |
234. Group.characteristic:comparator.extension:determinedByReference | |
Slice Name | determinedByReference |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByReference) (Extension Type: Reference(Device, DeviceDefinition, DeviceMetric)) |
Is Modifier | 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() ) |
236. Group.characteristic:comparator.extension:determinedByExpression | |
Slice Name | determinedByExpression |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByExpression) (Extension Type: Expression) |
Is Modifier | 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() ) |
238. Group.characteristic:comparator.extension:offset | |
Slice Name | offset |
Definition | Defines the reference point for comparison when other than 0. |
Short | Reference point for comparison |
Control | 0..1 |
Type | Extension(CharacteristicOffset) (Extension Type: CodeableConcept) |
Is Modifier | 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() ) |
240. Group.characteristic:comparator.extension:instancesQuantity | |
Slice Name | instancesQuantity |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesQuantity) (Extension Type: Quantity) |
Is Modifier | 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() ) |
242. Group.characteristic:comparator.extension:instancesRange | |
Slice Name | instancesRange |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesRange) (Extension Type: Range) |
Is Modifier | 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() ) |
244. Group.characteristic:comparator.extension:durationDuration | |
Slice Name | durationDuration |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationDuration) (Extension Type: Duration) |
Is Modifier | 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() ) |
246. Group.characteristic:comparator.extension:durationRange | |
Slice Name | durationRange |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationRange) (Extension Type: Range) |
Is Modifier | 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() ) |
248. Group.characteristic:comparator.extension:timing | |
Slice Name | timing |
Definition | Timing in which the characteristic is determined. |
Short | Timing in which the characteristic is determined |
Control | 0..* |
Type | Extension(CharacteristicTiming) (Complex Extension) |
Is Modifier | 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() ) |
250. Group.characteristic:comparator.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 managable, 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() ) |
252. Group.characteristic:comparator.code | |
Definition | A code that identifies the kind of trait being asserted. |
Short | Kind of characteristic |
Control | 1..1 |
Binding | List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Need a formal way of identifying the characteristic being described. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
254. Group.characteristic:comparator.code.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 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
256. Group.characteristic:comparator.code.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 managable, 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 Group.characteristic.code.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
258. Group.characteristic:comparator.code.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 | 0..* |
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()) ) |
260. Group.characteristic:comparator.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Short | Plain text representation of the concept |
Comments | Very often the text is the same as a displayName of one of the codings. |
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 |
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. |
Pattern Value | Comparator |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
262. Group.characteristic:comparator.value[x] | |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 1..1 |
Binding | Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. |
Type | Choice of: CodeableConcept, boolean, Quantity, Range, Reference |
[x] Note | See Choice of Data Types for 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 |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
Slicing | This element introduces a set of slices on Group.characteristic.value[x] . The slices are unordered and Open, and can be differentiated using the following discriminators: |
264. Group.characteristic:comparator.value[x]:valueReference | |
Slice Name | valueReference |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 0..1 |
Type | Reference(EvidenceVariable, Group) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
266. Group.characteristic:comparator.exclude | |
Definition | If true, indicates the characteristic is one that is NOT held by members of the group. |
Short | Group includes or excludes |
Comments | This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa. |
Control | 1..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Sometimes group membership is determined by characteristics not possessed. |
Pattern Value | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
268. Group.characteristic:comparator.period | |
Definition | The period over which the characteristic is tested; e.g. the patient had an operation during the month of June. |
Short | Period over which characteristic is tested |
Control | 0..1 |
Type | Period |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
270. Group.characteristic:outcomes | |
Slice Name | outcomes |
Definition | Identifies traits whose presence r absence is shared by members of the group. |
Short | Include / Exclude group members by Trait |
Comments | All the identified characteristics must be true for an entity to a member of the group. |
Control | 0..1 |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Needs to be a generic mechanism for identifying what individuals can be part of a group. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
272. Group.characteristic:outcomes.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 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
274. Group.characteristic:outcomes.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 Group.characteristic.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
276. Group.characteristic:outcomes.extension:valueUri | |
Slice Name | valueUri |
Definition | The value of the trait that holds for members of the group, held by uri. |
Short | Value held by uri |
Control | 0..1 |
Type | Extension(CharacteristicValueUri) (Extension Type: uri) |
Is Modifier | 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() ) |
278. Group.characteristic:outcomes.extension:valueExpression | |
Slice Name | valueExpression |
Definition | The value of the trait that holds for members of the group, held by Expression. |
Short | Value held by Expression |
Control | 0..1 |
Type | Extension(CharacteristicValueExpression) (Extension Type: Expression) |
Is Modifier | 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() ) |
280. Group.characteristic:outcomes.extension:description | |
Slice Name | description |
Definition | A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user. |
Short | Natural language description of the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicDescription) (Extension Type: markdown) |
Is Modifier | 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() ) |
282. Group.characteristic:outcomes.extension:method | |
Slice Name | method |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..* |
Type | Extension(CharacteristicMethod) (Extension Type: CodeableConcept) |
Is Modifier | 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() ) |
284. Group.characteristic:outcomes.extension:determinedByReference | |
Slice Name | determinedByReference |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByReference) (Extension Type: Reference(Device, DeviceDefinition, DeviceMetric)) |
Is Modifier | 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() ) |
286. Group.characteristic:outcomes.extension:determinedByExpression | |
Slice Name | determinedByExpression |
Definition | Method for how the characteristic value was determined. |
Short | Method for how the characteristic value was determined |
Control | 0..1 |
Type | Extension(CharacteristicDeterminedByExpression) (Extension Type: Expression) |
Is Modifier | 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() ) |
288. Group.characteristic:outcomes.extension:offset | |
Slice Name | offset |
Definition | Defines the reference point for comparison when other than 0. |
Short | Reference point for comparison |
Control | 0..1 |
Type | Extension(CharacteristicOffset) (Extension Type: CodeableConcept) |
Is Modifier | 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() ) |
290. Group.characteristic:outcomes.extension:instancesQuantity | |
Slice Name | instancesQuantity |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesQuantity) (Extension Type: Quantity) |
Is Modifier | 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() ) |
292. Group.characteristic:outcomes.extension:instancesRange | |
Slice Name | instancesRange |
Definition | Number of occurrences meeting the characteristic. |
Short | Number of occurrences meeting the characteristic |
Control | 0..1 |
Type | Extension(CharacteristicInstancesRange) (Extension Type: Range) |
Is Modifier | 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() ) |
294. Group.characteristic:outcomes.extension:durationDuration | |
Slice Name | durationDuration |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationDuration) (Extension Type: Duration) |
Is Modifier | 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() ) |
296. Group.characteristic:outcomes.extension:durationRange | |
Slice Name | durationRange |
Definition | Length of time in which the characteristic is met. |
Short | Length of time in which the characteristic is met |
Control | 0..1 |
Type | Extension(CharacteristicDurationRange) (Extension Type: Range) |
Is Modifier | 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() ) |
298. Group.characteristic:outcomes.extension:timing | |
Slice Name | timing |
Definition | Timing in which the characteristic is determined. |
Short | Timing in which the characteristic is determined |
Control | 0..* |
Type | Extension(CharacteristicTiming) (Complex Extension) |
Is Modifier | 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() ) |
300. Group.characteristic:outcomes.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 managable, 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() ) |
302. Group.characteristic:outcomes.code | |
Definition | A code that identifies the kind of trait being asserted. |
Short | Kind of characteristic |
Control | 1..1 |
Binding | List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | Need a formal way of identifying the characteristic being described. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
304. Group.characteristic:outcomes.code.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 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
306. Group.characteristic:outcomes.code.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 managable, 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 Group.characteristic.code.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
308. Group.characteristic:outcomes.code.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 | 0..* |
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()) ) |
310. Group.characteristic:outcomes.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Short | Plain text representation of the concept |
Comments | Very often the text is the same as a displayName of one of the codings. |
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 |
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. |
Pattern Value | Outcomes |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
312. Group.characteristic:outcomes.value[x] | |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 1..1 |
Binding | Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. |
Type | Choice of: CodeableConcept, boolean, Quantity, Range, Reference |
[x] Note | See Choice of Data Types for 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 |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
Slicing | This element introduces a set of slices on Group.characteristic.value[x] . The slices are unordered and Open, and can be differentiated using the following discriminators: |
314. Group.characteristic:outcomes.value[x]:valueReference | |
Slice Name | valueReference |
Definition | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Short | Value held by characteristic |
Comments | For Range, it means members of the group have a value that falls somewhere within the specified range. |
Control | 0..1 |
Type | Reference(OutcomeList) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Is Modifier | false |
Must Support | false |
Summary | true |
Requirements | The value of the characteristic is what determines group membership. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
316. Group.characteristic:outcomes.exclude | |
Definition | If true, indicates the characteristic is one that is NOT held by members of the group. |
Short | Group includes or excludes |
Comments | This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa. |
Control | 1..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | false |
Summary | true |
Requirements | Sometimes group membership is determined by characteristics not possessed. |
Pattern Value | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
318. Group.characteristic:outcomes.period | |
Definition | The period over which the characteristic is tested; e.g. the patient had an operation during the month of June. |
Short | Period over which characteristic is tested |
Control | 0..1 |
Type | Period |
Is Modifier | false |
Must Support | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
320. Group.member | |
Definition | Identifies the resource instances that are members of the group. |
Short | Who or what is in group |
Control | 0..0 |
Type | BackboneElement |
Is Modifier | false |
Must Support | false |
Summary | false |
Requirements | Often the only thing of interest about a group is "who's in it". |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |