Package org.hl7.fhir.r4.model

Class CodeSystem

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.model.MetadataResource

org.hl7.fhir.r4.model.CodeSystem

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 CodeSystem
extends MetadataResource

The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CodeSystem.CodeSystemContentMode
static class	CodeSystem.CodeSystemContentModeEnumFactory
static class	CodeSystem.CodeSystemFilterComponent
static enum	CodeSystem.CodeSystemHierarchyMeaning
static class	CodeSystem.CodeSystemHierarchyMeaningEnumFactory
static class	CodeSystem.ConceptDefinitionComponent
class	CodeSystem.ConceptDefinitionComponentSorter
static class	CodeSystem.ConceptDefinitionDesignationComponent
static class	CodeSystem.ConceptPropertyComponent
static enum	CodeSystem.FilterOperator
static class	CodeSystem.FilterOperatorEnumFactory
static class	CodeSystem.PropertyComponent
static enum	CodeSystem.PropertyType
static class	CodeSystem.PropertyTypeEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected BooleanType	caseSensitive	If code comparison is case sensitive when codes within this system are compared to each other.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CODE	Fluent Client search parameter constant for code
protected BooleanType	compositional	The code system defines a compositional (post-coordination) grammar.
protected List<CodeSystem.ConceptDefinitionComponent>	concept	Concepts that are in the code system.
protected Enumeration<CodeSystem.CodeSystemContentMode>	content	The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTENT_MODE	Fluent Client search parameter constant for content-mode
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTEXT	Fluent Client search parameter constant for context
static final ca.uhn.fhir.rest.gclient.QuantityClientParam	CONTEXT_QUANTITY	Fluent Client search parameter constant for context-quantity
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTEXT_TYPE	Fluent Client search parameter constant for context-type
static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam>	CONTEXT_TYPE_QUANTITY	Fluent Client search parameter constant for context-type-quantity
static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>	CONTEXT_TYPE_VALUE	Fluent Client search parameter constant for context-type-value
protected MarkdownType	copyright	A copyright statement relating to the code system and/or its contents.
protected UnsignedIntType	count	The total number of concepts defined by the code system.
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
protected List<CodeSystem.CodeSystemFilterComponent>	filter	A filter that can be used in a value set compose statement when selecting concepts using a filter.
protected Enumeration<CodeSystem.CodeSystemHierarchyMeaning>	hierarchyMeaning	The meaning of the hierarchy of concepts as represented in this resource.
protected List<Identifier>	identifier	A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUPPLEMENTS	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	JURISDICTION	Fluent Client search parameter constant for jurisdiction
static final ca.uhn.fhir.rest.gclient.TokenClientParam	LANGUAGE	Fluent Client search parameter constant for language
static final ca.uhn.fhir.rest.gclient.StringClientParam	NAME	Fluent Client search parameter constant for name
protected List<CodeSystem.PropertyComponent>	property	A property defines an additional slot through which additional information can be provided about a concept.
static final ca.uhn.fhir.rest.gclient.StringClientParam	PUBLISHER	Fluent Client search parameter constant for publisher
protected MarkdownType	purpose	Explanation of why this code system is needed and why it has been designed as it has.
static final String	SP_CODE	Search parameter: code
static final String	SP_CONTENT_MODE	Search parameter: content-mode
static final String	SP_CONTEXT	Search parameter: context
static final String	SP_CONTEXT_QUANTITY	Search parameter: context-quantity
static final String	SP_CONTEXT_TYPE	Search parameter: context-type
static final String	SP_CONTEXT_TYPE_QUANTITY	Search parameter: context-type-quantity
static final String	SP_CONTEXT_TYPE_VALUE	Search parameter: context-type-value
static final String	SP_DATE	Search parameter: date
static final String	SP_DESCRIPTION	Search parameter: description
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_JURISDICTION	Search parameter: jurisdiction
static final String	SP_LANGUAGE	Search parameter: language
static final String	SP_NAME	Search parameter: name
static final String	SP_PUBLISHER	Search parameter: publisher
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUPPLEMENTS	Search parameter: supplements
static final String	SP_SYSTEM	Search parameter: system
static final String	SP_TITLE	Search parameter: title
static final String	SP_URL	Search parameter: url
static final String	SP_VERSION	Search parameter: version
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected CanonicalType	supplements	The canonical URL of the code system that this code system supplement is adding designations and properties to.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUPPLEMENTS	Fluent Client search parameter constant for supplements
static final ca.uhn.fhir.rest.gclient.UriClientParam	SYSTEM	Fluent Client search parameter constant for system
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
protected CanonicalType	valueSet	Canonical reference to the value set that contains the entire code system.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	VERSION	Fluent Client search parameter constant for version
protected BooleanType	versionNeeded	This flag is used to signify that the code system does not commit to concept permanence across versions.

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

contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
CodeSystem()	Constructor
CodeSystem(Enumeration<Enumerations.PublicationStatus> status, Enumeration<CodeSystem.CodeSystemContentMode> content)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CodeSystem.ConceptDefinitionComponent	addConcept()
CodeSystem	addConcept(CodeSystem.ConceptDefinitionComponent t)
ContactDetail	addContact()
CodeSystem	addContact(ContactDetail t)
CodeSystem.CodeSystemFilterComponent	addFilter()
CodeSystem	addFilter(CodeSystem.CodeSystemFilterComponent t)
Identifier	addIdentifier()
CodeSystem	addIdentifier(Identifier t)
CodeableConcept	addJurisdiction()
CodeSystem	addJurisdiction(CodeableConcept t)
CodeSystem.PropertyComponent	addProperty()
CodeSystem	addProperty(CodeSystem.PropertyComponent t)
UsageContext	addUseContext()
CodeSystem	addUseContext(UsageContext t)
CodeSystem	copy()
void	copyValues(CodeSystem dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
boolean	getCaseSensitive()
BooleanType	getCaseSensitiveElement()
boolean	getCompositional()
BooleanType	getCompositionalElement()
List<CodeSystem.ConceptDefinitionComponent>	getConcept()
CodeSystem.ConceptDefinitionComponent	getConceptFirstRep()
List<ContactDetail>	getContact()
ContactDetail	getContactFirstRep()
CodeSystem.CodeSystemContentMode	getContent()
Enumeration<CodeSystem.CodeSystemContentMode>	getContentElement()
String	getCopyright()
MarkdownType	getCopyrightElement()
int	getCount()
UnsignedIntType	getCountElement()
Date	getDate()
DateTimeType	getDateElement()
String	getDescription()
MarkdownType	getDescriptionElement()
boolean	getExperimental()
BooleanType	getExperimentalElement()
List<CodeSystem.CodeSystemFilterComponent>	getFilter()
CodeSystem.CodeSystemFilterComponent	getFilterFirstRep()
CodeSystem.CodeSystemHierarchyMeaning	getHierarchyMeaning()
Enumeration<CodeSystem.CodeSystemHierarchyMeaning>	getHierarchyMeaningElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<CodeableConcept>	getJurisdiction()
CodeableConcept	getJurisdictionFirstRep()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
List<CodeSystem.PropertyComponent>	getProperty()
Base[]	getProperty(int hash, String name, boolean checkValid)
CodeSystem.PropertyComponent	getProperty(String code)
CodeSystem.PropertyComponent	getPropertyFirstRep()
String	getPublisher()
StringType	getPublisherElement()
String	getPurpose()
MarkdownType	getPurposeElement()
ResourceType	getResourceType()
Enumerations.PublicationStatus	getStatus()
Enumeration<Enumerations.PublicationStatus>	getStatusElement()
String	getSupplements()
CanonicalType	getSupplementsElement()
String	getTitle()
StringType	getTitleElement()
String[]	getTypesForProperty(int hash, String name)
String	getUrl()
UriType	getUrlElement()
List<UsageContext>	getUseContext()
UsageContext	getUseContextFirstRep()
String	getValueSet()
CanonicalType	getValueSetElement()
String	getVersion()
StringType	getVersionElement()
boolean	getVersionNeeded()
BooleanType	getVersionNeededElement()
boolean	hasCaseSensitive()
boolean	hasCaseSensitiveElement()
boolean	hasCompositional()
boolean	hasCompositionalElement()
boolean	hasConcept()
boolean	hasContact()
boolean	hasContent()
boolean	hasContentElement()
boolean	hasCopyright()
boolean	hasCopyrightElement()
boolean	hasCount()
boolean	hasCountElement()
boolean	hasDate()
boolean	hasDateElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasExperimental()
boolean	hasExperimentalElement()
boolean	hasFilter()
boolean	hasHierarchyMeaning()
boolean	hasHierarchyMeaningElement()
boolean	hasIdentifier()
boolean	hasJurisdiction()
boolean	hasName()
boolean	hasNameElement()
boolean	hasProperty()
boolean	hasPublisher()
boolean	hasPublisherElement()
boolean	hasPurpose()
boolean	hasPurposeElement()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSupplements()
boolean	hasSupplementsElement()
boolean	hasTitle()
boolean	hasTitleElement()
boolean	hasUrl()
boolean	hasUrlElement()
boolean	hasUseContext()
boolean	hasValueSet()
boolean	hasValueSetElement()
boolean	hasVersion()
boolean	hasVersionElement()
boolean	hasVersionNeeded()
boolean	hasVersionNeededElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
CodeSystem	setCaseSensitive(boolean value)
CodeSystem	setCaseSensitiveElement(BooleanType value)
CodeSystem	setCompositional(boolean value)
CodeSystem	setCompositionalElement(BooleanType value)
CodeSystem	setConcept(List<CodeSystem.ConceptDefinitionComponent> theConcept)
CodeSystem	setContact(List<ContactDetail> theContact)
CodeSystem	setContent(CodeSystem.CodeSystemContentMode value)
CodeSystem	setContentElement(Enumeration<CodeSystem.CodeSystemContentMode> value)
CodeSystem	setCopyright(String value)
CodeSystem	setCopyrightElement(MarkdownType value)
CodeSystem	setCount(int value)
CodeSystem	setCountElement(UnsignedIntType value)
CodeSystem	setDate(Date value)
CodeSystem	setDateElement(DateTimeType value)
CodeSystem	setDescription(String value)
CodeSystem	setDescriptionElement(MarkdownType value)
CodeSystem	setExperimental(boolean value)
CodeSystem	setExperimentalElement(BooleanType value)
CodeSystem	setFilter(List<CodeSystem.CodeSystemFilterComponent> theFilter)
CodeSystem	setHierarchyMeaning(CodeSystem.CodeSystemHierarchyMeaning value)
CodeSystem	setHierarchyMeaningElement(Enumeration<CodeSystem.CodeSystemHierarchyMeaning> value)
CodeSystem	setIdentifier(List<Identifier> theIdentifier)
CodeSystem	setJurisdiction(List<CodeableConcept> theJurisdiction)
CodeSystem	setName(String value)
CodeSystem	setNameElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
CodeSystem	setProperty(List<CodeSystem.PropertyComponent> theProperty)
CodeSystem	setPublisher(String value)
CodeSystem	setPublisherElement(StringType value)
CodeSystem	setPurpose(String value)
CodeSystem	setPurposeElement(MarkdownType value)
CodeSystem	setStatus(Enumerations.PublicationStatus value)
CodeSystem	setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
CodeSystem	setSupplements(String value)
CodeSystem	setSupplementsElement(CanonicalType value)
CodeSystem	setTitle(String value)
CodeSystem	setTitleElement(StringType value)
CodeSystem	setUrl(String value)
CodeSystem	setUrlElement(UriType value)
CodeSystem	setUseContext(List<UsageContext> theUseContext)
CodeSystem	setValueSet(String value)
CodeSystem	setValueSetElement(CanonicalType value)
CodeSystem	setVersion(String value)
CodeSystem	setVersionElement(StringType value)
CodeSystem	setVersionNeeded(boolean value)
CodeSystem	setVersionNeededElement(BooleanType value)
void	sort()
void	sort(Comparator<CodeSystem.ConceptDefinitionComponent> comp)
void	sort(List<CodeSystem.ConceptDefinitionComponent> list, Comparator<CodeSystem.ConceptDefinitionComponent> comp)
protected CodeSystem	typedCopy()

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

copyValues, present, toString

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

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r4.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN, setXhtml

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, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.

purpose

protected MarkdownType purpose

Explanation of why this code system is needed and why it has been designed as it has.

copyright

protected MarkdownType copyright

A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.

caseSensitive

protected BooleanType caseSensitive

If code comparison is case sensitive when codes within this system are compared to each other.

valueSet

protected CanonicalType valueSet

Canonical reference to the value set that contains the entire code system.

hierarchyMeaning

protected Enumeration<CodeSystem.CodeSystemHierarchyMeaning> hierarchyMeaning

The meaning of the hierarchy of concepts as represented in this resource.

compositional

protected BooleanType compositional

The code system defines a compositional (post-coordination) grammar.

versionNeeded

protected BooleanType versionNeeded

This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.

content

protected Enumeration<CodeSystem.CodeSystemContentMode> content

The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.

supplements

protected CanonicalType supplements

The canonical URL of the code system that this code system supplement is adding designations and properties to.

count

protected UnsignedIntType count

The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.

filter

protected List<CodeSystem.CodeSystemFilterComponent> filter

A filter that can be used in a value set compose statement when selecting concepts using a filter.

property

protected List<CodeSystem.PropertyComponent> property

A property defines an additional slot through which additional information can be provided about a concept.

concept

protected List<CodeSystem.ConceptDefinitionComponent> concept

Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.

SP_DATE

public static final String SP_DATE

Search parameter: date

Description: The code system publication date
Type: date
Path: CodeSystem.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 code system publication date
Type: date
Path: CodeSystem.date

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: External identifier for the code system
Type: token
Path: CodeSystem.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: External identifier for the code system
Type: token
Path: CodeSystem.identifier

SP_CODE

public static final String SP_CODE

Search parameter: code

Description: A code defined in the code system
Type: token
Path: CodeSystem.concept.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: A code defined in the code system
Type: token
Path: CodeSystem.concept.code

SP_CONTEXT_TYPE_VALUE

public static final String SP_CONTEXT_TYPE_VALUE

Search parameter: context-type-value

Description: A use context type and value assigned to the code system
Type: composite
Path:

See Also:

• Constant Field Values

CONTEXT_TYPE_VALUE

public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE

Fluent Client search parameter constant for context-type-value

Description: A use context type and value assigned to the code system
Type: composite
Path:

SP_CONTENT_MODE

public static final String SP_CONTENT_MODE

Search parameter: content-mode

Description: not-present | example | fragment | complete | supplement
Type: token
Path: CodeSystem.content

See Also:

• Constant Field Values

CONTENT_MODE

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

Fluent Client search parameter constant for content-mode

Description: not-present | example | fragment | complete | supplement
Type: token
Path: CodeSystem.content

SP_JURISDICTION

public static final String SP_JURISDICTION

Search parameter: jurisdiction

Description: Intended jurisdiction for the code system
Type: token
Path: CodeSystem.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 code system
Type: token
Path: CodeSystem.jurisdiction

SP_DESCRIPTION

public static final String SP_DESCRIPTION

Search parameter: description

Description: The description of the code system
Type: string
Path: CodeSystem.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 code system
Type: string
Path: CodeSystem.description

SP_CONTEXT_TYPE

public static final String SP_CONTEXT_TYPE

Search parameter: context-type

Description: A type of use context assigned to the code system
Type: token
Path: CodeSystem.useContext.code

See Also:

• Constant Field Values

CONTEXT_TYPE

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

Fluent Client search parameter constant for context-type

Description: A type of use context assigned to the code system
Type: token
Path: CodeSystem.useContext.code

SP_LANGUAGE

public static final String SP_LANGUAGE

Search parameter: language

Description: A language in which a designation is provided
Type: token
Path: CodeSystem.concept.designation.language

See Also:

• Constant Field Values

LANGUAGE

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

Fluent Client search parameter constant for language

Description: A language in which a designation is provided
Type: token
Path: CodeSystem.concept.designation.language

SP_TITLE

public static final String SP_TITLE

Search parameter: title

Description: The human-friendly name of the code system
Type: string
Path: CodeSystem.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 code system
Type: string
Path: CodeSystem.title

SP_VERSION

public static final String SP_VERSION

Search parameter: version

Description: The business version of the code system
Type: token
Path: CodeSystem.version

See Also:

• Constant Field Values

VERSION

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

Fluent Client search parameter constant for version

Description: The business version of the code system
Type: token
Path: CodeSystem.version

SP_URL

public static final String SP_URL

Search parameter: url

Description: The uri that identifies the code system
Type: uri
Path: CodeSystem.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 code system
Type: uri
Path: CodeSystem.url

SP_CONTEXT_QUANTITY

public static final String SP_CONTEXT_QUANTITY

Search parameter: context-quantity

Description: A quantity- or range-valued use context assigned to the code system
Type: quantity
Path: CodeSystem.useContext.valueQuantity, CodeSystem.useContext.valueRange

See Also:

• Constant Field Values

CONTEXT_QUANTITY

public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY

Fluent Client search parameter constant for context-quantity

Description: A quantity- or range-valued use context assigned to the code system
Type: quantity
Path: CodeSystem.useContext.valueQuantity, CodeSystem.useContext.valueRange

SP_SUPPLEMENTS

public static final String SP_SUPPLEMENTS

Search parameter: supplements

Description: Find code system supplements for the referenced code system
Type: reference
Path: CodeSystem.supplements

See Also:

• Constant Field Values

SUPPLEMENTS

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUPPLEMENTS

Fluent Client search parameter constant for supplements

Description: Find code system supplements for the referenced code system
Type: reference
Path: CodeSystem.supplements

INCLUDE_SUPPLEMENTS

public static final ca.uhn.fhir.model.api.Include INCLUDE_SUPPLEMENTS

Constant for fluent queries to be used to add include statements. Specifies the path value of "CodeSystem:supplements".

SP_SYSTEM

public static final String SP_SYSTEM

Search parameter: system

Description: The system for any codes defined by this code system (same as 'url')
Type: uri
Path: CodeSystem.url

See Also:

• Constant Field Values

SYSTEM

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

Fluent Client search parameter constant for system

Description: The system for any codes defined by this code system (same as 'url')
Type: uri
Path: CodeSystem.url

SP_NAME

public static final String SP_NAME

Search parameter: name

Description: Computationally friendly name of the code system
Type: string
Path: CodeSystem.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 code system
Type: string
Path: CodeSystem.name

SP_CONTEXT

public static final String SP_CONTEXT

Search parameter: context

Description: A use context assigned to the code system
Type: token
Path: CodeSystem.useContext.valueCodeableConcept

See Also:

• Constant Field Values

CONTEXT

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

Fluent Client search parameter constant for context

Description: A use context assigned to the code system
Type: token
Path: CodeSystem.useContext.valueCodeableConcept

SP_PUBLISHER

public static final String SP_PUBLISHER

Search parameter: publisher

Description: Name of the publisher of the code system
Type: string
Path: CodeSystem.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 code system
Type: string
Path: CodeSystem.publisher

SP_CONTEXT_TYPE_QUANTITY

public static final String SP_CONTEXT_TYPE_QUANTITY

Search parameter: context-type-quantity

Description: A use context type and quantity- or range-based value assigned to the code system
Type: composite
Path:

See Also:

• Constant Field Values

CONTEXT_TYPE_QUANTITY

public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY

Fluent Client search parameter constant for context-type-quantity

Description: A use context type and quantity- or range-based value assigned to the code system
Type: composite
Path:

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The current status of the code system
Type: token
Path: CodeSystem.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 code system
Type: token
Path: CodeSystem.status

Constructor Details

CodeSystem

public CodeSystem()

Constructor

CodeSystem

public CodeSystem(Enumeration<Enumerations.PublicationStatus> status,
 Enumeration<CodeSystem.CodeSystemContentMode> content)

Constructor

Method Details

getUrlElement

public UriType getUrlElement()

Overrides:

getUrlElement in class MetadataResource

Returns:

MetadataResource.url (An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in [Coding](datatypes.html#Coding).system.). 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 CodeSystem setUrlElement(UriType value)

Overrides:

setUrlElement in class MetadataResource

Parameters:

value - MetadataResource.url (An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in [Coding](datatypes.html#Coding).system.). 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 code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in [Coding](datatypes.html#Coding).system.

setUrl

public CodeSystem setUrl(String value)

Overrides:

setUrl in class MetadataResource

Parameters:

value - An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in [Coding](datatypes.html#Coding).system.

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.)

setIdentifier

public CodeSystem setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public CodeSystem addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

getVersionElement

public StringType getVersionElement()

Overrides:

getVersionElement in class MetadataResource

Returns:

MetadataResource.version (The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding](datatypes.html#Coding).version.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

hasVersionElement

public boolean hasVersionElement()

Overrides:

hasVersionElement in class MetadataResource

hasVersion

public boolean hasVersion()

Overrides:

hasVersion in class MetadataResource

setVersionElement

public CodeSystem setVersionElement(StringType value)

Overrides:

setVersionElement in class MetadataResource

Parameters:

value - MetadataResource.version (The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding](datatypes.html#Coding).version.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

getVersion

public String getVersion()

Overrides:

getVersion in class MetadataResource

Returns:

The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding](datatypes.html#Coding).version.

setVersion

public CodeSystem setVersion(String value)

Overrides:

setVersion in class MetadataResource

Parameters:

value - The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding](datatypes.html#Coding).version.

getNameElement

public StringType getNameElement()

Overrides:

getNameElement in class MetadataResource

Returns:

MetadataResource.name (A natural language name identifying the code system. 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 CodeSystem setNameElement(StringType value)

Overrides:

setNameElement in class MetadataResource

Parameters:

value - MetadataResource.name (A natural language name identifying the code system. 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 code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.

setName

public CodeSystem setName(String value)

Overrides:

setName in class MetadataResource

Parameters:

value - A natural language name identifying the code system. 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 code system.). 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 CodeSystem setTitleElement(StringType value)

Overrides:

setTitleElement in class MetadataResource

Parameters:

value - MetadataResource.title (A short, descriptive, user-friendly title for the code system.). 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 code system.

setTitle

public CodeSystem setTitle(String value)

Overrides:

setTitle in class MetadataResource

Parameters:

value - A short, descriptive, user-friendly title for the code system.

getStatusElement

public Enumeration<Enumerations.PublicationStatus> getStatusElement()

Overrides:

getStatusElement in class MetadataResource

Returns:

MetadataResource.status (The date (and optionally time) when the code system resource was created or revised.). 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 CodeSystem setStatusElement(Enumeration<Enumerations.PublicationStatus> value)

Overrides:

setStatusElement in class MetadataResource

Parameters:

value - MetadataResource.status (The date (and optionally time) when the code system resource was created or revised.). 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 date (and optionally time) when the code system resource was created or revised.

setStatus

public CodeSystem setStatus(Enumerations.PublicationStatus value)

Overrides:

setStatus in class MetadataResource

Parameters:

value - The date (and optionally time) when the code system resource was created or revised.

getExperimentalElement

public BooleanType getExperimentalElement()

Overrides:

getExperimentalElement in class MetadataResource

Returns:

MetadataResource.experimental (A Boolean value to indicate that this code system 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 CodeSystem setExperimentalElement(BooleanType value)

Overrides:

setExperimentalElement in class MetadataResource

Parameters:

value - MetadataResource.experimental (A Boolean value to indicate that this code system 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 code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

setExperimental

public CodeSystem setExperimental(boolean value)

Overrides:

setExperimental in class MetadataResource

Parameters:

value - A Boolean value to indicate that this code system 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 code system was published. The date must change 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 code system 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 CodeSystem setDateElement(DateTimeType value)

Overrides:

setDateElement in class MetadataResource

Parameters:

value - MetadataResource.date (The date (and optionally time) when the code system was published. The date must change 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 code system 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 code system was published. The date must change 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 code system changes.

setDate

public CodeSystem setDate(Date value)

Overrides:

setDate in class MetadataResource

Parameters:

value - The date (and optionally time) when the code system was published. The date must change 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 code system changes.

getPublisherElement

public StringType getPublisherElement()

Overrides:

getPublisherElement in class MetadataResource

Returns:

MetadataResource.publisher (The name of the organization or individual that published the code system.). 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 CodeSystem setPublisherElement(StringType value)

Overrides:

setPublisherElement in class MetadataResource

Parameters:

value - MetadataResource.publisher (The name of the organization or individual that published the code system.). 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 organization or individual that published the code system.

setPublisher

public CodeSystem setPublisher(String value)

Overrides:

setPublisher in class MetadataResource

Parameters:

value - The name of the organization or individual that published the code system.

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 CodeSystem 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 CodeSystem 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 code system 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 CodeSystem setDescriptionElement(MarkdownType value)

Overrides:

setDescriptionElement in class MetadataResource

Parameters:

value - MetadataResource.description (A free text natural language description of the code system 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 code system from a consumer's perspective.

setDescription

public CodeSystem setDescription(String value)

Overrides:

setDescription in class MetadataResource

Parameters:

value - A free text natural language description of the code system from a consumer's perspective.

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 contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances.)

setUseContext

public CodeSystem 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 CodeSystem 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 code system is intended to be used.)

setJurisdiction

public CodeSystem 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 CodeSystem 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

getPurposeElement

public MarkdownType getPurposeElement()

Returns:

purpose (Explanation of why this code system 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 CodeSystem setPurposeElement(MarkdownType value)

Parameters:

value - purpose (Explanation of why this code system 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:

Explanation of why this code system is needed and why it has been designed as it has.

setPurpose

public CodeSystem setPurpose(String value)

Parameters:

value - Explanation of why this code system is needed and why it has been designed as it has.

getCopyrightElement

public MarkdownType getCopyrightElement()

Returns:

copyright (A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value

hasCopyrightElement

public boolean hasCopyrightElement()

hasCopyright

public boolean hasCopyright()

setCopyrightElement

public CodeSystem setCopyrightElement(MarkdownType value)

Parameters:

value - copyright (A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value

getCopyright

public String getCopyright()

Returns:

A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.

setCopyright

public CodeSystem setCopyright(String value)

Parameters:

value - A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.

getCaseSensitiveElement

public BooleanType getCaseSensitiveElement()

Returns:

caseSensitive (If code comparison is case sensitive when codes within this system are compared to each other.). This is the underlying object with id, value and extensions. The accessor "getCaseSensitive" gives direct access to the value

hasCaseSensitiveElement

public boolean hasCaseSensitiveElement()

hasCaseSensitive

public boolean hasCaseSensitive()

setCaseSensitiveElement

public CodeSystem setCaseSensitiveElement(BooleanType value)

Parameters:

value - caseSensitive (If code comparison is case sensitive when codes within this system are compared to each other.). This is the underlying object with id, value and extensions. The accessor "getCaseSensitive" gives direct access to the value

getCaseSensitive

public boolean getCaseSensitive()

Returns:

If code comparison is case sensitive when codes within this system are compared to each other.

setCaseSensitive

public CodeSystem setCaseSensitive(boolean value)

Parameters:

value - If code comparison is case sensitive when codes within this system are compared to each other.

getValueSetElement

public CanonicalType getValueSetElement()

Returns:

valueSet (Canonical reference to the value set that contains the entire code system.). This is the underlying object with id, value and extensions. The accessor "getValueSet" gives direct access to the value

hasValueSetElement

public boolean hasValueSetElement()

hasValueSet

public boolean hasValueSet()

setValueSetElement

public CodeSystem setValueSetElement(CanonicalType value)

Parameters:

value - valueSet (Canonical reference to the value set that contains the entire code system.). This is the underlying object with id, value and extensions. The accessor "getValueSet" gives direct access to the value

getValueSet

public String getValueSet()

Returns:

Canonical reference to the value set that contains the entire code system.

setValueSet

public CodeSystem setValueSet(String value)

Parameters:

value - Canonical reference to the value set that contains the entire code system.

getHierarchyMeaningElement

public Enumeration<CodeSystem.CodeSystemHierarchyMeaning> getHierarchyMeaningElement()

Returns:

hierarchyMeaning (The meaning of the hierarchy of concepts as represented in this resource.). This is the underlying object with id, value and extensions. The accessor "getHierarchyMeaning" gives direct access to the value

hasHierarchyMeaningElement

public boolean hasHierarchyMeaningElement()

hasHierarchyMeaning

public boolean hasHierarchyMeaning()

setHierarchyMeaningElement

public CodeSystem setHierarchyMeaningElement(Enumeration<CodeSystem.CodeSystemHierarchyMeaning> value)

Parameters:

value - hierarchyMeaning (The meaning of the hierarchy of concepts as represented in this resource.). This is the underlying object with id, value and extensions. The accessor "getHierarchyMeaning" gives direct access to the value

getHierarchyMeaning

public CodeSystem.CodeSystemHierarchyMeaning getHierarchyMeaning()

Returns:

The meaning of the hierarchy of concepts as represented in this resource.

setHierarchyMeaning

public CodeSystem setHierarchyMeaning(CodeSystem.CodeSystemHierarchyMeaning value)

Parameters:

value - The meaning of the hierarchy of concepts as represented in this resource.

getCompositionalElement

public BooleanType getCompositionalElement()

Returns:

compositional (The code system defines a compositional (post-coordination) grammar.). This is the underlying object with id, value and extensions. The accessor "getCompositional" gives direct access to the value

hasCompositionalElement

public boolean hasCompositionalElement()

hasCompositional

public boolean hasCompositional()

setCompositionalElement

public CodeSystem setCompositionalElement(BooleanType value)

Parameters:

value - compositional (The code system defines a compositional (post-coordination) grammar.). This is the underlying object with id, value and extensions. The accessor "getCompositional" gives direct access to the value

getCompositional

public boolean getCompositional()

Returns:

The code system defines a compositional (post-coordination) grammar.

setCompositional

public CodeSystem setCompositional(boolean value)

Parameters:

value - The code system defines a compositional (post-coordination) grammar.

getVersionNeededElement

public BooleanType getVersionNeededElement()

Returns:

versionNeeded (This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.). This is the underlying object with id, value and extensions. The accessor "getVersionNeeded" gives direct access to the value

hasVersionNeededElement

public boolean hasVersionNeededElement()

hasVersionNeeded

public boolean hasVersionNeeded()

setVersionNeededElement

public CodeSystem setVersionNeededElement(BooleanType value)

Parameters:

value - versionNeeded (This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.). This is the underlying object with id, value and extensions. The accessor "getVersionNeeded" gives direct access to the value

getVersionNeeded

public boolean getVersionNeeded()

Returns:

This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.

setVersionNeeded

public CodeSystem setVersionNeeded(boolean value)

Parameters:

value - This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.

getContentElement

public Enumeration<CodeSystem.CodeSystemContentMode> getContentElement()

Returns:

content (The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.). This is the underlying object with id, value and extensions. The accessor "getContent" gives direct access to the value

hasContentElement

public boolean hasContentElement()

hasContent

public boolean hasContent()

setContentElement

public CodeSystem setContentElement(Enumeration<CodeSystem.CodeSystemContentMode> value)

Parameters:

value - content (The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.). This is the underlying object with id, value and extensions. The accessor "getContent" gives direct access to the value

getContent

public CodeSystem.CodeSystemContentMode getContent()

Returns:

The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.

setContent

public CodeSystem setContent(CodeSystem.CodeSystemContentMode value)

Parameters:

value - The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.

getSupplementsElement

public CanonicalType getSupplementsElement()

Returns:

supplements (The canonical URL of the code system that this code system supplement is adding designations and properties to.). This is the underlying object with id, value and extensions. The accessor "getSupplements" gives direct access to the value

hasSupplementsElement

public boolean hasSupplementsElement()

hasSupplements

public boolean hasSupplements()

setSupplementsElement

public CodeSystem setSupplementsElement(CanonicalType value)

Parameters:

value - supplements (The canonical URL of the code system that this code system supplement is adding designations and properties to.). This is the underlying object with id, value and extensions. The accessor "getSupplements" gives direct access to the value

getSupplements

public String getSupplements()

Returns:

The canonical URL of the code system that this code system supplement is adding designations and properties to.

setSupplements

public CodeSystem setSupplements(String value)

Parameters:

value - The canonical URL of the code system that this code system supplement is adding designations and properties to.

getCountElement

public UnsignedIntType getCountElement()

Returns:

count (The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.). This is the underlying object with id, value and extensions. The accessor "getCount" gives direct access to the value

hasCountElement

public boolean hasCountElement()

hasCount

public boolean hasCount()

setCountElement

public CodeSystem setCountElement(UnsignedIntType value)

Parameters:

value - count (The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.). This is the underlying object with id, value and extensions. The accessor "getCount" gives direct access to the value

getCount

public int getCount()

Returns:

The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.

setCount

public CodeSystem setCount(int value)

Parameters:

value - The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.

getFilter

public List<CodeSystem.CodeSystemFilterComponent> getFilter()

Returns:

filter (A filter that can be used in a value set compose statement when selecting concepts using a filter.)

setFilter

public CodeSystem setFilter(List<CodeSystem.CodeSystemFilterComponent> theFilter)

Returns:

Returns a reference to this for easy method chaining

hasFilter

public boolean hasFilter()

addFilter

public CodeSystem.CodeSystemFilterComponent addFilter()

addFilter

public CodeSystem addFilter(CodeSystem.CodeSystemFilterComponent t)

getFilterFirstRep

public CodeSystem.CodeSystemFilterComponent getFilterFirstRep()

Returns:

The first repetition of repeating field filter, creating it if it does not already exist

getProperty

public List<CodeSystem.PropertyComponent> getProperty()

Returns:

property (A property defines an additional slot through which additional information can be provided about a concept.)

setProperty

public CodeSystem setProperty(List<CodeSystem.PropertyComponent> theProperty)

Returns:

Returns a reference to this for easy method chaining

hasProperty

public boolean hasProperty()

addProperty

public CodeSystem.PropertyComponent addProperty()

addProperty

public CodeSystem addProperty(CodeSystem.PropertyComponent t)

getPropertyFirstRep

public CodeSystem.PropertyComponent getPropertyFirstRep()

Returns:

The first repetition of repeating field property, creating it if it does not already exist

getConcept

public List<CodeSystem.ConceptDefinitionComponent> getConcept()

Returns:

concept (Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.)

setConcept

public CodeSystem setConcept(List<CodeSystem.ConceptDefinitionComponent> theConcept)

Returns:

Returns a reference to this for easy method chaining

hasConcept

public boolean hasConcept()

addConcept

public CodeSystem.ConceptDefinitionComponent addConcept()

addConcept

public CodeSystem addConcept(CodeSystem.ConceptDefinitionComponent t)

getConceptFirstRep

public CodeSystem.ConceptDefinitionComponent getConceptFirstRep()

Returns:

The first repetition of repeating field concept, 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 DomainResource

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

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild 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 CodeSystem copy()

Specified by:

copy in class MetadataResource

copyValues

public void copyValues(CodeSystem dst)

typedCopy

protected CodeSystem 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

getProperty

public CodeSystem.PropertyComponent getProperty(String code)

sort

public void sort()

sort

public void sort(List<CodeSystem.ConceptDefinitionComponent> list,
 Comparator<CodeSystem.ConceptDefinitionComponent> comp)

sort

public void sort(Comparator<CodeSystem.ConceptDefinitionComponent> comp)