org.hl7.fhir.dstu3.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 MetadataResource

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 class

CompartmentDefinition.CompartmentDefinitionResourceComponent

static enum

CompartmentDefinition.CompartmentType

static class

CompartmentDefinition.CompartmentTypeEnumFactory
Field Summary

Fields

Modifier and Type

Field

Description

protected Enumeration<CompartmentDefinition.CompartmentType>

code

Which compartment this definition describes.

static final ca.uhn.fhir.rest.gclient.TokenClientParam

CODE

Fluent Client search parameter constant for code

static final ca.uhn.fhir.rest.gclient.DateClientParam

DATE

Fluent Client search parameter constant for date

static final ca.uhn.fhir.rest.gclient.StringClientParam

DESCRIPTION

Fluent Client search parameter constant for description

static final ca.uhn.fhir.rest.gclient.TokenClientParam

JURISDICTION

Fluent Client search parameter constant for jurisdiction

static final ca.uhn.fhir.rest.gclient.StringClientParam

NAME

Fluent Client search parameter constant for name

static final ca.uhn.fhir.rest.gclient.StringClientParam

PUBLISHER

Fluent Client search parameter constant for publisher

protected MarkdownType

purpose

Explaination of why this compartment definition is needed and why it has been designed as it has.

protected List<CompartmentDefinition.CompartmentDefinitionResourceComponent>

resource

Information about how a resource is related to the compartment.

static final ca.uhn.fhir.rest.gclient.TokenClientParam

RESOURCE

Fluent Client search parameter constant for resource

protected BooleanType

search

Whether the search syntax is supported,.

static final String

SP_CODE

Search parameter: code

static final String

SP_DATE

Search parameter: date

static final String

SP_DESCRIPTION

Search parameter: description

static final String

SP_JURISDICTION

Search parameter: jurisdiction

static final String

SP_NAME

Search parameter: name

static final String

SP_PUBLISHER

Search parameter: publisher

static final String

SP_RESOURCE

Search parameter: resource

static final String

SP_STATUS

Search parameter: status

static final String

SP_TITLE

Search parameter: title

static final String

SP_URL

Search parameter: url

static final ca.uhn.fhir.rest.gclient.TokenClientParam

STATUS

Fluent Client search parameter constant for status

static final ca.uhn.fhir.rest.gclient.StringClientParam

TITLE

Fluent Client search parameter constant for title

static final ca.uhn.fhir.rest.gclient.UriClientParam

URL

Fluent Client search parameter constant for url

Fields inherited from class org.hl7.fhir.dstu3.model.MetadataResource
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu3.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

Constructor

Description

CompartmentDefinition()

Constructor

CompartmentDefinition(UriType url, StringType name, Enumeration<Enumerations.PublicationStatus> status, Enumeration<CompartmentDefinition.CompartmentType> code, BooleanType search)

Constructor
Method Summary

Modifier and Type

Method

Description

Base

addChild(String name)

ContactDetail

addContact()

CompartmentDefinition

addContact(ContactDetail t)

CodeableConcept

addJurisdiction()

CompartmentDefinition

addJurisdiction(CodeableConcept t)

CompartmentDefinition.CompartmentDefinitionResourceComponent

addResource()

CompartmentDefinition

addResource(CompartmentDefinition.CompartmentDefinitionResourceComponent t)

UsageContext

addUseContext()

CompartmentDefinition

addUseContext(UsageContext t)

CompartmentDefinition

copy()

boolean

equalsDeep(Base other_)

boolean

equalsShallow(Base other_)

String

fhirType()

CompartmentDefinition.CompartmentType

getCode()

Enumeration<CompartmentDefinition.CompartmentType>

getCodeElement()

List<ContactDetail>

getContact()

ContactDetail

getContactFirstRep()

Date

getDate()

DateTimeType

getDateElement()

String

getDescription()

MarkdownType

getDescriptionElement()

boolean

getExperimental()

BooleanType

getExperimentalElement()

List<CodeableConcept>

getJurisdiction()

CodeableConcept

getJurisdictionFirstRep()

String

getName()

Property

getNamedProperty(int _hash, String _name, boolean _checkValid)

StringType

getNameElement()

Base[]

getProperty(int hash, String name, boolean checkValid)

String

getPublisher()

StringType

getPublisherElement()

String

getPurpose()

MarkdownType

getPurposeElement()

List<CompartmentDefinition.CompartmentDefinitionResourceComponent>

getResource()

CompartmentDefinition.CompartmentDefinitionResourceComponent

getResourceFirstRep()

ResourceType

getResourceType()

boolean

getSearch()

BooleanType

getSearchElement()

Enumerations.PublicationStatus

getStatus()

Enumeration<Enumerations.PublicationStatus>

getStatusElement()

String

getTitle()

StringType

getTitleElement()

String[]

getTypesForProperty(int hash, String name)

String

getUrl()

UriType

getUrlElement()

List<UsageContext>

getUseContext()

UsageContext

getUseContextFirstRep()

boolean

hasCode()

boolean

hasCodeElement()

boolean

hasContact()

boolean

hasDate()

boolean

hasDateElement()

boolean

hasDescription()

boolean

hasDescriptionElement()

boolean

hasExperimental()

boolean

hasExperimentalElement()

boolean

hasJurisdiction()

boolean

hasName()

boolean

hasNameElement()

boolean

hasPublisher()

boolean

hasPublisherElement()

boolean

hasPurpose()

boolean

hasPurposeElement()

boolean

hasResource()

boolean

hasSearch()

boolean

hasSearchElement()

boolean

hasStatus()

boolean

hasStatusElement()

boolean

hasTitle()

boolean

hasTitleElement()

boolean

hasUrl()

boolean

hasUrlElement()

boolean

hasUseContext()

boolean

isEmpty()

protected void

listChildren(List<Property> children)

Base

makeProperty(int hash, String name)

CompartmentDefinition

setCode(CompartmentDefinition.CompartmentType value)

CompartmentDefinition

setCodeElement(Enumeration<CompartmentDefinition.CompartmentType> value)

CompartmentDefinition

setContact(List<ContactDetail> theContact)

CompartmentDefinition

setDate(Date value)

CompartmentDefinition

setDateElement(DateTimeType value)

CompartmentDefinition

setDescription(String value)

CompartmentDefinition

setDescriptionElement(MarkdownType value)

CompartmentDefinition

setExperimental(boolean value)

CompartmentDefinition

setExperimentalElement(BooleanType value)

CompartmentDefinition

setJurisdiction(List<CodeableConcept> theJurisdiction)

CompartmentDefinition

setName(String value)

CompartmentDefinition

setNameElement(StringType value)

Base

setProperty(int hash, String name, Base value)

Base

setProperty(String name, Base value)

CompartmentDefinition

setPublisher(String value)

CompartmentDefinition

setPublisherElement(StringType value)

CompartmentDefinition

setPurpose(String value)

CompartmentDefinition

setPurposeElement(MarkdownType value)

CompartmentDefinition

setResource(List<CompartmentDefinition.CompartmentDefinitionResourceComponent> theResource)

CompartmentDefinition

setSearch(boolean value)

CompartmentDefinition

setSearchElement(BooleanType value)

CompartmentDefinition

setStatus(Enumerations.PublicationStatus value)

CompartmentDefinition

setStatusElement(Enumeration<Enumerations.PublicationStatus> value)

CompartmentDefinition

setTitle(String value)

CompartmentDefinition

setTitleElement(StringType value)

CompartmentDefinition

setUrl(String value)

CompartmentDefinition

setUrlElement(UriType value)

CompartmentDefinition

setUseContext(List<UsageContext> theUseContext)

protected CompartmentDefinition

typedCopy()

Methods inherited from class org.hl7.fhir.dstu3.model.MetadataResource
checkCanUseUrl, copyValues, getVersion, getVersionElement, hasVersion, hasVersionElement, setVersion, setVersionElement, toString

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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
- purpose
  
  protected MarkdownType purpose
  
  Explaination of why this compartment definition is needed and why it has been designed as it has.
- 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 is related to the compartment.
- SP_DATE
  
  public static final String SP_DATE
  
  Search parameter: date
  Description: The compartment definition publication date
  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 date
  Description: The compartment definition publication date
  Type: date
  Path: CompartmentDefinition.date
- SP_CODE
  
  public static final String SP_CODE
  
  Search parameter: code
  Description: 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 code
  Description: Patient | Encounter | RelatedPerson | Practitioner | Device
  Type: token
  Path: CompartmentDefinition.code
- SP_RESOURCE
  
  public static final String SP_RESOURCE
  
  Search parameter: resource
  Description: 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 resource
  Description: Name of resource type
  Type: token
  Path: CompartmentDefinition.resource.code
- SP_JURISDICTION
  
  public static final String SP_JURISDICTION
  
  Search parameter: jurisdiction
  Description: Intended jurisdiction for the compartment definition
  Type: token
  Path: CompartmentDefinition.jurisdiction
  See Also:
  
  Constant Field Values
- JURISDICTION
  
  public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
  
  Fluent Client search parameter constant for jurisdiction
  Description: Intended jurisdiction for the compartment definition
  Type: token
  Path: CompartmentDefinition.jurisdiction
- SP_NAME
  
  public static final String SP_NAME
  
  Search parameter: name
  Description: Computationally friendly name of the 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 name
  Description: Computationally friendly name of the compartment definition
  Type: string
  Path: CompartmentDefinition.name
- SP_DESCRIPTION
  
  public static final String SP_DESCRIPTION
  
  Search parameter: description
  Description: The description of the compartment definition
  Type: string
  Path: CompartmentDefinition.description
  See Also:
  
  Constant Field Values
- DESCRIPTION
  
  public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
  
  Fluent Client search parameter constant for description
  Description: The description of the compartment definition
  Type: string
  Path: CompartmentDefinition.description
- SP_PUBLISHER
  
  public static final String SP_PUBLISHER
  
  Search parameter: publisher
  Description: Name of the publisher of the compartment definition
  Type: string
  Path: CompartmentDefinition.publisher
  See Also:
  
  Constant Field Values
- PUBLISHER
  
  public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
  
  Fluent Client search parameter constant for publisher
  Description: Name of the publisher of the compartment definition
  Type: string
  Path: CompartmentDefinition.publisher
- SP_TITLE
  
  public static final String SP_TITLE
  
  Search parameter: title
  Description: The human-friendly name of the compartment definition
  Type: string
  Path: CompartmentDefinition.title
  See Also:
  
  Constant Field Values
- TITLE
  
  public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
  
  Fluent Client search parameter constant for title
  Description: The human-friendly name of the compartment definition
  Type: string
  Path: CompartmentDefinition.title
- SP_URL
  
  public static final String SP_URL
  
  Search parameter: url
  Description: The uri that identifies the 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 url
  Description: The uri that identifies the compartment definition
  Type: uri
  Path: CompartmentDefinition.url
- SP_STATUS
  
  public static final String SP_STATUS
  
  Search parameter: status
  Description: The current status of the compartment definition
  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 status
  Description: The current status of the compartment definition
  Type: token
  Path: CompartmentDefinition.status
Constructor Details
- CompartmentDefinition
  
  public CompartmentDefinition()
  
  Constructor
- CompartmentDefinition
  
  public CompartmentDefinition(UriType url, StringType name, Enumeration<Enumerations.PublicationStatus> status, Enumeration<CompartmentDefinition.CompartmentType> code, BooleanType search)
  
  Constructor
Method Details
- getUrlElement
  
  public UriType getUrlElement()
  
  Overrides:
  
  getUrlElement in class MetadataResource
  
  Returns:
  
  MetadataResource.url (An absolute URI 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. The URL SHOULD include the major version of the compartment definition. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
- hasUrlElement
  
  public boolean hasUrlElement()
  
  Overrides:
  
  hasUrlElement in class MetadataResource
- hasUrl
  
  public boolean hasUrl()
  
  Overrides:
  
  hasUrl in class MetadataResource
- setUrlElement
  
  public CompartmentDefinition setUrlElement(UriType value)
  
  Overrides:
  
  setUrlElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.url (An absolute URI 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. The URL SHOULD include the major version of the compartment definition. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
- getUrl
  
  public String getUrl()
  
  Overrides:
  
  getUrl in class MetadataResource
  
  Returns:
  
  An absolute URI 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. The URL SHOULD include the major version of the compartment definition. For more information see [Technical and Business Versions](resource.html#versions).
- setUrl
  
  public CompartmentDefinition setUrl(String value)
  
  Overrides:
  
  setUrl in class MetadataResource
  
  Parameters:
  
  value - An absolute URI 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. The URL SHOULD include the major version of the compartment definition. For more information see [Technical and Business Versions](resource.html#versions).
- getNameElement
  
  public StringType getNameElement()
  
  Overrides:
  
  getNameElement in class MetadataResource
  
  Returns:
  
  MetadataResource.name (A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
- hasNameElement
  
  public boolean hasNameElement()
  
  Overrides:
  
  hasNameElement in class MetadataResource
- hasName
  
  public boolean hasName()
  
  Overrides:
  
  hasName in class MetadataResource
- setNameElement
  
  public CompartmentDefinition setNameElement(StringType value)
  
  Overrides:
  
  setNameElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.name (A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
- getName
  
  public String getName()
  
  Overrides:
  
  getName in class MetadataResource
  
  Returns:
  
  A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- setName
  
  public CompartmentDefinition setName(String value)
  
  Overrides:
  
  setName in class MetadataResource
  
  Parameters:
  
  value - A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- getTitleElement
  
  public StringType getTitleElement()
  
  Overrides:
  
  getTitleElement in class MetadataResource
  
  Returns:
  
  MetadataResource.title (A short, descriptive, user-friendly title for the compartment definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
- hasTitleElement
  
  public boolean hasTitleElement()
  
  Overrides:
  
  hasTitleElement in class MetadataResource
- hasTitle
  
  public boolean hasTitle()
  
  Overrides:
  
  hasTitle in class MetadataResource
- setTitleElement
  
  public CompartmentDefinition setTitleElement(StringType value)
  
  Overrides:
  
  setTitleElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.title (A short, descriptive, user-friendly title for the compartment definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
- getTitle
  
  public String getTitle()
  
  Overrides:
  
  getTitle in class MetadataResource
  
  Returns:
  
  A short, descriptive, user-friendly title for the compartment definition.
- setTitle
  
  public CompartmentDefinition setTitle(String value)
  
  Overrides:
  
  setTitle in class MetadataResource
  
  Parameters:
  
  value - A short, descriptive, user-friendly title for the compartment definition.
- getStatusElement
  
  public Enumeration<Enumerations.PublicationStatus> getStatusElement()
  
  Overrides:
  
  getStatusElement in class MetadataResource
  
  Returns:
  
  MetadataResource.status (The status of this compartment definition. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
- hasStatusElement
  
  public boolean hasStatusElement()
  
  Overrides:
  
  hasStatusElement in class MetadataResource
- hasStatus
  
  public boolean hasStatus()
  
  Overrides:
  
  hasStatus in class MetadataResource
- setStatusElement
  
  public CompartmentDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
  
  Overrides:
  
  setStatusElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.status (The status of this compartment definition. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
- getStatus
  
  public Enumerations.PublicationStatus getStatus()
  
  Overrides:
  
  getStatus in class MetadataResource
  
  Returns:
  
  The status of this compartment definition. Enables tracking the life-cycle of the content.
- setStatus
  
  public CompartmentDefinition setStatus(Enumerations.PublicationStatus value)
  
  Overrides:
  
  setStatus in class MetadataResource
  
  Parameters:
  
  value - The status of this compartment definition. Enables tracking the life-cycle of the content.
- getExperimentalElement
  
  public BooleanType getExperimentalElement()
  
  Overrides:
  
  getExperimentalElement in class MetadataResource
  
  Returns:
  
  MetadataResource.experimental (A boolean value to indicate that this compartment 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()
  
  Overrides:
  
  hasExperimentalElement in class MetadataResource
- hasExperimental
  
  public boolean hasExperimental()
  
  Overrides:
  
  hasExperimental in class MetadataResource
- setExperimentalElement
  
  public CompartmentDefinition setExperimentalElement(BooleanType value)
  
  Overrides:
  
  setExperimentalElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.experimental (A boolean value to indicate that this compartment 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()
  
  Overrides:
  
  getExperimental in class MetadataResource
  
  Returns:
  
  A boolean value to indicate that this compartment 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)
  
  Overrides:
  
  setExperimental in class MetadataResource
  
  Parameters:
  
  value - A boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
- getDateElement
  
  public DateTimeType getDateElement()
  
  Overrides:
  
  getDateElement in class MetadataResource
  
  Returns:
  
  MetadataResource.date (The date (and optionally time) when the compartment definition was published. The date must change if and when the business version changes 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()
  
  Overrides:
  
  hasDateElement in class MetadataResource
- hasDate
  
  public boolean hasDate()
  
  Overrides:
  
  hasDate in class MetadataResource
- setDateElement
  
  public CompartmentDefinition setDateElement(DateTimeType value)
  
  Overrides:
  
  setDateElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.date (The date (and optionally time) when the compartment definition was published. The date must change if and when the business version changes 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()
  
  Overrides:
  
  getDate in class MetadataResource
  
  Returns:
  
  The date (and optionally time) when the compartment definition was published. The date must change if and when the business version changes 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)
  
  Overrides:
  
  setDate in class MetadataResource
  
  Parameters:
  
  value - The date (and optionally time) when the compartment definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.
- getPublisherElement
  
  public StringType getPublisherElement()
  
  Overrides:
  
  getPublisherElement in class MetadataResource
  
  Returns:
  
  MetadataResource.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()
  
  Overrides:
  
  hasPublisherElement in class MetadataResource
- hasPublisher
  
  public boolean hasPublisher()
  
  Overrides:
  
  hasPublisher in class MetadataResource
- setPublisherElement
  
  public CompartmentDefinition setPublisherElement(StringType value)
  
  Overrides:
  
  setPublisherElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.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()
  
  Overrides:
  
  getPublisher in class MetadataResource
  
  Returns:
  
  The name of the individual or organization that published the compartment definition.
- setPublisher
  
  public CompartmentDefinition setPublisher(String value)
  
  Overrides:
  
  setPublisher in class MetadataResource
  
  Parameters:
  
  value - The name of the individual or organization that published the compartment definition.
- getContact
  
  public List<ContactDetail> getContact()
  
  Overrides:
  
  getContact in class MetadataResource
  
  Returns:
  
  MetadataResource.contact (Contact details to assist a user in finding and communicating with the publisher.)
- setContact
  
  public CompartmentDefinition setContact(List<ContactDetail> theContact)
  
  Overrides:
  
  setContact in class MetadataResource
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasContact
  
  public boolean hasContact()
  
  Overrides:
  
  hasContact in class MetadataResource
- addContact
  
  public ContactDetail addContact()
  
  Overrides:
  
  addContact in class MetadataResource
- addContact
  
  public CompartmentDefinition addContact(ContactDetail t)
  
  Overrides:
  
  addContact in class MetadataResource
- getContactFirstRep
  
  public ContactDetail getContactFirstRep()
  
  Overrides:
  
  getContactFirstRep in class MetadataResource
  
  Returns:
  
  The first repetition of repeating field MetadataResource.contact, creating it if it does not already exist
- getDescriptionElement
  
  public MarkdownType getDescriptionElement()
  
  Overrides:
  
  getDescriptionElement in class MetadataResource
  
  Returns:
  
  MetadataResource.description (A free text natural language description of the compartment definition from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
- hasDescriptionElement
  
  public boolean hasDescriptionElement()
  
  Overrides:
  
  hasDescriptionElement in class MetadataResource
- hasDescription
  
  public boolean hasDescription()
  
  Overrides:
  
  hasDescription in class MetadataResource
- setDescriptionElement
  
  public CompartmentDefinition setDescriptionElement(MarkdownType value)
  
  Overrides:
  
  setDescriptionElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.description (A free text natural language description of the compartment definition from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
- getDescription
  
  public String getDescription()
  
  Overrides:
  
  getDescription in class MetadataResource
  
  Returns:
  
  A free text natural language description of the compartment definition from a consumer's perspective.
- setDescription
  
  public CompartmentDefinition setDescription(String value)
  
  Overrides:
  
  setDescription in class MetadataResource
  
  Parameters:
  
  value - A free text natural language description of the compartment definition from a consumer's perspective.
- getPurposeElement
  
  public MarkdownType getPurposeElement()
  
  Returns:
  
  purpose (Explaination of why this compartment definition is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
- hasPurposeElement
  
  public boolean hasPurposeElement()
- hasPurpose
  
  public boolean hasPurpose()
- setPurposeElement
  
  public CompartmentDefinition setPurposeElement(MarkdownType value)
  
  Parameters:
  
  value - purpose (Explaination of why this compartment definition is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
- getPurpose
  
  public String getPurpose()
  
  Returns:
  
  Explaination of why this compartment definition is needed and why it has been designed as it has.
- setPurpose
  
  public CompartmentDefinition setPurpose(String value)
  
  Parameters:
  
  value - Explaination of why this compartment definition is needed and why it has been designed as it has.
- getUseContext
  
  public List<UsageContext> getUseContext()
  
  Overrides:
  
  getUseContext in class MetadataResource
  
  Returns:
  
  MetadataResource.useContext (The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate compartment definition instances.)
- setUseContext
  
  public CompartmentDefinition setUseContext(List<UsageContext> theUseContext)
  
  Overrides:
  
  setUseContext in class MetadataResource
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasUseContext
  
  public boolean hasUseContext()
  
  Overrides:
  
  hasUseContext in class MetadataResource
- addUseContext
  
  public UsageContext addUseContext()
  
  Overrides:
  
  addUseContext in class MetadataResource
- addUseContext
  
  public CompartmentDefinition addUseContext(UsageContext t)
  
  Overrides:
  
  addUseContext in class MetadataResource
- getUseContextFirstRep
  
  public UsageContext getUseContextFirstRep()
  
  Overrides:
  
  getUseContextFirstRep in class MetadataResource
  
  Returns:
  
  The first repetition of repeating field MetadataResource.useContext, creating it if it does not already exist
- getJurisdiction
  
  public List<CodeableConcept> getJurisdiction()
  
  Overrides:
  
  getJurisdiction in class MetadataResource
  
  Returns:
  
  MetadataResource.jurisdiction (A legal or geographic region in which the compartment definition is intended to be used.)
- setJurisdiction
  
  public CompartmentDefinition setJurisdiction(List<CodeableConcept> theJurisdiction)
  
  Overrides:
  
  setJurisdiction in class MetadataResource
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasJurisdiction
  
  public boolean hasJurisdiction()
  
  Overrides:
  
  hasJurisdiction in class MetadataResource
- addJurisdiction
  
  public CodeableConcept addJurisdiction()
  
  Overrides:
  
  addJurisdiction in class MetadataResource
- addJurisdiction
  
  public CompartmentDefinition addJurisdiction(CodeableConcept t)
  
  Overrides:
  
  addJurisdiction in class MetadataResource
- getJurisdictionFirstRep
  
  public CodeableConcept getJurisdictionFirstRep()
  
  Overrides:
  
  getJurisdictionFirstRep in class MetadataResource
  
  Returns:
  
  The first repetition of repeating field MetadataResource.jurisdiction, creating it if it does not already exist
- 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 is related to the compartment.)
- setResource
  
  public CompartmentDefinition setResource(List<CompartmentDefinition.CompartmentDefinitionResourceComponent> theResource)
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasResource
  
  public boolean hasResource()
- addResource
  
  public CompartmentDefinition.CompartmentDefinitionResourceComponent addResource()
- addResource
  
  public CompartmentDefinition addResource(CompartmentDefinition.CompartmentDefinitionResourceComponent t)
- getResourceFirstRep
  
  public CompartmentDefinition.CompartmentDefinitionResourceComponent getResourceFirstRep()
  
  Returns:
  
  The first repetition of repeating field resource, creating it if it does not already exist
- listChildren
  
  protected void listChildren(List<Property> children)
  
  Overrides:
  
  listChildren in class MetadataResource
- getNamedProperty
  
  public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  getNamedProperty in class MetadataResource
  
  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 class MetadataResource
  
  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 class MetadataResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- setProperty
  
  public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  setProperty in class MetadataResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- makeProperty
  
  public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  makeProperty in class MetadataResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- getTypesForProperty
  
  public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  getTypesForProperty in class MetadataResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- addChild
  
  public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  addChild in class MetadataResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- fhirType
  
  public String fhirType()
  
  Specified by:
  
  fhirType in interface org.hl7.fhir.instance.model.api.IBase
  
  Overrides:
  
  fhirType in class MetadataResource
- copy
  
  public CompartmentDefinition copy()
  
  Specified by:
  
  copy in class MetadataResource
- typedCopy
  
  protected CompartmentDefinition typedCopy()
- equalsDeep
  
  public boolean equalsDeep(Base other_)
  
  Overrides:
  
  equalsDeep in class MetadataResource
- equalsShallow
  
  public boolean equalsShallow(Base other_)
  
  Overrides:
  
  equalsShallow in class MetadataResource
- isEmpty
  
  public boolean isEmpty()
  
  Specified by:
  
  isEmpty in interface org.hl7.fhir.instance.model.api.IBase
  
  Overrides:
  
  isEmpty in class MetadataResource
- getResourceType
  
  public ResourceType getResourceType()
  
  Specified by:
  
  getResourceType in class Resource

Class CompartmentDefinition

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.dstu3.model.MetadataResource

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu3.model.MetadataResource

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource

Methods inherited from class org.hl7.fhir.dstu3.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Field Details

purpose

code

search

resource

SP_DATE

DATE

SP_CODE

CODE

SP_RESOURCE

RESOURCE

SP_JURISDICTION

JURISDICTION

SP_NAME

NAME

SP_DESCRIPTION

DESCRIPTION

SP_PUBLISHER

PUBLISHER

SP_TITLE

TITLE

SP_URL

URL

SP_STATUS

STATUS

Constructor Details

CompartmentDefinition

CompartmentDefinition

Method Details

getUrlElement

hasUrlElement

hasUrl

setUrlElement

getUrl

setUrl

getNameElement

hasNameElement

hasName

setNameElement

getName

setName

getTitleElement

hasTitleElement

hasTitle

setTitleElement

getTitle

setTitle

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getExperimentalElement

hasExperimentalElement

hasExperimental

setExperimentalElement

getExperimental

setExperimental

getDateElement

hasDateElement