Class CompartmentDefinition
- java.lang.Object
-
- org.hl7.fhir.dstu2016may.model.Base
-
- org.hl7.fhir.dstu2016may.model.BaseResource
-
- org.hl7.fhir.dstu2016may.model.Resource
-
- org.hl7.fhir.dstu2016may.model.DomainResource
-
- org.hl7.fhir.dstu2016may.model.CompartmentDefinition
-
- 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 CompartmentDefinition extends DomainResource
A compartment definition that defines how resources are accessed on a server.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCompartmentDefinition.CompartmentDefinitionContactComponentstatic classCompartmentDefinition.CompartmentDefinitionResourceComponentstatic classCompartmentDefinition.CompartmentTypestatic classCompartmentDefinition.CompartmentTypeEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected Enumeration<CompartmentDefinition.CompartmentType>codeWhich compartment this definition describes.static ca.uhn.fhir.rest.gclient.TokenClientParamCODEFluent Client search parameter constant for codeprotected List<CompartmentDefinition.CompartmentDefinitionContactComponent>contactContacts to assist a user in finding and communicating with the publisher.protected DateTimeTypedateThe date (and optionally time) when the compartment definition definition was published.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected StringTypedescriptionA free text natural language description of the CompartmentDefinition and its use.protected BooleanTypeexperimentalA flag to indicate that this compartment definition definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.protected StringTypenameA free text natural language name identifying the compartment definition.static ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for nameprotected StringTypepublisherThe name of the individual or organization that published the compartment definition.protected StringTyperequirementsThe Scope and Usage that this compartment definition was created to meet.protected List<CompartmentDefinition.CompartmentDefinitionResourceComponent>resourceInformation about how a resource it related to the compartment.static ca.uhn.fhir.rest.gclient.TokenClientParamRESOURCEFluent Client search parameter constant for resourceprotected BooleanTypesearchWhether the search syntax is supported.static StringSP_CODESearch parameter: codestatic StringSP_DATESearch parameter: datestatic StringSP_NAMESearch parameter: namestatic StringSP_RESOURCESearch parameter: resourcestatic StringSP_STATUSSearch parameter: statusstatic StringSP_URLSearch parameter: urlprotected Enumeration<Enumerations.ConformanceResourceStatus>statusThe status of this compartment definition definition.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected UriTypeurlAn absolute URL that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance.static ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for url-
Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description CompartmentDefinition()ConstructorCompartmentDefinition(UriType url, StringType name, Enumeration<CompartmentDefinition.CompartmentType> code, BooleanType search)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource
getStructureFhirVersionEnum, setId
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, 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
-
url
protected UriType url
An absolute URL that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this compartment definition is (or will be) published.
-
name
protected StringType name
A free text natural language name identifying the compartment definition.
-
status
protected Enumeration<Enumerations.ConformanceResourceStatus> status
The status of this compartment definition definition.
-
experimental
protected BooleanType experimental
A flag to indicate that this compartment definition definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
publisher
protected StringType publisher
The name of the individual or organization that published the compartment definition.
-
contact
protected List<CompartmentDefinition.CompartmentDefinitionContactComponent> contact
Contacts to assist a user in finding and communicating with the publisher.
-
date
protected DateTimeType date
The date (and optionally time) when the compartment definition definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.
-
description
protected StringType description
A free text natural language description of the CompartmentDefinition and its use.
-
requirements
protected StringType requirements
The Scope and Usage that this compartment definition was created to meet.
-
code
protected Enumeration<CompartmentDefinition.CompartmentType> code
Which compartment this definition describes.
-
search
protected BooleanType search
Whether the search syntax is supported.
-
resource
protected List<CompartmentDefinition.CompartmentDefinitionResourceComponent> resource
Information about how a resource it related to the compartment.
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: draft | active | retired
Type: token
Path: CompartmentDefinition.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 | retired
Type: token
Path: CompartmentDefinition.status
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: Informal name for this compartment definition
Type: string
Path: CompartmentDefinition.name
- See Also:
- Constant Field Values
-
NAME
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Fluent Client search parameter constant for nameDescription: Informal name for this compartment definition
Type: string
Path: CompartmentDefinition.name
-
SP_RESOURCE
public static final String SP_RESOURCE
Search parameter: resourceDescription: Name of resource type
Type: token
Path: CompartmentDefinition.resource.code
- See Also:
- Constant Field Values
-
RESOURCE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam RESOURCE
Fluent Client search parameter constant for resourceDescription: Name of resource type
Type: token
Path: CompartmentDefinition.resource.code
-
SP_CODE
public static final String SP_CODE
Search parameter: codeDescription: Patient | Encounter | RelatedPerson | Practitioner | Device
Type: token
Path: CompartmentDefinition.code
- See Also:
- Constant Field Values
-
CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
Fluent Client search parameter constant for codeDescription: Patient | Encounter | RelatedPerson | Practitioner | Device
Type: token
Path: CompartmentDefinition.code
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: Publication Date(/time)
Type: date
Path: CompartmentDefinition.date
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: Publication Date(/time)
Type: date
Path: CompartmentDefinition.date
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: Absolute URL used to reference this compartment definition
Type: uri
Path: CompartmentDefinition.url
- See Also:
- Constant Field Values
-
URL
public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
Fluent Client search parameter constant for urlDescription: Absolute URL used to reference this compartment definition
Type: uri
Path: CompartmentDefinition.url
-
-
Constructor Detail
-
CompartmentDefinition
public CompartmentDefinition()
Constructor
-
CompartmentDefinition
public CompartmentDefinition(UriType url, StringType name, Enumeration<CompartmentDefinition.CompartmentType> code, BooleanType search)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Returns:
url(An absolute URL that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this compartment definition is (or will be) published.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
public boolean hasUrlElement()
-
hasUrl
public boolean hasUrl()
-
setUrlElement
public CompartmentDefinition setUrlElement(UriType value)
- Parameters:
value-url(An absolute URL that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this compartment definition is (or will be) published.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
public String getUrl()
- Returns:
- An absolute URL that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this compartment definition is (or will be) published.
-
setUrl
public CompartmentDefinition setUrl(String value)
- Parameters:
value- An absolute URL that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this compartment definition is (or will be) published.
-
getNameElement
public StringType getNameElement()
- Returns:
name(A free text natural language name identifying the compartment definition.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
public boolean hasNameElement()
-
hasName
public boolean hasName()
-
setNameElement
public CompartmentDefinition setNameElement(StringType value)
- Parameters:
value-name(A free text natural language name identifying the compartment definition.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
getName
public String getName()
- Returns:
- A free text natural language name identifying the compartment definition.
-
setName
public CompartmentDefinition setName(String value)
- Parameters:
value- A free text natural language name identifying the compartment definition.
-
getStatusElement
public Enumeration<Enumerations.ConformanceResourceStatus> getStatusElement()
- Returns:
status(The status of this compartment definition definition.). 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 CompartmentDefinition setStatusElement(Enumeration<Enumerations.ConformanceResourceStatus> value)
- Parameters:
value-status(The status of this compartment definition definition.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Enumerations.ConformanceResourceStatus getStatus()
- Returns:
- The status of this compartment definition definition.
-
setStatus
public CompartmentDefinition setStatus(Enumerations.ConformanceResourceStatus value)
- Parameters:
value- The status of this compartment definition definition.
-
getExperimentalElement
public BooleanType getExperimentalElement()
- Returns:
experimental(A flag to indicate that this compartment definition definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
hasExperimentalElement
public boolean hasExperimentalElement()
-
hasExperimental
public boolean hasExperimental()
-
setExperimentalElement
public CompartmentDefinition setExperimentalElement(BooleanType value)
- Parameters:
value-experimental(A flag to indicate that this compartment definition definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
getExperimental
public boolean getExperimental()
- Returns:
- A flag to indicate that this compartment definition definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
setExperimental
public CompartmentDefinition setExperimental(boolean value)
- Parameters:
value- A flag to indicate that this compartment definition definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
getPublisherElement
public StringType getPublisherElement()
- Returns:
publisher(The name of the individual or organization that published the compartment definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
hasPublisherElement
public boolean hasPublisherElement()
-
hasPublisher
public boolean hasPublisher()
-
setPublisherElement
public CompartmentDefinition setPublisherElement(StringType value)
- Parameters:
value-publisher(The name of the individual or organization that published the compartment definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
getPublisher
public String getPublisher()
- Returns:
- The name of the individual or organization that published the compartment definition.
-
setPublisher
public CompartmentDefinition setPublisher(String value)
- Parameters:
value- The name of the individual or organization that published the compartment definition.
-
getContact
public List<CompartmentDefinition.CompartmentDefinitionContactComponent> getContact()
- Returns:
contact(Contacts to assist a user in finding and communicating with the publisher.)
-
hasContact
public boolean hasContact()
-
addContact
public CompartmentDefinition.CompartmentDefinitionContactComponent addContact()
- Returns:
contact(Contacts to assist a user in finding and communicating with the publisher.)
-
addContact
public CompartmentDefinition addContact(CompartmentDefinition.CompartmentDefinitionContactComponent t)
-
getDateElement
public DateTimeType getDateElement()
- Returns:
date(The date (and optionally time) when the compartment definition definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
public boolean hasDateElement()
-
hasDate
public boolean hasDate()
-
setDateElement
public CompartmentDefinition setDateElement(DateTimeType value)
- Parameters:
value-date(The date (and optionally time) when the compartment definition definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
public Date getDate()
- Returns:
- The date (and optionally time) when the compartment definition definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.
-
setDate
public CompartmentDefinition setDate(Date value)
- Parameters:
value- The date (and optionally time) when the compartment definition definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.
-
getDescriptionElement
public StringType getDescriptionElement()
- Returns:
description(A free text natural language description of the CompartmentDefinition and its use.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
public boolean hasDescriptionElement()
-
hasDescription
public boolean hasDescription()
-
setDescriptionElement
public CompartmentDefinition setDescriptionElement(StringType value)
- Parameters:
value-description(A free text natural language description of the CompartmentDefinition and its use.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Returns:
- A free text natural language description of the CompartmentDefinition and its use.
-
setDescription
public CompartmentDefinition setDescription(String value)
- Parameters:
value- A free text natural language description of the CompartmentDefinition and its use.
-
getRequirementsElement
public StringType getRequirementsElement()
- Returns:
requirements(The Scope and Usage that this compartment definition was created to meet.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value
-
hasRequirementsElement
public boolean hasRequirementsElement()
-
hasRequirements
public boolean hasRequirements()
-
setRequirementsElement
public CompartmentDefinition setRequirementsElement(StringType value)
- Parameters:
value-requirements(The Scope and Usage that this compartment definition was created to meet.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value
-
getRequirements
public String getRequirements()
- Returns:
- The Scope and Usage that this compartment definition was created to meet.
-
setRequirements
public CompartmentDefinition setRequirements(String value)
- Parameters:
value- The Scope and Usage that this compartment definition was created to meet.
-
getCodeElement
public Enumeration<CompartmentDefinition.CompartmentType> getCodeElement()
- Returns:
code(Which compartment this definition describes.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value
-
hasCodeElement
public boolean hasCodeElement()
-
hasCode
public boolean hasCode()
-
setCodeElement
public CompartmentDefinition setCodeElement(Enumeration<CompartmentDefinition.CompartmentType> value)
- Parameters:
value-code(Which compartment this definition describes.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value
-
getCode
public CompartmentDefinition.CompartmentType getCode()
- Returns:
- Which compartment this definition describes.
-
setCode
public CompartmentDefinition setCode(CompartmentDefinition.CompartmentType value)
- Parameters:
value- Which compartment this definition describes.
-
getSearchElement
public BooleanType getSearchElement()
- Returns:
search(Whether the search syntax is supported.). This is the underlying object with id, value and extensions. The accessor "getSearch" gives direct access to the value
-
hasSearchElement
public boolean hasSearchElement()
-
hasSearch
public boolean hasSearch()
-
setSearchElement
public CompartmentDefinition setSearchElement(BooleanType value)
- Parameters:
value-search(Whether the search syntax is supported.). This is the underlying object with id, value and extensions. The accessor "getSearch" gives direct access to the value
-
getSearch
public boolean getSearch()
- Returns:
- Whether the search syntax is supported.
-
setSearch
public CompartmentDefinition setSearch(boolean value)
- Parameters:
value- Whether the search syntax is supported.
-
getResource
public List<CompartmentDefinition.CompartmentDefinitionResourceComponent> getResource()
- Returns:
resource(Information about how a resource it related to the compartment.)
-
hasResource
public boolean hasResource()
-
addResource
public CompartmentDefinition.CompartmentDefinitionResourceComponent addResource()
- Returns:
resource(Information about how a resource it related to the compartment.)
-
addResource
public CompartmentDefinition addResource(CompartmentDefinition.CompartmentDefinitionResourceComponent t)
-
listChildren
protected void listChildren(List<Property> childrenList)
- Overrides:
listChildrenin classDomainResource
-
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 void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void 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
Description copied from class:Basemake an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property- Overrides:
makePropertyin classDomainResource- Returns:
- 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 CompartmentDefinition copy()
- Specified by:
copyin classDomainResource
-
typedCopy
protected CompartmentDefinition typedCopy()
-
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
-
-