Data @ the Point of Care Implementation Guide

SD.2 StructureDefinition-dpc-profile-attestation

The profile defines the required format for Attribution Attestations 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:

A Provenance.reason to have the code http://hl7.org/fhir/v3/ActReason#TREAT
A Provenance.recorded with the current date
At least 1 Provenance.agent with the following properties:
- Provenance.agent.role with the code http://hl7.org/fhir/v3/RoleClass#AGNT
- Provenance.agent.who with a reference to the Organization making the attribution request
- Provenance.agent.onBehalfOf with a reference to the Practitioner on which the attribution request is being made for

SD.2.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-attestation

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

This profile builds on Provenance

Summary

Mandatory: 7 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

The element Provenance.reason is sliced based on the values of value:system, value:code
The element Provenance.agent is sliced based on the value of value:role

Differential View

Name	Card.	Type	Description & Constraints
Provenance	0..*	Provenance	Who, What, When for a set of resources
target	0..*	Reference(Resource)	Target Reference(s) (usually version specific)
reason	0..*	(Slice Definition)	Reason the activity is occurring Slice: Unordered, Open by value:system, value:code
reason:provenance-reason	1..1	Coding	Reason the activity is occurring
system	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/v3/ActReason
code	1..1	code	Symbol in syntax defined by the system Fixed Value: TREAT
agent	1..*	(Slice Definition)	Actor involved Slice: Unordered, Open by value:role
agent:performer	1..1	BackboneElement	Actor involved
role	1..*	CodeableConcept	What the agents role was Required Pattern: At least the following
coding	1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/v3/RoleClass
code	1..1	code	Symbol in syntax defined by the system Fixed Value: AGNT
whoReference	1..1	Reference(DPC Organization)	Who participated
onBehalfOfReference	1..1	Reference(DPC Practitioner)	Who the agent is representing
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Provenance	I	0..*	Provenance	Who, What, When for a set of resources
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
target	Σ	0..*	Reference(Resource)	Target Reference(s) (usually version specific)
period		0..1	Period	When the activity occurred
recorded	Σ	1..1	instant	When the activity was recorded / updated
policy		0..*	uri	Policy or plan the activity was defined by
location		0..1	Reference(Location)	Where the activity occurred, if relevant
reason		0..*	(Slice Definition)	Reason the activity is occurring Slice: Unordered, Open by value:system, value:code Binding: PurposeOfUse (extensible)
reason:provenance-reason		1..1	Coding	Reason the activity is occurring Binding: PurposeOfUse (extensible)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/v3/ActReason
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: TREAT
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
activity		0..1	Coding	Activity that occurred Binding: ProvenanceActivityType (extensible)
agent	I	1..*	(Slice Definition)	Actor involved Slice: Unordered, Open by value:role
agent:All Slices				Content/Rules for all slices
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
role	Σ	0..*	CodeableConcept	What the agents role was Binding: SecurityRoleType (extensible)
who[x]	Σ	1..1		Who participated
whoUri			uri
whoReference			Reference(Practitioner \| RelatedPerson \| Patient \| Device \| Organization)
onBehalfOf[x]		0..1		Who the agent is representing
onBehalfOfUri			uri
onBehalfOfReference			Reference(Practitioner \| RelatedPerson \| Patient \| Device \| Organization)
relatedAgentType		0..1	CodeableConcept	Type of relationship between agents Binding: RoleLinkType (example)
agent:performer	I	1..1	BackboneElement	Actor involved
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
role	Σ	1..*	CodeableConcept	What the agents role was Binding: SecurityRoleType (extensible) Required Pattern: At least the following
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/v3/RoleClass
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: AGNT
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
who[x]	Σ	1..1	Reference(DPC Organization)	Who participated
onBehalfOf[x]		1..1	Reference(DPC Practitioner)	Who the agent is representing
relatedAgentType		0..1	CodeableConcept	Type of relationship between agents Binding: RoleLinkType (example)
entity	I	0..*	BackboneElement	An entity used in this activity
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
role	Σ	1..1	code	derivation \| revision \| quotation \| source \| removal Binding: ProvenanceEntityRole (required)
what[x]	Σ	1..1		Identity of entity
whatUri			uri
whatReference			Reference(Resource)
whatIdentifier			Identifier
agent		0..*	See agent	Entity is attributed to this agent
signature		0..*	Signature	Signature on target
Documentation for this format

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