Da Vinci Payer Data Exchange
2.2.1 - STU 2.2 United States of America flag

Da Vinci Payer Data Exchange, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-epdx/ and changes regularly. See the Directory of published versions

Resource Profile: PDex Provider Group ( Experimental )

Official URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-group Version: 2.2.1
Standards status: Informative Computable Name: PDexProviderGroup
Other Identifiers: OID:2.16.840.1.113883.4.642.40.8.42.38

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

The Provider Attribution Group List. Based on the Da Vinci Attribution Group (ATRGroup) Profile. The member element represents the patients attributed to the provider for data access purposes.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group C 0..* ATRGroup Davinci ATR Group
Constraints: grp-1
Group.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Group.meta.lastUpdated This element must be supported. This element is included in summaries. 1..1 instant When the resource version last changed
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Group.Slices for extension.extension:intendedRecipientIdentifier This element must be supported. 0..1 Identifier ATR Intended Recipient Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-intended-recipient-identifier-extension
Group.Slices for extension.extension:contractValidityPeriod This element must be supported. 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
Group.Slices for extension.extension:attributionListStatus This element must be supported. 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.
Group.Slices for extension.extension:optedOut This element must be supported. 0..1 Quantity Members Opted-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-members-opted-out
Group.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Group.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Unique id
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Group.Slices for identifier.identifier:npi This element must be supported. This element is included in summaries. 0..* Identifier Unique id
Group.Slices for identifier.identifier:npi.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Group.Slices for identifier.identifier:npi.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi (no extensions allowed)
Group.Slices for identifier.identifier:npi.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Group.Slices for identifier.identifier:tin This element must be supported. This element is included in summaries. 0..* Identifier Unique id
Group.Slices for identifier.identifier:tin.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Group.Slices for identifier.identifier:tin.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4 (no extensions allowed)
Group.Slices for identifier.identifier:tin.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Group.active This element must be supported. This element is included in summaries. 0..1 boolean Whether this group's record is in active use
Group.type This element must be supported. This element is included in summaries. 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: person (no extensions allowed)
Group.actual This element must be supported. This element is included in summaries. C 1..1 boolean Descriptive or actual
Fixed Value: true (no extensions allowed)
Group.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of Group members
Binding: PDex Multi-Member Match Result Value Set (required)
Group.name This element must be supported. This element is included in summaries. 0..1 string Label for Group
Group.quantity This element must be supported. This element is included in summaries. 0..1 unsignedInt Number of members
Group.managingEntity This element must be supported. This element is included in summaries. 1..1 Reference(Davinci ATR Organization) Entity that is the custodian of the Group's definition
Group.characteristic 0..* BackboneElement Include / Exclude group members by Trait
Group.characteristic.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.characteristic.code This element must be supported. 1..1 CodeableConcept Kind of characteristic
Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMemberAttributionCS",
      "code" : "pdexprovidergroup",
      "display" : "PDex Provider Group"
    }
  ]
}
Group.characteristic.Slices for value[x] This element must be supported. 1..1 Value held by characteristic
Slice: Unordered, Closed by type:$this
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Group.characteristic.Slices for value[x].valueCodeableConcept CodeableConcept
Group.characteristic.Slices for value[x].valueBoolean boolean
Group.characteristic.Slices for value[x].valueQuantity Quantity
Group.characteristic.Slices for value[x].valueRange Range
Group.characteristic.Slices for value[x].valueReference Reference(Any)
Group.characteristic.Slices for value[x].value[x]:valueReference This element must be supported. 0..1 Reference() Value held by characteristic
Group.characteristic.exclude 1..1 boolean Group includes or excludes
Required Pattern: false (extensions allowed)
Group.characteristic.period This element must be supported. 0..1 Period Period over which characteristic is tested
Group.member This element must be supported. C 0..* BackboneElement Who or what is in group
Group.member.Slices for extension Content/Rules for all slices
Group.member.Slices for extension.extension:associatedData This element must be supported. 0..1 Reference() ATR Any Resource Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension
Group.member.Slices for extension.extension:changeType This element must be supported. 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
Group.member.Slices for extension.extension:coverageReference This element must be supported. 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
Group.member.Slices for extension.extension:attributedProvider This element must be supported. 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
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.member.entity This element must be supported. 1..1 Reference(Davinci ATR Patient) Reference to the group member
Group.member.period This element must be supported. 0..1 Period Period member belonged to the group
Group.member.inactive This element must be supported. 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.identifier:npi.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Group.identifier:tin.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG
Group.characteristic.​code Base extensible DaVinci Group Characteristic 📦2.1.0 Da Vinci - Member Attribution v2.1
Group.characteristic.​value[x] Base example Not State Unknown
Group.characteristic.​value[x]:valueCodeableConcept Base example Not State Unknown
Group.characteristic.​value[x]:valueQuantity Base example Not State Unknown
Group.characteristic.​value[x]:valueRange Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression

This structure is derived from ATRGroup

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group 0..* ATRGroup Davinci ATR Group
Group.Slices for extension Content/Rules for all slices
Group.Slices for extension.extension:optedOut This element must be supported. 0..1 Quantity Members Opted-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-members-opted-out
Group.code This element must be supported. 1..1 CodeableConcept Kind of Group members
Binding: PDex Multi-Member Match Result Value Set (required)
Group.characteristic
Group.characteristic.code 1..1 CodeableConcept Kind of characteristic
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMemberAttributionCS",
      "code" : "pdexprovidergroup",
      "display" : "PDex Provider Group"
    }
  ]
}
Group.characteristic.Slices for value[x] 1..1 CodeableConcept, boolean, Quantity, Range, Reference() Value held by characteristic
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Group.characteristic.Slices for value[x].value[x]:valueReference This element must be supported. 0..1 Reference() Value held by characteristic
Group.characteristic.exclude 1..1 boolean Group includes or excludes
Required Pattern: false (extensions allowed)
Group.characteristic.period This element must be supported. 0..1 Period Period over which characteristic is tested

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Group.code Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group C 0..* ATRGroup Davinci ATR Group
Constraints: grp-1
Group.id This element is included in summaries. 0..1 id Logical id of this artifact
Group.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Group.meta.id 0..1 string Unique id for inter-element referencing
Group.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Group.meta.lastUpdated This element must be supported. This element is included in summaries. 1..1 instant When the resource version last changed
Group.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Group.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Group.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Group.meta.tag This element is included in summaries. 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".
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Group.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Group.contained 0..* Resource Contained, inline Resources
Group.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Group.Slices for extension.extension:intendedRecipientIdentifier This element must be supported. 0..1 Identifier ATR Intended Recipient Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-intended-recipient-identifier-extension
Group.Slices for extension.extension:contractValidityPeriod This element must be supported. 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
Group.Slices for extension.extension:attributionListStatus This element must be supported. 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.
Group.Slices for extension.extension:optedOut This element must be supported. 0..1 Quantity Members Opted-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-members-opted-out
Group.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Group.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Unique id
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Group.Slices for identifier.identifier:npi This element must be supported. This element is included in summaries. 0..* Identifier Unique id
Group.Slices for identifier.identifier:npi.id 0..1 string Unique id for inter-element referencing
Group.Slices for identifier.identifier:npi.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.Slices for identifier.identifier:npi.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Group.Slices for identifier.identifier:npi.type This element is included in summaries. 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.
Group.Slices for identifier.identifier:npi.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi (no extensions allowed)
Group.Slices for identifier.identifier:npi.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Group.Slices for identifier.identifier:npi.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Group.Slices for identifier.identifier:npi.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Group.Slices for identifier.identifier:tin This element must be supported. This element is included in summaries. 0..* Identifier Unique id
Group.Slices for identifier.identifier:tin.id 0..1 string Unique id for inter-element referencing
Group.Slices for identifier.identifier:tin.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.Slices for identifier.identifier:tin.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Group.Slices for identifier.identifier:tin.type This element is included in summaries. 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.
Group.Slices for identifier.identifier:tin.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4 (no extensions allowed)
Group.Slices for identifier.identifier:tin.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Group.Slices for identifier.identifier:tin.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Group.Slices for identifier.identifier:tin.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Group.active This element must be supported. This element is included in summaries. 0..1 boolean Whether this group's record is in active use
Group.type This element must be supported. This element is included in summaries. 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: person (no extensions allowed)
Group.actual This element must be supported. This element is included in summaries. C 1..1 boolean Descriptive or actual
Fixed Value: true (no extensions allowed)
Group.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of Group members
Binding: PDex Multi-Member Match Result Value Set (required)
Group.name This element must be supported. This element is included in summaries. 0..1 string Label for Group
Group.quantity This element must be supported. This element is included in summaries. 0..1 unsignedInt Number of members
Group.managingEntity This element must be supported. This element is included in summaries. 1..1 Reference(Davinci ATR Organization) Entity that is the custodian of the Group's definition
Group.characteristic 0..* BackboneElement Include / Exclude group members by Trait
Group.characteristic.id 0..1 string Unique id for inter-element referencing
Group.characteristic.extension 0..* Extension Additional content defined by implementations
Group.characteristic.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.characteristic.code This element must be supported. 1..1 CodeableConcept Kind of characteristic
Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMemberAttributionCS",
      "code" : "pdexprovidergroup",
      "display" : "PDex Provider Group"
    }
  ]
}
Group.characteristic.Slices for value[x] This element must be supported. 1..1 Value held by characteristic
Slice: Unordered, Closed by type:$this
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Group.characteristic.Slices for value[x].valueCodeableConcept CodeableConcept
Group.characteristic.Slices for value[x].valueBoolean boolean
Group.characteristic.Slices for value[x].valueQuantity Quantity
Group.characteristic.Slices for value[x].valueRange Range
Group.characteristic.Slices for value[x].valueReference Reference(Any)
Group.characteristic.Slices for value[x].value[x]:valueReference This element must be supported. 0..1 Reference() Value held by characteristic
Group.characteristic.exclude 1..1 boolean Group includes or excludes
Required Pattern: false (extensions allowed)
Group.characteristic.period This element must be supported. 0..1 Period Period over which characteristic is tested
Group.member This element must be supported. C 0..* BackboneElement Who or what is in group
Group.member.id 0..1 string Unique id for inter-element referencing
Group.member.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Group.member.Slices for extension.extension:associatedData This element must be supported. 0..1 Reference() ATR Any Resource Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension
Group.member.Slices for extension.extension:changeType This element must be supported. 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
Group.member.Slices for extension.extension:coverageReference This element must be supported. 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
Group.member.Slices for extension.extension:attributedProvider This element must be supported. 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
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.member.entity This element must be supported. 1..1 Reference(Davinci ATR Patient) Reference to the group member
Group.member.period This element must be supported. 0..1 Period Period member belonged to the group
Group.member.inactive This element must be supported. 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.meta.security Base extensible SecurityLabels 📦4.0.1 FHIR Std.
Group.meta.tag Base example Common Tags 📦4.0.1 FHIR Std.
Group.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Group.identifier:npi.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Group.identifier:npi.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Group.identifier:tin.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Group.identifier:tin.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG
Group.characteristic.​code Base extensible DaVinci Group Characteristic 📦2.1.0 Da Vinci - Member Attribution v2.1
Group.characteristic.​value[x] Base example Not State Unknown
Group.characteristic.​value[x]:valueCodeableConcept Base example Not State Unknown
Group.characteristic.​value[x]:valueQuantity Base example Not State Unknown
Group.characteristic.​value[x]:valueRange Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression

This structure is derived from ATRGroup

Summary

Mandatory: 1 element
Must-Support: 4 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Group.characteristic.value[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group C 0..* ATRGroup Davinci ATR Group
Constraints: grp-1
Group.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Group.meta.lastUpdated This element must be supported. This element is included in summaries. 1..1 instant When the resource version last changed
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Group.Slices for extension.extension:intendedRecipientIdentifier This element must be supported. 0..1 Identifier ATR Intended Recipient Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-intended-recipient-identifier-extension
Group.Slices for extension.extension:contractValidityPeriod This element must be supported. 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
Group.Slices for extension.extension:attributionListStatus This element must be supported. 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.
Group.Slices for extension.extension:optedOut This element must be supported. 0..1 Quantity Members Opted-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-members-opted-out
Group.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Group.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Unique id
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Group.Slices for identifier.identifier:npi This element must be supported. This element is included in summaries. 0..* Identifier Unique id
Group.Slices for identifier.identifier:npi.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Group.Slices for identifier.identifier:npi.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi (no extensions allowed)
Group.Slices for identifier.identifier:npi.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Group.Slices for identifier.identifier:tin This element must be supported. This element is included in summaries. 0..* Identifier Unique id
Group.Slices for identifier.identifier:tin.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Group.Slices for identifier.identifier:tin.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4 (no extensions allowed)
Group.Slices for identifier.identifier:tin.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Group.active This element must be supported. This element is included in summaries. 0..1 boolean Whether this group's record is in active use
Group.type This element must be supported. This element is included in summaries. 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: person (no extensions allowed)
Group.actual This element must be supported. This element is included in summaries. C 1..1 boolean Descriptive or actual
Fixed Value: true (no extensions allowed)
Group.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of Group members
Binding: PDex Multi-Member Match Result Value Set (required)
Group.name This element must be supported. This element is included in summaries. 0..1 string Label for Group
Group.quantity This element must be supported. This element is included in summaries. 0..1 unsignedInt Number of members
Group.managingEntity This element must be supported. This element is included in summaries. 1..1 Reference(Davinci ATR Organization) Entity that is the custodian of the Group's definition
Group.characteristic 0..* BackboneElement Include / Exclude group members by Trait
Group.characteristic.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.characteristic.code This element must be supported. 1..1 CodeableConcept Kind of characteristic
Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMemberAttributionCS",
      "code" : "pdexprovidergroup",
      "display" : "PDex Provider Group"
    }
  ]
}
Group.characteristic.Slices for value[x] This element must be supported. 1..1 Value held by characteristic
Slice: Unordered, Closed by type:$this
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Group.characteristic.Slices for value[x].valueCodeableConcept CodeableConcept
Group.characteristic.Slices for value[x].valueBoolean boolean
Group.characteristic.Slices for value[x].valueQuantity Quantity
Group.characteristic.Slices for value[x].valueRange Range
Group.characteristic.Slices for value[x].valueReference Reference(Any)
Group.characteristic.Slices for value[x].value[x]:valueReference This element must be supported. 0..1 Reference() Value held by characteristic
Group.characteristic.exclude 1..1 boolean Group includes or excludes
Required Pattern: false (extensions allowed)
Group.characteristic.period This element must be supported. 0..1 Period Period over which characteristic is tested
Group.member This element must be supported. C 0..* BackboneElement Who or what is in group
Group.member.Slices for extension Content/Rules for all slices
Group.member.Slices for extension.extension:associatedData This element must be supported. 0..1 Reference() ATR Any Resource Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension
Group.member.Slices for extension.extension:changeType This element must be supported. 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
Group.member.Slices for extension.extension:coverageReference This element must be supported. 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
Group.member.Slices for extension.extension:attributedProvider This element must be supported. 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
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.member.entity This element must be supported. 1..1 Reference(Davinci ATR Patient) Reference to the group member
Group.member.period This element must be supported. 0..1 Period Period member belonged to the group
Group.member.inactive This element must be supported. 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.identifier:npi.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Group.identifier:tin.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG
Group.characteristic.​code Base extensible DaVinci Group Characteristic 📦2.1.0 Da Vinci - Member Attribution v2.1
Group.characteristic.​value[x] Base example Not State Unknown
Group.characteristic.​value[x]:valueCodeableConcept Base example Not State Unknown
Group.characteristic.​value[x]:valueQuantity Base example Not State Unknown
Group.characteristic.​value[x]:valueRange Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from ATRGroup

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group 0..* ATRGroup Davinci ATR Group
Group.Slices for extension Content/Rules for all slices
Group.Slices for extension.extension:optedOut This element must be supported. 0..1 Quantity Members Opted-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-members-opted-out
Group.code This element must be supported. 1..1 CodeableConcept Kind of Group members
Binding: PDex Multi-Member Match Result Value Set (required)
Group.characteristic
Group.characteristic.code 1..1 CodeableConcept Kind of characteristic
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMemberAttributionCS",
      "code" : "pdexprovidergroup",
      "display" : "PDex Provider Group"
    }
  ]
}
Group.characteristic.Slices for value[x] 1..1 CodeableConcept, boolean, Quantity, Range, Reference() Value held by characteristic
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Group.characteristic.Slices for value[x].value[x]:valueReference This element must be supported. 0..1 Reference() Value held by characteristic
Group.characteristic.exclude 1..1 boolean Group includes or excludes
Required Pattern: false (extensions allowed)
Group.characteristic.period This element must be supported. 0..1 Period Period over which characteristic is tested

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Group.code Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Group C 0..* ATRGroup Davinci ATR Group
Constraints: grp-1
Group.id This element is included in summaries. 0..1 id Logical id of this artifact
Group.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Group.meta.id 0..1 string Unique id for inter-element referencing
Group.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Group.meta.lastUpdated This element must be supported. This element is included in summaries. 1..1 instant When the resource version last changed
Group.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Group.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Group.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Group.meta.tag This element is included in summaries. 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".
Group.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Group.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Group.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Group.contained 0..* Resource Contained, inline Resources
Group.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Group.Slices for extension.extension:intendedRecipientIdentifier This element must be supported. 0..1 Identifier ATR Intended Recipient Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-intended-recipient-identifier-extension
Group.Slices for extension.extension:contractValidityPeriod This element must be supported. 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
Group.Slices for extension.extension:attributionListStatus This element must be supported. 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.
Group.Slices for extension.extension:optedOut This element must be supported. 0..1 Quantity Members Opted-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-members-opted-out
Group.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Group.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Unique id
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Group.Slices for identifier.identifier:npi This element must be supported. This element is included in summaries. 0..* Identifier Unique id
Group.Slices for identifier.identifier:npi.id 0..1 string Unique id for inter-element referencing
Group.Slices for identifier.identifier:npi.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.Slices for identifier.identifier:npi.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Group.Slices for identifier.identifier:npi.type This element is included in summaries. 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.
Group.Slices for identifier.identifier:npi.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi (no extensions allowed)
Group.Slices for identifier.identifier:npi.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Group.Slices for identifier.identifier:npi.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Group.Slices for identifier.identifier:npi.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Group.Slices for identifier.identifier:tin This element must be supported. This element is included in summaries. 0..* Identifier Unique id
Group.Slices for identifier.identifier:tin.id 0..1 string Unique id for inter-element referencing
Group.Slices for identifier.identifier:tin.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Group.Slices for identifier.identifier:tin.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Group.Slices for identifier.identifier:tin.type This element is included in summaries. 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.
Group.Slices for identifier.identifier:tin.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4 (no extensions allowed)
Group.Slices for identifier.identifier:tin.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Group.Slices for identifier.identifier:tin.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Group.Slices for identifier.identifier:tin.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Group.active This element must be supported. This element is included in summaries. 0..1 boolean Whether this group's record is in active use
Group.type This element must be supported. This element is included in summaries. 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: person (no extensions allowed)
Group.actual This element must be supported. This element is included in summaries. C 1..1 boolean Descriptive or actual
Fixed Value: true (no extensions allowed)
Group.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of Group members
Binding: PDex Multi-Member Match Result Value Set (required)
Group.name This element must be supported. This element is included in summaries. 0..1 string Label for Group
Group.quantity This element must be supported. This element is included in summaries. 0..1 unsignedInt Number of members
Group.managingEntity This element must be supported. This element is included in summaries. 1..1 Reference(Davinci ATR Organization) Entity that is the custodian of the Group's definition
Group.characteristic 0..* BackboneElement Include / Exclude group members by Trait
Group.characteristic.id 0..1 string Unique id for inter-element referencing
Group.characteristic.extension 0..* Extension Additional content defined by implementations
Group.characteristic.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.characteristic.code This element must be supported. 1..1 CodeableConcept Kind of characteristic
Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMemberAttributionCS",
      "code" : "pdexprovidergroup",
      "display" : "PDex Provider Group"
    }
  ]
}
Group.characteristic.Slices for value[x] This element must be supported. 1..1 Value held by characteristic
Slice: Unordered, Closed by type:$this
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Group.characteristic.Slices for value[x].valueCodeableConcept CodeableConcept
Group.characteristic.Slices for value[x].valueBoolean boolean
Group.characteristic.Slices for value[x].valueQuantity Quantity
Group.characteristic.Slices for value[x].valueRange Range
Group.characteristic.Slices for value[x].valueReference Reference(Any)
Group.characteristic.Slices for value[x].value[x]:valueReference This element must be supported. 0..1 Reference() Value held by characteristic
Group.characteristic.exclude 1..1 boolean Group includes or excludes
Required Pattern: false (extensions allowed)
Group.characteristic.period This element must be supported. 0..1 Period Period over which characteristic is tested
Group.member This element must be supported. C 0..* BackboneElement Who or what is in group
Group.member.id 0..1 string Unique id for inter-element referencing
Group.member.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Group.member.Slices for extension.extension:associatedData This element must be supported. 0..1 Reference() ATR Any Resource Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension
Group.member.Slices for extension.extension:changeType This element must be supported. 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
Group.member.Slices for extension.extension:coverageReference This element must be supported. 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
Group.member.Slices for extension.extension:attributedProvider This element must be supported. 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
Group.member.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Group.member.entity This element must be supported. 1..1 Reference(Davinci ATR Patient) Reference to the group member
Group.member.period This element must be supported. 0..1 Period Period member belonged to the group
Group.member.inactive This element must be supported. 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.meta.security Base extensible SecurityLabels 📦4.0.1 FHIR Std.
Group.meta.tag Base example Common Tags 📦4.0.1 FHIR Std.
Group.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Group.identifier:npi.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Group.identifier:npi.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Group.identifier:tin.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Group.identifier:tin.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base required PDex Multi-Member Match Result Value Set 📦2.2.1 This IG
Group.characteristic.​code Base extensible DaVinci Group Characteristic 📦2.1.0 Da Vinci - Member Attribution v2.1
Group.characteristic.​value[x] Base example Not State Unknown
Group.characteristic.​value[x]:valueCodeableConcept Base example Not State Unknown
Group.characteristic.​value[x]:valueQuantity Base example Not State Unknown
Group.characteristic.​value[x]:valueRange Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression

This structure is derived from ATRGroup

Summary

Mandatory: 1 element
Must-Support: 4 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Group.characteristic.value[x]

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Mandatory Search Parameters

  1. SHALL support searching for code for a Group. §pdex-396 Group_Code Search Parameter

    GET [base]/Group?code={code}

    Example:

    GET [base]/Group?code="pdexprovidergroup"

    NOTE:

    Server should limit responses to records that requesting user or service is permitted to access. For example, Attributed Group lists for Practitioners working in a Facility where the system accessing is accessing on behalf of the facility.

Back to Artifacts