FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

FHIR Infrastructure icon Work Group Maturity Level: 0Trial Use Use Context: Any

Definitions for the groupdefinition Profile.

Group
Element IdGroup
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 DisplayGroup of multiple entities
Cardinality1..1
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.

Invariants
Inherited by this element
cnl-2RuleGroup.type SHALL be defined if Group.membership is either 'definitional' or 'enumerated'Group.type.exists() or (Group.membership = 'conceptual')
Group.id
Element IdGroup.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Short DisplayLogical id of this artifact
Cardinality0..1
Typeid
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.

Group.meta
Element IdGroup.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 DisplayMetadata about the resource
Cardinality0..1
TypeMeta
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.implicitRules
Element IdGroup.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 DisplayA set of rules under which this content was created
Cardinality0..1
Typeuri
Is Modifiertrue (Reason: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation)
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.language
Element IdGroup.language
Definition

The base language in which the resource is written.

Short DisplayLanguage of the resource content
Cardinality0..1
Terminology BindingIETF language tag for a human language
The codes SHALL be taken from All Languages
Typecode
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).

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.text
Element IdGroup.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 DisplayText summary of the resource, for human interpretation
Cardinality0..1 This element is affected by the following invariants: dom-6
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.contained
Element IdGroup.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 DisplayContained, inline Resources
Cardinality0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Group.extension
Element IdGroup.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and 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 DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.modifierExtension
Element IdGroup.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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 DisplayExtensions that cannot be ignored
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them)
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 Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.url
Element IdGroup.url
Definition

An absolute URI that is used to identify this Group 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 Group is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Group is stored on different servers.

Short DisplayCanonical identifier for this Group, represented as an absolute URI (globally unique)
Cardinality0..1
Typeuri
Requirements

Allows the Group to be referenced by a single globally unique identifier.

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.

Invariants
Inherited by this element
cnl-1WarningURL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.identifier
Element IdGroup.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 DisplayBusiness Identifier for this Group
Cardinality0..*
TypeIdentifier
Requirements

Allows identification of the group as it is known by various participating systems and in a way that remains consistent across servers.

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.version
Element IdGroup.version
Definition

The identifier that is used to identify this version of the Group when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Group 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 without additional knowledge.

Short DisplayBusiness version of the Group
Cardinality0..1
Typestring
Comments

There may be different Groups that have the same url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the Group with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.versionAlgorithm[x]
Element IdGroup.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which is more current.

Short DisplayHow to compare versions
Cardinality0..1
Terminology Bindingnull
The codes SHALL be taken from Version Algorithm; other codes may be used where these codes are not suitable
TypeChoice of: string, Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.name
Element IdGroup.name
Definition

A label assigned to the group for human identification and communication.

Short DisplayLabel for Group
Cardinality0..1
Typestring
Requirements

Used to identify the group in human communication.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.title
Element IdGroup.title
Definition

A short, descriptive, user-friendly title for the Group.

Short DisplayName for this Group (human friendly)
Cardinality0..1
Typestring
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.status
Element IdGroup.status
Definition

The current state of this Group.

Short Displaydraft | active | retired | unknown
Cardinality0..1
Terminology BindingThe lifecycle status of an artifact.
The codes SHALL be taken from PublicationStatus
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired Group without due consideration)
Requirements

Enables tracking the life-cycle of the content and filtering of Groups that are appropriate for use versus not.

Comments

A nominal state-transition diagram can be found in the Definition pattern documentation.

Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.experimental
Element IdGroup.experimental
Definition

A Boolean value to indicate that this Group is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage.

Short DisplayFor testing purposes, not real usage
Cardinality0..1
Typeboolean
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level Group.

Comments

Allows filtering of Groups that are appropriate for use versus not.

Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.date
Element IdGroup.date
Definition

The date (and optionally time) when the Group 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 Group changes.

Short DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate NamesRevision Date
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 Group. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.publisher
Element IdGroup.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the Group.

Short DisplayName of the publisher/steward (organization or individual)
Cardinality0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the Group. May also allow for contact.

Comments

Usually an organization but may be an individual. The publisher (or steward) of the Group is the organization or individual primarily responsible for the maintenance and upkeep of the Group. 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 Group. This item SHOULD be populated unless the information is available from context.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.contact
Element IdGroup.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Comments

May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.description
Element IdGroup.description
Definition

Explanation of what the group represents and how it is intended to be used.

Short DisplayNatural language description of the group
Cardinality0..1
Typemarkdown
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.useContext
Element IdGroup.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 Groups.

Short DisplayThe context that the content is intended to support
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.purpose
Element IdGroup.purpose
Definition

Explanation of why this Group is needed and why it has been designed as it has.

Short DisplayWhy this Group is defined
Cardinality0..1
Typemarkdown
Comments

This element does not describe the usage of the Group. 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 Group.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.copyright
Element IdGroup.copyright
Definition

A copyright statement relating to the Group and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Group.

Short DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the Group and/or its content.

Alternate NamesLicense, Restrictions
Comments

The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.copyrightLabel
Element IdGroup.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 DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.type
Element IdGroup.type
Definition

Identifies the broad classification of the kind of resources the group includes.

Short Displayperson | animal | practitioner | device | careteam | healthcareservice | location | organization | relatedperson | specimen
Cardinality0..1
Terminology BindingTypes of resources that are part of group.
The codes SHALL be taken from Group Type
Typecode
Requirements

Identifies what type of resources the group is made up of.

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.membership
Element IdGroup.membership
Definition

Basis for membership in the Group:

  • 'definitional': The Group.characteristics specified are both necessary and sufficient to determine membership. All entities that meet the criteria are considered to be members of the group, whether referenced by the group or not. If members are present, they are individuals that happen to be known as meeting the Group.characteristics. The list cannot be presumed to be complete.
  • 'conceptual': The Group.characteristics specified are both necessary and sufficient to determine membership. The 'conceptual' Group is a 'definitional' Group in which the Group.type is not bound to FHIR types.
  • 'enumerated': The Group.characteristics are necessary but not sufficient to determine membership. Membership is determined by being listed as one of the Group.member.
Short Displaydefinitional | conceptual | enumerated
Cardinality1..1
Terminology BindingThe basis for membership in a group
The codes SHALL be taken from Group Membership Basis
Typecode
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.

Fixed Valuedefinitional
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.code
Element IdGroup.code
Definition

Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.

Short DisplayKind of Group members
Cardinality0..1
Terminology BindingKind of particular resource; e.g. cow, syringe, lake, etc.
TypeCodeableConcept
Comments

This would generally be omitted for Person resources.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.quantity
Element IdGroup.quantity
Definition

A count of the number of resource instances that are part of the group.

Short DisplayNumber of members
Cardinality0..1
TypeunsignedInt
Requirements

Group size is a common defining characteristic.

Comments

Note that the quantity may be less than the number of members if some of the members are not active.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.managingEntity
Element IdGroup.managingEntity
Definition

Entity responsible for defining and maintaining Group characteristics and/or registered members.

Short DisplayEntity that is the custodian of the Group's definition
Cardinality0..1
TypeReference(Organization)
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.combinationMethod
Element IdGroup.combinationMethod
Definition

Used to specify how two or more characteristics are combined.

Short Displayall-of | any-of | at-least | at-most | except-subset
Cardinality0..1
Terminology Bindingnull
The codes SHALL be taken from Group Characteristic Combination
Typecode
Is Modifiertrue (Reason: Changing the combinationMethod from all-of to any other value changes the interpretation of multiple characteristics.)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.combinationThreshold
Element IdGroup.combinationThreshold
Definition

Provides the value of "n" when "at-least" or "at-most" codes are used for combinationMethod.

Short DisplayProvides the value of "n" when "at-least" or "at-most" codes are used
Cardinality0..1
TypepositiveInt
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.characteristic
Element IdGroup.characteristic
Definition

Identifies traits whose presence r absence is shared by members of the group.

Short DisplayInclude / Exclude group members by Trait
Cardinality1..*
TypeBackboneElement
Requirements

Needs to be a generic mechanism for identifying what individuals can be part of a group.

Comments

All the identified characteristics must be true for an entity to a member of the group.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.characteristic.id
Element IdGroup.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 DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
Group.characteristic.extension
Element IdGroup.characteristic.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 DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.characteristic.modifierExtension
Element IdGroup.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 DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
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 Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.characteristic.code
Element IdGroup.characteristic.code
Definition

A code that identifies the kind of trait being asserted.

Short DisplayKind of characteristic
Cardinality1..1
Terminology BindingList of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
TypeCodeableConcept
Requirements

Need a formal way of identifying the characteristic being described.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.characteristic.value[x]
Element IdGroup.characteristic.value[x]
Definition

The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

Short DisplayValue held by characteristic
Cardinality1..1
Terminology BindingValue of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
TypeChoice of: CodeableConcept, boolean, Quantity, Range, Reference, uri, Expression
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Requirements

The value of the characteristic is what determines group membership.

Comments

For Range, it means members of the group have a value that falls somewhere within the specified range.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.characteristic.exclude
Element IdGroup.characteristic.exclude
Definition

If true, indicates the characteristic is one that is NOT held by members of the group.

Short DisplayGroup includes or excludes
Cardinality1..1
Typeboolean
Requirements

Sometimes group membership is determined by characteristics not possessed.

Comments

This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.characteristic.description
Element IdGroup.characteristic.description
Definition

A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.

Short DisplayNatural language description of the characteristic
Cardinality0..1
Typemarkdown
Requirements

Need to be able to describe characteristics in natural language so that end users can understand the criteria.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.characteristic.method
Element IdGroup.characteristic.method
Definition

Method for how the characteristic value was determined.

Short DisplayMethod for how the characteristic value was determined
Cardinality0..*
Terminology Bindingnull
For example codes, see Definition Method
TypeCodeableConcept
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.characteristic.determinedBy[x]
Element IdGroup.characteristic.determinedBy[x]
Definition

Defines the characteristic (without using type and value) by either a Reference or an Expression.

Short DisplayDefines the characteristic
Cardinality0..1
TypeChoice of: Reference(Device), Expression
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Requirements

The value of the characteristic is what determines group membership.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.characteristic.offset
Element IdGroup.characteristic.offset
Definition

Defines the reference point for comparison when other than 0.

Short DisplayReference point for comparison
Cardinality0..1
Terminology Bindingnull
For example codes, see Characteristic Offset
TypeCodeableConcept
Is Modifiertrue (Reason: If offset is present it must be included to interpret the characteristic value.)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.characteristic.instances[x]
Element IdGroup.characteristic.instances[x]
Definition

Number of occurrences meeting the characteristic.

Short DisplayNumber of occurrences meeting the characteristic
Cardinality0..1
TypeChoice of: Quantity, Range
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.characteristic.duration[x]
Element IdGroup.characteristic.duration[x]
Definition

Length of time in which the characteristic is met.

Short DisplayLength of time in which the characteristic is met
Cardinality0..1
TypeChoice of: Duration, Range
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.characteristic.period
Element IdGroup.characteristic.period
Definition

The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.

Short DisplayPeriod over which characteristic is tested
Cardinality0..1
TypePeriod
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.characteristic.timing
Element IdGroup.characteristic.timing
Definition

Timing in which the characteristic is determined.

Short DisplayTiming in which the characteristic is determined
Cardinality0..*
TypeRelativeTime
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.member
Element IdGroup.member
Definition

Identifies the resource instances that are members of the group.

Short DisplayWho or what is in group
Cardinality0..*
TypeBackboneElement
Requirements

Often the only thing of interest about a group is "who's in it".

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.member.id
Element IdGroup.member.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 DisplayUnique id for inter-element referencing
Cardinality0..1 This element is affected by the following invariants: ele-1
Typestring
Group.member.extension
Element IdGroup.member.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 DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.member.modifierExtension
Element IdGroup.member.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 DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
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 Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.member.entity
Element IdGroup.member.entity
Definition

A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.

Short DisplayReference to the group member
Cardinality1..1
TypeReference(CareTeam)
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.member.period
Element IdGroup.member.period
Definition

The period that the member was in the group, if known.

Short DisplayPeriod member belonged to the group
Cardinality0..1
TypePeriod
Requirements

Need to track who was in a group at a particular time.

Meaning if MissingThe member is in the group at this time
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Group.member.inactive
Element IdGroup.member.inactive
Definition

A flag to indicate that the member is no longer in the group, but previously may have been a member.

Short DisplayIf member is no longer in group
Cardinality0..1
Typeboolean
Requirements

Sometimes you don't know when someone stopped being in a group, but not when.

Meaning if MissingMembers are considered active unless explicitly specified otherwise
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())