Da Vinci Payer Data Exchange
2.1.0-ballot - STU2 Ballot
Da Vinci Payer Data Exchange
2.1.0-ballot - STU2 Ballot
This page is part of the Da Vinci Payer Data Exchange (v2.1.0-ballot: STU2.1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-group | Version: 2.1.0-ballot | |||
| Standards status: Trial-use | Computable Name: PDexProviderGroup | |||
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 with the addition of extensions to track latest download for a member. Each member element in the Group record, that is processed by the export operation, should be updated with the execution date/time in lastTransmitted, list of resources (resourceTypes) in lastResources and query filters (filterQueries) in lastFilters.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ATRGroup
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Group |
0..* | ATRGroup | Davinci ATR Group | |
  Slices for extension |
Content/Rules for all slices | |||
   optedOut |
S | 0..1 | Quantity | Members Opted-out URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-members-opted-out |
  code |
S | 1..1 | CodeableConcept | Kind of Group members Binding: PDex Multi-Member Match Result Value Set (required) |
| characteristic |
||||
| code |
1..1 | CodeableConcept | Kind of characteristic Required Pattern: At least the following | |
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMemberAttributionCS | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pdexprovidergroup | |
 display |
1..1 | string | Representation defined by the system Fixed Value: PDex Provider Group | |
| Slices for value[x] |
1..1 | CodeableConcept, boolean, Quantity, Range, Reference() | Value held by characteristic Slice: Unordered, Open by type:$this | |
| value[x]:valueReference |
S | 0..1 | Reference() | Value held by characteristic |
| exclude |
1..1 | boolean | Group includes or excludes Required Pattern: false | |
| period |
S | 0..1 | Period | Period over which characteristic is tested |
| member |
||||
| Slices for extension |
Content/Rules for all slices | |||
 lastTransmitted |
S | 0..1 | dateTime | Member Last Transmission URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-transmission |
| lastResources |
S | 0..1 | string | Member Last Resource Types URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-types |
| lastFilters |
S | 0..1 | string | Member Last Resource Filters URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-typefilter |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Group.code | required | PDexMultiMemberMatchResultVShttp://hl7.org/fhir/us/davinci-pdex/ValueSet/PDexMultiMemberMatchResultVSfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group |
C | 0..* | ATRGroup | Davinci ATR Group grp-1: Can only have members if group is "actual" |
 meta |
Σ | 0..1 | Meta | Metadata about the resource |
 lastUpdated |
SΣ | 1..1 | instant | When the resource version last changed |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| intendedRecipientIdentifier |
S | 0..1 | Identifier | ATR Intended Recipient Extension URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-intended-recipient-identifier-extension |
| contractValidityPeriod |
S | 0..1 | Period | Indicates the validity period for Contract which is the basis for the Member Attribution List. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-contractValidityPeriod |
| attributionListStatus |
S | 1..1 | code | Indicates the status of the attribution list URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributionListStatus Binding: DaVinci Attribution List Status (extensible): The Da Vinci Attribution List Status is a starter set of codes used to indicate the status of the attribution list. |
| optedOut |
S | 0..1 | Quantity | Members Opted-out URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-members-opted-out |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
SΣ | 0..* | Identifier | Unique id Slice: Unordered, Open by value:system |
 identifier:npi |
SΣ | 0..* | Identifier | Unique id |
  use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi |
 value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
 identifier:tin |
SΣ | 0..* | Identifier | Unique id |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4 |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| active |
SΣ | 0..1 | boolean | Whether this group's record is in active use |
| type |
SΣ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person |
| actual |
SΣC | 1..1 | boolean | Descriptive or actual Fixed Value: true |
| code |
SΣ | 1..1 | CodeableConcept | Kind of Group members Binding: PDex Multi-Member Match Result Value Set (required) |
| name |
SΣ | 0..1 | string | Label for Group |
| quantity |
SΣ | 0..1 | unsignedInt | Number of members |
 managingEntity |
SΣ | 1..1 | Reference(Davinci ATR Organization) | Entity that is the custodian of the Group's definition |
| characteristic |
0..* | BackboneElement | Include / Exclude group members by Trait | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
S | 1..1 | CodeableConcept | Kind of characteristic Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMemberAttributionCS | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pdexprovidergroup | |
| display |
1..1 | string | Representation defined by the system Fixed Value: PDex Provider Group | |
| Slices for value[x] |
S | 1..1 | Value held by characteristic Slice: Unordered, Open by type:$this Binding Description (No ValueSet): (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | |
| valueCodeableConcept |
CodeableConcept | |||
| valueBoolean |
boolean | |||
| valueQuantity |
Quantity | |||
| valueRange |
Range | |||
| valueReference |
Reference(Any) | |||
| value[x]:valueReference |
S | 0..1 | Reference() | Value held by characteristic |
| exclude |
1..1 | boolean | Group includes or excludes Required Pattern: false | |
| period |
S | 0..1 | Period | Period over which characteristic is tested |
| member |
SC | 0..* | BackboneElement | Who or what is in group |
| Slices for extension |
Content/Rules for all slices | |||
| associatedData |
S | 0..1 | Reference() | ATR Any Resource Extension URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension |
| changeType |
S | 0..1 | code | Indicates whether a member was added, removed or changed when the Group was created/updated. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-changeType Binding: DaVinci ATR Change Types (extensible): The Da Vinci ATR Change Type Value Set is a 'starter set' of codes for identifying the detailed changes associated with Member Attribution Lists |
| coverageReference |
S | 0..1 | Reference(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 |
S | 0..1 | Reference(Davinci ATR Organization | Davinci ATR Practitioner | Davinci ATR PractitionerRole) | Indicates the attributed provider. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributedProvider |
| lastTransmitted |
S | 0..1 | dateTime | Member Last Transmission URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-transmission |
| lastResources |
S | 0..1 | string | Member Last Resource Types URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-types |
| lastFilters |
S | 0..1 | string | Member Last Resource Filters URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-typefilter |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity |
S | 1..1 | Reference(Davinci ATR Patient) | Reference to the group member |
| period |
S | 0..1 | Period | Period member belonged to the group |
| inactive |
S | 0..1 | boolean | If member is no longer in group |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Group.identifier:npi.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Group.identifier:tin.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Group.type | required | Fixed Value: personhttp://hl7.org/fhir/ValueSet/group-type|4.0.1from the FHIR Standard | |
| Group.code | required | PDexMultiMemberMatchResultVShttp://hl7.org/fhir/us/davinci-pdex/ValueSet/PDexMultiMemberMatchResultVSfrom this IG | |
| Group.characteristic.code | extensible | Pattern: pdexprovidergroup("PDex Provider Group")http://hl7.org/fhir/us/davinci-atr/ValueSet/davinci-group-characteristic | |
| Group.characteristic.value[x] | example |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Group |
C | 0..* | ATRGroup | Davinci ATR Group grp-1: Can only have members if group is "actual" | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
SΣ | 1..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| intendedRecipientIdentifier |
S | 0..1 | Identifier | ATR Intended Recipient Extension URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-intended-recipient-identifier-extension | ||||
| contractValidityPeriod |
S | 0..1 | Period | Indicates the validity period for Contract which is the basis for the Member Attribution List. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-contractValidityPeriod | ||||
| attributionListStatus |
S | 1..1 | code | Indicates the status of the attribution list URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributionListStatus Binding: DaVinci Attribution List Status (extensible): The Da Vinci Attribution List Status is a starter set of codes used to indicate the status of the attribution list. | ||||
| optedOut |
S | 0..1 | Quantity | Members Opted-out URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-members-opted-out | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣ | 0..* | Identifier | Unique id Slice: Unordered, Open by value:system | ||||
| identifier:npi |
SΣ | 0..* | Identifier | Unique id | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:tin |
SΣ | 0..* | Identifier | Unique id | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4 | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active |
SΣ | 0..1 | boolean | Whether this group's record is in active use | ||||
| type |
SΣ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person | ||||
| actual |
SΣC | 1..1 | boolean | Descriptive or actual Fixed Value: true | ||||
| code |
SΣ | 1..1 | CodeableConcept | Kind of Group members Binding: PDex Multi-Member Match Result Value Set (required) | ||||
| name |
SΣ | 0..1 | string | Label for Group | ||||
| quantity |
SΣ | 0..1 | unsignedInt | Number of members | ||||
| managingEntity |
SΣ | 1..1 | Reference(Davinci ATR Organization) | Entity that is the custodian of the Group's definition | ||||
| characteristic |
0..* | BackboneElement | Include / Exclude group members by Trait | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
S | 1..1 | CodeableConcept | Kind of characteristic Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMemberAttributionCS | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pdexprovidergroup | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: PDex Provider Group | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| Slices for value[x] |
S | 1..1 | Value held by characteristic Slice: Unordered, Open by type:$this Binding Description (No ValueSet): (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | |||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueBoolean |
boolean | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueReference |
Reference(Any) | |||||||
| value[x]:valueReference |
S | 0..1 | Reference() | Value held by characteristic | ||||
| exclude |
1..1 | boolean | Group includes or excludes Required Pattern: false | |||||
| period |
S | 0..1 | Period | Period over which characteristic is tested | ||||
| member |
SC | 0..* | BackboneElement | Who or what is in group | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| associatedData |
S | 0..1 | Reference() | ATR Any Resource Extension URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension | ||||
| changeType |
S | 0..1 | code | Indicates whether a member was added, removed or changed when the Group was created/updated. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-changeType Binding: DaVinci ATR Change Types (extensible): The Da Vinci ATR Change Type Value Set is a 'starter set' of codes for identifying the detailed changes associated with Member Attribution Lists | ||||
| coverageReference |
S | 0..1 | Reference(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 |
S | 0..1 | Reference(Davinci ATR Organization | Davinci ATR Practitioner | Davinci ATR PractitionerRole) | Indicates the attributed provider. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributedProvider | ||||
| lastTransmitted |
S | 0..1 | dateTime | Member Last Transmission URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-transmission | ||||
| lastResources |
S | 0..1 | string | Member Last Resource Types URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-types | ||||
| lastFilters |
S | 0..1 | string | Member Last Resource Filters URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-typefilter | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| entity |
S | 1..1 | Reference(Davinci ATR Patient) | Reference to the group member | ||||
| period |
S | 0..1 | Period | Period member belonged to the group | ||||
| inactive |
S | 0..1 | boolean | If member is no longer in group | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Group.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Group.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Group.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Group.identifier:npi.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Group.identifier:npi.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Group.identifier:tin.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Group.identifier:tin.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Group.type | required | Fixed Value: personhttp://hl7.org/fhir/ValueSet/group-type|4.0.1from the FHIR Standard | ||||
| Group.code | required | PDexMultiMemberMatchResultVShttp://hl7.org/fhir/us/davinci-pdex/ValueSet/PDexMultiMemberMatchResultVSfrom this IG | ||||
| Group.characteristic.code | extensible | Pattern: pdexprovidergroup("PDex Provider Group")http://hl7.org/fhir/us/davinci-atr/ValueSet/davinci-group-characteristic | ||||
| Group.characteristic.value[x] | example |
This structure is derived from ATRGroup
Summary
Mandatory: 1 element
Must-Support: 7 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ATRGroup
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group |
0..* | ATRGroup | Davinci ATR Group | |
| Slices for extension |
Content/Rules for all slices | |||
| optedOut |
S | 0..1 | Quantity | Members Opted-out URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-members-opted-out |
| code |
S | 1..1 | CodeableConcept | Kind of Group members Binding: PDex Multi-Member Match Result Value Set (required) |
| characteristic |
||||
| code |
1..1 | CodeableConcept | Kind of characteristic Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMemberAttributionCS | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pdexprovidergroup | |
| display |
1..1 | string | Representation defined by the system Fixed Value: PDex Provider Group | |
| Slices for value[x] |
1..1 | CodeableConcept, boolean, Quantity, Range, Reference() | Value held by characteristic Slice: Unordered, Open by type:$this | |
| value[x]:valueReference |
S | 0..1 | Reference() | Value held by characteristic |
| exclude |
1..1 | boolean | Group includes or excludes Required Pattern: false | |
| period |
S | 0..1 | Period | Period over which characteristic is tested |
| member |
||||
| Slices for extension |
Content/Rules for all slices | |||
| lastTransmitted |
S | 0..1 | dateTime | Member Last Transmission URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-transmission |
| lastResources |
S | 0..1 | string | Member Last Resource Types URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-types |
| lastFilters |
S | 0..1 | string | Member Last Resource Filters URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-typefilter |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Group.code | required | PDexMultiMemberMatchResultVShttp://hl7.org/fhir/us/davinci-pdex/ValueSet/PDexMultiMemberMatchResultVSfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group |
C | 0..* | ATRGroup | Davinci ATR Group grp-1: Can only have members if group is "actual" |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| lastUpdated |
SΣ | 1..1 | instant | When the resource version last changed |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| intendedRecipientIdentifier |
S | 0..1 | Identifier | ATR Intended Recipient Extension URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-intended-recipient-identifier-extension |
| contractValidityPeriod |
S | 0..1 | Period | Indicates the validity period for Contract which is the basis for the Member Attribution List. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-contractValidityPeriod |
| attributionListStatus |
S | 1..1 | code | Indicates the status of the attribution list URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributionListStatus Binding: DaVinci Attribution List Status (extensible): The Da Vinci Attribution List Status is a starter set of codes used to indicate the status of the attribution list. |
| optedOut |
S | 0..1 | Quantity | Members Opted-out URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-members-opted-out |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
SΣ | 0..* | Identifier | Unique id Slice: Unordered, Open by value:system |
| identifier:npi |
SΣ | 0..* | Identifier | Unique id |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:tin |
SΣ | 0..* | Identifier | Unique id |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4 |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| active |
SΣ | 0..1 | boolean | Whether this group's record is in active use |
| type |
SΣ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person |
| actual |
SΣC | 1..1 | boolean | Descriptive or actual Fixed Value: true |
| code |
SΣ | 1..1 | CodeableConcept | Kind of Group members Binding: PDex Multi-Member Match Result Value Set (required) |
| name |
SΣ | 0..1 | string | Label for Group |
| quantity |
SΣ | 0..1 | unsignedInt | Number of members |
| managingEntity |
SΣ | 1..1 | Reference(Davinci ATR Organization) | Entity that is the custodian of the Group's definition |
| characteristic |
0..* | BackboneElement | Include / Exclude group members by Trait | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
S | 1..1 | CodeableConcept | Kind of characteristic Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMemberAttributionCS | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pdexprovidergroup | |
| display |
1..1 | string | Representation defined by the system Fixed Value: PDex Provider Group | |
| Slices for value[x] |
S | 1..1 | Value held by characteristic Slice: Unordered, Open by type:$this Binding Description (No ValueSet): (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | |
| valueCodeableConcept |
CodeableConcept | |||
| valueBoolean |
boolean | |||
| valueQuantity |
Quantity | |||
| valueRange |
Range | |||
| valueReference |
Reference(Any) | |||
| value[x]:valueReference |
S | 0..1 | Reference() | Value held by characteristic |
| exclude |
1..1 | boolean | Group includes or excludes Required Pattern: false | |
| period |
S | 0..1 | Period | Period over which characteristic is tested |
| member |
SC | 0..* | BackboneElement | Who or what is in group |
| Slices for extension |
Content/Rules for all slices | |||
| associatedData |
S | 0..1 | Reference() | ATR Any Resource Extension URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension |
| changeType |
S | 0..1 | code | Indicates whether a member was added, removed or changed when the Group was created/updated. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-changeType Binding: DaVinci ATR Change Types (extensible): The Da Vinci ATR Change Type Value Set is a 'starter set' of codes for identifying the detailed changes associated with Member Attribution Lists |
| coverageReference |
S | 0..1 | Reference(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 |
S | 0..1 | Reference(Davinci ATR Organization | Davinci ATR Practitioner | Davinci ATR PractitionerRole) | Indicates the attributed provider. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributedProvider |
| lastTransmitted |
S | 0..1 | dateTime | Member Last Transmission URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-transmission |
| lastResources |
S | 0..1 | string | Member Last Resource Types URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-types |
| lastFilters |
S | 0..1 | string | Member Last Resource Filters URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-typefilter |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity |
S | 1..1 | Reference(Davinci ATR Patient) | Reference to the group member |
| period |
S | 0..1 | Period | Period member belonged to the group |
| inactive |
S | 0..1 | boolean | If member is no longer in group |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Group.identifier:npi.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Group.identifier:tin.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Group.type | required | Fixed Value: personhttp://hl7.org/fhir/ValueSet/group-type|4.0.1from the FHIR Standard | |
| Group.code | required | PDexMultiMemberMatchResultVShttp://hl7.org/fhir/us/davinci-pdex/ValueSet/PDexMultiMemberMatchResultVSfrom this IG | |
| Group.characteristic.code | extensible | Pattern: pdexprovidergroup("PDex Provider Group")http://hl7.org/fhir/us/davinci-atr/ValueSet/davinci-group-characteristic | |
| Group.characteristic.value[x] | example |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Group |
C | 0..* | ATRGroup | Davinci ATR Group grp-1: Can only have members if group is "actual" | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
SΣ | 1..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| intendedRecipientIdentifier |
S | 0..1 | Identifier | ATR Intended Recipient Extension URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-intended-recipient-identifier-extension | ||||
| contractValidityPeriod |
S | 0..1 | Period | Indicates the validity period for Contract which is the basis for the Member Attribution List. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-contractValidityPeriod | ||||
| attributionListStatus |
S | 1..1 | code | Indicates the status of the attribution list URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributionListStatus Binding: DaVinci Attribution List Status (extensible): The Da Vinci Attribution List Status is a starter set of codes used to indicate the status of the attribution list. | ||||
| optedOut |
S | 0..1 | Quantity | Members Opted-out URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-members-opted-out | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣ | 0..* | Identifier | Unique id Slice: Unordered, Open by value:system | ||||
| identifier:npi |
SΣ | 0..* | Identifier | Unique id | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:tin |
SΣ | 0..* | Identifier | Unique id | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.4 | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active |
SΣ | 0..1 | boolean | Whether this group's record is in active use | ||||
| type |
SΣ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person | ||||
| actual |
SΣC | 1..1 | boolean | Descriptive or actual Fixed Value: true | ||||
| code |
SΣ | 1..1 | CodeableConcept | Kind of Group members Binding: PDex Multi-Member Match Result Value Set (required) | ||||
| name |
SΣ | 0..1 | string | Label for Group | ||||
| quantity |
SΣ | 0..1 | unsignedInt | Number of members | ||||
| managingEntity |
SΣ | 1..1 | Reference(Davinci ATR Organization) | Entity that is the custodian of the Group's definition | ||||
| characteristic |
0..* | BackboneElement | Include / Exclude group members by Trait | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
S | 1..1 | CodeableConcept | Kind of characteristic Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pdex/CodeSystem/PdexMemberAttributionCS | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pdexprovidergroup | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: PDex Provider Group | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| Slices for value[x] |
S | 1..1 | Value held by characteristic Slice: Unordered, Open by type:$this Binding Description (No ValueSet): (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | |||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueBoolean |
boolean | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueReference |
Reference(Any) | |||||||
| value[x]:valueReference |
S | 0..1 | Reference() | Value held by characteristic | ||||
| exclude |
1..1 | boolean | Group includes or excludes Required Pattern: false | |||||
| period |
S | 0..1 | Period | Period over which characteristic is tested | ||||
| member |
SC | 0..* | BackboneElement | Who or what is in group | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| associatedData |
S | 0..1 | Reference() | ATR Any Resource Extension URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension | ||||
| changeType |
S | 0..1 | code | Indicates whether a member was added, removed or changed when the Group was created/updated. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-changeType Binding: DaVinci ATR Change Types (extensible): The Da Vinci ATR Change Type Value Set is a 'starter set' of codes for identifying the detailed changes associated with Member Attribution Lists | ||||
| coverageReference |
S | 0..1 | Reference(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 |
S | 0..1 | Reference(Davinci ATR Organization | Davinci ATR Practitioner | Davinci ATR PractitionerRole) | Indicates the attributed provider. URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributedProvider | ||||
| lastTransmitted |
S | 0..1 | dateTime | Member Last Transmission URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-transmission | ||||
| lastResources |
S | 0..1 | string | Member Last Resource Types URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-types | ||||
| lastFilters |
S | 0..1 | string | Member Last Resource Filters URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-typefilter | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| entity |
S | 1..1 | Reference(Davinci ATR Patient) | Reference to the group member | ||||
| period |
S | 0..1 | Period | Period member belonged to the group | ||||
| inactive |
S | 0..1 | boolean | If member is no longer in group | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Group.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Group.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Group.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Group.identifier:npi.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Group.identifier:npi.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Group.identifier:tin.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Group.identifier:tin.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Group.type | required | Fixed Value: personhttp://hl7.org/fhir/ValueSet/group-type|4.0.1from the FHIR Standard | ||||
| Group.code | required | PDexMultiMemberMatchResultVShttp://hl7.org/fhir/us/davinci-pdex/ValueSet/PDexMultiMemberMatchResultVSfrom this IG | ||||
| Group.characteristic.code | extensible | Pattern: pdexprovidergroup("PDex Provider Group")http://hl7.org/fhir/us/davinci-atr/ValueSet/davinci-group-characteristic | ||||
| Group.characteristic.value[x] | example |
This structure is derived from ATRGroup
Summary
Mandatory: 1 element
Must-Support: 7 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
SHALL support searching for code for a Group. 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.
IG © 2024+ HL7 International / Financial Management. Package hl7.fhir.us.davinci-pdex#2.1.0-ballot based on FHIR 4.0.1. Generated 2024-08-14
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change