SecurityAndPrivacy
Class ConsentDirective

This class represents a set of privacy consent directives issued by a consenter on behalf of self or someone else. [HL7 DAM] A Consent Directive is a record of a Subject of Care’s health information privacy policy. A Consent Directive grants or withholds authorization to collect, access, use, or disclose individually identifiable health information about the client. [HL7 CDA]
Note: There used to be a class called "PublishedConsent" the definition of which was: "This specialization of the ConsentDirective class is used to describe a consent directive published to a registry. If a client s consent directive is published, a URL/URI is made available for reference. The client may use this URI to allow providers access to the consent directive created by the consenter." We have moved the uri property to this class and deleted the Published Consent class.

Attributes
«CS» Code category category

"A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements." - HL7 FHIR, Consent.category
Possible values include: Access And Save Only; Access Only; Advance Directive; De-Identified Information Access; Display; Do Not Resuscitate; Emergency Only; Health Care Directive; Information Access; Information Collection; Information Disclosure; Information Redisclosure; Notice Of Privacy Practices; Patient Consent; Physician Orders for Life-Sustaining Treatment; Privacy Policy Acknowledgement Document; Privacy Policy Organization Document; Re-Identifiable Information Access; Release Of Information Consent; Research Information Access.

Consenter consenter consenter

The grantor, which is the entity responsible for granting the rights listed in a Consent Directive.
Note that FHIR has a "performer", which could be a grantor or a grantee. FHIM retains this property, but further elaboration is required, as performer is imprecise.

«TS» PointInTime dateCreated dateCreated

"When this Consent was issued / created / indexed." - HL7 FHIR, Consent.dateTime

«II» Id identifier identifier

Unique identifier that refers to a specific Consent Directive instance. This id or the published URI may be used to lookup the client's consent directives in order to apply them to the collection, access, use, or disclosure of health records.
"Unique identifier for this copy of the Consent Statement." - HL7 FHIR, Consent.identifier

Organization organization organization

"The organization that manages the consent, and the framework within which it is executed." - HL7 FHIR, Consent.organization

Patient patient patient

Identifies the person to whose information assets (i.e., medical records) the consent directive applies. This person may or may not be the same person as the consent author, as in the case where the patient is a minor child or an incapacitated person.
"The patient/healthcare consumer to whom this consent applies." - HL7 FHIR, Consent.patient

Participation performer performer

"Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions." - HL7 FHIR, Consent.performer

Provision provision provision

"An exception to the base policy of this consent. An exception can be an addition or removal of access permissions." - HL7 FHIR, Consent.provision

PrivacyPolicy publishedPolicy publishedPolicy

"The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law." - HL7 FHIR, Consent.policy

«CS» Code scope scope

"A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible." Possible values include: Advanced Care Directive; Research; Privacy Consent; Treatment - HL7 FHIR, Consent.scope

Image sourceAttachment sourceAttachment

This optional attribute references a signed paper document containing the client's consent directive.
"The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document." - HL7 FHIR, Consent.source[x]

«ANY» Any sourceReference sourceReference

"The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document." - HL7 FHIR, Consent.source[x]

«CS» Code status status

Indicates whether the consent directive is active or not.
"Indicates the current state of this consent." Possible values are: Pending; Proposed; Active; Rejected; Inactive; Entered in Error. - HL7 FHIR, Consent.status

Verification verification verification

"Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person." - HL7 FHIR, Consent.verification


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameConsentDirective
Name Expression
NamespaceSecurityAndPrivacy
Owned Template Signature
OwnerSecurityAndPrivacy
Owning Template Parameter
PackageSecurityAndPrivacy
Qualified NameFHIM::SecurityAndPrivacy::ConsentDirective
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 category
Public «CS» Code category

"A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements." - HL7 FHIR, Consent.category
Possible values include: Access And Save Only; Access Only; Advance Directive; De-Identified Information Access; Display; Do Not Resuscitate; Emergency Only; Health Care Directive; Information Access; Information Collection; Information Disclosure; Information Redisclosure; Notice Of Privacy Practices; Patient Consent; Physician Orders for Life-Sustaining Treatment; Privacy Policy Acknowledgement Document; Privacy Policy Organization Document; Re-Identifiable Information Access; Release Of Information Consent; Research Information Access.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassConsentDirective
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1..*
Namecategory
Name Expression
NamespaceConsentDirective
Opposite
OwnerConsentDirective
Owning Association
Owning Template Parameter
Qualified NameFHIM::SecurityAndPrivacy::ConsentDirective::category
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 consenter
Public Consenter consenter

The grantor, which is the entity responsible for granting the rights listed in a Consent Directive.
Note that FHIR has a "performer", which could be a grantor or a grantee. FHIM retains this property, but further elaboration is required, as performer is imprecise.

Constraints:
Properties:

AggregationComposite
Alias
AssociationconsentDirective_consenter
Association End
ClassConsentDirective
Datatype
Default
Default Value
Is Compositetrue
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameconsenter
Name Expression
NamespaceConsentDirective
Opposite
OwnerConsentDirective
Owning Association
Owning Template Parameter
Qualified NameFHIM::SecurityAndPrivacy::ConsentDirective::consenter
Stereotype
Template Parameter
TypeConsenter
Upper*
Upper Value(*)
VisibilityPublic


 dateCreated
Public «TS» PointInTime dateCreated

"When this Consent was issued / created / indexed." - HL7 FHIR, Consent.dateTime

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassConsentDirective
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamedateCreated
Name Expression
NamespaceConsentDirective
Opposite
OwnerConsentDirective
Owning Association
Owning Template Parameter
Qualified NameFHIM::SecurityAndPrivacy::ConsentDirective::dateCreated
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic


 identifier
Public «II» Id identifier

Unique identifier that refers to a specific Consent Directive instance. This id or the published URI may be used to lookup the client's consent directives in order to apply them to the collection, access, use, or disclosure of health records.
"Unique identifier for this copy of the Consent Statement." - HL7 FHIR, Consent.identifier

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassConsentDirective
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Nameidentifier
Name Expression
NamespaceConsentDirective
Opposite
OwnerConsentDirective
Owning Association
Owning Template Parameter
Qualified NameFHIM::SecurityAndPrivacy::ConsentDirective::identifier
Stereotype
Template Parameter
Type«II» Id
Upper1
Upper Value(1)
VisibilityPublic


 organization
Public Organization organization

"The organization that manages the consent, and the framework within which it is executed." - HL7 FHIR, Consent.organization

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassConsentDirective
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameorganization
Name Expression
NamespaceConsentDirective
Opposite
OwnerConsentDirective
Owning Association
Owning Template Parameter
Qualified NameFHIM::SecurityAndPrivacy::ConsentDirective::organization
Stereotype
Template Parameter
TypeOrganization
Upper*
Upper Value(*)
VisibilityPublic


 patient
Public Patient patient

Identifies the person to whose information assets (i.e., medical records) the consent directive applies. This person may or may not be the same person as the consent author, as in the case where the patient is a minor child or an incapacitated person.
"The patient/healthcare consumer to whom this consent applies." - HL7 FHIR, Consent.patient

Constraints:
Properties:

AggregationNone
Alias
AssociationconsentDirective_subjectOfConsent
Association End
ClassConsentDirective
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namepatient
Name Expression
NamespaceConsentDirective
Opposite
OwnerConsentDirective
Owning Association
Owning Template Parameter
Qualified NameFHIM::SecurityAndPrivacy::ConsentDirective::patient
Stereotype
Template Parameter
TypePatient
Upper1
Upper Value(1)
VisibilityPublic


 performer
Public Participation performer

"Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions." - HL7 FHIR, Consent.performer

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassConsentDirective
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameperformer
Name Expression
NamespaceConsentDirective
Opposite
OwnerConsentDirective
Owning Association
Owning Template Parameter
Qualified NameFHIM::SecurityAndPrivacy::ConsentDirective::performer
Stereotype
Template Parameter
TypeParticipation
Upper*
Upper Value(*)
VisibilityPublic


 provision
Public Provision provision

"An exception to the base policy of this consent. An exception can be an addition or removal of access permissions." - HL7 FHIR, Consent.provision

Constraints:
Properties:

AggregationNone
Alias
AssociationconsentDirective_provision
Association End
ClassConsentDirective
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameprovision
Name Expression
NamespaceConsentDirective
Opposite
OwnerConsentDirective
Owning Association
Owning Template Parameter
Qualified NameFHIM::SecurityAndPrivacy::ConsentDirective::provision
Stereotype
Template Parameter
TypeProvision
Upper*
Upper Value(*)
VisibilityPublic


 publishedPolicy
Public PrivacyPolicy publishedPolicy

"The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law." - HL7 FHIR, Consent.policy

Constraints:
Properties:

AggregationNone
Alias
AssociationconsentDirective_publishedPolicy
Association End
ClassConsentDirective
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamepublishedPolicy
Name Expression
NamespaceConsentDirective
Opposite
OwnerConsentDirective
Owning Association
Owning Template Parameter
Qualified NameFHIM::SecurityAndPrivacy::ConsentDirective::publishedPolicy
Stereotype
Template Parameter
TypePrivacyPolicy
Upper1
Upper Value(1)
VisibilityPublic


 scope
Public «CS» Code scope

"A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible." Possible values include: Advanced Care Directive; Research; Privacy Consent; Treatment - HL7 FHIR, Consent.scope

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassConsentDirective
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namescope
Name Expression
NamespaceConsentDirective
Opposite
OwnerConsentDirective
Owning Association
Owning Template Parameter
Qualified NameFHIM::SecurityAndPrivacy::ConsentDirective::scope
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 sourceAttachment
Public Image sourceAttachment

This optional attribute references a signed paper document containing the client's consent directive.
"The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document." - HL7 FHIR, Consent.source[x]

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassConsentDirective
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamesourceAttachment
Name Expression
NamespaceConsentDirective
Opposite
OwnerConsentDirective
Owning Association
Owning Template Parameter
Qualified NameFHIM::SecurityAndPrivacy::ConsentDirective::sourceAttachment
Stereotype
Template Parameter
TypeImage
Upper1
Upper Value(1)
VisibilityPublic


 sourceReference
Public «ANY» Any sourceReference

"The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document." - HL7 FHIR, Consent.source[x]

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassConsentDirective
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamesourceReference
Name Expression
NamespaceConsentDirective
Opposite
OwnerConsentDirective
Owning Association
Owning Template Parameter
Qualified NameFHIM::SecurityAndPrivacy::ConsentDirective::sourceReference
Stereotype
Template Parameter
Type«ANY» Any
Upper1
Upper Value(1)
VisibilityPublic


 status
Public «CS» Code status

Indicates whether the consent directive is active or not.
"Indicates the current state of this consent." Possible values are: Pending; Proposed; Active; Rejected; Inactive; Entered in Error. - HL7 FHIR, Consent.status

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassConsentDirective
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namestatus
Name Expression
NamespaceConsentDirective
Opposite
OwnerConsentDirective
Owning Association
Owning Template Parameter
Qualified NameFHIM::SecurityAndPrivacy::ConsentDirective::status
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 verification
Public Verification verification

"Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person." - HL7 FHIR, Consent.verification

Constraints:
Properties:

AggregationNone
Alias
AssociationconsentDirective_verification
Association End
ClassConsentDirective
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameverification
Name Expression
NamespaceConsentDirective
Opposite
OwnerConsentDirective
Owning Association
Owning Template Parameter
Qualified NameFHIM::SecurityAndPrivacy::ConsentDirective::verification
Stereotype
Template Parameter
TypeVerification
Upper*
Upper Value(*)
VisibilityPublic