Da Vinci Payer Data Exchange
2.1.0 - STU2 Ballot 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.1.0 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.1.0
Standards status: Informative 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:

Formal Views of Profile Content

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

This structure is derived from ATRGroup

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Group.coderequiredPDexMultiMemberMatchResultVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/PDexMultiMemberMatchResultVS
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C 0..* ATRGroup Davinci ATR Group
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
grp-1: Can only have members if group is "actual"
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... lastUpdated SΣ 1..1 instant When the resource version last changed
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... intendedRecipientIdentifier S 0..1 Identifier ATR Intended Recipient Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-intended-recipient-identifier-extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... contractValidityPeriod S 0..1 Period Indicates the validity period for Contract which is the basis for the Member Attribution List.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-contractValidityPeriod
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... attributionListStatus S 1..1 code Indicates the status of the attribution list
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributionListStatus
Binding: DaVinci Attribution List Status (extensible): The Da Vinci Attribution List Status is a starter set of codes used to indicate the status of the attribution list.


ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... optedOut S 0..1 Quantity Members Opted-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-members-opted-out
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier SΣ 0..* Identifier Unique id
Slice: Unordered, Open by value:system
ele-1: All FHIR elements must have a @value or children
.... identifier:npi SΣ 0..* Identifier Unique id
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system SΣ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value SΣ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:tin SΣ 0..* Identifier Unique id
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system SΣ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Fixed Value: urn:oid:2.16.840.1.113883.4.4
..... value SΣ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... active SΣ 0..1 boolean Whether this group's record is in active use
ele-1: All FHIR elements must have a @value or children
... type SΣ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


ele-1: All FHIR elements must have a @value or children
Fixed Value: person
... actual SΣC 1..1 boolean Descriptive or actual
ele-1: All FHIR elements must have a @value or children
Fixed Value: true
... code SΣ 1..1 CodeableConcept Kind of Group members
Binding: PDex Multi-Member Match Result Value Set (required)
ele-1: All FHIR elements must have a @value or children
... name SΣ 0..1 string Label for Group
ele-1: All FHIR elements must have a @value or children
... quantity SΣ 0..1 unsignedInt Number of members
ele-1: All FHIR elements must have a @value or children
... managingEntity SΣ 1..1 Reference(Davinci ATR Organization) Entity that is the custodian of the Group's definition
ele-1: All FHIR elements must have a @value or children
... characteristic 0..* BackboneElement Include / Exclude group members by Trait
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... code S 1..1 CodeableConcept Kind of characteristic
Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members


ele-1: All FHIR elements must have a @value or children
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.


ele-1: All FHIR elements must have a @value or children
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(Any)
..... value[x]:valueReference S 0..1 Reference() Value held by characteristic
ele-1: All FHIR elements must have a @value or children
.... exclude 1..1 boolean Group includes or excludes
ele-1: All FHIR elements must have a @value or children
Required Pattern: false
.... period S 0..1 Period Period over which characteristic is tested
ele-1: All FHIR elements must have a @value or children
... member SC 0..* BackboneElement Who or what is in group
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... associatedData S 0..1 Reference() ATR Any Resource Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... changeType S 0..1 code Indicates whether a member was added, removed or changed when the Group was created/updated.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-changeType
Binding: DaVinci ATR Change Types (extensible): The Da Vinci ATR Change Type Value Set is a 'starter set' of codes for identifying the detailed changes associated with Member Attribution Lists


ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... 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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... attributedProvider S 0..1 Reference(Davinci ATR Organization | Davinci ATR Practitioner | Davinci ATR PractitionerRole) Indicates the attributed provider.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributedProvider
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... lastTransmitted S 0..1 dateTime Member Last Transmission
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-transmission
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... lastResources S 0..1 string Member Last Resource Types
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-types
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... lastFilters S 0..1 string Member Last Resource Filters
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-typefilter
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... entity S 1..1 Reference(Davinci ATR Patient) Reference to the group member
ele-1: All FHIR elements must have a @value or children
.... period S 0..1 Period Period member belonged to the group
ele-1: All FHIR elements must have a @value or children
.... inactive S 0..1 boolean If member is no longer in group
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.identifier:npi.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Group.identifier:tin.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Group.typerequiredFixed Value: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.coderequiredPDexMultiMemberMatchResultVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/PDexMultiMemberMatchResultVS
from this IG
Group.characteristic.codeextensiblePattern: pdexprovidergroup("PDex Provider Group")
http://hl7.org/fhir/us/davinci-atr/ValueSet/davinci-group-characteristic
Group.characteristic.value[x]example
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Group.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Group.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Group.identifier:npi.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Group.identifier:npi.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Group.identifier:tin.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Group.identifier:tin.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Group.typerequiredFixed Value: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.coderequiredPDexMultiMemberMatchResultVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/PDexMultiMemberMatchResultVS
from this IG
Group.characteristic.codeextensiblePattern: 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:

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

Differential View

This structure is derived from ATRGroup

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Group.coderequiredPDexMultiMemberMatchResultVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/PDexMultiMemberMatchResultVS
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C 0..* ATRGroup Davinci ATR Group
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
grp-1: Can only have members if group is "actual"
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... lastUpdated SΣ 1..1 instant When the resource version last changed
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... intendedRecipientIdentifier S 0..1 Identifier ATR Intended Recipient Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-intended-recipient-identifier-extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... contractValidityPeriod S 0..1 Period Indicates the validity period for Contract which is the basis for the Member Attribution List.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-contractValidityPeriod
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... attributionListStatus S 1..1 code Indicates the status of the attribution list
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributionListStatus
Binding: DaVinci Attribution List Status (extensible): The Da Vinci Attribution List Status is a starter set of codes used to indicate the status of the attribution list.


ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... optedOut S 0..1 Quantity Members Opted-out
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-members-opted-out
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier SΣ 0..* Identifier Unique id
Slice: Unordered, Open by value:system
ele-1: All FHIR elements must have a @value or children
.... identifier:npi SΣ 0..* Identifier Unique id
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system SΣ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value SΣ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:tin SΣ 0..* Identifier Unique id
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system SΣ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Fixed Value: urn:oid:2.16.840.1.113883.4.4
..... value SΣ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... active SΣ 0..1 boolean Whether this group's record is in active use
ele-1: All FHIR elements must have a @value or children
... type SΣ 1..1 code person | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


ele-1: All FHIR elements must have a @value or children
Fixed Value: person
... actual SΣC 1..1 boolean Descriptive or actual
ele-1: All FHIR elements must have a @value or children
Fixed Value: true
... code SΣ 1..1 CodeableConcept Kind of Group members
Binding: PDex Multi-Member Match Result Value Set (required)
ele-1: All FHIR elements must have a @value or children
... name SΣ 0..1 string Label for Group
ele-1: All FHIR elements must have a @value or children
... quantity SΣ 0..1 unsignedInt Number of members
ele-1: All FHIR elements must have a @value or children
... managingEntity SΣ 1..1 Reference(Davinci ATR Organization) Entity that is the custodian of the Group's definition
ele-1: All FHIR elements must have a @value or children
... characteristic 0..* BackboneElement Include / Exclude group members by Trait
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... code S 1..1 CodeableConcept Kind of characteristic
Binding: DaVinci Group Characteristic (extensible): The set of characteristics shared by the members


ele-1: All FHIR elements must have a @value or children
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.


ele-1: All FHIR elements must have a @value or children
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(Any)
..... value[x]:valueReference S 0..1 Reference() Value held by characteristic
ele-1: All FHIR elements must have a @value or children
.... exclude 1..1 boolean Group includes or excludes
ele-1: All FHIR elements must have a @value or children
Required Pattern: false
.... period S 0..1 Period Period over which characteristic is tested
ele-1: All FHIR elements must have a @value or children
... member SC 0..* BackboneElement Who or what is in group
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... associatedData S 0..1 Reference() ATR Any Resource Extension
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-any-resource-extension
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... changeType S 0..1 code Indicates whether a member was added, removed or changed when the Group was created/updated.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-changeType
Binding: DaVinci ATR Change Types (extensible): The Da Vinci ATR Change Type Value Set is a 'starter set' of codes for identifying the detailed changes associated with Member Attribution Lists


ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... 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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... attributedProvider S 0..1 Reference(Davinci ATR Organization | Davinci ATR Practitioner | Davinci ATR PractitionerRole) Indicates the attributed provider.
URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/ext-attributedProvider
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... lastTransmitted S 0..1 dateTime Member Last Transmission
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-transmission
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... lastResources S 0..1 string Member Last Resource Types
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-types
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... lastFilters S 0..1 string Member Last Resource Filters
URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/base-ext-last-typefilter
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... entity S 1..1 Reference(Davinci ATR Patient) Reference to the group member
ele-1: All FHIR elements must have a @value or children
.... period S 0..1 Period Period member belonged to the group
ele-1: All FHIR elements must have a @value or children
.... inactive S 0..1 boolean If member is no longer in group
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.identifier:npi.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Group.identifier:tin.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Group.typerequiredFixed Value: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.coderequiredPDexMultiMemberMatchResultVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/PDexMultiMemberMatchResultVS
from this IG
Group.characteristic.codeextensiblePattern: pdexprovidergroup("PDex Provider Group")
http://hl7.org/fhir/us/davinci-atr/ValueSet/davinci-group-characteristic
Group.characteristic.value[x]example

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Group.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Group.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Group.identifier:npi.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Group.identifier:npi.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Group.identifier:tin.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Group.identifier:tin.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Group.typerequiredFixed Value: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.coderequiredPDexMultiMemberMatchResultVS
http://hl7.org/fhir/us/davinci-pdex/ValueSet/PDexMultiMemberMatchResultVS
from this IG
Group.characteristic.codeextensiblePattern: 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:

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