| SecurityAndPrivacy UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
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 |
"A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements." - HL7 FHIR, Consent.categoryPossible 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 |
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 |
"When this Consent was issued / created / indexed." - HL7 FHIR, Consent.dateTime |
«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 |
Organization | organization |
"The organization that manages the consent, and the framework within which it is executed." - HL7 FHIR, Consent.organization |
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 |
"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 |
"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 |
"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 |
"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 |
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 |
"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 |
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 |
"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 Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | ConsentDirective |
Name Expression | |
Namespace | SecurityAndPrivacy |
Owned Template Signature | |
Owner | SecurityAndPrivacy |
Owning Template Parameter | |
Package | SecurityAndPrivacy |
Qualified Name | FHIM::SecurityAndPrivacy::ConsentDirective |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
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.categoryPossible 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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ConsentDirective |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1..* |
Name | category |
Name Expression | |
Namespace | ConsentDirective |
Opposite | |
Owner | ConsentDirective |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::SecurityAndPrivacy::ConsentDirective::category |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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.
Aggregation | Composite |
Alias | |
Association | consentDirective_consenter |
Association End | |
Class | ConsentDirective |
Datatype | |
Default | |
Default Value | |
Is Composite | true |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | consenter |
Name Expression | |
Namespace | ConsentDirective |
Opposite | |
Owner | ConsentDirective |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::SecurityAndPrivacy::ConsentDirective::consenter |
Stereotype | |
Template Parameter | |
Type | Consenter |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «TS» PointInTime dateCreated
"When this Consent was issued / created / indexed." - HL7 FHIR, Consent.dateTime
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ConsentDirective |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | dateCreated |
Name Expression | |
Namespace | ConsentDirective |
Opposite | |
Owner | ConsentDirective |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::SecurityAndPrivacy::ConsentDirective::dateCreated |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ConsentDirective |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | identifier |
Name Expression | |
Namespace | ConsentDirective |
Opposite | |
Owner | ConsentDirective |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::SecurityAndPrivacy::ConsentDirective::identifier |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Organization organization
"The organization that manages the consent, and the framework within which it is executed." - HL7 FHIR, Consent.organization
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ConsentDirective |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | organization |
Name Expression | |
Namespace | ConsentDirective |
Opposite | |
Owner | ConsentDirective |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::SecurityAndPrivacy::ConsentDirective::organization |
Stereotype | |
Template Parameter | |
Type | Organization |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | consentDirective_subjectOfConsent |
Association End | |
Class | ConsentDirective |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | patient |
Name Expression | |
Namespace | ConsentDirective |
Opposite | |
Owner | ConsentDirective |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::SecurityAndPrivacy::ConsentDirective::patient |
Stereotype | |
Template Parameter | |
Type | Patient |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ConsentDirective |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | performer |
Name Expression | |
Namespace | ConsentDirective |
Opposite | |
Owner | ConsentDirective |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::SecurityAndPrivacy::ConsentDirective::performer |
Stereotype | |
Template Parameter | |
Type | Participation |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | consentDirective_provision |
Association End | |
Class | ConsentDirective |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | provision |
Name Expression | |
Namespace | ConsentDirective |
Opposite | |
Owner | ConsentDirective |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::SecurityAndPrivacy::ConsentDirective::provision |
Stereotype | |
Template Parameter | |
Type | Provision |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | consentDirective_publishedPolicy |
Association End | |
Class | ConsentDirective |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | publishedPolicy |
Name Expression | |
Namespace | ConsentDirective |
Opposite | |
Owner | ConsentDirective |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::SecurityAndPrivacy::ConsentDirective::publishedPolicy |
Stereotype | |
Template Parameter | |
Type | PrivacyPolicy |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ConsentDirective |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | scope |
Name Expression | |
Namespace | ConsentDirective |
Opposite | |
Owner | ConsentDirective |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::SecurityAndPrivacy::ConsentDirective::scope |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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]
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ConsentDirective |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | sourceAttachment |
Name Expression | |
Namespace | ConsentDirective |
Opposite | |
Owner | ConsentDirective |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::SecurityAndPrivacy::ConsentDirective::sourceAttachment |
Stereotype | |
Template Parameter | |
Type | Image |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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]
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ConsentDirective |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | sourceReference |
Name Expression | |
Namespace | ConsentDirective |
Opposite | |
Owner | ConsentDirective |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::SecurityAndPrivacy::ConsentDirective::sourceReference |
Stereotype | |
Template Parameter | |
Type | «ANY» Any |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ConsentDirective |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | status |
Name Expression | |
Namespace | ConsentDirective |
Opposite | |
Owner | ConsentDirective |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::SecurityAndPrivacy::ConsentDirective::status |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | consentDirective_verification |
Association End | |
Class | ConsentDirective |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | verification |
Name Expression | |
Namespace | ConsentDirective |
Opposite | |
Owner | ConsentDirective |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::SecurityAndPrivacy::ConsentDirective::verification |
Stereotype | |
Template Parameter | |
Type | Verification |
Upper | * |
Upper Value | (*) |
Visibility | Public |
| SecurityAndPrivacy UML Documentation |
Summary:AttributesProperties | Detail:Attributes |