Package org.hl7.fhir.dstu3.model

Class Consent

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.BaseResource

org.hl7.fhir.dstu3.model.Resource

org.hl7.fhir.dstu3.model.DomainResource

org.hl7.fhir.dstu3.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 policy 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 class	Consent.ConsentActorComponent
static class	Consent.ConsentDataComponent
static enum	Consent.ConsentDataMeaning
static class	Consent.ConsentDataMeaningEnumFactory
static enum	Consent.ConsentExceptType
static class	Consent.ConsentExceptTypeEnumFactory
static class	Consent.ConsentPolicyComponent
static enum	Consent.ConsentState
static class	Consent.ConsentStateEnumFactory
static class	Consent.ExceptActorComponent
static class	Consent.ExceptComponent
static class	Consent.ExceptDataComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected List<CodeableConcept>	action	Actions controlled by this consent.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	ACTION	Fluent Client search parameter constant for action
protected List<Consent.ConsentActorComponent>	actor	Who or what is controlled by this consent.
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
protected List<Reference>	consentingParty	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>	consentingPartyTarget	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.ReferenceClientParam	CONSENTOR	Fluent Client search parameter constant for consentor
protected List<Consent.ConsentDataComponent>	data	The resources controlled by this consent, if specific resources are referenced.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DATA	Fluent Client search parameter constant for data
protected Period	dataPeriod	Clinical or Operational Relevant period of time that bounds the data controlled by this consent.
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<Consent.ExceptComponent>	except	An exception to the base policy of this consent.
protected 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	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 Period	period	Relevant time or time-period when this Consent is applicable.
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 UriType	policyRule	A referece to the specific computable policy.
protected List<Coding>	purpose	The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	PURPOSE	Fluent Client search parameter constant for purpose
protected List<Coding>	securityLabel	A set of security labels that define which resources are controlled by this consent.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SECURITYLABEL	Fluent Client search parameter constant for securitylabel
protected Type	source	The source on which this consent statement is based.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SOURCE	Fluent Client search parameter constant for source
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_SECURITYLABEL	Search parameter: securitylabel
static final String	SP_SOURCE	Search parameter: source
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

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, SP_RES_ID

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, Reference patient)	Constructor

Method Summary

Modifier and Type	Method	Description
CodeableConcept	addAction()
Consent	addAction(CodeableConcept t)
Consent.ConsentActorComponent	addActor()
Consent	addActor(Consent.ConsentActorComponent t)
CodeableConcept	addCategory()
Consent	addCategory(CodeableConcept t)
Base	addChild(String name)
Reference	addConsentingParty()
Consent	addConsentingParty(Reference t)
Consent.ConsentDataComponent	addData()
Consent	addData(Consent.ConsentDataComponent t)
Consent.ExceptComponent	addExcept()
Consent	addExcept(Consent.ExceptComponent t)
Reference	addOrganization()
Consent	addOrganization(Reference t)
Organization	addOrganizationTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Consent.ConsentPolicyComponent	addPolicy()
Consent	addPolicy(Consent.ConsentPolicyComponent t)
Coding	addPurpose()
Consent	addPurpose(Coding t)
Coding	addSecurityLabel()
Consent	addSecurityLabel(Coding t)
Consent	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<CodeableConcept>	getAction()
CodeableConcept	getActionFirstRep()
List<Consent.ConsentActorComponent>	getActor()
Consent.ConsentActorComponent	getActorFirstRep()
List<CodeableConcept>	getCategory()
CodeableConcept	getCategoryFirstRep()
List<Reference>	getConsentingParty()
Reference	getConsentingPartyFirstRep()
List<Resource>	getConsentingPartyTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<Consent.ConsentDataComponent>	getData()
Consent.ConsentDataComponent	getDataFirstRep()
Period	getDataPeriod()
Date	getDateTime()
DateTimeType	getDateTimeElement()
List<Consent.ExceptComponent>	getExcept()
Consent.ExceptComponent	getExceptFirstRep()
Identifier	getIdentifier()
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()
Period	getPeriod()
List<Consent.ConsentPolicyComponent>	getPolicy()
Consent.ConsentPolicyComponent	getPolicyFirstRep()
String	getPolicyRule()
UriType	getPolicyRuleElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<Coding>	getPurpose()
Coding	getPurposeFirstRep()
ResourceType	getResourceType()
List<Coding>	getSecurityLabel()
Coding	getSecurityLabelFirstRep()
Type	getSource()
Attachment	getSourceAttachment()
Identifier	getSourceIdentifier()
Reference	getSourceReference()
Consent.ConsentState	getStatus()
Enumeration<Consent.ConsentState>	getStatusElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAction()
boolean	hasActor()
boolean	hasCategory()
boolean	hasConsentingParty()
boolean	hasData()
boolean	hasDataPeriod()
boolean	hasDateTime()
boolean	hasDateTimeElement()
boolean	hasExcept()
boolean	hasIdentifier()
boolean	hasOrganization()
boolean	hasPatient()
boolean	hasPeriod()
boolean	hasPolicy()
boolean	hasPolicyRule()
boolean	hasPolicyRuleElement()
boolean	hasPurpose()
boolean	hasSecurityLabel()
boolean	hasSource()
boolean	hasSourceAttachment()
boolean	hasSourceIdentifier()
boolean	hasSourceReference()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
Consent	setAction(List<CodeableConcept> theAction)
Consent	setActor(List<Consent.ConsentActorComponent> theActor)
Consent	setCategory(List<CodeableConcept> theCategory)
Consent	setConsentingParty(List<Reference> theConsentingParty)
Consent	setData(List<Consent.ConsentDataComponent> theData)
Consent	setDataPeriod(Period value)
Consent	setDateTime(Date value)
Consent	setDateTimeElement(DateTimeType value)
Consent	setExcept(List<Consent.ExceptComponent> theExcept)
Consent	setIdentifier(Identifier value)
Consent	setOrganization(List<Reference> theOrganization)
Consent	setPatient(Reference value)
Consent	setPatientTarget(Patient value)
Consent	setPeriod(Period value)
Consent	setPolicy(List<Consent.ConsentPolicyComponent> thePolicy)
Consent	setPolicyRule(String value)
Consent	setPolicyRuleElement(UriType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Consent	setPurpose(List<Coding> thePurpose)
Consent	setSecurityLabel(List<Coding> theSecurityLabel)
Consent	setSource(Type value)
Consent	setStatus(Consent.ConsentState value)
Consent	setStatusElement(Enumeration<Consent.ConsentState> value)
protected Consent	typedCopy()

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

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

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

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, 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.dstu3.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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, setId

Field Details

identifier

protected Identifier identifier

Unique identifier for this copy of the Consent Statement.

status

protected Enumeration<Consent.ConsentState> status

Indicates the current state of this consent.

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

period

protected Period period

Relevant time or time-period when this Consent is applicable.

dateTime

protected DateTimeType dateTime

When this Consent was issued / created / indexed.

consentingParty

protected List<Reference> consentingParty

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.

consentingPartyTarget

protected List<Resource> consentingPartyTarget

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

actor

protected List<Consent.ConsentActorComponent> actor

Who or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').

action

protected List<CodeableConcept> action

Actions controlled by this consent.

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 UriType policyRule

A referece to the specific computable policy.

securityLabel

protected List<Coding> securityLabel

A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.

purpose

protected List<Coding> purpose

The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.

dataPeriod

protected Period dataPeriod

Clinical or Operational Relevant period of time that bounds the data controlled by this consent.

data

protected List<Consent.ConsentDataComponent> data

The resources controlled by this consent, if specific resources are referenced.

except

protected List<Consent.ExceptComponent> except

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_SECURITYLABEL

public static final String SP_SECURITYLABEL

Search parameter: securitylabel

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

See Also:

• Constant Field Values

SECURITYLABEL

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

Fluent Client search parameter constant for securitylabel

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

SP_PERIOD

public static final String SP_PERIOD

Search parameter: period

Description: Period that this consent applies
Type: date
Path: Consent.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: Period that this consent applies
Type: date
Path: Consent.period

SP_DATA

public static final String SP_DATA

Search parameter: data

Description: The actual data reference
Type: reference
Path: Consent.data.reference, Consent.except.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.data.reference, Consent.except.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 for which the agreement is made
Type: token
Path: Consent.purpose, Consent.except.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 for which the agreement is made
Type: token
Path: Consent.purpose, Consent.except.purpose

SP_SOURCE

public static final String SP_SOURCE

Search parameter: source

Description: Source from which this consent is taken
Type: reference
Path: Consent.source[x]

See Also:

• Constant Field Values

SOURCE

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

Fluent Client search parameter constant for source

Description: Source from which this consent is taken
Type: reference
Path: Consent.source[x]

INCLUDE_SOURCE

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

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

SP_ACTOR

public static final String SP_ACTOR

Search parameter: actor

Description: Resource for the actor (or group, by role)
Type: reference
Path: Consent.actor.reference, Consent.except.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.actor.reference, Consent.except.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_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_ACTION

public static final String SP_ACTION

Search parameter: action

Description: Actions controlled by this consent
Type: token
Path: Consent.action, Consent.except.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 consent
Type: token
Path: Consent.action, Consent.except.action

SP_CONSENTOR

public static final String SP_CONSENTOR

Search parameter: consentor

Description: Who is agreeing to the policy and exceptions
Type: reference
Path: Consent.consentingParty

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 exceptions
Type: reference
Path: Consent.consentingParty

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,
 Reference patient)

Constructor

Method Details

getIdentifier

public Identifier getIdentifier()

Returns:

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

hasIdentifier

public boolean hasIdentifier()

setIdentifier

public Consent setIdentifier(Identifier value)

Parameters:

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

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.

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

getPeriod

public Period getPeriod()

Returns:

period (Relevant time or time-period when this Consent is applicable.)

hasPeriod

public boolean hasPeriod()

setPeriod

public Consent setPeriod(Period value)

Parameters:

value - period (Relevant time or time-period when this Consent is applicable.)

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.

getConsentingParty

public List<Reference> getConsentingParty()

Returns:

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

setConsentingParty

public Consent setConsentingParty(List<Reference> theConsentingParty)

Returns:

Returns a reference to this for easy method chaining

hasConsentingParty

public boolean hasConsentingParty()

addConsentingParty

public Reference addConsentingParty()

addConsentingParty

public Consent addConsentingParty(Reference t)

getConsentingPartyFirstRep

public Reference getConsentingPartyFirstRep()

Returns:

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

getConsentingPartyTarget

@Deprecated
public List<Resource> getConsentingPartyTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getActor

public List<Consent.ConsentActorComponent> getActor()

Returns:

actor (Who or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').)

setActor

public Consent setActor(List<Consent.ConsentActorComponent> theActor)

Returns:

Returns a reference to this for easy method chaining

hasActor

public boolean hasActor()

addActor

public Consent.ConsentActorComponent addActor()

addActor

public Consent addActor(Consent.ConsentActorComponent t)

getActorFirstRep

public Consent.ConsentActorComponent getActorFirstRep()

Returns:

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

getAction

public List<CodeableConcept> getAction()

Returns:

action (Actions controlled by this consent.)

setAction

public Consent setAction(List<CodeableConcept> theAction)

Returns:

Returns a reference to this for easy method chaining

hasAction

public boolean hasAction()

addAction

public CodeableConcept addAction()

addAction

public Consent addAction(CodeableConcept t)

getActionFirstRep

public CodeableConcept getActionFirstRep()

Returns:

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

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

getSourceIdentifier

public Identifier getSourceIdentifier()
                               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

hasSourceIdentifier

public boolean hasSourceIdentifier()

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)
                  throws org.hl7.fhir.exceptions.FHIRFormatError

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

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

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

getPolicyRuleElement

public UriType getPolicyRuleElement()

Returns:

policyRule (A referece to the specific computable policy.). This is the underlying object with id, value and extensions. The accessor "getPolicyRule" gives direct access to the value

hasPolicyRuleElement

public boolean hasPolicyRuleElement()

hasPolicyRule

public boolean hasPolicyRule()

setPolicyRuleElement

public Consent setPolicyRuleElement(UriType value)

Parameters:

value - policyRule (A referece to the specific computable policy.). This is the underlying object with id, value and extensions. The accessor "getPolicyRule" gives direct access to the value

getPolicyRule

public String getPolicyRule()

Returns:

A referece to the specific computable policy.

setPolicyRule

public Consent setPolicyRule(String value)

Parameters:

value - A referece to the specific computable policy.

getSecurityLabel

public List<Coding> getSecurityLabel()

Returns:

securityLabel (A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.)

setSecurityLabel

public Consent setSecurityLabel(List<Coding> theSecurityLabel)

Returns:

Returns a reference to this for easy method chaining

hasSecurityLabel

public boolean hasSecurityLabel()

addSecurityLabel

public Coding addSecurityLabel()

addSecurityLabel

public Consent addSecurityLabel(Coding t)

getSecurityLabelFirstRep

public Coding getSecurityLabelFirstRep()

Returns:

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

getPurpose

public List<Coding> getPurpose()

Returns:

purpose (The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.)

setPurpose

public Consent setPurpose(List<Coding> thePurpose)

Returns:

Returns a reference to this for easy method chaining

hasPurpose

public boolean hasPurpose()

addPurpose

public Coding addPurpose()

addPurpose

public Consent addPurpose(Coding t)

getPurposeFirstRep

public Coding getPurposeFirstRep()

Returns:

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

getDataPeriod

public Period getDataPeriod()

Returns:

dataPeriod (Clinical or Operational Relevant period of time that bounds the data controlled by this consent.)

hasDataPeriod

public boolean hasDataPeriod()

setDataPeriod

public Consent setDataPeriod(Period value)

Parameters:

value - dataPeriod (Clinical or Operational Relevant period of time that bounds the data controlled by this consent.)

getData

public List<Consent.ConsentDataComponent> getData()

Returns:

data (The resources controlled by this consent, if specific resources are referenced.)

setData

public Consent setData(List<Consent.ConsentDataComponent> theData)

Returns:

Returns a reference to this for easy method chaining

hasData

public boolean hasData()

addData

public Consent.ConsentDataComponent addData()

addData

public Consent addData(Consent.ConsentDataComponent t)

getDataFirstRep

public Consent.ConsentDataComponent getDataFirstRep()

Returns:

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

getExcept

public List<Consent.ExceptComponent> getExcept()

Returns:

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

setExcept

public Consent setExcept(List<Consent.ExceptComponent> theExcept)

Returns:

Returns a reference to this for easy method chaining

hasExcept

public boolean hasExcept()

addExcept

public Consent.ExceptComponent addExcept()

addExcept

public Consent addExcept(Consent.ExceptComponent t)

getExceptFirstRep

public Consent.ExceptComponent getExceptFirstRep()

Returns:

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

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

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

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