Da Vinci - Member Attribution (ATR) List
2.0.0-ballot - STU 2.0.0 US

This page is part of the Risk Based Contracts Member Attribution List FHIR IG (v2.0.0-ballot: STU2 Release 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: ATRGroup - Detailed Descriptions

Active as of 2019-09-01

Definitions for the atr-group resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. Group
Definition

Sets expectations for supported capabilities for Group resource in Member Attribution Lists.

Sets expectations for supported capabilities of a Group resource for Patient List.

2. Group.meta
Control0..?
3. Group.meta.lastUpdated
Control1..1
Must Supporttrue
4. Group.extension:contractValidityPeriod
SliceNamecontractValidityPeriod
Control0..1
TypeExtension(ContractValidityPeriod) (Extension Type: Period)
Must Supporttrue
5. Group.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
SlicingThis element introduces a set of slices on Group.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ type.coding.system
  • value @ type.coding.system,
6. Group.identifier:NPIIdentifier
SliceNameNPIIdentifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
Must Supporttrue
7. Group.identifier:NPIIdentifier.type
Control1..1
TypeCodeableConcept
Must Supporttrue
8. Group.identifier:NPIIdentifier.type.coding
Control1..1
Must Supporttrue
9. Group.identifier:NPIIdentifier.type.coding.system
Control1..1
Typeuri
Must Supporttrue
Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
10. Group.identifier:NPIIdentifier.type.coding.code
Control1..1
Typecode
Must Supporttrue
Fixed ValueNPI
11. Group.identifier:NPIIdentifier.system
Control1..1
Must Supporttrue
12. Group.identifier:NPIIdentifier.value
Control1..1
Must Supporttrue
13. Group.identifier:TAXIdentifier
SliceNameTAXIdentifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
Must Supporttrue
14. Group.identifier:TAXIdentifier.type
Control1..1
TypeCodeableConcept
Must Supporttrue
15. Group.identifier:TAXIdentifier.type.coding
Control1..1
Must Supporttrue
16. Group.identifier:TAXIdentifier.type.coding.system
Control1..1
Typeuri
Must Supporttrue
Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
17. Group.identifier:TAXIdentifier.type.coding.code
Control1..1
Typecode
Must Supporttrue
Fixed ValueTAX
18. Group.identifier:TAXIdentifier.system
Control1..1
Must Supporttrue
19. Group.identifier:TAXIdentifier.value
Control1..1
Must Supporttrue
20. Group.member
Must Supporttrue
21. Group.member.extension:changeType
SliceNamechangeType
Control0..1
BindingThe codes SHALL be taken from Da Vinci ATR Change Types; other codes may be used where these codes are not suitable The Da Vinci ATR Change Type Value Set is a 'starter set' of codes for identifying the detailed changes associated with Member Attribution List
TypeExtension(ChangeType) (Extension Type: code)
Must Supporttrue
22. Group.member.extension:coverageReference
SliceNamecoverageReference
Control0..1
TypeExtension(CoverageReference) (Extension Type: Reference(ATRCoverage))
Must Supporttrue
23. Group.member.extension:attributedProvider
SliceNameattributedProvider
Control0..1
TypeExtension(AttributedProvider) (Extension Type: Reference(ATROrganization|ATRPractitioner|ATRPractitionerRole))
Must Supporttrue

Guidance on how to interpret the contents of this table can be found here.

1. Group
Definition

Sets expectations for supported capabilities for Group resource in Member Attribution Lists.

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.

Control0..*
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.

InvariantsDefined on this element
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (: text.`div`.exists())
grp-1: Can only have members if group is "actual" (: member.empty() or (actual = true))
2. 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.

Control0..1
TypeMeta
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. Group.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Control10..1
Typeinstant
Must Supporttrue
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. 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.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Group.extension:intendedRecipientIdentifier
SliceNameintendedRecipientIdentifier
Definition

Specifies the Identifier of the entity that is going to be using the group.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(AtrIntendedRecipientIdentifierExtension) (Extension Type: Identifier)
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
6. Group.extension:contractValidityPeriod
SliceNamecontractValidityPeriod
Definition

Indicates the validity period for Contract which is the basis for the Member Attribution List.

Control0..1
TypeExtension(ContractValidityPeriod) (Extension Type: Period)
Must Supporttrue
InvariantsDefined on this element
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())
7. Group.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
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.

InvariantsDefined on this element
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.identifier
Definition

A unique business identifier for this group.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Must Supporttrue
Requirements

Allows the group to be referenced from external specifications.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Group.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ type.coding.system
  • value @ type.coding.system,
9. Group.identifier:NPIIdentifier
SliceNameNPIIdentifier
Definition

A unique business identifier for this group.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Must Supporttrue
Requirements

Allows the group to be referenced from external specifications.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. Group.identifier:NPIIdentifier.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Group.identifier:NPIIdentifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control10..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Must Supporttrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Group.identifier:NPIIdentifier.type.coding
Definition

A reference to a code defined by a terminology system.

Control10..1*
TypeCoding
Must Supporttrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Group.identifier:NPIIdentifier.type.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control10..1
Typeuri
Must Supporttrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Group.identifier:NPIIdentifier.type.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control10..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Fixed ValueNPI
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Group.identifier:NPIIdentifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control10..1
Typeuri
Must Supporttrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Group.identifier:NPIIdentifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control10..1
Typestring
Must Supporttrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Group.identifier:TAXIdentifier
SliceNameTAXIdentifier
Definition

A unique business identifier for this group.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Must Supporttrue
Requirements

Allows the group to be referenced from external specifications.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. Group.identifier:TAXIdentifier.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Group.identifier:TAXIdentifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control10..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Must Supporttrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. Group.identifier:TAXIdentifier.type.coding
Definition

A reference to a code defined by a terminology system.

Control10..1*
TypeCoding
Must Supporttrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. Group.identifier:TAXIdentifier.type.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control10..1
Typeuri
Must Supporttrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Group.identifier:TAXIdentifier.type.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control10..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Fixed ValueTAX
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Group.identifier:TAXIdentifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control10..1
Typeuri
Must Supporttrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. Group.identifier:TAXIdentifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control10..1
Typestring
Must Supporttrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. Group.active
Definition

Indicates whether the record for the group is available for use or is merely being retained for historical purposes.

Control0..1
Typeboolean
Must Supporttrue
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 MissingThis resource is generally assumed to be active if no value is provided for the active element
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. Group.type
Definition

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

Control1..1
BindingThe codes SHALL be taken from GroupType

Types of resources that are part of group.

Typecode
Must Supporttrue
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, Device, Medication or Substance for the other types.).

Fixed Valueperson
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Group.actual
Definition

If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.

Control1..1 This element is affected by the following invariants: grp-1
Typeboolean
Must Supporttrue
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 flag.

Fixed Valuetrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Group.name
Definition

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

Control0..1
Typestring
Must Supporttrue
Requirements

Used to identify the group in human communication.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Group.quantity
Definition

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

Control0..1
TypeunsignedInt
Must Supporttrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Group.managingEntity
Definition

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

Control10..1
TypeReference(ATROrganization|Organization|RelatedPerson|Practitioner|PractitionerRole)
Must Supporttrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. Group.characteristic
Definition

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

Control0..*
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
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.

InvariantsDefined on this element
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())
33. Group.characteristic.code
Definition

A code that identifies the kind of trait being asserted.

Control1..1
BindingThe codes SHALL be taken from DaVinci Group Characteristic; other codes may be used where these codes are not suitableFor example codes, see (unbound)

The set of characteristics shared by the members

List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.

TypeCodeableConcept
Must Supporttrue
Requirements

Need a formal way of identifying the characteristic being described.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. Group.characteristic.value[x]
Definition

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

Control1..1
Binding

Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

TypeChoice of: CodeableConcept, boolean, Quantity, Range, Reference
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Group.characteristic.exclude
Definition

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

Control1..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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Group.member
Definition

Identifies the resource instances that are members of the group.

Control0..* This element is affected by the following invariants: grp-1
TypeBackboneElement
Must Supporttrue
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. Group.member.extension:associatedData
SliceNameassociatedData
Definition

Specifies a resource that are associated with the member of the Group.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(AtrAnyResourceExtension) (Extension Type: Reference)
Must Supporttrue
InvariantsDefined on this element
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.member.extension:changeType
SliceNamechangeType
Definition

changeType can be new (member added), dropped (member removed), changed (member information has changed), nochange (no change in member information since group was created).

Control0..1
TypeExtension(ChangeType) (Extension Type: code)
Must Supporttrue
InvariantsDefined on this element
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())
39. Group.member.extension:coverageReference
SliceNamecoverageReference
Definition

Indicates the Coverage assocaited with the member placing them on the attribution list.

Control0..1
TypeExtension(CoverageReference) (Extension Type: Reference(ATRCoverage))
Must Supporttrue
InvariantsDefined on this element
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.member.extension:attributedProvider
SliceNameattributedProvider
Definition

Indicates the attributed provider.

Control0..1
TypeExtension(AttributedProvider) (Extension Type: Reference(ATROrganization|ATRPractitioner|ATRPractitionerRole))
Must Supporttrue
InvariantsDefined on this element
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())
41. Group.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
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.

InvariantsDefined on this element
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.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.

Control1..1
TypeReference(ATRPatient|Patient|Practitioner|PractitionerRole|Device|Medication|Substance|Group)
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. Group.member.period
Definition

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

Control0..1
TypePeriod
Must Supporttrue
Requirements

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

Meaning if MissingThe member is in the group at this time
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. Group.member.inactive
Definition

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

Control0..1
Typeboolean
Must Supporttrue
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
InvariantsDefined on this element
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.

1. Group
Definition

Sets expectations for supported capabilities for Group resource in Member Attribution Lists.

Control0..*
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.

2. Group.id
Definition

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

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. 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.

Control0..1
TypeMeta
4. Group.meta.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
5. Group.meta.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Group.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. Group.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Control0..1
Typeid
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Group.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Control1..1
Typeinstant
Must Supporttrue
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. Group.meta.source
Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Control0..1
Typeuri
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Group.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control0..*
Typecanonical(StructureDefinition)
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. Group.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Control0..*
BindingThe codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System
TypeCoding
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Group.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..*
BindingFor example codes, see CommonTags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
TypeCoding
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. 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.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Group.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages A human language
Additional BindingsPurpose
AllLanguagesMax Binding
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. 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.

Control0..1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Group.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
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.

16. Group.extension
Definition

An Extension

Control0..*
TypeExtension
InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Group.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
17. Group.extension:intendedRecipientIdentifier
SliceNameintendedRecipientIdentifier
Definition

Specifies the Identifier of the entity that is going to be using the group.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(AtrIntendedRecipientIdentifierExtension) (Extension Type: Identifier)
Must Supporttrue
InvariantsDefined on this element
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:contractValidityPeriod
SliceNamecontractValidityPeriod
Definition

Indicates the validity period for Contract which is the basis for the Member Attribution List.

Control0..1
TypeExtension(ContractValidityPeriod) (Extension Type: Period)
Must Supporttrue
InvariantsDefined on this element
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())
19. Group.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
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.

InvariantsDefined on this element
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.identifier
Definition

A unique business identifier for this group.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Must Supporttrue
Requirements

Allows the group to be referenced from external specifications.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Group.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ type.coding.system
  • value @ type.coding.system,
21. Group.identifier:NPIIdentifier
SliceNameNPIIdentifier
Definition

A unique business identifier for this group.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Must Supporttrue
Requirements

Allows the group to be referenced from external specifications.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Group.identifier:NPIIdentifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
23. Group.identifier:NPIIdentifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Group.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
24. Group.identifier:NPIIdentifier.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. Group.identifier:NPIIdentifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control1..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Must Supporttrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. Group.identifier:NPIIdentifier.type.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
27. Group.identifier:NPIIdentifier.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Group.identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
28. Group.identifier:NPIIdentifier.type.coding
Definition

A reference to a code defined by a terminology system.

Control1..1
TypeCoding
Must Supporttrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Group.identifier:NPIIdentifier.type.coding.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
30. Group.identifier:NPIIdentifier.type.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Group.identifier.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
31. Group.identifier:NPIIdentifier.type.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Must Supporttrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. Group.identifier:NPIIdentifier.type.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. Group.identifier:NPIIdentifier.type.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Fixed ValueNPI
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. Group.identifier:NPIIdentifier.type.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Group.identifier:NPIIdentifier.type.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Group.identifier:NPIIdentifier.type.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. Group.identifier:NPIIdentifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control1..1
Typeuri
Must Supporttrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. Group.identifier:NPIIdentifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control1..1
Typestring
Must Supporttrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. Group.identifier:NPIIdentifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. Group.identifier:NPIIdentifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. Group.identifier:TAXIdentifier
SliceNameTAXIdentifier
Definition

A unique business identifier for this group.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Must Supporttrue
Requirements

Allows the group to be referenced from external specifications.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. Group.identifier:TAXIdentifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
43. Group.identifier:TAXIdentifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Group.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
44. Group.identifier:TAXIdentifier.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. Group.identifier:TAXIdentifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control1..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Must Supporttrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. Group.identifier:TAXIdentifier.type.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
47. Group.identifier:TAXIdentifier.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Group.identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
48. Group.identifier:TAXIdentifier.type.coding
Definition

A reference to a code defined by a terminology system.

Control1..1
TypeCoding
Must Supporttrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. Group.identifier:TAXIdentifier.type.coding.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
50. Group.identifier:TAXIdentifier.type.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Group.identifier.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
51. Group.identifier:TAXIdentifier.type.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Must Supporttrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://terminology.hl7.org/CodeSystem/v2-0203
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. Group.identifier:TAXIdentifier.type.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
53. Group.identifier:TAXIdentifier.type.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Fixed ValueTAX
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. Group.identifier:TAXIdentifier.type.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
55. Group.identifier:TAXIdentifier.type.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
56. Group.identifier:TAXIdentifier.type.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. Group.identifier:TAXIdentifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control1..1
Typeuri
Must Supporttrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
58. Group.identifier:TAXIdentifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control1..1
Typestring
Must Supporttrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. Group.identifier:TAXIdentifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
60. Group.identifier:TAXIdentifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. Group.active
Definition

Indicates whether the record for the group is available for use or is merely being retained for historical purposes.

Control0..1
Typeboolean
Must Supporttrue
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 MissingThis resource is generally assumed to be active if no value is provided for the active element
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. Group.type
Definition

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

Control1..1
BindingThe codes SHALL be taken from GroupType Types of resources that are part of group
Typecode
Must Supporttrue
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, Device, Medication or Substance for the other types.).

Fixed Valueperson
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. Group.actual
Definition

If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.

Control1..1 This element is affected by the following invariants: grp-1
Typeboolean
Must Supporttrue
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 flag.

Fixed Valuetrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
64. Group.code
Definition

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

Control0..1
Binding

Kind of particular resource; e.g. cow, syringe, lake, etc.

TypeCodeableConcept
Comments

This would generally be omitted for Person resources.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
65. Group.name
Definition

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

Control0..1
Typestring
Must Supporttrue
Requirements

Used to identify the group in human communication.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. Group.quantity
Definition

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

Control0..1
TypeunsignedInt
Must Supporttrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
67. Group.managingEntity
Definition

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

Control1..1
TypeReference(ATROrganization)
Must Supporttrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. Group.characteristic
Definition

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

Control0..*
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.

69. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
70. Group.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
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.

InvariantsDefined on this element
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())
71. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
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.

InvariantsDefined on this element
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.code
Definition

A code that identifies the kind of trait being asserted.

Control1..1
BindingThe codes SHALL be taken from DaVinci Group Characteristic; other codes may be used where these codes are not suitable The set of characteristics shared by the member
TypeCodeableConcept
Must Supporttrue
Requirements

Need a formal way of identifying the characteristic being described.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
73. Group.characteristic.value[x]
Definition

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

Control1..1
Binding

Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

TypeChoice of: CodeableConcept, boolean, Quantity, Range, Reference
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
74. Group.characteristic.exclude
Definition

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

Control1..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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
75. Group.characteristic.period
Definition

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

Control0..1
TypePeriod
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
76. Group.member
Definition

Identifies the resource instances that are members of the group.

Control0..* This element is affected by the following invariants: grp-1
TypeBackboneElement
Must Supporttrue
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
77. Group.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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
78. Group.member.extension
Definition

An Extension

Control0..*
TypeExtension
InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Group.member.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
79. Group.member.extension:associatedData
SliceNameassociatedData
Definition

Specifies a resource that are associated with the member of the Group.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(AtrAnyResourceExtension) (Extension Type: Reference)
Must Supporttrue
InvariantsDefined on this element
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.member.extension:changeType
SliceNamechangeType
Definition

changeType can be new (member added), dropped (member removed), changed (member information has changed), nochange (no change in member information since group was created).

Control0..1
TypeExtension(ChangeType) (Extension Type: code)
Must Supporttrue
InvariantsDefined on this element
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())
81. Group.member.extension:coverageReference
SliceNamecoverageReference
Definition

Indicates the Coverage assocaited with the member placing them on the attribution list.

Control0..1
TypeExtension(CoverageReference) (Extension Type: Reference(ATRCoverage))
Must Supporttrue
InvariantsDefined on this element
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.member.extension:attributedProvider
SliceNameattributedProvider
Definition

Indicates the attributed provider.

Control0..1
TypeExtension(AttributedProvider) (Extension Type: Reference(ATROrganization|ATRPractitioner|ATRPractitionerRole))
Must Supporttrue
InvariantsDefined on this element
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())
83. Group.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
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.

InvariantsDefined on this element
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.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.

Control1..1
TypeReference(ATRPatient)
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
85. Group.member.period
Definition

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

Control0..1
TypePeriod
Must Supporttrue
Requirements

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

Meaning if MissingThe member is in the group at this time
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
86. Group.member.inactive
Definition

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

Control0..1
Typeboolean
Must Supporttrue
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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))