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 classConsent.ConsentDataMeaningstatic classConsent.ConsentDataMeaningEnumFactorystatic classConsent.ConsentPolicyComponentstatic classConsent.ConsentProvisionTypestatic classConsent.ConsentProvisionTypeEnumFactorystatic classConsent.ConsentStatestatic classConsent.ConsentStateEnumFactorystatic classConsent.ConsentVerificationComponentstatic classConsent.ProvisionActorComponentstatic classConsent.ProvisionComponentstatic classConsent.ProvisionDataComponent
-
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.TokenClientParamACTIONFluent Client search parameter constant for actionstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamACTORFluent Client search parameter constant for actorprotected List<CodeableConcept>categoryA classification of the type of consents found in the statement.static ca.uhn.fhir.rest.gclient.TokenClientParamCATEGORYFluent Client search parameter constant for categoryprotected List<Reference>controllerThe actor that controls/enforces the access according to the consent.static ca.uhn.fhir.rest.gclient.ReferenceClientParamCONTROLLERFluent Client search parameter constant for controllerstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamDATAFluent Client search parameter constant for datastatic ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected DateTimeTypedateTimeDate and time the consent instance was agreed to.protected List<Reference>granteeThe entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.static ca.uhn.fhir.rest.gclient.ReferenceClientParamGRANTEEFluent Client search parameter constant for granteeprotected List<Reference>grantorThe entity responsible for granting the rights listed in a Consent Directive.protected List<Identifier>identifierUnique identifier for this copy of the Consent Statement.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_ACTORConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_CONTROLLERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_DATAConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_GRANTEEConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_MANAGERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SOURCE_REFERENCEConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.protected List<Reference>managerThe actor that manages the consent through its lifecycle.static ca.uhn.fhir.rest.gclient.ReferenceClientParamMANAGERFluent Client search parameter constant for managerstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientstatic ca.uhn.fhir.rest.gclient.DateClientParamPERIODFluent Client search parameter constant for periodprotected List<Consent.ConsentPolicyComponent>policyThe references to the policies that are included in this consent scope.static ca.uhn.fhir.rest.gclient.UriClientParamPOLICY_URIFluent Client search parameter constant for policy-uriprotected CodeableConceptpolicyRuleA reference to the specific base computable regulation or policy.protected Consent.ProvisionComponentprovisionAn exception to the base policy of this consent.static ca.uhn.fhir.rest.gclient.TokenClientParamPURPOSEFluent Client search parameter constant for purposestatic ca.uhn.fhir.rest.gclient.TokenClientParamSECURITY_LABELFluent Client search parameter constant for security-labelstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamSOURCE_REFERENCEFluent Client search parameter constant for source-referenceprotected List<Attachment>sourceAttachmentThe source on which this consent statement is based.protected List<Reference>sourceReferenceA reference to a consent that links back to such a source, a reference to a document repository (e.g.static StringSP_ACTIONSearch parameter: actionstatic StringSP_ACTORSearch parameter: actorstatic StringSP_CATEGORYSearch parameter: categorystatic StringSP_CONTROLLERSearch parameter: controllerstatic StringSP_DATASearch parameter: datastatic StringSP_DATESearch parameter: datestatic StringSP_GRANTEESearch parameter: granteestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_MANAGERSearch parameter: managerstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_PERIODSearch parameter: periodstatic StringSP_POLICY_URISearch parameter: policy-uristatic StringSP_PURPOSESearch parameter: purposestatic StringSP_SECURITY_LABELSearch parameter: security-labelstatic StringSP_SOURCE_REFERENCESearch parameter: source-referencestatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUBJECTSearch parameter: subjectstatic StringSP_VERIFIEDSearch parameter: verifiedstatic StringSP_VERIFIED_DATESearch parameter: verified-dateprotected Enumeration<Consent.ConsentState>statusIndicates the current state of this Consent resource.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected ReferencesubjectThe patient/healthcare practitioner or group of persons to whom this consent applies.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectprotected List<Consent.ConsentVerificationComponent>verificationWhether a treatment instruction (e.g.static ca.uhn.fhir.rest.gclient.TokenClientParamVERIFIEDFluent Client search parameter constant for verifiedstatic ca.uhn.fhir.rest.gclient.DateClientParamVERIFIED_DATEFluent 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
-
-
Constructor Summary
Constructors Constructor Description Consent()ConstructorConsent(Consent.ConsentState status)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
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.
-
dateTime
protected DateTimeType dateTime
Date and time the consent instance was agreed to.
-
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.
-
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.
-
policy
protected List<Consent.ConsentPolicyComponent> policy
The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
-
policyRule
protected CodeableConcept policyRule
A reference to the specific base computable regulation or policy.
-
verification
protected List<Consent.ConsentVerificationComponent> verification
Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.
-
provision
protected Consent.ProvisionComponent provision
An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
-
SP_ACTION
public static final String SP_ACTION
Search parameter: actionDescription: 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 actionDescription: Actions controlled by this rule
Type: token
Path: Consent.provision.action
-
SP_ACTOR
public static final String SP_ACTOR
Search parameter: actorDescription: 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 actorDescription: 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: categoryDescription: 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 categoryDescription: Classification of the consent statement - for indexing/retrieval
Type: token
Path: Consent.category
-
SP_CONTROLLER
public static final String SP_CONTROLLER
Search parameter: controllerDescription: 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 controllerDescription: 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: dataDescription: 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 dataDescription: 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: granteeDescription: 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 granteeDescription: 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: managerDescription: 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 managerDescription: 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: periodDescription: 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 periodDescription: Timeframe for this rule
Type: date
Path: Consent.provision.period
-
SP_POLICY_URI
public static final String SP_POLICY_URI
Search parameter: policy-uriDescription: Search for Consents aligned with a specific policy or policy date/version. URIs should be complete with date/version and not assume the Resource will maintain versioning information
Type: uri
Path: Consent.policy.uri
- See Also:
- Constant Field Values
-
POLICY_URI
public static final ca.uhn.fhir.rest.gclient.UriClientParam POLICY_URI
Fluent Client search parameter constant for policy-uriDescription: Search for Consents aligned with a specific policy or policy date/version. URIs should be complete with date/version and not assume the Resource will maintain versioning information
Type: uri
Path: Consent.policy.uri
-
SP_PURPOSE
public static final String SP_PURPOSE
Search parameter: purposeDescription: 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 purposeDescription: 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-labelDescription: 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-labelDescription: 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-referenceDescription: 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-referenceDescription: 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: statusDescription: 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 statusDescription: draft | active | inactive | entered-in-error | unknown
Type: token
Path: Consent.status
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: 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 subjectDescription: 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-dateDescription: 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-dateDescription: When consent verified
Type: date
Path: Consent.verification.verificationDate
-
SP_VERIFIED
public static final String SP_VERIFIED
Search parameter: verifiedDescription: 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 verifiedDescription: Has been verified
Type: token
Path: Consent.verification.verified
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance 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 [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 [List](list.html): When the list was prepared [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period [Procedure](procedure.html): When the procedure occurred or is occurring [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AllergyIntolerance.recordedDate | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.dateTime | DiagnosticReport.effective | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence as dateTime) | List.date | Observation.effective | Procedure.occurrence | (RiskAssessment.occurrence as 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 dateDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance 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 [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 [List](list.html): When the list was prepared [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period [Procedure](procedure.html): When the procedure occurred or is occurring [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AllergyIntolerance.recordedDate | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.dateTime | DiagnosticReport.effective | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence as dateTime) | List.date | Observation.effective | Procedure.occurrence | (RiskAssessment.occurrence as dateTime) | SupplyRequest.authoredOn
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [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) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business 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 [MedicationUsage](medicationusage.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 [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.content.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.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 identifierDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [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) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business 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 [MedicationUsage](medicationusage.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 [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.content.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [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 [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 [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [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 [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [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 [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.patient | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.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 patientDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [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 [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 [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [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 [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [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 [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.patient | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.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 Detail
-
Consent
public Consent()
Constructor
-
Consent
public Consent(Consent.ConsentState status)
Constructor
-
-
Method Detail
-
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
thisfor 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
thisfor 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.)
-
getDateTimeElement
public DateTimeType getDateTimeElement()
- Returns:
dateTime(Date and time the consent instance was agreed to.). 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(Date and time the consent instance was agreed to.). This is the underlying object with id, value and extensions. The accessor "getDateTime" gives direct access to the value
-
getDateTime
public Date getDateTime()
- Returns:
- Date and time the consent instance was agreed to.
-
setDateTime
public Consent setDateTime(Date value)
- Parameters:
value- Date and time the consent instance was agreed to.
-
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
thisfor 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
thisfor 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
thisfor 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
thisfor 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
thisfor 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
thisfor 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}
-
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
thisfor 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 {3}
-
getPolicyRule
public CodeableConcept getPolicyRule()
- Returns:
policyRule(A reference to the specific base computable regulation or policy.)
-
hasPolicyRule
public boolean hasPolicyRule()
-
setPolicyRule
public Consent setPolicyRule(CodeableConcept value)
- Parameters:
value-policyRule(A reference to the specific base computable regulation or policy.)
-
getVerification
public List<Consent.ConsentVerificationComponent> getVerification()
- Returns:
verification(Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.)
-
setVerification
public Consent setVerification(List<Consent.ConsentVerificationComponent> theVerification)
- Returns:
- Returns a reference to
thisfor 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}
-
getProvision
public Consent.ProvisionComponent getProvision()
- Returns:
provision(An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.)
-
hasProvision
public boolean hasProvision()
-
setProvision
public Consent setProvision(Consent.ProvisionComponent value)
- Parameters:
value-provision(An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.)
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Consent copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(Consent dst)
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-