Introduction

This profile represents an instance of Member Attribution List. The resource instance contain information related to members who are attributed to a specific individual provider or a provider organization. The instance may also contains information about the contract, settlement entity details. In addition, NPI and TIN of the consumer (provider) organization may be contained within the instance. Attribution information such as the attributed period, attributed provider is also contained within the group resource. Members may be added or removed from the member attribution list. Group.member has a cardinality of 0..* because Groups may have zero members when they are initially created and members get added at a later point in time. The Group.member.inactive flag is used to indicate that the patient is no longer part of the Member Attribution List.

Implementation Requirements

Implementers are advised to read Data Model Requirements to implement the Group profile and create a Member Attribution List.

APIs : Retrieval of Group Resource Instance:

The Group instance is retrieved using search parameters outlined in the Group discovery APIs.

The retrieved Group resource instance which represents the Member Attribution List has member and other related resource references. In order to retrieve the complete Member Attribution List information including member, coverage, attributed provider information a Bulk API request is initiated on the retrieved Group resource.

Handling Large Groups

Groups which have large number of members (for e.g > 100,000) end up consuming a large number of resources on server, client and the network to retrieve the Group either using search mechanisms or read mechanisms. In order to limit the amount of data being returned by the server the following requirements are being levied.

* All Group search operations or read operations should use the _summary=true parameter. This parameter will only return teh summary of the Group resource and does not include any members. This makes the operation light weight for clients and severs. 

* Once the Group is received, the client can perform the davinci-data-export operation on the Group resource which will create a NDJSON file for the Group itself. In this case the NDJSON file will only contain a single line with a large number of data based on the number of members present in the Group.

* NOTE: There is discussion on creating a new operation to page the Group resource based on the number of data elements. When this is made available, the IG will be revised to use the method for Group searches and reads without the _summary parameter. 

Using Sub Groups

A Group can contain other groups. This capability may be used by use cases where multiple characteristics have to be grouped into a composite group. For e.g if you want to create a group of patients attributed to an Organization (Say Org-AttributionList Group), which consists of a group of patients attributed to provider A (ProviderA-AttributionList) and Provider B (ProviderB-AttributionList). In this case the Org-AttributionList group may contain the sub-groups namely ProviderA-AttributionList and ProviderB-AttributionList. The existing DaVinci use cases do not require this level of complexity and hence it is not explicitly identifies as being required for DaVinci use cases.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
Group	C	0..*	DaVinciPatientList	Davinci ATR Group dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management grp-1: Can only have members if group is "actual"
meta	Σ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
lastUpdated	SΣ	1..1	instant	When the resource version last changed ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:intendedRecipientIdentifier	S	0..1	Identifier	ATR Intended Recipient Extension URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-intended-recipient-identifier-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:contractValidityPeriod	S	0..1	Period	Indicates the validity period for Contract which is the basis for the Member Attribution List. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-contractValidityPeriod ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:attributionListStatus	S	1..1	code	Indicates the status of the attribution list URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributionListStatus Binding: DaVinci Attribution List Status (extensible): The Da Vinci Attribution List Status is a starter set of codes used to indicate the status of the attribution list. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier	SΣ	0..*	Identifier	Unique id Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
identifier:npi	SΣ	0..*	Identifier	Unique id ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/sid/us-npi
value	SΣ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:tin	SΣ	0..*	Identifier	Unique id ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: urn:oid:2.16.840.1.113883.4.4
value	SΣ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
active	SΣ	0..1	boolean	Whether this group's record is in active use ele-1: All FHIR elements must have a @value or children
type	SΣ	1..1	code	person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. ele-1: All FHIR elements must have a @value or children Fixed Value: person
actual	SΣC	1..1	boolean	Descriptive or actual ele-1: All FHIR elements must have a @value or children Fixed Value: true
name	SΣ	0..1	string	Label for Group ele-1: All FHIR elements must have a @value or children
quantity	SΣ	0..1	unsignedInt	Number of members ele-1: All FHIR elements must have a @value or children
managingEntity	SΣ	1..1	Reference(Davinci ATR Organization)	Entity that is the custodian of the Group's definition ele-1: All FHIR elements must have a @value or children
characteristic		0..*	BackboneElement	Include / Exclude group members by Trait ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
code	S	1..1	CodeableConcept	Kind of characteristic Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members ele-1: All FHIR elements must have a @value or children
value[x]	S	1..1		Value held by characteristic Binding Description (No ValueSet): (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. ele-1: All FHIR elements must have a @value or children
valueCodeableConcept			CodeableConcept
valueBoolean			boolean
valueQuantity			Quantity
valueRange			Range
valueReference			Reference(Any)
exclude		1..1	boolean	Group includes or excludes ele-1: All FHIR elements must have a @value or children
member	SC	0..*	BackboneElement	Who or what is in group ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:associatedData	S	0..1	Reference()	ATR Any Resource Extension URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:changeType	S	0..1	code	Indicates whether a member was added, removed or changed when the Group was created/updated. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-changeType Binding: DaVinci ATR Change Types (extensible): The Da Vinci ATR Change Type Value Set is a 'starter set' of codes for identifying the detailed changes associated with Member Attribution Lists ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:coverageReference	S	0..1	Reference(US Core Coverage Profile(7.0.0) | DaVinci ATR Coverage 3.1)	Indicates the Coverage assocaited with the member placing them on the attribution list. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-coverageReference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:attributedProvider	S	0..1	Reference(Davinci ATR Organization | Davinci ATR Practitioner | Davinci ATR PractitionerRole)	Indicates the attributed provider. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributedProvider ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
entity	S	1..1	Reference(Davinci ATR Patient)	Reference to the group member ele-1: All FHIR elements must have a @value or children
period	S	0..1	Period	Period member belonged to the group ele-1: All FHIR elements must have a @value or children
inactive	S	0..1	boolean	If member is no longer in group ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Group.identifier:npi.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Group.identifier:tin.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Group.type	required	Fixed Value: person http://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard
Group.characteristic.code	extensible	DaVinciGroupCharacteristic http://hl7.org/fhir/us/davinci-atr/ValueSet/davinci-group-characteristic from this IG
Group.characteristic.value[x]	example

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Group	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Group	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	error	Group	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	error	Group	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Group	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
grp-1	error	Group	Can only have members if group is "actual" : member.empty() or (actual = true)

This structure is derived from DaVinciPatientList

Name	Flags	Card.	Type	Description & Constraints
Group		0..*	DaVinciPatientList	Davinci ATR Group
meta
lastUpdated	S	1..1	instant	When the resource version last changed
Slices for extension				Content/Rules for all slices
extension:contractValidityPeriod	S	0..1	Period	Indicates the validity period for Contract which is the basis for the Member Attribution List. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-contractValidityPeriod
extension:attributionListStatus	S	1..1	code	Indicates the status of the attribution list URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributionListStatus Binding: DaVinci Attribution List Status (extensible): The Da Vinci Attribution List Status is a starter set of codes used to indicate the status of the attribution list.
Slices for identifier	S	0..*	Identifier	Unique id Slice: Unordered, Open by value:system
identifier:npi	S	0..*	Identifier	Unique id
system	S	1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value	S	1..1	string	The value that is unique
identifier:tin	S	0..*	Identifier	Unique id
system	S	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4
value	S	1..1	string	The value that is unique
member	S	0..*	BackboneElement	Who or what is in group
Slices for extension				Content/Rules for all slices
extension:changeType	S	0..1	code	Indicates whether a member was added, removed or changed when the Group was created/updated. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-changeType Binding: DaVinci ATR Change Types (extensible): The Da Vinci ATR Change Type Value Set is a 'starter set' of codes for identifying the detailed changes associated with Member Attribution Lists
extension:coverageReference	S	0..1	Reference(US Core Coverage Profile(7.0.0) | DaVinci ATR Coverage 3.1)	Indicates the Coverage assocaited with the member placing them on the attribution list. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-coverageReference
extension:attributedProvider	S	0..1	Reference(Davinci ATR Organization | Davinci ATR Practitioner | Davinci ATR PractitionerRole)	Indicates the attributed provider. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributedProvider
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Group.extension:attributionListStatus [CanonicalType[http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributionListStatus]]	extensible	DaVinciAttributionListStatus (a valid code from DaVinci Attribution List Status Codes) http://hl7.org/fhir/us/davinci-atr/ValueSet/atr-attribution-list-status from this IG
Group.member.extension:changeType [CanonicalType[http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-changeType]]	extensible	DaVinciAtrChangeType (a valid code from DaVinci ATR Change Type Codes) http://hl7.org/fhir/us/davinci-atr/ValueSet/atr-changetype from this IG

Name	Flags	Card.	Type	Description & Constraints
Group	C	0..*	DaVinciPatientList	Davinci ATR Group grp-1: Can only have members if group is "actual"
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	SΣ	1..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:intendedRecipientIdentifier	S	0..1	Identifier	ATR Intended Recipient Extension URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-intended-recipient-identifier-extension
extension:contractValidityPeriod	S	0..1	Period	Indicates the validity period for Contract which is the basis for the Member Attribution List. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-contractValidityPeriod
extension:attributionListStatus	S	1..1	code	Indicates the status of the attribution list URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributionListStatus Binding: DaVinci Attribution List Status (extensible): The Da Vinci Attribution List Status is a starter set of codes used to indicate the status of the attribution list.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	Unique id Slice: Unordered, Open by value:system
identifier:npi	SΣ	0..*	Identifier	Unique id
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:tin	SΣ	0..*	Identifier	Unique id
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	SΣ	0..1	boolean	Whether this group's record is in active use
type	SΣ	1..1	code	person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person
actual	SΣC	1..1	boolean	Descriptive or actual Fixed Value: true
code	Σ	0..1	CodeableConcept	Kind of Group members Binding Description (No ValueSet): (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
name	SΣ	0..1	string	Label for Group
quantity	SΣ	0..1	unsignedInt	Number of members
managingEntity	SΣ	1..1	Reference(Davinci ATR Organization)	Entity that is the custodian of the Group's definition
characteristic		0..*	BackboneElement	Include / Exclude group members by Trait
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	S	1..1	CodeableConcept	Kind of characteristic Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members
value[x]	S	1..1		Value held by characteristic Binding Description (No ValueSet): (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
valueCodeableConcept			CodeableConcept
valueBoolean			boolean
valueQuantity			Quantity
valueRange			Range
valueReference			Reference(Any)
exclude		1..1	boolean	Group includes or excludes
period		0..1	Period	Period over which characteristic is tested
member	SC	0..*	BackboneElement	Who or what is in group
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:associatedData	S	0..1	Reference()	ATR Any Resource Extension URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension
extension:changeType	S	0..1	code	Indicates whether a member was added, removed or changed when the Group was created/updated. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-changeType Binding: DaVinci ATR Change Types (extensible): The Da Vinci ATR Change Type Value Set is a 'starter set' of codes for identifying the detailed changes associated with Member Attribution Lists
extension:coverageReference	S	0..1	Reference(US Core Coverage Profile(7.0.0) | DaVinci ATR Coverage 3.1)	Indicates the Coverage assocaited with the member placing them on the attribution list. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-coverageReference
extension:attributedProvider	S	0..1	Reference(Davinci ATR Organization | Davinci ATR Practitioner | Davinci ATR PractitionerRole)	Indicates the attributed provider. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributedProvider
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
entity	S	1..1	Reference(Davinci ATR Patient)	Reference to the group member
period	S	0..1	Period	Period member belonged to the group
inactive	S	0..1	boolean	If member is no longer in group
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Group.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Group.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Group.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Group.identifier:npi.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Group.identifier:npi.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Group.identifier:tin.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Group.identifier:tin.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Group.type	required	Fixed Value: person http://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard
Group.code	example
Group.characteristic.code	extensible	DaVinciGroupCharacteristic http://hl7.org/fhir/us/davinci-atr/ValueSet/davinci-group-characteristic from this IG
Group.characteristic.value[x]	example

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Group	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Group	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	error	Group	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	error	Group	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Group	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
grp-1	error	Group	Can only have members if group is "actual" : member.empty() or (actual = true)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Group	C	0..*	DaVinciPatientList	Davinci ATR Group dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management grp-1: Can only have members if group is "actual"
meta	Σ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
lastUpdated	SΣ	1..1	instant	When the resource version last changed ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:intendedRecipientIdentifier	S	0..1	Identifier	ATR Intended Recipient Extension URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-intended-recipient-identifier-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:contractValidityPeriod	S	0..1	Period	Indicates the validity period for Contract which is the basis for the Member Attribution List. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-contractValidityPeriod ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:attributionListStatus	S	1..1	code	Indicates the status of the attribution list URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributionListStatus Binding: DaVinci Attribution List Status (extensible): The Da Vinci Attribution List Status is a starter set of codes used to indicate the status of the attribution list. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier	SΣ	0..*	Identifier	Unique id Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
identifier:npi	SΣ	0..*	Identifier	Unique id ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/sid/us-npi
value	SΣ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:tin	SΣ	0..*	Identifier	Unique id ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: urn:oid:2.16.840.1.113883.4.4
value	SΣ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
active	SΣ	0..1	boolean	Whether this group's record is in active use ele-1: All FHIR elements must have a @value or children
type	SΣ	1..1	code	person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. ele-1: All FHIR elements must have a @value or children Fixed Value: person
actual	SΣC	1..1	boolean	Descriptive or actual ele-1: All FHIR elements must have a @value or children Fixed Value: true
name	SΣ	0..1	string	Label for Group ele-1: All FHIR elements must have a @value or children
quantity	SΣ	0..1	unsignedInt	Number of members ele-1: All FHIR elements must have a @value or children
managingEntity	SΣ	1..1	Reference(Davinci ATR Organization)	Entity that is the custodian of the Group's definition ele-1: All FHIR elements must have a @value or children
characteristic		0..*	BackboneElement	Include / Exclude group members by Trait ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
code	S	1..1	CodeableConcept	Kind of characteristic Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members ele-1: All FHIR elements must have a @value or children
value[x]	S	1..1		Value held by characteristic Binding Description (No ValueSet): (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. ele-1: All FHIR elements must have a @value or children
valueCodeableConcept			CodeableConcept
valueBoolean			boolean
valueQuantity			Quantity
valueRange			Range
valueReference			Reference(Any)
exclude		1..1	boolean	Group includes or excludes ele-1: All FHIR elements must have a @value or children
member	SC	0..*	BackboneElement	Who or what is in group ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:associatedData	S	0..1	Reference()	ATR Any Resource Extension URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:changeType	S	0..1	code	Indicates whether a member was added, removed or changed when the Group was created/updated. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-changeType Binding: DaVinci ATR Change Types (extensible): The Da Vinci ATR Change Type Value Set is a 'starter set' of codes for identifying the detailed changes associated with Member Attribution Lists ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:coverageReference	S	0..1	Reference(US Core Coverage Profile(7.0.0) | DaVinci ATR Coverage 3.1)	Indicates the Coverage assocaited with the member placing them on the attribution list. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-coverageReference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:attributedProvider	S	0..1	Reference(Davinci ATR Organization | Davinci ATR Practitioner | Davinci ATR PractitionerRole)	Indicates the attributed provider. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributedProvider ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
entity	S	1..1	Reference(Davinci ATR Patient)	Reference to the group member ele-1: All FHIR elements must have a @value or children
period	S	0..1	Period	Period member belonged to the group ele-1: All FHIR elements must have a @value or children
inactive	S	0..1	boolean	If member is no longer in group ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Group.identifier:npi.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Group.identifier:tin.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Group.type	required	Fixed Value: person http://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard
Group.characteristic.code	extensible	DaVinciGroupCharacteristic http://hl7.org/fhir/us/davinci-atr/ValueSet/davinci-group-characteristic from this IG
Group.characteristic.value[x]	example

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Group	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Group	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	error	Group	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	error	Group	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Group	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
grp-1	error	Group	Can only have members if group is "actual" : member.empty() or (actual = true)

Differential View

This structure is derived from DaVinciPatientList

Name	Flags	Card.	Type	Description & Constraints
Group		0..*	DaVinciPatientList	Davinci ATR Group
meta
lastUpdated	S	1..1	instant	When the resource version last changed
Slices for extension				Content/Rules for all slices
extension:contractValidityPeriod	S	0..1	Period	Indicates the validity period for Contract which is the basis for the Member Attribution List. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-contractValidityPeriod
extension:attributionListStatus	S	1..1	code	Indicates the status of the attribution list URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributionListStatus Binding: DaVinci Attribution List Status (extensible): The Da Vinci Attribution List Status is a starter set of codes used to indicate the status of the attribution list.
Slices for identifier	S	0..*	Identifier	Unique id Slice: Unordered, Open by value:system
identifier:npi	S	0..*	Identifier	Unique id
system	S	1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value	S	1..1	string	The value that is unique
identifier:tin	S	0..*	Identifier	Unique id
system	S	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4
value	S	1..1	string	The value that is unique
member	S	0..*	BackboneElement	Who or what is in group
Slices for extension				Content/Rules for all slices
extension:changeType	S	0..1	code	Indicates whether a member was added, removed or changed when the Group was created/updated. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-changeType Binding: DaVinci ATR Change Types (extensible): The Da Vinci ATR Change Type Value Set is a 'starter set' of codes for identifying the detailed changes associated with Member Attribution Lists
extension:coverageReference	S	0..1	Reference(US Core Coverage Profile(7.0.0) | DaVinci ATR Coverage 3.1)	Indicates the Coverage assocaited with the member placing them on the attribution list. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-coverageReference
extension:attributedProvider	S	0..1	Reference(Davinci ATR Organization | Davinci ATR Practitioner | Davinci ATR PractitionerRole)	Indicates the attributed provider. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributedProvider
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Group.extension:attributionListStatus [CanonicalType[http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributionListStatus]]	extensible	DaVinciAttributionListStatus (a valid code from DaVinci Attribution List Status Codes) http://hl7.org/fhir/us/davinci-atr/ValueSet/atr-attribution-list-status from this IG
Group.member.extension:changeType [CanonicalType[http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-changeType]]	extensible	DaVinciAtrChangeType (a valid code from DaVinci ATR Change Type Codes) http://hl7.org/fhir/us/davinci-atr/ValueSet/atr-changetype from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Group	C	0..*	DaVinciPatientList	Davinci ATR Group grp-1: Can only have members if group is "actual"
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	SΣ	1..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:intendedRecipientIdentifier	S	0..1	Identifier	ATR Intended Recipient Extension URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-intended-recipient-identifier-extension
extension:contractValidityPeriod	S	0..1	Period	Indicates the validity period for Contract which is the basis for the Member Attribution List. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-contractValidityPeriod
extension:attributionListStatus	S	1..1	code	Indicates the status of the attribution list URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributionListStatus Binding: DaVinci Attribution List Status (extensible): The Da Vinci Attribution List Status is a starter set of codes used to indicate the status of the attribution list.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	0..*	Identifier	Unique id Slice: Unordered, Open by value:system
identifier:npi	SΣ	0..*	Identifier	Unique id
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:tin	SΣ	0..*	Identifier	Unique id
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	SΣ	0..1	boolean	Whether this group's record is in active use
type	SΣ	1..1	code	person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person
actual	SΣC	1..1	boolean	Descriptive or actual Fixed Value: true
code	Σ	0..1	CodeableConcept	Kind of Group members Binding Description (No ValueSet): (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
name	SΣ	0..1	string	Label for Group
quantity	SΣ	0..1	unsignedInt	Number of members
managingEntity	SΣ	1..1	Reference(Davinci ATR Organization)	Entity that is the custodian of the Group's definition
characteristic		0..*	BackboneElement	Include / Exclude group members by Trait
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	S	1..1	CodeableConcept	Kind of characteristic Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members
value[x]	S	1..1		Value held by characteristic Binding Description (No ValueSet): (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
valueCodeableConcept			CodeableConcept
valueBoolean			boolean
valueQuantity			Quantity
valueRange			Range
valueReference			Reference(Any)
exclude		1..1	boolean	Group includes or excludes
period		0..1	Period	Period over which characteristic is tested
member	SC	0..*	BackboneElement	Who or what is in group
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:associatedData	S	0..1	Reference()	ATR Any Resource Extension URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension
extension:changeType	S	0..1	code	Indicates whether a member was added, removed or changed when the Group was created/updated. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-changeType Binding: DaVinci ATR Change Types (extensible): The Da Vinci ATR Change Type Value Set is a 'starter set' of codes for identifying the detailed changes associated with Member Attribution Lists
extension:coverageReference	S	0..1	Reference(US Core Coverage Profile(7.0.0) | DaVinci ATR Coverage 3.1)	Indicates the Coverage assocaited with the member placing them on the attribution list. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-coverageReference
extension:attributedProvider	S	0..1	Reference(Davinci ATR Organization | Davinci ATR Practitioner | Davinci ATR PractitionerRole)	Indicates the attributed provider. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributedProvider
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
entity	S	1..1	Reference(Davinci ATR Patient)	Reference to the group member
period	S	0..1	Period	Period member belonged to the group
inactive	S	0..1	boolean	If member is no longer in group
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Group.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Group.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Group.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Group.identifier:npi.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Group.identifier:npi.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Group.identifier:tin.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Group.identifier:tin.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Group.type	required	Fixed Value: person http://hl7.org/fhir/ValueSet/group-type|4.0.1 from the FHIR Standard
Group.code	example
Group.characteristic.code	extensible	DaVinciGroupCharacteristic http://hl7.org/fhir/us/davinci-atr/ValueSet/davinci-group-characteristic from this IG
Group.characteristic.value[x]	example

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Group	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Group	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	error	Group	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	error	Group	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Group	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
grp-1	error	Group	Can only have members if group is "actual" : member.empty() or (actual = true)

This structure is derived from DaVinciPatientList

Summary

Mandatory: 1 element(5 nested mandatory elements)
Must-Support: 14 elements
Fixed: 2 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-contractValidityPeriod
• http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributionListStatus
• http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-changeType
• http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-coverageReference
• http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributedProvider

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Group.identifier

Maturity: 2