Consent class
Consent A record of a healthcare consumer’s choices or choices made on their behalf by a third party, 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.
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
Consent({@Default(R5ResourceType.Consent) @JsonKey(unknownEnumValue: R5ResourceType.Consent) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<
Resource> ? contained, @JsonKey(name: 'extension') List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, List<Identifier> ? identifier, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, List<CodeableConcept> ? category, Reference? subject, FhirDate? date, @JsonKey(name: '_date') Element? dateElement, Period? period, List<Reference> ? grantor, List<Reference> ? grantee, List<Reference> ? manager, List<Reference> ? controller, List<Attachment> ? sourceAttachment, List<Reference> ? sourceReference, List<CodeableConcept> ? regulatoryBasis, ConsentPolicyBasis? policyBasis, List<Reference> ? policyText, List<ConsentVerification> ? verification, FhirCode? decision, @JsonKey(name: '_decision') Element? decisionElement, List<ConsentProvision> ? provision}) -
Consent A record of a healthcare consumer’s choices or choices made
on their behalf by a third party, 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.
constfactory
-
Consent.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- Consent.fromJsonString(String source)
-
Acts like a constructor, returns a Consent, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- Consent.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
-
category
→ List<
CodeableConcept> ? -
category A classification of the type of consents found in the
statement. This element supports indexing and retrieval of consent
statements.
no setterinherited
-
contained
→ List<
Resource> ? -
contained These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, nor can they have their own independent transaction
scope. This is allowed to be a Parameters resource if and only if it
is referenced by a resource that provides context/meaning.
no setterinherited
-
controller
→ List<
Reference> ? -
controller The actor that controls/enforces the access according to
the consent.
no setterinherited
-
copyWith
→ $ConsentCopyWith<
Consent> -
no setterinherited
- date → FhirDate?
-
date Date the consent instance was agreed to.
no setterinherited
- dateElement → Element?
-
dateElement ("_date") Extensions for date
no setterinherited
- dbId → int?
-
no setterinherited
- decision → FhirCode?
-
decision Action to take - permit or deny - as default.
no setterinherited
- decisionElement → Element?
-
decisionElement ("_decision") Extensions for decision
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
extension_ ("extension") May be used to represent additional
information that is not part of the basic definition of the resource.
To make the use of extensions safe and managable, there is a strict
set of governance applied to the definition and use of extensions.
Though any implementer can define an extension, there is a set of
requirements that SHALL be met as part of the definition of the
extension.
no setterinherited
- fhirId → FhirId?
-
id The logical id of the resource, as used in the URL for the
resource. Once assigned, this value never changes.
no setterinherited
-
grantee
→ List<
Reference> ? -
grantee The entity responsible for complying with the Consent
Directive, including any obligations or limitations on authorizations
and enforcement of prohibitions.
no setterinherited
-
grantor
→ List<
Reference> ? -
grantor The entity responsible for granting the rights listed in a
Consent Directive.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ List<
Identifier> ? -
identifier Unique identifier for this copy of the Consent Statement.
no setterinherited
- implicitRules → FhirUri?
-
implicitRules A reference to a set of rules that were followed when
the resource was constructed, and which must be understood when
processing the content. Often, this is a reference to an
implementation guide that defines the special rules along with other
profiles etc.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement ("_language") Extensions for language
no setterinherited
-
manager
→ List<
Reference> ? -
manager The actor that manages the consent through its lifecycle.
no setterinherited
- meta → FhirMeta?
-
meta The metadata about the resource. This is content that is
maintained by the infrastructure. Changes to the content might not
always be associated with version changes to the resource.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
modifierExtension May be used to represent additional information
that is not part of the basic definition of the resource and that
modifies the understanding of the element that contains it and/or the
understanding of the containing element's descendants. Usually
modifier elements provide negation or qualification. To make the use
of extensions safe and managable, there is a strict set of governance
applied to the definition and use of extensions. Though any
implementer is allowed to define an extension, there is a set of
requirements that SHALL be met as part of the definition of the
extension. Applications processing a resource are required to check
for modifier extensions.Modifier extensions SHALL NOT change the
meaning of any elements on Resource or DomainResource (including
cannot change the meaning of modifierExtension itself).
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
- period → Period?
-
period Effective period for this Consent Resource and all provisions
unless specified in that provision.
no setterinherited
- policyBasis → ConsentPolicyBasis?
-
policyBasis A Reference or URL used to uniquely identify the policy
the organization will enforce for this Consent. This Reference or URL
should be specific to the version of the policy and should be
dereferencable to a computable policy of some form.
no setterinherited
-
policyText
→ List<
Reference> ? -
policyText A Reference to the human readable policy explaining the
basis for the Consent.
no setterinherited
-
provision
→ List<
ConsentProvision> ? -
provision An exception to the base policy of this consent. An
exception can be an addition or removal of access permissions.
no setterinherited
-
regulatoryBasis
→ List<
CodeableConcept> ? -
regulatoryBasis A set of codes that indicate the regulatory basis (if
any) that this consent supports.
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a Consent resource
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sourceAttachment
→ List<
Attachment> ? -
sourceAttachment The source on which this consent statement is based.
The source might be a scanned original paper form.
no setterinherited
-
sourceReference
→ List<
Reference> ? -
sourceReference 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.
no setterinherited
- status → FhirCode?
-
status Indicates the current state of this Consent resource.
no setterinherited
- statusElement → Element?
-
statusElement ("_status") Extensions for status
no setterinherited
- subject → Reference?
-
subject The patient/healthcare practitioner or group of persons to
whom this consent applies.
no setterinherited
- text → Narrative?
-
text A human-readable narrative that contains a summary of the
resource and can be used to represent the content of the resource to a
human. The narrative need not encode all the structured data, but is
required to contain sufficient detail to make it "clinically safe" for
a human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
-
verification
→ List<
ConsentVerification> ? -
verification Whether a treatment instruction (e.g. artificial
respiration: yes or no) was verified with the patient, his/her family
or another authorized person.
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
override
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited