Package org.hl7.fhir.r5.model

Class Consent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.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 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.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Consent.ConsentPolicyBasisComponent
static enum	Consent.ConsentState
static class	Consent.ConsentStateEnumFactory
static class	Consent.ConsentVerificationComponent
static class	Consent.ProvisionActorComponent
static class	Consent.ProvisionComponent
static class	Consent.ProvisionDataComponent

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

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
protected List<Reference>	controller	The actor that controls/enforces the access according to the consent.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	CONTROLLER	Fluent Client search parameter constant for controller
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DATA	Fluent Client search parameter constant for data
protected DateType	date	Date the consent instance was agreed to.
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
protected Enumeration<Enumerations.ConsentProvisionType>	decision	Action to take - permit or deny - as default.
protected List<Reference>	grantee	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	GRANTEE	Fluent Client search parameter constant for grantee
protected List<Reference>	grantor	The entity responsible for granting the rights listed in a Consent Directive.
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_CONTROLLER	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_GRANTEE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_MANAGER	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.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUBJECT	Constant for fluent queries to be used to add include statements.
protected List<Reference>	manager	The actor that manages the consent through its lifecycle.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	MANAGER	Fluent Client search parameter constant for manager
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected Period	period	Effective period for this Consent Resource and all provisions unless specified in that provision.
static final ca.uhn.fhir.rest.gclient.DateClientParam	PERIOD	Fluent Client search parameter constant for period
protected Consent.ConsentPolicyBasisComponent	policyBasis	A Reference or URL used to uniquely identify the policy the organization will enforce for this Consent.
protected List<Reference>	policyText	A Reference to the human readable policy explaining the basis for the Consent.
protected List<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 List<CodeableConcept>	regulatoryBasis	A set of codes that indicate the regulatory basis (if any) that this consent supports.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SECURITY_LABEL	Fluent Client search parameter constant for security-label
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SOURCE_REFERENCE	Fluent Client search parameter constant for source-reference
protected List<Attachment>	sourceAttachment	The source on which this consent statement is based.
protected List<Reference>	sourceReference	A reference to a consent that links back to such a source, a reference to a document repository (e.g.
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_CONTROLLER	Search parameter: controller
static final String	SP_DATA	Search parameter: data
static final String	SP_DATE	Search parameter: date
static final String	SP_GRANTEE	Search parameter: grantee
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_MANAGER	Search parameter: manager
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_SECURITY_LABEL	Search parameter: security-label
static final String	SP_SOURCE_REFERENCE	Search parameter: source-reference
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUBJECT	Search parameter: subject
static final String	SP_VERIFIED	Search parameter: verified
static final String	SP_VERIFIED_DATE	Search parameter: verified-date
protected Enumeration<Consent.ConsentState>	status	Indicates the current state of this Consent resource.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected Reference	subject	The patient/healthcare practitioner or group of persons to whom this consent applies.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject
protected List<Consent.ConsentVerificationComponent>	verification	Whether a treatment instruction (e.g.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	VERIFIED	Fluent Client search parameter constant for verified
static final ca.uhn.fhir.rest.gclient.DateClientParam	VERIFIED_DATE	Fluent Client search parameter constant for verified-date

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

contained, extension, modifierExtension, SP_TEXT, text, TEXT

Fields inherited from class org.hl7.fhir.r5.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(Consent.ConsentState status)	Constructor

Method Summary

Modifier and Type	Method	Description
CodeableConcept	addCategory()
Consent	addCategory(CodeableConcept t)
Base	addChild(String name)
Reference	addController()
Consent	addController(Reference t)
Reference	addGrantee()
Consent	addGrantee(Reference t)
Reference	addGrantor()
Consent	addGrantor(Reference t)
Identifier	addIdentifier()
Consent	addIdentifier(Identifier t)
Reference	addManager()
Consent	addManager(Reference t)
Reference	addPolicyText()
Consent	addPolicyText(Reference t)
Consent.ProvisionComponent	addProvision()
Consent	addProvision(Consent.ProvisionComponent t)
CodeableConcept	addRegulatoryBasis()
Consent	addRegulatoryBasis(CodeableConcept t)
Attachment	addSourceAttachment()
Consent	addSourceAttachment(Attachment t)
Reference	addSourceReference()
Consent	addSourceReference(Reference 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()
List<Reference>	getController()
Reference	getControllerFirstRep()
Date	getDate()
DateType	getDateElement()
Enumerations.ConsentProvisionType	getDecision()
Enumeration<Enumerations.ConsentProvisionType>	getDecisionElement()
List<Reference>	getGrantee()
Reference	getGranteeFirstRep()
List<Reference>	getGrantor()
Reference	getGrantorFirstRep()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<Reference>	getManager()
Reference	getManagerFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Period	getPeriod()
Consent.ConsentPolicyBasisComponent	getPolicyBasis()
List<Reference>	getPolicyText()
Reference	getPolicyTextFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<Consent.ProvisionComponent>	getProvision()
Consent.ProvisionComponent	getProvisionFirstRep()
List<CodeableConcept>	getRegulatoryBasis()
CodeableConcept	getRegulatoryBasisFirstRep()
ResourceType	getResourceType()
List<Attachment>	getSourceAttachment()
Attachment	getSourceAttachmentFirstRep()
List<Reference>	getSourceReference()
Reference	getSourceReferenceFirstRep()
Consent.ConsentState	getStatus()
Enumeration<Consent.ConsentState>	getStatusElement()
Reference	getSubject()
String[]	getTypesForProperty(int hash, String name)
List<Consent.ConsentVerificationComponent>	getVerification()
Consent.ConsentVerificationComponent	getVerificationFirstRep()
boolean	hasCategory()
boolean	hasController()
boolean	hasDate()
boolean	hasDateElement()
boolean	hasDecision()
boolean	hasDecisionElement()
boolean	hasGrantee()
boolean	hasGrantor()
boolean	hasIdentifier()
boolean	hasManager()
boolean	hasPeriod()
boolean	hasPolicyBasis()
boolean	hasPolicyText()
boolean	hasProvision()
boolean	hasRegulatoryBasis()
boolean	hasSourceAttachment()
boolean	hasSourceReference()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
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	setController(List<Reference> theController)
Consent	setDate(Date value)
Consent	setDateElement(DateType value)
Consent	setDecision(Enumerations.ConsentProvisionType value)
Consent	setDecisionElement(Enumeration<Enumerations.ConsentProvisionType> value)
Consent	setGrantee(List<Reference> theGrantee)
Consent	setGrantor(List<Reference> theGrantor)
Consent	setIdentifier(List<Identifier> theIdentifier)
Consent	setManager(List<Reference> theManager)
Consent	setPeriod(Period value)
Consent	setPolicyBasis(Consent.ConsentPolicyBasisComponent value)
Consent	setPolicyText(List<Reference> thePolicyText)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Consent	setProvision(List<Consent.ProvisionComponent> theProvision)
Consent	setRegulatoryBasis(List<CodeableConcept> theRegulatoryBasis)
Consent	setSourceAttachment(List<Attachment> theSourceAttachment)
Consent	setSourceReference(List<Reference> theSourceReference)
Consent	setStatus(Consent.ConsentState value)
Consent	setStatusElement(Enumeration<Consent.ConsentState> value)
Consent	setSubject(Reference value)
Consent	setVerification(List<Consent.ConsentVerificationComponent> theVerification)
protected Consent	typedCopy()

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

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

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

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

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

getStructureFhirVersionEnum, isResource, setId

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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 resource.

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.

subject

protected Reference subject

The patient/healthcare practitioner or group of persons to whom this consent applies.

date

protected DateType date

Date the consent instance was agreed to.

period

protected Period period

Effective period for this Consent Resource and all provisions unless specified in that provision.

grantor

protected List<Reference> grantor

The entity responsible for granting the rights listed in a Consent Directive.

grantee

protected List<Reference> grantee

The entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.

manager

protected List<Reference> manager

The actor that manages the consent through its lifecycle.

controller

protected List<Reference> controller

The actor that controls/enforces the access according to the consent.

sourceAttachment

protected List<Attachment> sourceAttachment

The source on which this consent statement is based. The source might be a scanned original paper form.

sourceReference

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

regulatoryBasis

protected List<CodeableConcept> regulatoryBasis

A set of codes that indicate the regulatory basis (if any) that this consent supports.

policyBasis

protected Consent.ConsentPolicyBasisComponent 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.

policyText

protected List<Reference> policyText

A Reference to the human readable policy explaining the basis for the Consent.

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.

decision

protected Enumeration<Enumerations.ConsentProvisionType> decision

Action to take - permit or deny - as default.

provision

protected List<Consent.ProvisionComponent> provision

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

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_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_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_CONTROLLER

public static final String SP_CONTROLLER

Search parameter: controller

Description: Consent Enforcer
Type: reference
Path: Consent.controller

See Also:

• Constant Field Values

CONTROLLER

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

Fluent Client search parameter constant for controller

Description: Consent Enforcer
Type: reference
Path: Consent.controller

INCLUDE_CONTROLLER

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

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

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_GRANTEE

public static final String SP_GRANTEE

Search parameter: grantee

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

See Also:

• Constant Field Values

GRANTEE

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

Fluent Client search parameter constant for grantee

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

INCLUDE_GRANTEE

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

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

SP_MANAGER

public static final String SP_MANAGER

Search parameter: manager

Description: Consent workflow management
Type: reference
Path: Consent.manager

See Also:

• Constant Field Values

MANAGER

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

Fluent Client search parameter constant for manager

Description: Consent workflow management
Type: reference
Path: Consent.manager

INCLUDE_MANAGER

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

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

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_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_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_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.sourceReference

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

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_STATUS

public static final String SP_STATUS

Search parameter: status

Description: draft | active | inactive | entered-in-error | unknown
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 | active | inactive | entered-in-error | unknown
Type: token
Path: Consent.status

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

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

See Also:

• Constant Field Values

SUBJECT

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

Fluent Client search parameter constant for subject

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

INCLUDE_SUBJECT

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

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

SP_VERIFIED_DATE

public static final String SP_VERIFIED_DATE

Search parameter: verified-date

Description: When consent verified
Type: date
Path: Consent.verification.verificationDate

See Also:

• Constant Field Values

VERIFIED_DATE

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

Fluent Client search parameter constant for verified-date

Description: When consent verified
Type: date
Path: Consent.verification.verificationDate

SP_VERIFIED

public static final String SP_VERIFIED

Search parameter: verified

Description: Has been verified
Type: token
Path: Consent.verification.verified

See Also:

• Constant Field Values

VERIFIED

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

Fluent Client search parameter constant for verified

Description: Has been verified
Type: token
Path: Consent.verification.verified

SP_DATE

public static final String SP_DATE

Search parameter: date

Description: Multiple Resources: [AdverseEvent](adverseevent.html): When the event occurred [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [Appointment](appointment.html): Appointment date/time. [AuditEvent](auditevent.html): Time when the event was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [DocumentReference](documentreference.html): When this document reference was created [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [ImmunizationEvaluation](immunizationevaluation.html): Date the evaluation was generated [ImmunizationRecommendation](immunizationrecommendation.html): Date recommendation(s) created [Invoice](invoice.html): Invoice date / posting date [List](list.html): When the list was prepared [MeasureReport](measurereport.html): The date of the measure report [NutritionIntake](nutritionintake.html): Date when patient was taking (or not taking) the medication [Observation](observation.html): Clinically relevant time/time-period for observation [Procedure](procedure.html): When the procedure occurred or is occurring [ResearchSubject](researchsubject.html): Start and end of participation [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AdverseEvent.occurrence.ofType(dateTime) | AdverseEvent.occurrence.ofType(Period) | AdverseEvent.occurrence.ofType(Timing) | AllergyIntolerance.recordedDate | (start | requestedPeriod.start).first() | AuditEvent.recorded | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.date | DiagnosticReport.effective.ofType(dateTime) | DiagnosticReport.effective.ofType(Period) | DocumentReference.date | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence.ofType(dateTime)) | ImmunizationEvaluation.date | ImmunizationRecommendation.date | Invoice.date | List.date | MeasureReport.date | NutritionIntake.occurrence.ofType(dateTime) | NutritionIntake.occurrence.ofType(Period) | Observation.effective.ofType(dateTime) | Observation.effective.ofType(Period) | Observation.effective.ofType(Timing) | Observation.effective.ofType(instant) | Procedure.occurrence.ofType(dateTime) | Procedure.occurrence.ofType(Period) | Procedure.occurrence.ofType(Timing) | ResearchSubject.period | (RiskAssessment.occurrence.ofType(dateTime)) | SupplyRequest.authoredOn

See Also:

• Constant Field Values

DATE

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

Fluent Client search parameter constant for date

Description: Multiple Resources: [AdverseEvent](adverseevent.html): When the event occurred [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [Appointment](appointment.html): Appointment date/time. [AuditEvent](auditevent.html): Time when the event was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [DocumentReference](documentreference.html): When this document reference was created [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [ImmunizationEvaluation](immunizationevaluation.html): Date the evaluation was generated [ImmunizationRecommendation](immunizationrecommendation.html): Date recommendation(s) created [Invoice](invoice.html): Invoice date / posting date [List](list.html): When the list was prepared [MeasureReport](measurereport.html): The date of the measure report [NutritionIntake](nutritionintake.html): Date when patient was taking (or not taking) the medication [Observation](observation.html): Clinically relevant time/time-period for observation [Procedure](procedure.html): When the procedure occurred or is occurring [ResearchSubject](researchsubject.html): Start and end of participation [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AdverseEvent.occurrence.ofType(dateTime) | AdverseEvent.occurrence.ofType(Period) | AdverseEvent.occurrence.ofType(Timing) | AllergyIntolerance.recordedDate | (start | requestedPeriod.start).first() | AuditEvent.recorded | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.date | DiagnosticReport.effective.ofType(dateTime) | DiagnosticReport.effective.ofType(Period) | DocumentReference.date | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence.ofType(dateTime)) | ImmunizationEvaluation.date | ImmunizationRecommendation.date | Invoice.date | List.date | MeasureReport.date | NutritionIntake.occurrence.ofType(dateTime) | NutritionIntake.occurrence.ofType(Period) | Observation.effective.ofType(dateTime) | Observation.effective.ofType(Period) | Observation.effective.ofType(Timing) | Observation.effective.ofType(instant) | Procedure.occurrence.ofType(dateTime) | Procedure.occurrence.ofType(Period) | Procedure.occurrence.ofType(Timing) | ResearchSubject.period | (RiskAssessment.occurrence.ofType(dateTime)) | SupplyRequest.authoredOn

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.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: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.identifier

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.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: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.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".

Constructor Details

Consent

public Consent()

Constructor

Consent

public Consent(Consent.ConsentState status)

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 {3}

getStatusElement

public Enumeration<Consent.ConsentState> getStatusElement()

Returns:

status (Indicates the current state of this Consent resource.). 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 resource.). 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 resource.

setStatus

public Consent setStatus(Consent.ConsentState value)

Parameters:

value - Indicates the current state of this Consent resource.

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 {3}

getSubject

public Reference getSubject()

Returns:

subject (The patient/healthcare practitioner or group of persons to whom this consent applies.)

hasSubject

public boolean hasSubject()

setSubject

public Consent setSubject(Reference value)

Parameters:

value - subject (The patient/healthcare practitioner or group of persons to whom this consent applies.)

getDateElement

public DateType getDateElement()

Returns:

date (Date the consent instance was agreed to.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

hasDateElement

public boolean hasDateElement()

hasDate

public boolean hasDate()

setDateElement

public Consent setDateElement(DateType value)

Parameters:

value - date (Date the consent instance was agreed to.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

getDate

public Date getDate()

Returns:

Date the consent instance was agreed to.

setDate

public Consent setDate(Date value)

Parameters:

value - Date the consent instance was agreed to.

getPeriod

public Period getPeriod()

Returns:

period (Effective period for this Consent Resource and all provisions unless specified in that provision.)

hasPeriod

public boolean hasPeriod()

setPeriod

public Consent setPeriod(Period value)

Parameters:

value - period (Effective period for this Consent Resource and all provisions unless specified in that provision.)

getGrantor

public List<Reference> getGrantor()

Returns:

grantor (The entity responsible for granting the rights listed in a Consent Directive.)

setGrantor

public Consent setGrantor(List<Reference> theGrantor)

Returns:

Returns a reference to this for easy method chaining

hasGrantor

public boolean hasGrantor()

addGrantor

public Reference addGrantor()

addGrantor

public Consent addGrantor(Reference t)

getGrantorFirstRep

public Reference getGrantorFirstRep()

Returns:

The first repetition of repeating field grantor, creating it if it does not already exist {3}

getGrantee

public List<Reference> getGrantee()

Returns:

grantee (The entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.)

setGrantee

public Consent setGrantee(List<Reference> theGrantee)

Returns:

Returns a reference to this for easy method chaining

hasGrantee

public boolean hasGrantee()

addGrantee

public Reference addGrantee()

addGrantee

public Consent addGrantee(Reference t)

getGranteeFirstRep

public Reference getGranteeFirstRep()

Returns:

The first repetition of repeating field grantee, creating it if it does not already exist {3}

getManager

public List<Reference> getManager()

Returns:

manager (The actor that manages the consent through its lifecycle.)

setManager

public Consent setManager(List<Reference> theManager)

Returns:

Returns a reference to this for easy method chaining

hasManager

public boolean hasManager()

addManager

public Reference addManager()

addManager

public Consent addManager(Reference t)

getManagerFirstRep

public Reference getManagerFirstRep()

Returns:

The first repetition of repeating field manager, creating it if it does not already exist {3}

getController

public List<Reference> getController()

Returns:

controller (The actor that controls/enforces the access according to the consent.)

setController

public Consent setController(List<Reference> theController)

Returns:

Returns a reference to this for easy method chaining

hasController

public boolean hasController()

addController

public Reference addController()

addController

public Consent addController(Reference t)

getControllerFirstRep

public Reference getControllerFirstRep()

Returns:

The first repetition of repeating field controller, creating it if it does not already exist {3}

getSourceAttachment

public List<Attachment> getSourceAttachment()

Returns:

sourceAttachment (The source on which this consent statement is based. The source might be a scanned original paper form.)

setSourceAttachment

public Consent setSourceAttachment(List<Attachment> theSourceAttachment)

Returns:

Returns a reference to this for easy method chaining

hasSourceAttachment

public boolean hasSourceAttachment()

addSourceAttachment

public Attachment addSourceAttachment()

addSourceAttachment

public Consent addSourceAttachment(Attachment t)

getSourceAttachmentFirstRep

public Attachment getSourceAttachmentFirstRep()

Returns:

The first repetition of repeating field sourceAttachment, creating it if it does not already exist {3}

getSourceReference

public List<Reference> getSourceReference()

Returns:

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

setSourceReference

public Consent setSourceReference(List<Reference> theSourceReference)

Returns:

Returns a reference to this for easy method chaining

hasSourceReference

public boolean hasSourceReference()

addSourceReference

public Reference addSourceReference()

addSourceReference

public Consent addSourceReference(Reference t)

getSourceReferenceFirstRep

public Reference getSourceReferenceFirstRep()

Returns:

The first repetition of repeating field sourceReference, creating it if it does not already exist {3}

getRegulatoryBasis

public List<CodeableConcept> getRegulatoryBasis()

Returns:

regulatoryBasis (A set of codes that indicate the regulatory basis (if any) that this consent supports.)

setRegulatoryBasis

public Consent setRegulatoryBasis(List<CodeableConcept> theRegulatoryBasis)

Returns:

Returns a reference to this for easy method chaining

hasRegulatoryBasis

public boolean hasRegulatoryBasis()

addRegulatoryBasis

public CodeableConcept addRegulatoryBasis()

addRegulatoryBasis

public Consent addRegulatoryBasis(CodeableConcept t)

getRegulatoryBasisFirstRep

public CodeableConcept getRegulatoryBasisFirstRep()

Returns:

The first repetition of repeating field regulatoryBasis, creating it if it does not already exist {3}

getPolicyBasis

public Consent.ConsentPolicyBasisComponent getPolicyBasis()

Returns:

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

hasPolicyBasis

public boolean hasPolicyBasis()

setPolicyBasis

public Consent setPolicyBasis(Consent.ConsentPolicyBasisComponent value)

Parameters:

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

getPolicyText

public List<Reference> getPolicyText()

Returns:

policyText (A Reference to the human readable policy explaining the basis for the Consent.)

setPolicyText

public Consent setPolicyText(List<Reference> thePolicyText)

Returns:

Returns a reference to this for easy method chaining

hasPolicyText

public boolean hasPolicyText()

addPolicyText

public Reference addPolicyText()

addPolicyText

public Consent addPolicyText(Reference t)

getPolicyTextFirstRep

public Reference getPolicyTextFirstRep()

Returns:

The first repetition of repeating field policyText, creating it if it does not already exist {3}

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 {3}

getDecisionElement

public Enumeration<Enumerations.ConsentProvisionType> getDecisionElement()

Returns:

decision (Action to take - permit or deny - as default.). This is the underlying object with id, value and extensions. The accessor "getDecision" gives direct access to the value

hasDecisionElement

public boolean hasDecisionElement()

hasDecision

public boolean hasDecision()

setDecisionElement

public Consent setDecisionElement(Enumeration<Enumerations.ConsentProvisionType> value)

Parameters:

value - decision (Action to take - permit or deny - as default.). This is the underlying object with id, value and extensions. The accessor "getDecision" gives direct access to the value

getDecision

public Enumerations.ConsentProvisionType getDecision()

Returns:

Action to take - permit or deny - as default.

setDecision

public Consent setDecision(Enumerations.ConsentProvisionType value)

Parameters:

value - Action to take - permit or deny - as default.

getProvision

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

setProvision

public Consent setProvision(List<Consent.ProvisionComponent> theProvision)

Returns:

Returns a reference to this for easy method chaining

hasProvision

public boolean hasProvision()

addProvision

public Consent.ProvisionComponent addProvision()

addProvision

public Consent addProvision(Consent.ProvisionComponent t)

getProvisionFirstRep

public Consent.ProvisionComponent getProvisionFirstRep()

Returns:

The first repetition of repeating field provision, creating it if it does not already exist {3}

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

Returns:

the FHIR type name of the instance (not the java class name)

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