Da Vinci - Member Attribution (ATR) List
2.0.0 - STU 2.0.0 United States of America flag

This page is part of the Risk Based Contracts Member Attribution List FHIR IG (v2.0.0: STU2 Release 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: ATRGroup

Official URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-group Version: 2.0.0
Active as of 2019-09-01 Computable Name: ATRGroup

This is the Group Resource profile for the IG.

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.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from DaVinciPatientList

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..*DaVinciPatientListDavinci ATR Group
... meta
.... lastUpdated S1..1instantWhen the resource version last changed
... contractValidityPeriod S0..1PeriodIndicates 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
... attributionListStatus S1..1codeIndicates 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.

.... identifier:npi S0..*IdentifierUnique id
..... system S1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value S1..1stringThe value that is unique
.... identifier:tin S0..*IdentifierUnique id
..... system S1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4
..... value S1..1stringThe value that is unique
... member S0..*BackboneElementWho or what is in group
.... changeType S0..1codeIndicates 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

.... coverageReference S0..1Reference(Davinci ATR Coverage)Indicates the Coverage assocaited with the member placing them on the attribution list.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-coverageReference
.... attributedProvider S0..1Reference(Davinci ATR Organization | Davinci ATR Practitioner | Davinci ATR PractitionerRole)Indicates the attributed provider.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributedProvider

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Group.extension:attributionListStatus
[CanonicalType[http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributionListStatus]]
extensibleDaVinciAttributionListStatus (a valid code from DaVinci Attribution List Status Codes)
Group.member.extension:changeType
[CanonicalType[http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-changeType]]
extensibleDaVinciAtrChangeType (a valid code from DaVinci ATR Change Type Codes)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*DaVinciPatientListDavinci ATR Group
... meta Σ0..1MetaMetadata about the resource
.... lastUpdated SΣ1..1instantWhen the resource version last changed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... contractValidityPeriod S0..1PeriodIndicates 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
... attributionListStatus S1..1codeIndicates 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..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierUnique id
Slice: Unordered, Open by value:system
.... identifier:npi SΣ0..*IdentifierUnique id
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value SΣ1..1stringThe value that is unique
Example General: 123456
.... identifier:tin SΣ0..*IdentifierUnique id
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4
..... value SΣ1..1stringThe value that is unique
Example General: 123456
... active SΣ0..1booleanWhether this group's record is in active use
... type SΣ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual SΣC1..1booleanDescriptive or actual
Fixed Value: true
... name SΣ0..1stringLabel for Group
... quantity SΣ0..1unsignedIntNumber of members
... managingEntity SΣ1..1Reference(Davinci ATR Organization)Entity that is the custodian of the Group's definition
... characteristic 0..*BackboneElementInclude / Exclude group members by Trait
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1CodeableConceptKind of characteristic
Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members

.... value[x] S1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference(Any)
.... exclude 1..1booleanGroup includes or excludes
... member SC0..*BackboneElementWho or what is in group
.... associatedData S0..1Reference()ATR Any Resource Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension
.... changeType S0..1codeIndicates 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


.... coverageReference S0..1Reference(Davinci ATR Coverage)Indicates the Coverage assocaited with the member placing them on the attribution list.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-coverageReference
.... attributedProvider S0..1Reference(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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity S1..1Reference(Davinci ATR Patient)Reference to the group member
.... period S0..1PeriodPeriod member belonged to the group
.... inactive S0..1booleanIf member is no longer in group

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Group.identifier:npi.userequiredIdentifierUse
Group.identifier:tin.userequiredIdentifierUse
Group.typerequiredFixed Value: person
Group.characteristic.codeextensibleDaVinciGroupCharacteristic
Group.characteristic.value[x]example

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*DaVinciPatientListDavinci ATR Group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... intendedRecipientIdentifier S0..1IdentifierATR Intended Recipient Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-intended-recipient-identifier-extension
... contractValidityPeriod S0..1PeriodIndicates 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
... attributionListStatus S1..1codeIndicates 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..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierUnique id
Slice: Unordered, Open by value:system
.... identifier:npi SΣ0..*IdentifierUnique id
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:tin SΣ0..*IdentifierUnique id
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active SΣ0..1booleanWhether this group's record is in active use
... type SΣ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual SΣC1..1booleanDescriptive or actual
Fixed Value: true
... code Σ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name SΣ0..1stringLabel for Group
... quantity SΣ0..1unsignedIntNumber of members
... managingEntity SΣ1..1Reference(Davinci ATR Organization)Entity that is the custodian of the Group's definition
... characteristic 0..*BackboneElementInclude / Exclude group members by Trait
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1CodeableConceptKind of characteristic
Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members

.... value[x] S1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference(Any)
.... exclude 1..1booleanGroup includes or excludes
.... period 0..1PeriodPeriod over which characteristic is tested
... member SC0..*BackboneElementWho or what is in group
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... associatedData S0..1Reference()ATR Any Resource Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension
.... changeType S0..1codeIndicates 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


.... coverageReference S0..1Reference(Davinci ATR Coverage)Indicates the Coverage assocaited with the member placing them on the attribution list.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-coverageReference
.... attributedProvider S0..1Reference(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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity S1..1Reference(Davinci ATR Patient)Reference to the group member
.... period S0..1PeriodPeriod member belonged to the group
.... inactive S0..1booleanIf member is no longer in group

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Group.meta.securityextensibleAll Security Labels
Group.meta.tagexampleCommonTags
Group.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Group.identifier:npi.userequiredIdentifierUse
Group.identifier:npi.typeextensibleIdentifier Type Codes
Group.identifier:tin.userequiredIdentifierUse
Group.identifier:tin.typeextensibleIdentifier Type Codes
Group.typerequiredFixed Value: person
Group.codeexample
Group.characteristic.codeextensibleDaVinciGroupCharacteristic
Group.characteristic.value[x]example

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
grp-1errorGroupCan 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 Value: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from DaVinciPatientList

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..*DaVinciPatientListDavinci ATR Group
... meta
.... lastUpdated S1..1instantWhen the resource version last changed
... contractValidityPeriod S0..1PeriodIndicates 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
... attributionListStatus S1..1codeIndicates 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.

.... identifier:npi S0..*IdentifierUnique id
..... system S1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value S1..1stringThe value that is unique
.... identifier:tin S0..*IdentifierUnique id
..... system S1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4
..... value S1..1stringThe value that is unique
... member S0..*BackboneElementWho or what is in group
.... changeType S0..1codeIndicates 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

.... coverageReference S0..1Reference(Davinci ATR Coverage)Indicates the Coverage assocaited with the member placing them on the attribution list.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-coverageReference
.... attributedProvider S0..1Reference(Davinci ATR Organization | Davinci ATR Practitioner | Davinci ATR PractitionerRole)Indicates the attributed provider.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributedProvider

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Group.extension:attributionListStatus
[CanonicalType[http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributionListStatus]]
extensibleDaVinciAttributionListStatus (a valid code from DaVinci Attribution List Status Codes)
Group.member.extension:changeType
[CanonicalType[http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-changeType]]
extensibleDaVinciAtrChangeType (a valid code from DaVinci ATR Change Type Codes)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*DaVinciPatientListDavinci ATR Group
... meta Σ0..1MetaMetadata about the resource
.... lastUpdated SΣ1..1instantWhen the resource version last changed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... contractValidityPeriod S0..1PeriodIndicates 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
... attributionListStatus S1..1codeIndicates 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..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierUnique id
Slice: Unordered, Open by value:system
.... identifier:npi SΣ0..*IdentifierUnique id
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value SΣ1..1stringThe value that is unique
Example General: 123456
.... identifier:tin SΣ0..*IdentifierUnique id
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4
..... value SΣ1..1stringThe value that is unique
Example General: 123456
... active SΣ0..1booleanWhether this group's record is in active use
... type SΣ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual SΣC1..1booleanDescriptive or actual
Fixed Value: true
... name SΣ0..1stringLabel for Group
... quantity SΣ0..1unsignedIntNumber of members
... managingEntity SΣ1..1Reference(Davinci ATR Organization)Entity that is the custodian of the Group's definition
... characteristic 0..*BackboneElementInclude / Exclude group members by Trait
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1CodeableConceptKind of characteristic
Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members

.... value[x] S1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference(Any)
.... exclude 1..1booleanGroup includes or excludes
... member SC0..*BackboneElementWho or what is in group
.... associatedData S0..1Reference()ATR Any Resource Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension
.... changeType S0..1codeIndicates 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


.... coverageReference S0..1Reference(Davinci ATR Coverage)Indicates the Coverage assocaited with the member placing them on the attribution list.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-coverageReference
.... attributedProvider S0..1Reference(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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity S1..1Reference(Davinci ATR Patient)Reference to the group member
.... period S0..1PeriodPeriod member belonged to the group
.... inactive S0..1booleanIf member is no longer in group

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Group.identifier:npi.userequiredIdentifierUse
Group.identifier:tin.userequiredIdentifierUse
Group.typerequiredFixed Value: person
Group.characteristic.codeextensibleDaVinciGroupCharacteristic
Group.characteristic.value[x]example

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*DaVinciPatientListDavinci ATR Group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... intendedRecipientIdentifier S0..1IdentifierATR Intended Recipient Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-intended-recipient-identifier-extension
... contractValidityPeriod S0..1PeriodIndicates 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
... attributionListStatus S1..1codeIndicates 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..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierUnique id
Slice: Unordered, Open by value:system
.... identifier:npi SΣ0..*IdentifierUnique id
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:tin SΣ0..*IdentifierUnique id
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active SΣ0..1booleanWhether this group's record is in active use
... type SΣ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual SΣC1..1booleanDescriptive or actual
Fixed Value: true
... code Σ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name SΣ0..1stringLabel for Group
... quantity SΣ0..1unsignedIntNumber of members
... managingEntity SΣ1..1Reference(Davinci ATR Organization)Entity that is the custodian of the Group's definition
... characteristic 0..*BackboneElementInclude / Exclude group members by Trait
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1CodeableConceptKind of characteristic
Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members

.... value[x] S1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference(Any)
.... exclude 1..1booleanGroup includes or excludes
.... period 0..1PeriodPeriod over which characteristic is tested
... member SC0..*BackboneElementWho or what is in group
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... associatedData S0..1Reference()ATR Any Resource Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension
.... changeType S0..1codeIndicates 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


.... coverageReference S0..1Reference(Davinci ATR Coverage)Indicates the Coverage assocaited with the member placing them on the attribution list.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-coverageReference
.... attributedProvider S0..1Reference(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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity S1..1Reference(Davinci ATR Patient)Reference to the group member
.... period S0..1PeriodPeriod member belonged to the group
.... inactive S0..1booleanIf member is no longer in group

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Group.meta.securityextensibleAll Security Labels
Group.meta.tagexampleCommonTags
Group.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Group.identifier:npi.userequiredIdentifierUse
Group.identifier:npi.typeextensibleIdentifier Type Codes
Group.identifier:tin.userequiredIdentifierUse
Group.identifier:tin.typeextensibleIdentifier Type Codes
Group.typerequiredFixed Value: person
Group.codeexample
Group.characteristic.codeextensibleDaVinciGroupCharacteristic
Group.characteristic.value[x]example

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
grp-1errorGroupCan 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 Value: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron