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

Resource Profile: ATRGroup

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

Introduction

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.

Formal Views of Profile Content

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:

  • The element Group.identifier is sliced based on the values of value:type.coding.system, value:type.coding.code

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..*GroupDavinci ATR Group
... meta
.... lastUpdated S1..1instantWhen the resource version last changed
... ext-contractValidityPeriod S0..1PeriodIndicates 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 S0..*(Slice Definition)Unique id
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... identifier:NPIIdentifier S0..*IdentifierUnique id
..... type S1..1CodeableConceptDescription of identifier
...... coding S1..1CodingCode defined by a terminology system
....... system S1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code S1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
..... system S1..1uriThe namespace for the identifier value
..... value S1..1stringThe value that is unique
.... identifier:TAXIdentifier S0..*IdentifierUnique id
..... type S1..1CodeableConceptDescription of identifier
...... coding S1..1CodingCode defined by a terminology system
....... system S1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code S1..1codeSymbol in syntax defined by the system
Fixed Value: TAX
..... system S1..1uriThe namespace for the identifier value
..... value S1..1stringThe value that is unique
... type S1..1codeperson | animal | practitioner | device | medication | substance
Fixed Value: person
... actual S1..1booleanDescriptive or actual
Fixed Value: true
... name S0..1stringLabel for Group
... managingEntity S1..1Reference(Davinci ATR Organization)Entity that is the custodian of the Group's definition
... member S0..*BackboneElementWho or what is in group
.... ext-changeType S0..1codeIndicates 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 S0..1Reference(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 S0..1Reference(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 S1..1Reference(Davinci ATR Patient)Reference to the group member
.... period S0..1PeriodPeriod member belonged to the group
.... inactive S0..1booleanIf member is no longer in group

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group I0..*GroupDavinci ATR Group
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-contractValidityPeriod S0..1PeriodIndicates 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..*ExtensionExtensions 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..*IdentifierUnique id
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ1..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:TAXIdentifier SΣ0..*IdentifierUnique id
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ1..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: TAX
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active SΣ0..1booleanWhether this group's record is in active use
... type SΣ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual SΣI1..1booleanDescriptive or actual
Fixed Value: true
... code Σ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name SΣ0..1stringLabel for Group
... quantity Σ0..1unsignedIntNumber of members
... managingEntity SΣ1..1Reference(Davinci ATR Organization)Entity that is the custodian of the Group's definition
... characteristic 0..*BackboneElementInclude / Exclude group members by Trait
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1CodeableConceptKind of characteristic
Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.

.... value[x] 1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference(Any)
.... exclude 1..1booleanGroup includes or excludes
.... period 0..1PeriodPeriod over which characteristic is tested
... member SI0..*BackboneElementWho or what is in group
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-changeType S0..1codeIndicates 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 S0..1Reference(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 S0..1Reference(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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity S1..1Reference(Davinci ATR Patient)Reference to the group member
.... period S0..1PeriodPeriod member belonged to the group
.... inactive S0..1booleanIf member is no longer in group

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group I0..*GroupDavinci ATR Group
... meta Σ0..1MetaMetadata about the resource
.... lastUpdated Σ1..1instantWhen the resource version last changed
... ext-contractValidityPeriod 0..1PeriodIndicates 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..*IdentifierUnique id
..... type Σ1..1CodeableConceptDescription 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..1CodingCode defined by a terminology system
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
..... system Σ1..1uriThe namespace for the identifier value
..... value Σ1..1stringThe value that is unique
.... identifier:TAXIdentifier Σ0..*IdentifierUnique id
..... type Σ1..1CodeableConceptDescription 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..1CodingCode defined by a terminology system
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: TAX
..... system Σ1..1uriThe namespace for the identifier value
..... value Σ1..1stringThe value that is unique
... type Σ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual ΣI1..1booleanDescriptive or actual
Fixed Value: true
... name Σ0..1stringLabel for Group
... managingEntity Σ1..1Reference(Davinci ATR Organization)Entity that is the custodian of the Group's definition
... member I0..*BackboneElementWho or what is in group
.... ext-changeType 0..1codeIndicates 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..1Reference(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..1Reference(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..1Reference(Davinci ATR Patient)Reference to the group member
.... period 0..1PeriodPeriod member belonged to the group
.... inactive 0..1booleanIf member is no longer in group

doco 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:

  • The element Group.identifier is sliced based on the values of value:type.coding.system, value:type.coding.code

Differential View

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..*GroupDavinci ATR Group
... meta
.... lastUpdated S1..1instantWhen the resource version last changed
... ext-contractValidityPeriod S0..1PeriodIndicates 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 S0..*(Slice Definition)Unique id
Slice: Unordered, Open by value:type.coding.system, value:type.coding.code
.... identifier:NPIIdentifier S0..*IdentifierUnique id
..... type S1..1CodeableConceptDescription of identifier
...... coding S1..1CodingCode defined by a terminology system
....... system S1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code S1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
..... system S1..1uriThe namespace for the identifier value
..... value S1..1stringThe value that is unique
.... identifier:TAXIdentifier S0..*IdentifierUnique id
..... type S1..1CodeableConceptDescription of identifier
...... coding S1..1CodingCode defined by a terminology system
....... system S1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code S1..1codeSymbol in syntax defined by the system
Fixed Value: TAX
..... system S1..1uriThe namespace for the identifier value
..... value S1..1stringThe value that is unique
... type S1..1codeperson | animal | practitioner | device | medication | substance
Fixed Value: person
... actual S1..1booleanDescriptive or actual
Fixed Value: true
... name S0..1stringLabel for Group
... managingEntity S1..1Reference(Davinci ATR Organization)Entity that is the custodian of the Group's definition
... member S0..*BackboneElementWho or what is in group
.... ext-changeType S0..1codeIndicates 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 S0..1Reference(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 S0..1Reference(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 S1..1Reference(Davinci ATR Patient)Reference to the group member
.... period S0..1PeriodPeriod member belonged to the group
.... inactive S0..1booleanIf member is no longer in group

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group I0..*GroupDavinci ATR Group
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated SΣ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-contractValidityPeriod S0..1PeriodIndicates 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..*ExtensionExtensions 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..*IdentifierUnique id
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ1..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:TAXIdentifier SΣ0..*IdentifierUnique id
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ1..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: TAX
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active SΣ0..1booleanWhether this group's record is in active use
... type SΣ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.


Fixed Value: person
... actual SΣI1..1booleanDescriptive or actual
Fixed Value: true
... code Σ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name SΣ0..1stringLabel for Group
... quantity Σ0..1unsignedIntNumber of members
... managingEntity SΣ1..1Reference(Davinci ATR Organization)Entity that is the custodian of the Group's definition
... characteristic 0..*BackboneElementInclude / Exclude group members by Trait
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1CodeableConceptKind of characteristic
Binding: (unbound) (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.

.... value[x] 1..1Value held by characteristic
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference(Any)
.... exclude 1..1booleanGroup includes or excludes
.... period 0..1PeriodPeriod over which characteristic is tested
... member SI0..*BackboneElementWho or what is in group
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-changeType S0..1codeIndicates 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 S0..1Reference(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 S0..1Reference(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..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity S1..1Reference(Davinci ATR Patient)Reference to the group member
.... period S0..1PeriodPeriod member belonged to the group
.... inactive S0..1booleanIf member is no longer in group

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Group.meta.securityextensibleAll Security Labels
Group.meta.tagexampleCommonTags
Group.languagepreferredCommonLanguages
Max Binding: AllLanguages
Group.identifier:NPIIdentifier.userequiredIdentifierUse
Group.identifier:NPIIdentifier.typeextensibleIdentifier Type Codes
Group.identifier:TAXIdentifier.userequiredIdentifierUse
Group.identifier:TAXIdentifier.typeextensibleIdentifier Type Codes
Group.typerequiredFixed Value: person
Group.codeexample
Group.characteristic.codeexample
Group.characteristic.value[x]example

Constraints

IdPathDetailsRequirements
dom-2GroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3GroupIf 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-4GroupIf 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-5GroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6GroupA resource should have narrative for robust management
: text.`div`.exists()
grp-1GroupCan only have members if group is "actual"
: member.empty() or (actual = true)
ele-1Group.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.meta.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.meta.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.meta.versionIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.meta.lastUpdatedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.meta.sourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.meta.profileAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.meta.securityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.meta.tagAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.extension:contractValidityPeriodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.extension:contractValidityPeriodMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:NPIIdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:NPIIdentifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.identifier:NPIIdentifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.identifier:NPIIdentifier.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:NPIIdentifier.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:NPIIdentifier.type.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.identifier:NPIIdentifier.type.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.identifier:NPIIdentifier.type.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:NPIIdentifier.type.coding.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.identifier:NPIIdentifier.type.coding.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.identifier:NPIIdentifier.type.coding.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:NPIIdentifier.type.coding.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:NPIIdentifier.type.coding.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:NPIIdentifier.type.coding.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:NPIIdentifier.type.coding.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:NPIIdentifier.type.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:NPIIdentifier.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:NPIIdentifier.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:NPIIdentifier.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:NPIIdentifier.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:TAXIdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:TAXIdentifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.identifier:TAXIdentifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.identifier:TAXIdentifier.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:TAXIdentifier.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:TAXIdentifier.type.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.identifier:TAXIdentifier.type.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.identifier:TAXIdentifier.type.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:TAXIdentifier.type.coding.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.identifier:TAXIdentifier.type.coding.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.identifier:TAXIdentifier.type.coding.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:TAXIdentifier.type.coding.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:TAXIdentifier.type.coding.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:TAXIdentifier.type.coding.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:TAXIdentifier.type.coding.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:TAXIdentifier.type.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:TAXIdentifier.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:TAXIdentifier.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:TAXIdentifier.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.identifier:TAXIdentifier.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.actualAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.quantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.managingEntityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.characteristicAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.characteristic.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.characteristic.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.characteristic.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.characteristic.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.characteristic.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.characteristic.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.characteristic.excludeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.characteristic.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.memberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.member.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.member.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.member.extension:changeTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.member.extension:changeTypeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.member.extension:coverageReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.member.extension:coverageReferenceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.member.extension:attributedProviderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.member.extension:attributedProviderMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.member.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Group.member.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Group.member.entityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.member.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Group.member.inactiveAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())