Package org.hl7.fhir.r4.model

Class Consent

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.model.Consent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class Consent
extends DomainResource

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.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Consent.ConsentDataMeaning
static class	Consent.ConsentDataMeaningEnumFactory
static class	Consent.ConsentPolicyComponent
static enum	Consent.ConsentProvisionType
static class	Consent.ConsentProvisionTypeEnumFactory
static enum	Consent.ConsentState
static class	Consent.ConsentStateEnumFactory
static class	Consent.ConsentVerificationComponent
static class	Consent.provisionActorComponent
static class	Consent.provisionComponent
static class	Consent.provisionDataComponent

Field Summary

Fields

Modifier and Type	Field	Description
static final ca.uhn.fhir.rest.gclient.TokenClientParam	ACTION	Fluent Client search parameter constant for action
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ACTOR	Fluent Client search parameter constant for actor
protected List<CodeableConcept>	category	A classification of the type of consents found in the statement.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CATEGORY	Fluent Client search parameter constant for category
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	CONSENTOR	Fluent Client search parameter constant for consentor
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DATA	Fluent Client search parameter constant for data
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
protected DateTimeType	dateTime	When this Consent was issued / created / indexed.
protected List<Identifier>	identifier	Unique identifier for this copy of the Consent Statement.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_ACTOR	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_CONSENTOR	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_DATA	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ORGANIZATION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SOURCE_REFERENCE	Constant for fluent queries to be used to add include statements.
protected List<Reference>	organization	The organization that manages the consent, and the framework within which it is executed.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ORGANIZATION	Fluent Client search parameter constant for organization
protected List<Organization>	organizationTarget	The actual objects that are the target of the reference (The organization that manages the consent, and the framework within which it is executed.)
protected Reference	patient	The patient/healthcare consumer to whom this consent applies.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected Patient	patientTarget	The actual object that is the target of the reference (The patient/healthcare consumer to whom this consent applies.)
protected List<Reference>	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.
protected List<Resource>	performerTarget	The actual objects that are the target of the reference (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.)
static final ca.uhn.fhir.rest.gclient.DateClientParam	PERIOD	Fluent Client search parameter constant for period
protected List<Consent.ConsentPolicyComponent>	policy	The references to the policies that are included in this consent scope.
protected CodeableConcept	policyRule	A reference to the specific base computable regulation or policy.
protected Consent.provisionComponent	provision	An exception to the base policy of this consent.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	PURPOSE	Fluent Client search parameter constant for purpose
protected CodeableConcept	scope	A selector of the type of consent being presented: ADR, Privacy, Treatment, Research.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SCOPE	Fluent Client search parameter constant for scope
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SECURITY_LABEL	Fluent Client search parameter constant for security-label
protected Type	source	The source on which this consent statement is based.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SOURCE_REFERENCE	Fluent Client search parameter constant for source-reference
static final String	SP_ACTION	Search parameter: action
static final String	SP_ACTOR	Search parameter: actor
static final String	SP_CATEGORY	Search parameter: category
static final String	SP_CONSENTOR	Search parameter: consentor
static final String	SP_DATA	Search parameter: data
static final String	SP_DATE	Search parameter: date
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_ORGANIZATION	Search parameter: organization
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_PERIOD	Search parameter: period
static final String	SP_PURPOSE	Search parameter: purpose
static final String	SP_SCOPE	Search parameter: scope
static final String	SP_SECURITY_LABEL	Search parameter: security-label
static final String	SP_SOURCE_REFERENCE	Search parameter: source-reference
static final String	SP_STATUS	Search parameter: status
protected Enumeration<Consent.ConsentState>	status	Indicates the current state of this consent.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected List<Consent.ConsentVerificationComponent>	verification	Whether a treatment instruction (e.g.

Fields inherited from class org.hl7.fhir.r4.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Consent()	Constructor
Consent(Enumeration<Consent.ConsentState> status, CodeableConcept scope)	Constructor

Method Summary

Modifier and Type	Method	Description
CodeableConcept	addCategory()
Consent	addCategory(CodeableConcept t)
Base	addChild(String name)
Identifier	addIdentifier()
Consent	addIdentifier(Identifier t)
Reference	addOrganization()
Consent	addOrganization(Reference t)
Organization	addOrganizationTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Reference	addPerformer()
Consent	addPerformer(Reference t)
Consent.ConsentPolicyComponent	addPolicy()
Consent	addPolicy(Consent.ConsentPolicyComponent t)
Consent.ConsentVerificationComponent	addVerification()
Consent	addVerification(Consent.ConsentVerificationComponent t)
Consent	copy()
void	copyValues(Consent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<CodeableConcept>	getCategory()
CodeableConcept	getCategoryFirstRep()
Date	getDateTime()
DateTimeType	getDateTimeElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Reference>	getOrganization()
Reference	getOrganizationFirstRep()
List<Organization>	getOrganizationTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Reference	getPatient()
Patient	getPatientTarget()
List<Reference>	getPerformer()
Reference	getPerformerFirstRep()
List<Resource>	getPerformerTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<Consent.ConsentPolicyComponent>	getPolicy()
Consent.ConsentPolicyComponent	getPolicyFirstRep()
CodeableConcept	getPolicyRule()
Base[]	getProperty(int hash, String name, boolean checkValid)
Consent.provisionComponent	getProvision()
ResourceType	getResourceType()
CodeableConcept	getScope()
Type	getSource()
Attachment	getSourceAttachment()
Reference	getSourceReference()
Consent.ConsentState	getStatus()
Enumeration<Consent.ConsentState>	getStatusElement()
String[]	getTypesForProperty(int hash, String name)
List<Consent.ConsentVerificationComponent>	getVerification()
Consent.ConsentVerificationComponent	getVerificationFirstRep()
boolean	hasCategory()
boolean	hasDateTime()
boolean	hasDateTimeElement()
boolean	hasIdentifier()
boolean	hasOrganization()
boolean	hasPatient()
boolean	hasPerformer()
boolean	hasPolicy()
boolean	hasPolicyRule()
boolean	hasProvision()
boolean	hasScope()
boolean	hasSource()
boolean	hasSourceAttachment()
boolean	hasSourceReference()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasVerification()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Consent	setCategory(List<CodeableConcept> theCategory)
Consent	setDateTime(Date value)
Consent	setDateTimeElement(DateTimeType value)
Consent	setIdentifier(List<Identifier> theIdentifier)
Consent	setOrganization(List<Reference> theOrganization)
Consent	setPatient(Reference value)
Consent	setPatientTarget(Patient value)
Consent	setPerformer(List<Reference> thePerformer)
Consent	setPolicy(List<Consent.ConsentPolicyComponent> thePolicy)
Consent	setPolicyRule(CodeableConcept value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Consent	setProvision(Consent.provisionComponent value)
Consent	setScope(CodeableConcept value)
Consent	setSource(Type value)
Consent	setStatus(Consent.ConsentState value)
Consent	setStatusElement(Enumeration<Consent.ConsentState> value)
Consent	setVerification(List<Consent.ConsentVerificationComponent> theVerification)
protected Consent	typedCopy()

Methods inherited from class org.hl7.fhir.r4.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r4.model.Resource

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r4.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

Unique identifier for this copy of the Consent Statement.

status

protected Enumeration<Consent.ConsentState> status

Indicates the current state of this consent.

scope

protected CodeableConcept scope

A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.

category

protected List<CodeableConcept> category

A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.

patient

protected Reference patient

The patient/healthcare consumer to whom this consent applies.

patientTarget

protected Patient patientTarget

The actual object that is the target of the reference (The patient/healthcare consumer to whom this consent applies.)

dateTime

protected DateTimeType dateTime

When this Consent was issued / created / indexed.

performer

protected List<Reference> 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.

performerTarget

protected List<Resource> performerTarget

The actual objects that are the target of the reference (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.)

organization

protected List<Reference> organization

The organization that manages the consent, and the framework within which it is executed.

organizationTarget

protected List<Organization> organizationTarget

The actual objects that are the target of the reference (The organization that manages the consent, and the framework within which it is executed.)

source

protected Type source

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.

policy

protected List<Consent.ConsentPolicyComponent> policy

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

policyRule

protected CodeableConcept policyRule

A reference to the specific base computable regulation or policy.

verification

protected List<Consent.ConsentVerificationComponent> verification

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

provision

protected Consent.provisionComponent provision

An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.

SP_DATE

public static final String SP_DATE

Search parameter: date

Description: When this Consent was created or indexed
Type: date
Path: Consent.dateTime

See Also:

• Constant Field Values

DATE

public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE

Fluent Client search parameter constant for date

Description: When this Consent was created or indexed
Type: date
Path: Consent.dateTime

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Identifier for this record (external references)
Type: token
Path: Consent.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: Identifier for this record (external references)
Type: token
Path: Consent.identifier

SP_PERIOD

public static final String SP_PERIOD

Search parameter: period

Description: Timeframe for this rule
Type: date
Path: Consent.provision.period

See Also:

• Constant Field Values

PERIOD

public static final ca.uhn.fhir.rest.gclient.DateClientParam PERIOD

Fluent Client search parameter constant for period

Description: Timeframe for this rule
Type: date
Path: Consent.provision.period

SP_DATA

public static final String SP_DATA

Search parameter: data

Description: The actual data reference
Type: reference
Path: Consent.provision.data.reference

See Also:

• Constant Field Values

DATA

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DATA

Fluent Client search parameter constant for data

Description: The actual data reference
Type: reference
Path: Consent.provision.data.reference

INCLUDE_DATA

public static final ca.uhn.fhir.model.api.Include INCLUDE_DATA

Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:data".

SP_PURPOSE

public static final String SP_PURPOSE

Search parameter: purpose

Description: Context of activities covered by this rule
Type: token
Path: Consent.provision.purpose

See Also:

• Constant Field Values

PURPOSE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam PURPOSE

Fluent Client search parameter constant for purpose

Description: Context of activities covered by this rule
Type: token
Path: Consent.provision.purpose

SP_SOURCE_REFERENCE

public static final String SP_SOURCE_REFERENCE

Search parameter: source-reference

Description: Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse
Type: reference
Path: Consent.source[x]

See Also:

• Constant Field Values

SOURCE_REFERENCE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SOURCE_REFERENCE

Fluent Client search parameter constant for source-reference

Description: Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse
Type: reference
Path: Consent.source[x]

INCLUDE_SOURCE_REFERENCE

public static final ca.uhn.fhir.model.api.Include INCLUDE_SOURCE_REFERENCE

Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:source-reference".

SP_ACTOR

public static final String SP_ACTOR

Search parameter: actor

Description: Resource for the actor (or group, by role)
Type: reference
Path: Consent.provision.actor.reference

See Also:

• Constant Field Values

ACTOR

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ACTOR

Fluent Client search parameter constant for actor

Description: Resource for the actor (or group, by role)
Type: reference
Path: Consent.provision.actor.reference

INCLUDE_ACTOR

public static final ca.uhn.fhir.model.api.Include INCLUDE_ACTOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:actor".

SP_SECURITY_LABEL

public static final String SP_SECURITY_LABEL

Search parameter: security-label

Description: Security Labels that define affected resources
Type: token
Path: Consent.provision.securityLabel

See Also:

• Constant Field Values

SECURITY_LABEL

public static final ca.uhn.fhir.rest.gclient.TokenClientParam SECURITY_LABEL

Fluent Client search parameter constant for security-label

Description: Security Labels that define affected resources
Type: token
Path: Consent.provision.securityLabel

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: Who the consent applies to
Type: reference
Path: Consent.patient

See Also:

• Constant Field Values

PATIENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: Who the consent applies to
Type: reference
Path: Consent.patient

INCLUDE_PATIENT

public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:patient".

SP_ORGANIZATION

public static final String SP_ORGANIZATION

Search parameter: organization

Description: Custodian of the consent
Type: reference
Path: Consent.organization

See Also:

• Constant Field Values

ORGANIZATION

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ORGANIZATION

Fluent Client search parameter constant for organization

Description: Custodian of the consent
Type: reference
Path: Consent.organization

INCLUDE_ORGANIZATION

public static final ca.uhn.fhir.model.api.Include INCLUDE_ORGANIZATION

Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:organization".

SP_SCOPE

public static final String SP_SCOPE

Search parameter: scope

Description: Which of the four areas this resource covers (extensible)
Type: token
Path: Consent.scope

See Also:

• Constant Field Values

SCOPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam SCOPE

Fluent Client search parameter constant for scope

Description: Which of the four areas this resource covers (extensible)
Type: token
Path: Consent.scope

SP_ACTION

public static final String SP_ACTION

Search parameter: action

Description: Actions controlled by this rule
Type: token
Path: Consent.provision.action

See Also:

• Constant Field Values

ACTION

public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACTION

Fluent Client search parameter constant for action

Description: Actions controlled by this rule
Type: token
Path: Consent.provision.action

SP_CONSENTOR

public static final String SP_CONSENTOR

Search parameter: consentor

Description: Who is agreeing to the policy and rules
Type: reference
Path: Consent.performer

See Also:

• Constant Field Values

CONSENTOR

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONSENTOR

Fluent Client search parameter constant for consentor

Description: Who is agreeing to the policy and rules
Type: reference
Path: Consent.performer

INCLUDE_CONSENTOR

public static final ca.uhn.fhir.model.api.Include INCLUDE_CONSENTOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:consentor".

SP_CATEGORY

public static final String SP_CATEGORY

Search parameter: category

Description: Classification of the consent statement - for indexing/retrieval
Type: token
Path: Consent.category

See Also:

• Constant Field Values

CATEGORY

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY

Fluent Client search parameter constant for category

Description: Classification of the consent statement - for indexing/retrieval
Type: token
Path: Consent.category

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: draft | proposed | active | rejected | inactive | entered-in-error
Type: token
Path: Consent.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: draft | proposed | active | rejected | inactive | entered-in-error
Type: token
Path: Consent.status

Constructor Details

Consent

public Consent()

Constructor

Consent

public Consent(Enumeration<Consent.ConsentState> status,
 CodeableConcept scope)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Unique identifier for this copy of the Consent Statement.)

setIdentifier

public Consent setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public Consent addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

getStatusElement

public Enumeration<Consent.ConsentState> getStatusElement()

Returns:

status (Indicates the current state of this consent.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public Consent setStatusElement(Enumeration<Consent.ConsentState> value)

Parameters:

value - status (Indicates the current state of this consent.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Consent.ConsentState getStatus()

Returns:

Indicates the current state of this consent.

setStatus

public Consent setStatus(Consent.ConsentState value)

Parameters:

value - Indicates the current state of this consent.

getScope

public CodeableConcept getScope()

Returns:

scope (A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.)

hasScope

public boolean hasScope()

setScope

public Consent setScope(CodeableConcept value)

Parameters:

value - scope (A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.)

getCategory

public List<CodeableConcept> getCategory()

Returns:

category (A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.)

setCategory

public Consent setCategory(List<CodeableConcept> theCategory)

Returns:

Returns a reference to this for easy method chaining

hasCategory

public boolean hasCategory()

addCategory

public CodeableConcept addCategory()

addCategory

public Consent addCategory(CodeableConcept t)

getCategoryFirstRep

public CodeableConcept getCategoryFirstRep()

Returns:

The first repetition of repeating field category, creating it if it does not already exist

getPatient

public Reference getPatient()

Returns:

patient (The patient/healthcare consumer to whom this consent applies.)

hasPatient

public boolean hasPatient()

setPatient

public Consent setPatient(Reference value)

Parameters:

value - patient (The patient/healthcare consumer to whom this consent applies.)

getPatientTarget

public Patient getPatientTarget()

Returns:

patient The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The patient/healthcare consumer to whom this consent applies.)

setPatientTarget

public Consent setPatientTarget(Patient value)

Parameters:

value - patient The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The patient/healthcare consumer to whom this consent applies.)

getDateTimeElement

public DateTimeType getDateTimeElement()

Returns:

dateTime (When this Consent was issued / created / indexed.). This is the underlying object with id, value and extensions. The accessor "getDateTime" gives direct access to the value

hasDateTimeElement

public boolean hasDateTimeElement()

hasDateTime

public boolean hasDateTime()

setDateTimeElement

public Consent setDateTimeElement(DateTimeType value)

Parameters:

value - dateTime (When this Consent was issued / created / indexed.). This is the underlying object with id, value and extensions. The accessor "getDateTime" gives direct access to the value

getDateTime

public Date getDateTime()

Returns:

When this Consent was issued / created / indexed.

setDateTime

public Consent setDateTime(Date value)

Parameters:

value - When this Consent was issued / created / indexed.

getPerformer

public List<Reference> getPerformer()

Returns:

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.)

setPerformer

public Consent setPerformer(List<Reference> thePerformer)

Returns:

Returns a reference to this for easy method chaining

hasPerformer

public boolean hasPerformer()

addPerformer

public Reference addPerformer()

addPerformer

public Consent addPerformer(Reference t)

getPerformerFirstRep

public Reference getPerformerFirstRep()

Returns:

The first repetition of repeating field performer, creating it if it does not already exist

getPerformerTarget

@Deprecated
public List<Resource> getPerformerTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getOrganization

public List<Reference> getOrganization()

Returns:

organization (The organization that manages the consent, and the framework within which it is executed.)

setOrganization

public Consent setOrganization(List<Reference> theOrganization)

Returns:

Returns a reference to this for easy method chaining

hasOrganization

public boolean hasOrganization()

addOrganization

public Reference addOrganization()

addOrganization

public Consent addOrganization(Reference t)

getOrganizationFirstRep

public Reference getOrganizationFirstRep()

Returns:

The first repetition of repeating field organization, creating it if it does not already exist

getOrganizationTarget

@Deprecated
public List<Organization> getOrganizationTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addOrganizationTarget

@Deprecated
public Organization addOrganizationTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getSource

public Type getSource()

Returns:

source (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.)

getSourceAttachment

public Attachment getSourceAttachment()
                               throws org.hl7.fhir.exceptions.FHIRException

Returns:

source (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.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasSourceAttachment

public boolean hasSourceAttachment()

getSourceReference

public Reference getSourceReference()
                             throws org.hl7.fhir.exceptions.FHIRException

Returns:

source (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.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasSourceReference

public boolean hasSourceReference()

hasSource

public boolean hasSource()

setSource

public Consent setSource(Type value)

Parameters:

value - source (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.)

getPolicy

public List<Consent.ConsentPolicyComponent> getPolicy()

Returns:

policy (The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.)

setPolicy

public Consent setPolicy(List<Consent.ConsentPolicyComponent> thePolicy)

Returns:

Returns a reference to this for easy method chaining

hasPolicy

public boolean hasPolicy()

addPolicy

public Consent.ConsentPolicyComponent addPolicy()

addPolicy

public Consent addPolicy(Consent.ConsentPolicyComponent t)

getPolicyFirstRep

public Consent.ConsentPolicyComponent getPolicyFirstRep()

Returns:

The first repetition of repeating field policy, creating it if it does not already exist

getPolicyRule

public CodeableConcept getPolicyRule()

Returns:

policyRule (A reference to the specific base computable regulation or policy.)

hasPolicyRule

public boolean hasPolicyRule()

setPolicyRule

public Consent setPolicyRule(CodeableConcept value)

Parameters:

value - policyRule (A reference to the specific base computable regulation or policy.)

getVerification

public List<Consent.ConsentVerificationComponent> getVerification()

Returns:

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

setVerification

public Consent setVerification(List<Consent.ConsentVerificationComponent> theVerification)

Returns:

Returns a reference to this for easy method chaining

hasVerification

public boolean hasVerification()

addVerification

public Consent.ConsentVerificationComponent addVerification()

addVerification

public Consent addVerification(Consent.ConsentVerificationComponent t)

getVerificationFirstRep

public Consent.ConsentVerificationComponent getVerificationFirstRep()

Returns:

The first repetition of repeating field verification, creating it if it does not already exist

getProvision

public Consent.provisionComponent getProvision()

Returns:

provision (An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.)

hasProvision

public boolean hasProvision()

setProvision

public Consent setProvision(Consent.provisionComponent value)

Parameters:

value - provision (An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public Consent copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(Consent dst)

typedCopy

protected Consent typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource