Da Vinci Payer Data Exchange
2.1.1 - STU 2.1
Da Vinci Payer Data Exchange
2.1.1 - STU 2.1
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.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-epdx/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/member-provider-treatment-relationship-group | Version: 2.1.1 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: MemberProviderTreatmentRelationship | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
||||
A Group resource representing the treatment relationship between a specific member/patient and one or more healthcare providers. The Payer is the managing organization. The member is identified through a characteristic containing the Patient ID. The group members are the providers that have an active or confirmed treatment relationship with the member.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Group |
C | 0..* | Group | Group of multiple entities Constraints: grp-1 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
SΣ | 0..* | Identifier | Unique identifier for the treatment relationship group |
| active |
SΣ | 0..1 | boolean | Treatment relationship group is active Required Pattern: true |
| type |
SΣ | 1..1 | code | Type of group (provider treatment relationship) Binding: GroupType (required): Types of resources that are part of group. Required Pattern: device |
| actual |
SΣC | 1..1 | boolean | This is an actual collection of providers Required Pattern: true |
| code |
SΣ | 0..1 | CodeableConcept | Kind of treatment relationship Binding: PDex Multi-Member Match Result Value Set (required) |
| quantity |
SΣ | 0..1 | unsignedInt | Number of providers in the group |
 managingEntity |
SΣ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | The Payer managing this treatment relationship |
 characteristic |
S | 0..* | BackboneElement | Member/Patient identifier and other characteristics |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
S | 1..1 | CodeableConcept | Identifies the member characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. 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 |
0..1 | uri | Identity of the terminology system | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pdex-member | |
| display |
1..1 | string | Representation defined by the system Fixed Value: PDex Member | |
 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: (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 |
0..1 | Reference(Patient) | Reference to the member/patient | |
| exclude |
1..1 | boolean | This is an include, not an exclude Required Pattern: false | |
| period |
S | 0..1 | Period | Period during which this group is valid |
 member |
SC | 0..* | BackboneElement | Providers with treatment relationship to the member |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity |
S | 1..1 | Reference(Practitioner | PractitionerRole) | Provider entity |
| Slices for extension |
Content/Rules for all slices | |||
| extension:treatmentDetails |
0..1 | string | Details of the treatment relationship URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/treatment-relationship-details | |
| inactive |
0..1 | boolean | Whether the treatment relationship is currently active | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | required | PDex Multi-Member Match Result Value Set | 📦2.1.1 | This IG |
| Group.characteristic.code | Base | example | Not State | Unknown | |
| Group.characteristic.value[x] | Base | example | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Group | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Group | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Group | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| grp-1 | error | Group | Can only have members if group is "actual" |
member.empty() or (actual = true)
|
This structure is derived from Group
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Group |
0..* | Group | Group of multiple entities | |
 identifier |
S | 0..* | Identifier | Unique identifier for the treatment relationship group |
| active |
S | 0..1 | boolean | Treatment relationship group is active Required Pattern: true |
| type |
S | 1..1 | code | Type of group (provider treatment relationship) Required Pattern: device |
| actual |
S | 1..1 | boolean | This is an actual collection of providers Required Pattern: true |
| code |
S | 0..1 | CodeableConcept | Kind of treatment relationship Binding: PDex Multi-Member Match Result Value Set (required) |
| quantity |
S | 0..1 | unsignedInt | Number of providers in the group |
| managingEntity |
S | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | The Payer managing this treatment relationship |
| characteristic |
S | 0..* | BackboneElement | Member/Patient identifier and other characteristics |
| code |
S | 1..1 | CodeableConcept | Identifies the member characteristic Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pdex-member | |
| display |
1..1 | string | Representation defined by the system Fixed Value: PDex Member | |
| Slices for value[x] |
S | 1..1 | CodeableConcept, boolean, Quantity, Range, Reference() | Value held by characteristic Slice: Unordered, Open by type:$this |
| value[x]:valueReference |
0..1 | Reference(Patient) | Reference to the member/patient | |
| exclude |
1..1 | boolean | This is an include, not an exclude Required Pattern: false | |
| period |
S | 0..1 | Period | Period during which this group is valid |
| member |
S | 0..* | BackboneElement | Providers with treatment relationship to the member |
| entity |
S | 1..1 | Reference(Practitioner | PractitionerRole) | Provider entity |
| Slices for extension |
Content/Rules for all slices | |||
| extension:treatmentDetails |
0..1 | string | Details of the treatment relationship URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/treatment-relationship-details | |
| inactive |
0..1 | boolean | Whether the treatment relationship is currently active | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.code | Base | required | PDex Multi-Member Match Result Value Set | 📦2.1.1 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Group |
C | 0..* | Group | Group of multiple entities Constraints: grp-1 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 0..* | Identifier | Unique identifier for the treatment relationship group | ||||
| active |
SΣ | 0..1 | boolean | Treatment relationship group is active Required Pattern: true | ||||
| type |
SΣ | 1..1 | code | Type of group (provider treatment relationship) Binding: GroupType (required): Types of resources that are part of group. Required Pattern: device | ||||
| actual |
SΣC | 1..1 | boolean | This is an actual collection of providers Required Pattern: true | ||||
| code |
SΣ | 0..1 | CodeableConcept | Kind of treatment relationship Binding: PDex Multi-Member Match Result Value Set (required) | ||||
| name |
Σ | 0..1 | string | Label for Group | ||||
| quantity |
SΣ | 0..1 | unsignedInt | Number of providers in the group | ||||
| managingEntity |
SΣ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | The Payer managing this treatment relationship | ||||
| characteristic |
S | 0..* | BackboneElement | Member/Patient identifier and other characteristics | ||||
| 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 | Identifies the member characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. 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 |
0..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pdex-member | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: PDex Member | |||||
| 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: (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 |
0..1 | Reference(Patient) | Reference to the member/patient | |||||
| exclude |
1..1 | boolean | This is an include, not an exclude Required Pattern: false | |||||
| period |
S | 0..1 | Period | Period during which this group is valid | ||||
| member |
SC | 0..* | BackboneElement | Providers with treatment relationship to the member | ||||
| 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 | ||||
| entity |
S | 1..1 | Reference(Practitioner | PractitionerRole) | Provider entity | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:treatmentDetails |
0..1 | string | Details of the treatment relationship URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/treatment-relationship-details | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| period |
0..1 | Period | Period member belonged to the group | |||||
| inactive |
0..1 | boolean | Whether the treatment relationship is currently active | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | required | PDex Multi-Member Match Result Value Set | 📦2.1.1 | This IG |
| Group.characteristic.code | Base | example | Not State | Unknown | |
| Group.characteristic.value[x] | Base | example | Not State | Unknown | |
| Group.member.entity.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Group | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Group | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Group | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| grp-1 | error | Group | Can only have members if group is "actual" |
member.empty() or (actual = true)
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Group |
C | 0..* | Group | Group of multiple entities Constraints: grp-1 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 0..* | Identifier | Unique identifier for the treatment relationship group |
| active |
SΣ | 0..1 | boolean | Treatment relationship group is active Required Pattern: true |
| type |
SΣ | 1..1 | code | Type of group (provider treatment relationship) Binding: GroupType (required): Types of resources that are part of group. Required Pattern: device |
| actual |
SΣC | 1..1 | boolean | This is an actual collection of providers Required Pattern: true |
| code |
SΣ | 0..1 | CodeableConcept | Kind of treatment relationship Binding: PDex Multi-Member Match Result Value Set (required) |
| quantity |
SΣ | 0..1 | unsignedInt | Number of providers in the group |
| managingEntity |
SΣ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | The Payer managing this treatment relationship |
| characteristic |
S | 0..* | BackboneElement | Member/Patient identifier and other characteristics |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
S | 1..1 | CodeableConcept | Identifies the member characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. 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 |
0..1 | uri | Identity of the terminology system | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pdex-member | |
| display |
1..1 | string | Representation defined by the system Fixed Value: PDex Member | |
| 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: (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 |
0..1 | Reference(Patient) | Reference to the member/patient | |
| exclude |
1..1 | boolean | This is an include, not an exclude Required Pattern: false | |
| period |
S | 0..1 | Period | Period during which this group is valid |
| member |
SC | 0..* | BackboneElement | Providers with treatment relationship to the member |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| entity |
S | 1..1 | Reference(Practitioner | PractitionerRole) | Provider entity |
| Slices for extension |
Content/Rules for all slices | |||
| extension:treatmentDetails |
0..1 | string | Details of the treatment relationship URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/treatment-relationship-details | |
| inactive |
0..1 | boolean | Whether the treatment relationship is currently active | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | required | PDex Multi-Member Match Result Value Set | 📦2.1.1 | This IG |
| Group.characteristic.code | Base | example | Not State | Unknown | |
| Group.characteristic.value[x] | Base | example | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Group | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Group | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Group | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| grp-1 | error | Group | Can only have members if group is "actual" |
member.empty() or (actual = true)
|
Differential View
This structure is derived from Group
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Group |
0..* | Group | Group of multiple entities | |
| identifier |
S | 0..* | Identifier | Unique identifier for the treatment relationship group |
| active |
S | 0..1 | boolean | Treatment relationship group is active Required Pattern: true |
| type |
S | 1..1 | code | Type of group (provider treatment relationship) Required Pattern: device |
| actual |
S | 1..1 | boolean | This is an actual collection of providers Required Pattern: true |
| code |
S | 0..1 | CodeableConcept | Kind of treatment relationship Binding: PDex Multi-Member Match Result Value Set (required) |
| quantity |
S | 0..1 | unsignedInt | Number of providers in the group |
| managingEntity |
S | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | The Payer managing this treatment relationship |
| characteristic |
S | 0..* | BackboneElement | Member/Patient identifier and other characteristics |
| code |
S | 1..1 | CodeableConcept | Identifies the member characteristic Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pdex-member | |
| display |
1..1 | string | Representation defined by the system Fixed Value: PDex Member | |
| Slices for value[x] |
S | 1..1 | CodeableConcept, boolean, Quantity, Range, Reference() | Value held by characteristic Slice: Unordered, Open by type:$this |
| value[x]:valueReference |
0..1 | Reference(Patient) | Reference to the member/patient | |
| exclude |
1..1 | boolean | This is an include, not an exclude Required Pattern: false | |
| period |
S | 0..1 | Period | Period during which this group is valid |
| member |
S | 0..* | BackboneElement | Providers with treatment relationship to the member |
| entity |
S | 1..1 | Reference(Practitioner | PractitionerRole) | Provider entity |
| Slices for extension |
Content/Rules for all slices | |||
| extension:treatmentDetails |
0..1 | string | Details of the treatment relationship URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/treatment-relationship-details | |
| inactive |
0..1 | boolean | Whether the treatment relationship is currently active | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.code | Base | required | PDex Multi-Member Match Result Value Set | 📦2.1.1 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Group |
C | 0..* | Group | Group of multiple entities Constraints: grp-1 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 0..* | Identifier | Unique identifier for the treatment relationship group | ||||
| active |
SΣ | 0..1 | boolean | Treatment relationship group is active Required Pattern: true | ||||
| type |
SΣ | 1..1 | code | Type of group (provider treatment relationship) Binding: GroupType (required): Types of resources that are part of group. Required Pattern: device | ||||
| actual |
SΣC | 1..1 | boolean | This is an actual collection of providers Required Pattern: true | ||||
| code |
SΣ | 0..1 | CodeableConcept | Kind of treatment relationship Binding: PDex Multi-Member Match Result Value Set (required) | ||||
| name |
Σ | 0..1 | string | Label for Group | ||||
| quantity |
SΣ | 0..1 | unsignedInt | Number of providers in the group | ||||
| managingEntity |
SΣ | 0..1 | Reference(Organization | RelatedPerson | Practitioner | PractitionerRole) | The Payer managing this treatment relationship | ||||
| characteristic |
S | 0..* | BackboneElement | Member/Patient identifier and other characteristics | ||||
| 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 | Identifies the member characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. 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 |
0..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pdex-member | |||||
| display |
1..1 | string | Representation defined by the system Fixed Value: PDex Member | |||||
| 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: (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 |
0..1 | Reference(Patient) | Reference to the member/patient | |||||
| exclude |
1..1 | boolean | This is an include, not an exclude Required Pattern: false | |||||
| period |
S | 0..1 | Period | Period during which this group is valid | ||||
| member |
SC | 0..* | BackboneElement | Providers with treatment relationship to the member | ||||
| 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 | ||||
| entity |
S | 1..1 | Reference(Practitioner | PractitionerRole) | Provider entity | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:treatmentDetails |
0..1 | string | Details of the treatment relationship URL: http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/treatment-relationship-details | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| period |
0..1 | Period | Period member belonged to the group | |||||
| inactive |
0..1 | boolean | Whether the treatment relationship is currently active | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Group.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Group.type | Base | required | GroupType | 📍4.0.1 | FHIR Std. |
| Group.code | Base | required | PDex Multi-Member Match Result Value Set | 📦2.1.1 | This IG |
| Group.characteristic.code | Base | example | Not State | Unknown | |
| Group.characteristic.value[x] | Base | example | Not State | Unknown | |
| Group.member.entity.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Group | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Group | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Group | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Group | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| grp-1 | error | Group | Can only have members if group is "actual" |
member.empty() or (actual = true)
|
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 International / Financial Management. Package hl7.fhir.us.davinci-pdex#2.1.1 based on FHIR 4.0.1. Generated 2025-12-18
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change