Overview

A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access Consent resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

Source

The Consent resource is derived from the DIRECTIV and related tables in athenaPractice and athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.

This structure is derived from Consent

Name	Flags	Card.	Type	Description & Constraints
Consent		0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
id		1..1	id	Logical id of this artifact
meta		0..1	Meta	Metadata about the resource
Slices for lastUpdated				Content/Rules for all slices
lastUpdated:athena-financialClassMid		1..1	instant	When the resource version last changed
Slices for profile				Content/Rules for all slices
profile:Athena-Consent-Profile		1..1	canonical()	Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-profile
Slices for security		0..2	Coding	Security Labels applied to this resource Slice: Unordered, Open by value:Security Tags
security:SENSITIVE-CHART		0..1	Coding	Security Labels applied to this resource
security:type		0..1	Coding	Security Labels applied to this resource
Slices for system				Content/Rules for all slices
system:uri		1..1	uri	Identity of the terminology system
Slices for code				Content/Rules for all slices
code:code		1..1	code	Symbol in syntax defined by the system
tag		1..2	Coding	Tags applied to this resource
Slices for extension				Content/Rules for all slices
encounter		0..1	(Complex)	Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-extension-encounter
url		1..1	uri	"https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-extension-encounter"
value[x]		1..1	Reference()	Value of extension
period		0..1	(Complex)	Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-extension-period
url		1..1	uri	"https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-extension-period"
value[x]		1..1	Period	Value of extension
identifier		0..*	Identifier	Identifier for this record (external references)
status	S	1..1	code	draft | proposed | active | rejected | inactive | entered-in-error
scope	S	1..1	CodeableConcept	Which of the four areas this resource covers (extensible)
category	S	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval
coding	S	1..1	Coding	Code defined by a terminology system
text	S	1..1	string	Plain text representation of the concept
patient		0..1	Reference(Patient)	Who the consent applies to
dateTime		0..1	dateTime	When this Consent was created or indexed
performer		0..*	Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Who is agreeing to the policy and rules
Documentation for this format

This structure is derived from Consent

Differential View

This structure is derived from Consent

Name	Flags	Card.	Type	Description & Constraints
Consent		0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
id		1..1	id	Logical id of this artifact
meta		0..1	Meta	Metadata about the resource
Slices for lastUpdated				Content/Rules for all slices
lastUpdated:athena-financialClassMid		1..1	instant	When the resource version last changed
Slices for profile				Content/Rules for all slices
profile:Athena-Consent-Profile		1..1	canonical()	Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-profile
Slices for security		0..2	Coding	Security Labels applied to this resource Slice: Unordered, Open by value:Security Tags
security:SENSITIVE-CHART		0..1	Coding	Security Labels applied to this resource
security:type		0..1	Coding	Security Labels applied to this resource
Slices for system				Content/Rules for all slices
system:uri		1..1	uri	Identity of the terminology system
Slices for code				Content/Rules for all slices
code:code		1..1	code	Symbol in syntax defined by the system
tag		1..2	Coding	Tags applied to this resource
Slices for extension				Content/Rules for all slices
encounter		0..1	(Complex)	Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-extension-encounter
url		1..1	uri	"https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-extension-encounter"
value[x]		1..1	Reference()	Value of extension
period		0..1	(Complex)	Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-extension-period
url		1..1	uri	"https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-extension-period"
value[x]		1..1	Period	Value of extension
identifier		0..*	Identifier	Identifier for this record (external references)
status	S	1..1	code	draft | proposed | active | rejected | inactive | entered-in-error
scope	S	1..1	CodeableConcept	Which of the four areas this resource covers (extensible)
category	S	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval
coding	S	1..1	Coding	Code defined by a terminology system
text	S	1..1	string	Plain text representation of the concept
patient		0..1	Reference(Patient)	Who the consent applies to
dateTime		0..1	dateTime	When this Consent was created or indexed
performer		0..*	Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Who is agreeing to the policy and rules
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Consent	C	0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient
id	Σ	1..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
Slices for lastUpdated				Content/Rules for all slices
lastUpdated:athena-financialClassMid	Σ	1..1	instant	When the resource version last changed
Slices for profile				Content/Rules for all slices
profile:Athena-Consent-Profile	Σ	1..1	canonical()	Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-profile
Slices for security	Σ	0..2	Coding	Security Labels applied to this resource Slice: Unordered, Open by value:Security Tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
security:SENSITIVE-CHART	Σ	0..1	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
security:type	Σ	0..1	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for system				Content/Rules for all slices
system:uri	Σ	1..1	uri	Identity of the terminology system
Slices for code				Content/Rules for all slices
code:code	Σ	1..1	code	Symbol in syntax defined by the system
tag	Σ	1..2	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
Slices for extension				Content/Rules for all slices
encounter		0..1	(Complex)	Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-extension-encounter
url		1..1	uri	"https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-extension-encounter"
value[x]		1..1	Reference()	Value of extension
period		0..1	(Complex)	Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-extension-period
url		1..1	uri	"https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-extension-period"
value[x]		1..1	Period	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
status	?!SΣ	1..1	code	draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent.
scope	?!SΣ	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
category	SΣ	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
coding	SΣ	1..1	Coding	Code defined by a terminology system
text	SΣ	1..1	string	Plain text representation of the concept
patient	Σ	0..1	Reference(Patient)	Who the consent applies to
dateTime	Σ	0..1	dateTime	When this Consent was created or indexed
performer	Σ	0..*	Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Who is agreeing to the policy and rules
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Consent.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Consent.meta.security:SENSITIVE-CHART	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Consent.meta.security:type	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Consent.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 from the FHIR Standard
Consent.scope	extensible	ConsentScopeCodes http://hl7.org/fhir/ValueSet/consent-scope from the FHIR Standard
Consent.category	extensible	ConsentCategoryCodes http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Consent	C	0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient
id	Σ	1..1	id	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
Slices for lastUpdated				Content/Rules for all slices
lastUpdated:athena-financialClassMid	Σ	1..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
Slices for profile				Content/Rules for all slices
profile:Athena-Consent-Profile	Σ	1..1	canonical()	Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-profile
Slices for security	Σ	0..2	Coding	Security Labels applied to this resource Slice: Unordered, Open by value:Security Tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
security:SENSITIVE-CHART	Σ	0..1	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
security:type	Σ	0..1	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification 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
Slices for system				Content/Rules for all slices
system:uri	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
Slices for code				Content/Rules for all slices
code:code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag	Σ	1..2	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): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
encounter		0..1	(Complex)	Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-extension-encounter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-extension-encounter"
value[x]		1..1	Reference()	Value of extension
period		0..1	(Complex)	Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-extension-period
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-extension-period"
value[x]		1..1	Period	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
status	?!SΣ	1..1	code	draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent.
scope	?!SΣ	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
category	SΣ	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
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
text	SΣ	1..1	string	Plain text representation of the concept
patient	Σ	0..1	Reference(Patient)	Who the consent applies to
dateTime	Σ	0..1	dateTime	When this Consent was created or indexed
performer	Σ	0..*	Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Who is agreeing to the policy and rules
organization	Σ	0..*	Reference(Organization)	Custodian of the consent
source[x]	Σ	0..1		Source from which this consent is taken
sourceAttachment			Attachment
sourceReference			Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
policy		0..*	BackboneElement	Policies covered by this consent
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
authority	C	0..1	uri	Enforcement source for policy
uri	C	0..1	uri	Specific policy covered by this consent
policyRule	ΣC	0..1	CodeableConcept	Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
verification	Σ	0..*	BackboneElement	Consent Verified by patient or family
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
verified	Σ	1..1	boolean	Has been verified
verifiedWith		0..1	Reference(Patient | RelatedPerson)	Person who verified
verificationDate		0..1	dateTime	When consent verified
provision	Σ	0..1	BackboneElement	Constraints to the base Consent.policyRule
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
type	Σ	0..1	code	deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
period	Σ	0..1	Period	Timeframe for this rule
actor		0..*	BackboneElement	Who|what controlled by this rule (or group, by role)
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
role		1..1	CodeableConcept	How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
reference		1..1	Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Resource for the actor (or group, by role)
action	Σ	0..*	CodeableConcept	Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action.
securityLabel	Σ	0..*	Coding	Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
purpose	Σ	0..*	Coding	Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
class	Σ	0..*	Coding	e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
code	Σ	0..*	CodeableConcept	e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
dataPeriod	Σ	0..1	Period	Timeframe for data controlled by this rule
data	Σ	0..*	BackboneElement	Data controlled by this rule
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
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
reference	Σ	1..1	Reference(Resource)	The actual data reference
provision		0..*	See provision (Consent)	Nested Exception Rules
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Consent.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Consent.meta.security:SENSITIVE-CHART	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Consent.meta.security:type	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Consent.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Consent.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 from the FHIR Standard
Consent.scope	extensible	ConsentScopeCodes http://hl7.org/fhir/ValueSet/consent-scope from the FHIR Standard
Consent.category	extensible	ConsentCategoryCodes http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard
Consent.policyRule	extensible	ConsentPolicyRuleCodes http://hl7.org/fhir/ValueSet/consent-policy from the FHIR Standard
Consent.provision.type	required	ConsentProvisionType http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 from the FHIR Standard
Consent.provision.actor.role	extensible	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Consent.provision.action	example	ConsentActionCodes http://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard
Consent.provision.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Consent.provision.purpose	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.class	extensible	ConsentContentClass http://hl7.org/fhir/ValueSet/consent-content-class from the FHIR Standard
Consent.provision.code	example	ConsentContentCodes (a valid code from LOINC) http://hl7.org/fhir/ValueSet/consent-content-code from the FHIR Standard
Consent.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard

This structure is derived from Consent

HTTP Response Codes

The following HTTP response codes are returned by this API call: