
Class 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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static enum
static class
static class
static class
static class
static class
Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for actionstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for actorprotected List<CodeableConcept>
A classification of the type of consents found in the statement.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for categoryThe actor that controls/enforces the access according to the consent.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for controllerstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for dataprotected DateType
Date the consent instance was agreed to.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for dateThe 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
Fluent Client search parameter constant for granteeThe entity responsible for granting the rights listed in a Consent Directive.protected List<Identifier>
Unique identifier for this copy of the Consent Statement.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.The actor that manages the consent through its lifecycle.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for managerstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientprotected Period
Effective period for this Consent Resource and all provisions unless specified in that provision.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for periodprotected Consent.ConsentPolicyBasisComponent
A Reference or URL used to uniquely identify the policy the organization will enforce for this Consent.A Reference to the human readable policy explaining the basis for the Consent.protected Consent.ProvisionComponent
An exception to the base policy of this consent.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for purposeprotected List<CodeableConcept>
A set of codes that indicate the regulatory basis (if any) that this consent supports.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for security-labelstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for source-referenceprotected List<Attachment>
The source on which this consent statement is based.A reference to a consent that links back to such a source, a reference to a document repository (e.g.static final String
Search parameter: actionstatic final String
Search parameter: actorstatic final String
Search parameter: categorystatic final String
Search parameter: controllerstatic final String
Search parameter: datastatic final String
Search parameter: datestatic final String
Search parameter: granteestatic final String
Search parameter: identifierstatic final String
Search parameter: managerstatic final String
Search parameter: patientstatic final String
Search parameter: periodstatic final String
Search parameter: purposestatic final String
Search parameter: security-labelstatic final String
Search parameter: source-referencestatic final String
Search parameter: statusstatic final String
Search parameter: subjectstatic final String
Search parameter: verifiedstatic final String
Search parameter: verified-dateprotected Enumeration<Consent.ConsentState>
Indicates the current state of this Consent resource.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected Reference
The patient/healthcare practitioner or group of persons to whom this consent applies.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectprotected List<Consent.ConsentVerificationComponent>
Whether a treatment instruction (e.g.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for verifiedstatic final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for verified-dateFields 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, SP_RES_ID
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncopy()
void
copyValues
(Consent dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getDate()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
hasDate()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setCategory
(List<CodeableConcept> theCategory) setController
(List<Reference> theController) setDateElement
(DateType value) setGrantee
(List<Reference> theGrantee) setGrantor
(List<Reference> theGrantor) setIdentifier
(List<Identifier> theIdentifier) setManager
(List<Reference> theManager) setPolicyText
(List<Reference> thePolicyText) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setRegulatoryBasis
(List<CodeableConcept> theRegulatoryBasis) setSourceAttachment
(List<Attachment> theSourceAttachment) setSourceReference
(List<Reference> theSourceReference) setStatus
(Consent.ConsentState value) setSubject
(Reference value) setVerification
(List<Consent.ConsentVerificationComponent> theVerification) protected Consent
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, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, hasValidationInfo, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, removeChild, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId
-
Field Details
-
identifier
Unique identifier for this copy of the Consent Statement. -
status
Indicates the current state of this Consent resource. -
category
A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. -
subject
The patient/healthcare practitioner or group of persons to whom this consent applies. -
date
Date the consent instance was agreed to. -
period
Effective period for this Consent Resource and all provisions unless specified in that provision. -
grantor
The entity responsible for granting the rights listed in a Consent Directive. -
grantee
The entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions. -
manager
The actor that manages the consent through its lifecycle. -
controller
The actor that controls/enforces the access according to the consent. -
sourceAttachment
The source on which this consent statement is based. The source might be a scanned original paper form. -
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
A set of codes that indicate the regulatory basis (if any) that this consent supports. -
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
A Reference to the human readable policy explaining the basis for the Consent. -
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
An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. -
SP_ACTION
Search parameter: actionDescription: Actions controlled by this rule
Type: token
Path: Consent.provision.action
- See Also:
-
ACTION
Fluent Client search parameter constant for actionDescription: Actions controlled by this rule
Type: token
Path: Consent.provision.action
-
SP_ACTOR
Search parameter: actorDescription: Resource for the actor (or group, by role)
Type: reference
Path: Consent.provision.actor.reference
- See Also:
-
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
Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:actor". -
SP_CATEGORY
Search parameter: categoryDescription: Classification of the consent statement - for indexing/retrieval
Type: token
Path: Consent.category
- See Also:
-
CATEGORY
Fluent Client search parameter constant for categoryDescription: Classification of the consent statement - for indexing/retrieval
Type: token
Path: Consent.category
-
SP_CONTROLLER
Search parameter: controllerDescription: Consent Enforcer
Type: reference
Path: Consent.controller
- See Also:
-
CONTROLLER
Fluent Client search parameter constant for controllerDescription: Consent Enforcer
Type: reference
Path: Consent.controller
-
INCLUDE_CONTROLLER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:controller". -
SP_DATA
Search parameter: dataDescription: The actual data reference
Type: reference
Path: Consent.provision.data.reference
- See Also:
-
DATA
Fluent Client search parameter constant for dataDescription: The actual data reference
Type: reference
Path: Consent.provision.data.reference
-
INCLUDE_DATA
Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:data". -
SP_GRANTEE
Search parameter: granteeDescription: Who is agreeing to the policy and rules
Type: reference
Path: Consent.grantee
- See Also:
-
GRANTEE
Fluent Client search parameter constant for granteeDescription: Who is agreeing to the policy and rules
Type: reference
Path: Consent.grantee
-
INCLUDE_GRANTEE
Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:grantee". -
SP_MANAGER
Search parameter: managerDescription: Consent workflow management
Type: reference
Path: Consent.manager
- See Also:
-
MANAGER
Fluent Client search parameter constant for managerDescription: Consent workflow management
Type: reference
Path: Consent.manager
-
INCLUDE_MANAGER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:manager". -
SP_PERIOD
Search parameter: periodDescription: Timeframe for this rule
Type: date
Path: Consent.provision.period
- See Also:
-
PERIOD
Fluent Client search parameter constant for periodDescription: Timeframe for this rule
Type: date
Path: Consent.provision.period
-
SP_PURPOSE
Search parameter: purposeDescription: Context of activities covered by this rule
Type: token
Path: Consent.provision.purpose
- See Also:
-
PURPOSE
Fluent Client search parameter constant for purposeDescription: Context of activities covered by this rule
Type: token
Path: Consent.provision.purpose
-
SP_SECURITY_LABEL
Search parameter: security-labelDescription: Security Labels that define affected resources
Type: token
Path: Consent.provision.securityLabel
- See Also:
-
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
Search parameter: source-referenceDescription: Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse
Type: reference
Path: Consent.sourceReference
- See Also:
-
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
Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:source-reference". -
SP_STATUS
Search parameter: statusDescription: draft | active | inactive | entered-in-error | unknown
Type: token
Path: Consent.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: draft | active | inactive | entered-in-error | unknown
Type: token
Path: Consent.status
-
SP_SUBJECT
Search parameter: subjectDescription: Who the consent applies to
Type: reference
Path: Consent.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: Who the consent applies to
Type: reference
Path: Consent.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:subject". -
SP_VERIFIED_DATE
Search parameter: verified-dateDescription: When consent verified
Type: date
Path: Consent.verification.verificationDate
- See Also:
-
VERIFIED_DATE
Fluent Client search parameter constant for verified-dateDescription: When consent verified
Type: date
Path: Consent.verification.verificationDate
-
SP_VERIFIED
Search parameter: verifiedDescription: Has been verified
Type: token
Path: Consent.verification.verified
- See Also:
-
VERIFIED
Fluent Client search parameter constant for verifiedDescription: Has been verified
Type: token
Path: Consent.verification.verified
-
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.date | DiagnosticReport.effective.as(dateTime) | DiagnosticReport.effective.as(Period) | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence as dateTime) | List.date | Observation.effective.as(dateTime) | Observation.effective.as(Period) | Observation.effective.as(Timing) | Observation.effective.as(instant) | Procedure.occurrence.as(dateTime) | Procedure.occurrence.as(Period) | Procedure.occurrence.as(Timing) | (RiskAssessment.occurrence as dateTime) | SupplyRequest.authoredOn
- See Also:
-
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.date | DiagnosticReport.effective.as(dateTime) | DiagnosticReport.effective.as(Period) | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence as dateTime) | List.date | Observation.effective.as(dateTime) | Observation.effective.as(Period) | Observation.effective.as(Timing) | Observation.effective.as(instant) | Procedure.occurrence.as(dateTime) | Procedure.occurrence.as(Period) | Procedure.occurrence.as(Timing) | (RiskAssessment.occurrence as dateTime) | SupplyRequest.authoredOn
-
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.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:
-
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.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
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 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) [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 [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [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.subject | 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.subject.where(resolve() is 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 | SupplyRequest.deliverFor | VisionPrescription.patient
- See Also:
-
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 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) [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 [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [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.subject | 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.subject.where(resolve() is 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 | SupplyRequest.deliverFor | VisionPrescription.patient
-
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
Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Unique identifier for this copy of the Consent Statement.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist {3}
-
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
-
hasStatus
-
setStatusElement
- 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
- Returns:
- Indicates the current state of this Consent resource.
-
setStatus
- Parameters:
value
- Indicates the current state of this Consent resource.
-
getCategory
- Returns:
category
(A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.)
-
setCategory
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCategory
-
addCategory
-
addCategory
-
getCategoryFirstRep
- Returns:
- The first repetition of repeating field
category
, creating it if it does not already exist {3}
-
getSubject
- Returns:
subject
(The patient/healthcare practitioner or group of persons to whom this consent applies.)
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(The patient/healthcare practitioner or group of persons to whom this consent applies.)
-
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
-
hasDate
-
setDateElement
- 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
- Returns:
- Date the consent instance was agreed to.
-
setDate
- Parameters:
value
- Date the consent instance was agreed to.
-
getPeriod
- Returns:
period
(Effective period for this Consent Resource and all provisions unless specified in that provision.)
-
hasPeriod
-
setPeriod
- Parameters:
value
-period
(Effective period for this Consent Resource and all provisions unless specified in that provision.)
-
getGrantor
- Returns:
grantor
(The entity responsible for granting the rights listed in a Consent Directive.)
-
setGrantor
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasGrantor
-
addGrantor
-
addGrantor
-
getGrantorFirstRep
- Returns:
- The first repetition of repeating field
grantor
, creating it if it does not already exist {3}
-
getGrantee
- Returns:
grantee
(The entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.)
-
setGrantee
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasGrantee
-
addGrantee
-
addGrantee
-
getGranteeFirstRep
- Returns:
- The first repetition of repeating field
grantee
, creating it if it does not already exist {3}
-
getManager
- Returns:
manager
(The actor that manages the consent through its lifecycle.)
-
setManager
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasManager
-
addManager
-
addManager
-
getManagerFirstRep
- Returns:
- The first repetition of repeating field
manager
, creating it if it does not already exist {3}
-
getController
- Returns:
controller
(The actor that controls/enforces the access according to the consent.)
-
setController
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasController
-
addController
-
addController
-
getControllerFirstRep
- Returns:
- The first repetition of repeating field
controller
, creating it if it does not already exist {3}
-
getSourceAttachment
- Returns:
sourceAttachment
(The source on which this consent statement is based. The source might be a scanned original paper form.)
-
setSourceAttachment
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSourceAttachment
-
addSourceAttachment
-
addSourceAttachment
-
getSourceAttachmentFirstRep
- Returns:
- The first repetition of repeating field
sourceAttachment
, creating it if it does not already exist {3}
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSourceReference
-
addSourceReference
-
addSourceReference
-
getSourceReferenceFirstRep
- Returns:
- The first repetition of repeating field
sourceReference
, creating it if it does not already exist {3}
-
getRegulatoryBasis
- Returns:
regulatoryBasis
(A set of codes that indicate the regulatory basis (if any) that this consent supports.)
-
setRegulatoryBasis
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRegulatoryBasis
-
addRegulatoryBasis
-
addRegulatoryBasis
-
getRegulatoryBasisFirstRep
- Returns:
- The first repetition of repeating field
regulatoryBasis
, creating it if it does not already exist {3}
-
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
-
setPolicyBasis
- 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
- Returns:
policyText
(A Reference to the human readable policy explaining the basis for the Consent.)
-
setPolicyText
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPolicyText
-
addPolicyText
-
addPolicyText
-
getPolicyTextFirstRep
- Returns:
- The first repetition of repeating field
policyText
, creating it if it does not already exist {3}
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasVerification
-
addVerification
-
addVerification
-
getVerificationFirstRep
- Returns:
- The first repetition of repeating field
verification
, creating it if it does not already exist {3}
-
getProvision
- Returns:
provision
(An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.)
-
hasProvision
-
setProvision
- Parameters:
value
-provision
(An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.)
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-