Da Vinci - Member Attribution (ATR) List
1.0.0 - STU 1 Publication
Da Vinci - Member Attribution (ATR) List
1.0.0 - STU 1 Publication
This page is part of the Risk Based Contracts Member Attribution List FHIR IG (v1.0.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-group |
| Version: | 1.0.0 |
| Name: | ATRGroup |
| Title: | Davinci ATR Group |
| Status: | Draft as of 2019-09-01 |
| Definition: | This is the Group Resource profile for the IG. |
| Publisher: | HL7 International - Financial Management Work Group |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-group
This profile represents an instance of Member Attribution List. The resource instance contain information related to members who are attributed to a specific individual provider or a provider organization. The instance may also contains information about the contract, settlement entity details. In addition, NPI and TIN of the consumer (provider) organization may be contained within the instance. Attribution information such as the attributed period, attributed provider is also contained within the group resource. Members may be added or removed from the member attribution list. Group.member has a cardinality of 0..* because Groups may have zero members when they are initially created and members get added at a later point in time. The Group.member.inactive flag is used to indicate that the patient is no longer part of the Member Attribution List.
Implementation Requirements
Implementers are advised to read Data Model Requirements to implement the Group profile and create a Member Attribution List.
APIs : Retrieval of Group Resource Instance:
The Group instance is retrieved using search parameters outlined in the Group discovery APIs.
The retrieved Group resource instance which represents the Member Attribution List has member and other related resource references. In order to retrieve the complete Member Attribution List information including member, coverage, attributed provider information a Bulk API request is initiated on the retrieved Group resource.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Group
Summary
Mandatory: 3 elements (14 nested mandatory elements)
Must-Support: 29 elements
Fixed Value: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Group
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Group | 0..* | Group | Davinci ATR Group | |
  meta | ||||
  lastUpdated | S | 1..1 | instant | When the resource version last changed |
  ext-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 |
 identifier | S | 0..* | (Slice Definition) | Unique id Slice: Unordered, Open by value:type.coding.system, value:type.coding.code |
 identifier:NPIIdentifier | S | 0..* | Identifier | Unique id |
   type | S | 1..1 | CodeableConcept | Description of identifier |
  coding | S | 1..1 | Coding | Code defined by a terminology system |
  system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPI |
 system | S | 1..1 | uri | The namespace for the identifier value |
 value | S | 1..1 | string | The value that is unique |
 identifier:TAXIdentifier | S | 0..* | Identifier | Unique id |
| type | S | 1..1 | CodeableConcept | Description of identifier |
| coding | S | 1..1 | Coding | Code defined by a terminology system |
| system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TAX |
| system | S | 1..1 | uri | The namespace for the identifier value |
| value | S | 1..1 | string | The value that is unique |
| 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 Fixed Value: person |
| actual | S | 1..1 | boolean | Descriptive or actual Fixed Value: true |
| name | S | 0..1 | string | Label for Group |
 managingEntity | S | 1..1 | Reference(Davinci ATR Organization) | Entity that is the custodian of the Group's definition |
| member | S | 0..* | BackboneElement | Who or what is in group |
| ext-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: Da Vinci 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 |
| ext-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 |
| ext-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 |
| 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | I | 0..* | Group | Davinci ATR Group |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ext-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 |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 0..* | (Slice Definition) | Unique id Slice: Unordered, Open by value:type.coding.system, value:type.coding.code |
| identifier:NPIIdentifier | 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 | SΣ | 1..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. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPI |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| 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:TAXIdentifier | 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 | SΣ | 1..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. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TAX |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| 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ΣI | 1..1 | boolean | Descriptive or actual Fixed Value: true |
| code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc. |
| name | SΣ | 0..1 | string | Label for Group |
| quantity | Σ | 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 | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |
 value[x] | 1..1 | Value held by characteristic Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||
| valueCodeableConcept | CodeableConcept | |||
| valueBoolean | boolean | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueReference | Reference(Any) | |||
| exclude | 1..1 | boolean | Group includes or excludes | |
| period | 0..1 | Period | Period over which characteristic is tested | |
| member | SI | 0..* | BackboneElement | Who or what is in group |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ext-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: Da Vinci 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 |
| ext-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 |
| ext-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 |
| 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | I | 0..* | Group | Davinci ATR Group |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed |
| ext-contractValidityPeriod | 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 | |
| identifier | Σ | 0..* | (Slice Definition) | Unique id Slice: Unordered, Open by value:type.coding.system, value:type.coding.code |
| identifier:NPIIdentifier | Σ | 0..* | Identifier | Unique id |
| type | Σ | 1..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. |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPI |
| system | Σ | 1..1 | uri | The namespace for the identifier value |
| value | Σ | 1..1 | string | The value that is unique |
| identifier:TAXIdentifier | Σ | 0..* | Identifier | Unique id |
| type | Σ | 1..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. |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TAX |
| system | Σ | 1..1 | uri | The namespace for the identifier value |
| value | Σ | 1..1 | string | The value that is unique |
| active | Σ | 0..1 | boolean | Whether this group's record is in active use |
| type | Σ | 1..1 | code | person | animal | practitioner | device | medication | substance Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person |
| actual | ΣI | 1..1 | boolean | Descriptive or actual Fixed Value: true |
| name | Σ | 0..1 | string | Label for Group |
| managingEntity | Σ | 1..1 | Reference(Davinci ATR Organization) | Entity that is the custodian of the Group's definition |
| member | I | 0..* | BackboneElement | Who or what is in group |
| ext-changeType | 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: Da Vinci 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 | |
| ext-coverageReference | 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 | |
| ext-attributedProvider | 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 | |
| entity | 1..1 | Reference(Davinci ATR Patient) | Reference to the group member | |
| period | 0..1 | Period | Period member belonged to the group | |
| inactive | 0..1 | boolean | If member is no longer in group | |
| Documentation for this format | ||||
This structure is derived from Group
Summary
Mandatory: 3 elements (14 nested mandatory elements)
Must-Support: 29 elements
Fixed Value: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Group
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | 0..* | Group | Davinci ATR Group | |
| meta | ||||
| lastUpdated | S | 1..1 | instant | When the resource version last changed |
| ext-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 |
| identifier | S | 0..* | (Slice Definition) | Unique id Slice: Unordered, Open by value:type.coding.system, value:type.coding.code |
| identifier:NPIIdentifier | S | 0..* | Identifier | Unique id |
| type | S | 1..1 | CodeableConcept | Description of identifier |
| coding | S | 1..1 | Coding | Code defined by a terminology system |
| system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPI |
| system | S | 1..1 | uri | The namespace for the identifier value |
| value | S | 1..1 | string | The value that is unique |
| identifier:TAXIdentifier | S | 0..* | Identifier | Unique id |
| type | S | 1..1 | CodeableConcept | Description of identifier |
| coding | S | 1..1 | Coding | Code defined by a terminology system |
| system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TAX |
| system | S | 1..1 | uri | The namespace for the identifier value |
| value | S | 1..1 | string | The value that is unique |
| 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 Fixed Value: person |
| actual | S | 1..1 | boolean | Descriptive or actual Fixed Value: true |
| name | S | 0..1 | string | Label for Group |
| managingEntity | S | 1..1 | Reference(Davinci ATR Organization) | Entity that is the custodian of the Group's definition |
| member | S | 0..* | BackboneElement | Who or what is in group |
| ext-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: Da Vinci 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 |
| ext-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 |
| ext-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 |
| 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 | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Group | I | 0..* | Group | Davinci ATR Group |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ext-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 |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 0..* | (Slice Definition) | Unique id Slice: Unordered, Open by value:type.coding.system, value:type.coding.code |
| identifier:NPIIdentifier | 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 | SΣ | 1..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. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: NPI |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| 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:TAXIdentifier | 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 | SΣ | 1..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. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: TAX |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| 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ΣI | 1..1 | boolean | Descriptive or actual Fixed Value: true |
| code | Σ | 0..1 | CodeableConcept | Kind of Group members Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc. |
| name | SΣ | 0..1 | string | Label for Group |
| quantity | Σ | 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 | 1..1 | CodeableConcept | Kind of characteristic Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |
| value[x] | 1..1 | Value held by characteristic Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||
| valueCodeableConcept | CodeableConcept | |||
| valueBoolean | boolean | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueReference | Reference(Any) | |||
| exclude | 1..1 | boolean | Group includes or excludes | |
| period | 0..1 | Period | Period over which characteristic is tested | |
| member | SI | 0..* | BackboneElement | Who or what is in group |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ext-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: Da Vinci 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 |
| ext-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 |
| ext-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 |
| 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 | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet / Code |
| Group.meta.security | extensible | All Security Labels |
| Group.meta.tag | example | CommonTags |
| Group.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Group.identifier:NPIIdentifier.use | required | IdentifierUse |
| Group.identifier:NPIIdentifier.type | extensible | Identifier Type Codes |
| Group.identifier:TAXIdentifier.use | required | IdentifierUse |
| Group.identifier:TAXIdentifier.type | extensible | Identifier Type Codes |
| Group.type | required | Fixed Value: person |
| Group.code | example | |
| Group.characteristic.code | example | |
| Group.characteristic.value[x] | example |
| Id | Path | Details | Requirements |
| dom-2 | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | Group | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Group | A resource should have narrative for robust management : text.`div`.exists() | |
| grp-1 | Group | Can only have members if group is "actual" : member.empty() or (actual = true) | |
| ele-1 | Group.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.meta.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.meta.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.meta.versionId | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.meta.lastUpdated | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.meta.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.meta.profile | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.meta.security | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.meta.tag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.extension:contractValidityPeriod | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.extension:contractValidityPeriod | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:NPIIdentifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:NPIIdentifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.identifier:NPIIdentifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.identifier:NPIIdentifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:NPIIdentifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:NPIIdentifier.type.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.identifier:NPIIdentifier.type.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.identifier:NPIIdentifier.type.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:NPIIdentifier.type.coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.identifier:NPIIdentifier.type.coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.identifier:NPIIdentifier.type.coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:NPIIdentifier.type.coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:NPIIdentifier.type.coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:NPIIdentifier.type.coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:NPIIdentifier.type.coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:NPIIdentifier.type.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:NPIIdentifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:NPIIdentifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:NPIIdentifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:NPIIdentifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:TAXIdentifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:TAXIdentifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.identifier:TAXIdentifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.identifier:TAXIdentifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:TAXIdentifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:TAXIdentifier.type.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.identifier:TAXIdentifier.type.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.identifier:TAXIdentifier.type.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:TAXIdentifier.type.coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.identifier:TAXIdentifier.type.coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.identifier:TAXIdentifier.type.coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:TAXIdentifier.type.coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:TAXIdentifier.type.coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:TAXIdentifier.type.coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:TAXIdentifier.type.coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:TAXIdentifier.type.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:TAXIdentifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:TAXIdentifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:TAXIdentifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.identifier:TAXIdentifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.actual | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.quantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.managingEntity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.characteristic | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.characteristic.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.characteristic.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.characteristic.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.characteristic.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.characteristic.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.characteristic.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.characteristic.exclude | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.characteristic.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.member | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.member.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.member.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.member.extension:changeType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.member.extension:changeType | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.member.extension:coverageReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.member.extension:coverageReference | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.member.extension:attributedProvider | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.member.extension:attributedProvider | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.member.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Group.member.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Group.member.entity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.member.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Group.member.inactive | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2019+ HL7 International - Financial Management Work Group. Package hl7.fhir.us.davinci-atr#1.0.0 based on FHIR 4.0.1. Generated 2021-02-08
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change