Package ca.uhn.fhir.model.dstu2.resource

Class Contract

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource
    public class Contract
extends BaseResource
implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR Contract Resource ()

    Definition: A formal agreement between parties regarding the conduct of business, exchange of information or other matters.

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/Contract

    See Also:
    Serialized Form

    • Field Detail

      • SP_SUBJECT

        public static final String SP_SUBJECT
        Search parameter constant for subject

        Description: The identity of the target of the contract
        Type: reference
        Path: Contract.subject

        See Also:
        Constant Field Values

      • SUBJECT

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

        Description: The identity of the target of the contract
        Type: reference
        Path: Contract.subject

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter constant for patient

        Description: The identity of the target of the contract (if a patient)
        Type: reference
        Path: Contract.subject

        See Also:
        Constant Field Values

      • PATIENT

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

        Description: The identity of the target of the contract (if a patient)
        Type: reference
        Path: Contract.subject

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter constant for identifier

        Description: The identity of the contract
        Type: token
        Path: Contract.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: The identity of the contract
        Type: token
        Path: Contract.identifier

      • ACTOR

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

        Description:
        Type: reference
        Path: Contract.actor.entity

      • SIGNER

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

        Description:
        Type: reference
        Path: Contract.signer.party

      • 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 "Contract:actor".

      • 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 "Contract:patient".

      • INCLUDE_SIGNER

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

      • 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 "Contract:subject".

    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase

      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

      • getIdentifier

        public IdentifierDt getIdentifier()
        Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.

        Definition: Unique identifier for this Contract.

      • getIssuedElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getIssuedElement()
        Gets the value(s) for issued (). creating it if it does not exist. Will not return null.

        Definition: When this Contract was issued.

      • getIssued

        public Date getIssued()
        Gets the value(s) for issued (). creating it if it does not exist. This method may return null.

        Definition: When this Contract was issued.

      • setIssued

        public Contract setIssued​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for issued ()

        Definition: When this Contract was issued.

      • setIssued

        public Contract setIssued​(Date theDate,
                          ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for issued ()

        Definition: When this Contract was issued.

      • getApplies

        public PeriodDt getApplies()
        Gets the value(s) for applies (). creating it if it does not exist. Will not return null.

        Definition: Relevant time or time-period when this Contract is applicable

      • setApplies

        public Contract setApplies​(PeriodDt theValue)
        Sets the value(s) for applies ()

        Definition: Relevant time or time-period when this Contract is applicable

      • getSubject

        public List<ResourceReferenceDt> getSubject()
        Gets the value(s) for subject (). creating it if it does not exist. Will not return null.

        Definition: Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.

      • setSubject

        public Contract setSubject​(List<ResourceReferenceDt> theValue)
        Sets the value(s) for subject ()

        Definition: Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.

      • addSubject

        public ResourceReferenceDt addSubject()
        Adds and returns a new value for subject ()

        Definition: Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.

      • getAuthority

        public List<ResourceReferenceDt> getAuthority()
        Gets the value(s) for authority (). creating it if it does not exist. Will not return null.

        Definition: A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.

      • setAuthority

        public Contract setAuthority​(List<ResourceReferenceDt> theValue)
        Sets the value(s) for authority ()

        Definition: A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.

      • addAuthority

        public ResourceReferenceDt addAuthority()
        Adds and returns a new value for authority ()

        Definition: A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.

      • getDomain

        public List<ResourceReferenceDt> getDomain()
        Gets the value(s) for domain (). creating it if it does not exist. Will not return null.

        Definition: Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.

      • setDomain

        public Contract setDomain​(List<ResourceReferenceDt> theValue)
        Sets the value(s) for domain ()

        Definition: Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.

      • addDomain

        public ResourceReferenceDt addDomain()
        Adds and returns a new value for domain ()

        Definition: Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.

      • getType

        public CodeableConceptDt getType()
        Gets the value(s) for type (). creating it if it does not exist. Will not return null.

        Definition: Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc.

      • setType

        public Contract setType​(CodeableConceptDt theValue)
        Sets the value(s) for type ()

        Definition: Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc.

      • getSubType

        public List<CodeableConceptDt> getSubType()
        Gets the value(s) for subType (). creating it if it does not exist. Will not return null.

        Definition: More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent.

      • setSubType

        public Contract setSubType​(List<CodeableConceptDt> theValue)
        Sets the value(s) for subType ()

        Definition: More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent.

      • addSubType

        public CodeableConceptDt addSubType()
        Adds and returns a new value for subType ()

        Definition: More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent.

      • addSubType

        public Contract addSubType​(CodeableConceptDt theValue)
        Adds a given new value for subType ()

        Definition: More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent.

        Parameters:
        theValue - The subType to add (must not be null)

      • getSubTypeFirstRep

        public CodeableConceptDt getSubTypeFirstRep()
        Gets the first repetition for subType (), creating it if it does not already exist.

        Definition: More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent.

      • getAction

        public List<CodeableConceptDt> getAction()
        Gets the value(s) for action (). creating it if it does not exist. Will not return null.

        Definition: Action stipulated by this Contract.

      • addAction

        public CodeableConceptDt addAction()
        Adds and returns a new value for action ()

        Definition: Action stipulated by this Contract.

      • addAction

        public Contract addAction​(CodeableConceptDt theValue)
        Adds a given new value for action ()

        Definition: Action stipulated by this Contract.

        Parameters:
        theValue - The action to add (must not be null)

      • getActionFirstRep

        public CodeableConceptDt getActionFirstRep()
        Gets the first repetition for action (), creating it if it does not already exist.

        Definition: Action stipulated by this Contract.

      • getActionReason

        public List<CodeableConceptDt> getActionReason()
        Gets the value(s) for actionReason (). creating it if it does not exist. Will not return null.

        Definition: Reason for action stipulated by this Contract.

      • addActionReason

        public CodeableConceptDt addActionReason()
        Adds and returns a new value for actionReason ()

        Definition: Reason for action stipulated by this Contract.

      • addActionReason

        public Contract addActionReason​(CodeableConceptDt theValue)
        Adds a given new value for actionReason ()

        Definition: Reason for action stipulated by this Contract.

        Parameters:
        theValue - The actionReason to add (must not be null)

      • getActionReasonFirstRep

        public CodeableConceptDt getActionReasonFirstRep()
        Gets the first repetition for actionReason (), creating it if it does not already exist.

        Definition: Reason for action stipulated by this Contract.

      • getActor

        public List<Contract.Actor> getActor()
        Gets the value(s) for actor (). creating it if it does not exist. Will not return null.

        Definition: List of Contract actors

      • addActor

        public Contract.Actor addActor()
        Adds and returns a new value for actor ()

        Definition: List of Contract actors

      • addActor

        public Contract addActor​(Contract.Actor theValue)
        Adds a given new value for actor ()

        Definition: List of Contract actors

        Parameters:
        theValue - The actor to add (must not be null)

      • getActorFirstRep

        public Contract.Actor getActorFirstRep()
        Gets the first repetition for actor (), creating it if it does not already exist.

        Definition: List of Contract actors

      • getValuedItem

        public List<Contract.ValuedItem> getValuedItem()
        Gets the value(s) for valuedItem (). creating it if it does not exist. Will not return null.

        Definition: Contract Valued Item List

      • addValuedItem

        public Contract addValuedItem​(Contract.ValuedItem theValue)
        Adds a given new value for valuedItem ()

        Definition: Contract Valued Item List

        Parameters:
        theValue - The valuedItem to add (must not be null)

      • getValuedItemFirstRep

        public Contract.ValuedItem getValuedItemFirstRep()
        Gets the first repetition for valuedItem (), creating it if it does not already exist.

        Definition: Contract Valued Item List

      • getSigner

        public List<Contract.Signer> getSigner()
        Gets the value(s) for signer (). creating it if it does not exist. Will not return null.

        Definition: Party signing this Contract.

      • addSigner

        public Contract.Signer addSigner()
        Adds and returns a new value for signer ()

        Definition: Party signing this Contract.

      • addSigner

        public Contract addSigner​(Contract.Signer theValue)
        Adds a given new value for signer ()

        Definition: Party signing this Contract.

        Parameters:
        theValue - The signer to add (must not be null)

      • getSignerFirstRep

        public Contract.Signer getSignerFirstRep()
        Gets the first repetition for signer (), creating it if it does not already exist.

        Definition: Party signing this Contract.

      • getTerm

        public List<Contract.Term> getTerm()
        Gets the value(s) for term (). creating it if it does not exist. Will not return null.

        Definition: One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.

      • setTerm

        public Contract setTerm​(List<Contract.Term> theValue)
        Sets the value(s) for term ()

        Definition: One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.

      • addTerm

        public Contract.Term addTerm()
        Adds and returns a new value for term ()

        Definition: One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.

      • addTerm

        public Contract addTerm​(Contract.Term theValue)
        Adds a given new value for term ()

        Definition: One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.

        Parameters:
        theValue - The term to add (must not be null)

      • getTermFirstRep

        public Contract.Term getTermFirstRep()
        Gets the first repetition for term (), creating it if it does not already exist.

        Definition: One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.

      • getBinding

        public ca.uhn.fhir.model.api.IDatatype getBinding()
        Gets the value(s) for binding[x] (). creating it if it does not exist. Will not return null.

        Definition: Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the \"source of truth\" and which would be the basis for legal action related to enforcement of this Contract.

      • setBinding

        public Contract setBinding​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for binding[x] ()

        Definition: Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the \"source of truth\" and which would be the basis for legal action related to enforcement of this Contract.

      • getFriendly

        public List<Contract.Friendly> getFriendly()
        Gets the value(s) for friendly (). creating it if it does not exist. Will not return null.

        Definition: The \"patient friendly language\" versionof the Contract in whole or in parts. \"Patient friendly language\" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.

      • setFriendly

        public Contract setFriendly​(List<Contract.Friendly> theValue)
        Sets the value(s) for friendly ()

        Definition: The \"patient friendly language\" versionof the Contract in whole or in parts. \"Patient friendly language\" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.

      • addFriendly

        public Contract.Friendly addFriendly()
        Adds and returns a new value for friendly ()

        Definition: The \"patient friendly language\" versionof the Contract in whole or in parts. \"Patient friendly language\" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.

      • addFriendly

        public Contract addFriendly​(Contract.Friendly theValue)
        Adds a given new value for friendly ()

        Definition: The \"patient friendly language\" versionof the Contract in whole or in parts. \"Patient friendly language\" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.

        Parameters:
        theValue - The friendly to add (must not be null)

      • getFriendlyFirstRep

        public Contract.Friendly getFriendlyFirstRep()
        Gets the first repetition for friendly (), creating it if it does not already exist.

        Definition: The \"patient friendly language\" versionof the Contract in whole or in parts. \"Patient friendly language\" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.

      • getLegal

        public List<Contract.Legal> getLegal()
        Gets the value(s) for legal (). creating it if it does not exist. Will not return null.

        Definition: List of Legal expressions or representations of this Contract.

      • setLegal

        public Contract setLegal​(List<Contract.Legal> theValue)
        Sets the value(s) for legal ()

        Definition: List of Legal expressions or representations of this Contract.

      • addLegal

        public Contract.Legal addLegal()
        Adds and returns a new value for legal ()

        Definition: List of Legal expressions or representations of this Contract.

      • addLegal

        public Contract addLegal​(Contract.Legal theValue)
        Adds a given new value for legal ()

        Definition: List of Legal expressions or representations of this Contract.

        Parameters:
        theValue - The legal to add (must not be null)

      • getLegalFirstRep

        public Contract.Legal getLegalFirstRep()
        Gets the first repetition for legal (), creating it if it does not already exist.

        Definition: List of Legal expressions or representations of this Contract.

      • getRule

        public List<Contract.Rule> getRule()
        Gets the value(s) for rule (). creating it if it does not exist. Will not return null.

        Definition: List of Computable Policy Rule Language Representations of this Contract.

      • setRule

        public Contract setRule​(List<Contract.Rule> theValue)
        Sets the value(s) for rule ()

        Definition: List of Computable Policy Rule Language Representations of this Contract.

      • addRule

        public Contract.Rule addRule()
        Adds and returns a new value for rule ()

        Definition: List of Computable Policy Rule Language Representations of this Contract.

      • addRule

        public Contract addRule​(Contract.Rule theValue)
        Adds a given new value for rule ()

        Definition: List of Computable Policy Rule Language Representations of this Contract.

        Parameters:
        theValue - The rule to add (must not be null)

      • getRuleFirstRep

        public Contract.Rule getRuleFirstRep()
        Gets the first repetition for rule (), creating it if it does not already exist.

        Definition: List of Computable Policy Rule Language Representations of this Contract.

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource

      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource