Package org.hl7.fhir.dstu3.model

Class Consent

java.lang.Object
org.hl7.fhir.dstu3.model.Base
org.hl7.fhir.dstu3.model.BaseResource
org.hl7.fhir.dstu3.model.Resource
org.hl7.fhir.dstu3.model.DomainResource
org.hl7.fhir.dstu3.model.Consent
All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
public class Consent extends DomainResource
A record of a healthcare consumer?s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
See Also:
Serialized Form

  • Field Details

    • identifier

      protected Identifier identifier
      Unique identifier for this copy of the Consent Statement.

    • status

      protected Enumeration<Consent.ConsentState> status
      Indicates the current state of this consent.

    • category

      protected List<CodeableConcept> category
      A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.

    • patient

      protected Reference patient
      The patient/healthcare consumer to whom this consent applies.

    • patientTarget

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

    • period

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

    • dateTime

      protected DateTimeType dateTime
      When this Consent was issued / created / indexed.

    • consentingParty

      protected List<Reference> consentingParty
      Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.

    • consentingPartyTarget

      protected List<Resource> consentingPartyTarget
      The actual objects that are the target of the reference (Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.)

    • actor

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

    • action

      protected List<CodeableConcept> action
      Actions controlled by this consent.

    • organization

      protected List<Reference> organization
      The organization that manages the consent, and the framework within which it is executed.

    • organizationTarget

      protected List<Organization> organizationTarget
      The actual objects that are the target of the reference (The organization that manages the consent, and the framework within which it is executed.)

    • source

      protected Type source
      The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.

    • policy

      protected List<Consent.ConsentPolicyComponent> policy
      The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.

    • policyRule

      protected UriType policyRule
      A referece to the specific computable policy.

    • securityLabel

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

    • purpose

      protected List<Coding> purpose
      The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.

    • dataPeriod

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

    • data

      protected List<Consent.ConsentDataComponent> data
      The resources controlled by this consent, if specific resources are referenced.

    • except

      protected List<Consent.ExceptComponent> except
      An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.

    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

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

      See Also:
      Constant Field Values

    • DATE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
      Fluent Client search parameter constant for date

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

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

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

      See Also:
      Constant Field Values

    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

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

    • SP_SECURITYLABEL

      public static final String SP_SECURITYLABEL
      Search parameter: securitylabel

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

      See Also:
      Constant Field Values

    • SECURITYLABEL

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam SECURITYLABEL
      Fluent Client search parameter constant for securitylabel

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

    • SP_PERIOD

      public static final String SP_PERIOD
      Search parameter: period

      Description: Period that this consent applies
      Type: date
      Path: Consent.period

      See Also:
      Constant Field Values

    • PERIOD

      public static final ca.uhn.fhir.rest.gclient.DateClientParam PERIOD
      Fluent Client search parameter constant for period

      Description: Period that this consent applies
      Type: date
      Path: Consent.period

    • SP_DATA

      public static final String SP_DATA
      Search parameter: data

      Description: The actual data reference
      Type: reference
      Path: Consent.data.reference, Consent.except.data.reference

      See Also:
      Constant Field Values

    • DATA

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DATA
      Fluent Client search parameter constant for data

      Description: The actual data reference
      Type: reference
      Path: Consent.data.reference, Consent.except.data.reference

    • INCLUDE_DATA

      public static final ca.uhn.fhir.model.api.Include INCLUDE_DATA
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:data".

    • SP_PURPOSE

      public static final String SP_PURPOSE
      Search parameter: purpose

      Description: Context of activities for which the agreement is made
      Type: token
      Path: Consent.purpose, Consent.except.purpose

      See Also:
      Constant Field Values

    • PURPOSE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam PURPOSE
      Fluent Client search parameter constant for purpose

      Description: Context of activities for which the agreement is made
      Type: token
      Path: Consent.purpose, Consent.except.purpose

    • SP_SOURCE

      public static final String SP_SOURCE
      Search parameter: source

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

      See Also:
      Constant Field Values

    • SOURCE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SOURCE
      Fluent Client search parameter constant for source

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

    • INCLUDE_SOURCE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SOURCE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:source".

    • SP_ACTOR

      public static final String SP_ACTOR
      Search parameter: actor

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

      See Also:
      Constant Field Values

    • ACTOR

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ACTOR
      Fluent Client search parameter constant for actor

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

    • INCLUDE_ACTOR

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ACTOR
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:actor".

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

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

      See Also:
      Constant Field Values

    • PATIENT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
      Fluent Client search parameter constant for patient

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

    • INCLUDE_PATIENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:patient".

    • SP_ORGANIZATION

      public static final String SP_ORGANIZATION
      Search parameter: organization

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

      See Also:
      Constant Field Values

    • ORGANIZATION

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ORGANIZATION
      Fluent Client search parameter constant for organization

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

    • INCLUDE_ORGANIZATION

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ORGANIZATION
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:organization".

    • SP_ACTION

      public static final String SP_ACTION
      Search parameter: action

      Description: Actions controlled by this consent
      Type: token
      Path: Consent.action, Consent.except.action

      See Also:
      Constant Field Values

    • ACTION

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACTION
      Fluent Client search parameter constant for action

      Description: Actions controlled by this consent
      Type: token
      Path: Consent.action, Consent.except.action

    • SP_CONSENTOR

      public static final String SP_CONSENTOR
      Search parameter: consentor

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

      See Also:
      Constant Field Values

    • CONSENTOR

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONSENTOR
      Fluent Client search parameter constant for consentor

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

    • INCLUDE_CONSENTOR

      public static final ca.uhn.fhir.model.api.Include INCLUDE_CONSENTOR
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Consent:consentor".

    • SP_CATEGORY

      public static final String SP_CATEGORY
      Search parameter: category

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

      See Also:
      Constant Field Values

    • CATEGORY

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
      Fluent Client search parameter constant for category

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

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

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

      See Also:
      Constant Field Values

    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

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

  • Constructor Details

  • Method Details