SD.3 StructureDefinition-dpc-profile-attribution-roster

The profile defines the required format for Attribution Rosters submitted by Organizations within the DPC application. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Group resource must have:

  1. Group.active be true
  2. A group type of Person
  3. Group.actual be true
  4. an attributed-to relationship in Group.characteristic
  5. The NPI of the attributed provider in Group.characteristic.valueCodeableConcept
  6. At least one member Reference

SD.3.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-attribution-roster

Published on Wed Apr 21 11:33:40 EDT 2021 as a draft by The DPC Team.

This profile builds on Group


Summary

Mandatory: 3 elements
Fixed Value: 4 elements

Slices

This structure defines the following Slices:

  • The element Group.characteristic.code.coding is sliced based on the value of value:code

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..*GroupGroup of multiple entities
... active 0..1booleanWhether this group's record is in active use
Fixed Value: true
... type 1..1codeperson | animal | practitioner | device | medication | substance
Fixed Value: person
... actual 1..1booleanDescriptive or actual
Fixed Value: true
... characteristic 1..1BackboneElementTrait of group members
.... code
..... coding 0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:code
...... coding:group-characteristic 1..*CodingCode defined by a terminology system
....... code 0..1codeSymbol in syntax defined by the system
Fixed Value: attributed-to
... member 1..*BackboneElementWho or what is in group

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group I0..*GroupGroup of multiple entities
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique id
... active Σ0..1booleanWhether this group's record is in active use
Fixed Value: true
... type Σ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required)
Fixed Value: person
... actual ΣI1..1booleanDescriptive or actual
Fixed Value: true
... code Σ0..1CodeableConceptKind of Group members
Binding: (unbound) (example)
... name Σ0..1stringLabel for Group
... quantity Σ0..1unsignedIntNumber of members
... characteristic I1..1BackboneElementTrait of group members
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... code 1..1CodeableConceptKind of characteristic
Binding: (unbound) (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:code
...... coding:group-characteristic Σ1..*CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriIdentity of the terminology system
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: attributed-to
....... 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
.... value[x] 1..1Value held by characteristic
Binding: (unbound) (example)
..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
.... exclude ?!1..1booleanGroup includes or excludes
.... period 0..1PeriodPeriod over which characteristic is tested
... member I1..*BackboneElementWho or what is in group
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... entity 1..1Reference(Patient | Practitioner | Device | Medication | Substance)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

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron