Class 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
- See Also:
- Serialized Form
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic classstatic classclassstatic classstatic classstatic classstatic classstatic classstatic classstatic class -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected BooleanTypeIf code comparison is case sensitive when codes within this system are compared to each other.static ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for codeprotected BooleanTypeThe code system defines a compositional (post-coordination) grammar.protected List<CodeSystem.ConceptDefinitionComponent>Concepts that are in the code system.protected Enumeration<CodeSystem.CodeSystemContentMode>The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.static ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for content-modestatic ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for contextstatic ca.uhn.fhir.rest.gclient.QuantityClientParamFluent Client search parameter constant for context-quantitystatic ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for context-typestatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam>Fluent Client search parameter constant for context-type-quantitystatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>Fluent Client search parameter constant for context-type-valueprotected MarkdownTypeA copyright statement relating to the code system and/or its contents.protected UnsignedIntTypeThe total number of concepts defined by the code system.static ca.uhn.fhir.rest.gclient.DateClientParamFluent Client search parameter constant for datestatic ca.uhn.fhir.rest.gclient.StringClientParamFluent Client search parameter constant for descriptionprotected List<CodeSystem.CodeSystemFilterComponent>A filter that can be used in a value set compose statement when selecting concepts using a filter.protected Enumeration<CodeSystem.CodeSystemHierarchyMeaning>The meaning of the hierarchy of concepts as represented in this resource.protected List<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 ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for jurisdictionstatic ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for languagestatic ca.uhn.fhir.rest.gclient.StringClientParamFluent Client search parameter constant for nameprotected List<CodeSystem.PropertyComponent>A property defines an additional slot through which additional information can be provided about a concept.static ca.uhn.fhir.rest.gclient.StringClientParamFluent Client search parameter constant for publisherprotected MarkdownTypeExplanation of why this code system is needed and why it has been designed as it has.static StringSearch parameter: codestatic StringSearch parameter: content-modestatic StringSearch parameter: contextstatic StringSearch parameter: context-quantitystatic StringSearch parameter: context-typestatic StringSearch parameter: context-type-quantitystatic StringSearch parameter: context-type-valuestatic StringSearch parameter: datestatic StringSearch parameter: descriptionstatic StringSearch parameter: identifierstatic StringSearch parameter: jurisdictionstatic StringSearch parameter: languagestatic StringSearch parameter: namestatic StringSearch parameter: publisherstatic StringSearch parameter: statusstatic StringSearch parameter: supplementsstatic StringSearch parameter: systemstatic StringSearch parameter: titlestatic StringSearch parameter: urlstatic StringSearch parameter: versionstatic ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for statusprotected CanonicalTypeThe canonical URL of the code system that this code system supplement is adding designations and properties to.static ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for supplementsstatic ca.uhn.fhir.rest.gclient.UriClientParamFluent Client search parameter constant for systemstatic ca.uhn.fhir.rest.gclient.StringClientParamFluent Client search parameter constant for titlestatic ca.uhn.fhir.rest.gclient.UriClientParamFluent Client search parameter constant for urlprotected CanonicalTypeCanonical reference to the value set that contains the entire code system.static ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for versionprotected BooleanTypeThis 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, versionFields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, textFields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, metaFields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGEFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET -
Constructor Summary
ConstructorsConstructorDescriptionConstructorCodeSystem(Enumeration<Enumerations.PublicationStatus> status, Enumeration<CodeSystem.CodeSystemContentMode> content)Constructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()voidcopyValues(CodeSystem dst)booleanequalsDeep(Base other_)booleanequalsShallow(Base other_)fhirType()booleanbooleanintgetCount()getDate()booleangetName()getNamedProperty(int _hash, String _name, boolean _checkValid)Base[]getProperty(int hash, String name, boolean checkValid)getProperty(String code)getTitle()String[]getTypesForProperty(int hash, String name)getUrl()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasCount()booleanbooleanhasDate()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasName()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasTitle()booleanbooleanhasUrl()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> children)makeProperty(int hash, String name)setCaseSensitive(boolean value)setCaseSensitiveElement(BooleanType value)setCompositional(boolean value)setCompositionalElement(BooleanType value)setConcept(List<CodeSystem.ConceptDefinitionComponent> theConcept)setContact(List<ContactDetail> theContact)setCopyright(String value)setCopyrightElement(MarkdownType value)setCount(int value)setCountElement(UnsignedIntType value)setDateElement(DateTimeType value)setDescription(String value)setDescriptionElement(MarkdownType value)setExperimental(boolean value)setExperimentalElement(BooleanType value)setFilter(List<CodeSystem.CodeSystemFilterComponent> theFilter)setIdentifier(List<Identifier> theIdentifier)setJurisdiction(List<CodeableConcept> theJurisdiction)setNameElement(StringType value)setProperty(int hash, String name, Base value)setProperty(String name, Base value)setProperty(List<CodeSystem.PropertyComponent> theProperty)setPublisher(String value)setPublisherElement(StringType value)setPurpose(String value)setPurposeElement(MarkdownType value)setSupplements(String value)setSupplementsElement(CanonicalType value)setTitleElement(StringType value)setUrlElement(UriType value)setUseContext(List<UsageContext> theUseContext)setValueSet(String value)setValueSetElement(CanonicalType value)setVersion(String value)setVersionElement(StringType value)setVersionNeeded(boolean value)setVersionNeededElement(BooleanType value)voidsort()voidvoidsort(List<CodeSystem.ConceptDefinitionComponent> list, Comparator<CodeSystem.ConceptDefinitionComponent> comp)protected CodeSystemMethods inherited from class org.hl7.fhir.r4.model.MetadataResource
copyValues, present, toStringMethods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setTextMethods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetaMethods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setIdMethods 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, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId
-
Field Details
-
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
Explanation of why this code system is needed and why it has been designed as it has. -
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
If code comparison is case sensitive when codes within this system are compared to each other. -
valueSet
Canonical reference to the value set that contains the entire code system. -
hierarchyMeaning
The meaning of the hierarchy of concepts as represented in this resource. -
compositional
The code system defines a compositional (post-coordination) grammar. -
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. -
The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.
-
supplements
The canonical URL of the code system that this code system supplement is adding designations and properties to. -
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
A filter that can be used in a value set compose statement when selecting concepts using a filter. -
property
A property defines an additional slot through which additional information can be provided about a concept. -
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
Search parameter: dateDescription: The code system publication date
Type: date
Path: CodeSystem.date
- See Also:
- Constant Field Values
-
DATE
Fluent Client search parameter constant for dateDescription: The code system publication date
Type: date
Path: CodeSystem.date
-
SP_IDENTIFIER
Search parameter: identifierDescription: External identifier for the code system
Type: token
Path: CodeSystem.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External identifier for the code system
Type: token
Path: CodeSystem.identifier
-
SP_CODE
Search parameter: codeDescription: A code defined in the code system
Type: token
Path: CodeSystem.concept.code
- See Also:
- Constant Field Values
-
CODE
Fluent Client search parameter constant for codeDescription: A code defined in the code system
Type: token
Path: CodeSystem.concept.code
-
SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-valueDescription: 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_VALUEFluent Client search parameter constant for context-type-valueDescription: A use context type and value assigned to the code system
Type: composite
Path:
-
SP_CONTENT_MODE
Search parameter: content-modeDescription: not-present | example | fragment | complete | supplement
Type: token
Path: CodeSystem.content
- See Also:
- Constant Field Values
-
CONTENT_MODE
Fluent Client search parameter constant for content-modeDescription: not-present | example | fragment | complete | supplement
Type: token
Path: CodeSystem.content
-
SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the code system
Type: token
Path: CodeSystem.jurisdiction
- See Also:
- Constant Field Values
-
JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the code system
Type: token
Path: CodeSystem.jurisdiction
-
SP_DESCRIPTION
Search parameter: descriptionDescription: The description of the code system
Type: string
Path: CodeSystem.description
- See Also:
- Constant Field Values
-
DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: The description of the code system
Type: string
Path: CodeSystem.description
-
SP_CONTEXT_TYPE
Search parameter: context-typeDescription: A type of use context assigned to the code system
Type: token
Path: CodeSystem.useContext.code
- See Also:
- Constant Field Values
-
CONTEXT_TYPE
Fluent Client search parameter constant for context-typeDescription: A type of use context assigned to the code system
Type: token
Path: CodeSystem.useContext.code
-
SP_LANGUAGE
Search parameter: languageDescription: A language in which a designation is provided
Type: token
Path: CodeSystem.concept.designation.language
- See Also:
- Constant Field Values
-
LANGUAGE
Fluent Client search parameter constant for languageDescription: A language in which a designation is provided
Type: token
Path: CodeSystem.concept.designation.language
-
SP_TITLE
Search parameter: titleDescription: The human-friendly name of the code system
Type: string
Path: CodeSystem.title
- See Also:
- Constant Field Values
-
TITLE
Fluent Client search parameter constant for titleDescription: The human-friendly name of the code system
Type: string
Path: CodeSystem.title
-
SP_VERSION
Search parameter: versionDescription: The business version of the code system
Type: token
Path: CodeSystem.version
- See Also:
- Constant Field Values
-
VERSION
Fluent Client search parameter constant for versionDescription: The business version of the code system
Type: token
Path: CodeSystem.version
-
SP_URL
Search parameter: urlDescription: The uri that identifies the code system
Type: uri
Path: CodeSystem.url
- See Also:
- Constant Field Values
-
URL
Fluent Client search parameter constant for urlDescription: The uri that identifies the code system
Type: uri
Path: CodeSystem.url
-
SP_CONTEXT_QUANTITY
Search parameter: context-quantityDescription: 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
Fluent Client search parameter constant for context-quantityDescription: A quantity- or range-valued use context assigned to the code system
Type: quantity
Path: CodeSystem.useContext.valueQuantity, CodeSystem.useContext.valueRange
-
SP_SUPPLEMENTS
Search parameter: supplementsDescription: Find code system supplements for the referenced code system
Type: reference
Path: CodeSystem.supplements
- See Also:
- Constant Field Values
-
SUPPLEMENTS
Fluent Client search parameter constant for supplementsDescription: Find code system supplements for the referenced code system
Type: reference
Path: CodeSystem.supplements
-
INCLUDE_SUPPLEMENTS
Constant for fluent queries to be used to add include statements. Specifies the path value of "CodeSystem:supplements". -
SP_SYSTEM
Search parameter: systemDescription: The system for any codes defined by this code system (same as 'url')
Type: uri
Path: CodeSystem.url
- See Also:
- Constant Field Values
-
SYSTEM
Fluent Client search parameter constant for systemDescription: The system for any codes defined by this code system (same as 'url')
Type: uri
Path: CodeSystem.url
-
SP_NAME
Search parameter: nameDescription: Computationally friendly name of the code system
Type: string
Path: CodeSystem.name
- See Also:
- Constant Field Values
-
NAME
Fluent Client search parameter constant for nameDescription: Computationally friendly name of the code system
Type: string
Path: CodeSystem.name
-
SP_CONTEXT
Search parameter: contextDescription: A use context assigned to the code system
Type: token
Path: CodeSystem.useContext.valueCodeableConcept
- See Also:
- Constant Field Values
-
CONTEXT
Fluent Client search parameter constant for contextDescription: A use context assigned to the code system
Type: token
Path: CodeSystem.useContext.valueCodeableConcept
-
SP_PUBLISHER
Search parameter: publisherDescription: Name of the publisher of the code system
Type: string
Path: CodeSystem.publisher
- See Also:
- Constant Field Values
-
PUBLISHER
Fluent Client search parameter constant for publisherDescription: Name of the publisher of the code system
Type: string
Path: CodeSystem.publisher
-
SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantityDescription: 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_QUANTITYFluent Client search parameter constant for context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the code system
Type: composite
Path:
-
SP_STATUS
Search parameter: statusDescription: The current status of the code system
Type: token
Path: CodeSystem.status
- See Also:
- Constant Field Values
-
STATUS
Fluent Client search parameter constant for statusDescription: 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
- Overrides:
getUrlElementin classMetadataResource- 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
- Overrides:
hasUrlElementin classMetadataResource
-
hasUrl
- Overrides:
hasUrlin classMetadataResource
-
setUrlElement
- Overrides:
setUrlElementin classMetadataResource- 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
- Overrides:
getUrlin classMetadataResource- 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
- Overrides:
setUrlin classMetadataResource- 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
- 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
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
getVersionElement
- Overrides:
getVersionElementin classMetadataResource- 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
- Overrides:
hasVersionElementin classMetadataResource
-
hasVersion
- Overrides:
hasVersionin classMetadataResource
-
setVersionElement
- Overrides:
setVersionElementin classMetadataResource- 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
- Overrides:
getVersionin classMetadataResource- 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
- Overrides:
setVersionin classMetadataResource- 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
- Overrides:
getNameElementin classMetadataResource- 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
- Overrides:
hasNameElementin classMetadataResource
-
hasName
- Overrides:
hasNamein classMetadataResource
-
setNameElement
- Overrides:
setNameElementin classMetadataResource- 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
- Overrides:
getNamein classMetadataResource- 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
- Overrides:
setNamein classMetadataResource- 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
- Overrides:
getTitleElementin classMetadataResource- 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
- Overrides:
hasTitleElementin classMetadataResource
-
hasTitle
- Overrides:
hasTitlein classMetadataResource
-
setTitleElement
- Overrides:
setTitleElementin classMetadataResource- 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
- Overrides:
getTitlein classMetadataResource- Returns:
- A short, descriptive, user-friendly title for the code system.
-
setTitle
- Overrides:
setTitlein classMetadataResource- Parameters:
value- A short, descriptive, user-friendly title for the code system.
-
getStatusElement
- Overrides:
getStatusElementin classMetadataResource- 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
- Overrides:
hasStatusElementin classMetadataResource
-
hasStatus
- Overrides:
hasStatusin classMetadataResource
-
setStatusElement
- Overrides:
setStatusElementin classMetadataResource- 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
- Overrides:
getStatusin classMetadataResource- Returns:
- The date (and optionally time) when the code system resource was created or revised.
-
setStatus
- Overrides:
setStatusin classMetadataResource- Parameters:
value- The date (and optionally time) when the code system resource was created or revised.
-
getExperimentalElement
- Overrides:
getExperimentalElementin classMetadataResource- 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
- Overrides:
hasExperimentalElementin classMetadataResource
-
hasExperimental
- Overrides:
hasExperimentalin classMetadataResource
-
setExperimentalElement
- Overrides:
setExperimentalElementin classMetadataResource- 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
- Overrides:
getExperimentalin classMetadataResource- 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
- Overrides:
setExperimentalin classMetadataResource- 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
- Overrides:
getDateElementin classMetadataResource- 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
- Overrides:
hasDateElementin classMetadataResource
-
hasDate
- Overrides:
hasDatein classMetadataResource
-
setDateElement
- Overrides:
setDateElementin classMetadataResource- 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
- Overrides:
getDatein classMetadataResource- 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
- Overrides:
setDatein classMetadataResource- 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
- Overrides:
getPublisherElementin classMetadataResource- 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
- Overrides:
hasPublisherElementin classMetadataResource
-
hasPublisher
- Overrides:
hasPublisherin classMetadataResource
-
setPublisherElement
- Overrides:
setPublisherElementin classMetadataResource- 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
- Overrides:
getPublisherin classMetadataResource- Returns:
- The name of the organization or individual that published the code system.
-
setPublisher
- Overrides:
setPublisherin classMetadataResource- Parameters:
value- The name of the organization or individual that published the code system.
-
getContact
- Overrides:
getContactin classMetadataResource- Returns:
MetadataResource.contact(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
- Overrides:
setContactin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
- Overrides:
hasContactin classMetadataResource
-
addContact
- Overrides:
addContactin classMetadataResource
-
addContact
- Overrides:
addContactin classMetadataResource
-
getContactFirstRep
- Overrides:
getContactFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.contact, creating it if it does not already exist
-
getDescriptionElement
- Overrides:
getDescriptionElementin classMetadataResource- 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
- Overrides:
hasDescriptionElementin classMetadataResource
-
hasDescription
- Overrides:
hasDescriptionin classMetadataResource
-
setDescriptionElement
- Overrides:
setDescriptionElementin classMetadataResource- 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
- Overrides:
getDescriptionin classMetadataResource- Returns:
- A free text natural language description of the code system from a consumer's perspective.
-
setDescription
- Overrides:
setDescriptionin classMetadataResource- Parameters:
value- A free text natural language description of the code system from a consumer's perspective.
-
getUseContext
- Overrides:
getUseContextin classMetadataResource- 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
- Overrides:
setUseContextin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUseContext
- Overrides:
hasUseContextin classMetadataResource
-
addUseContext
- Overrides:
addUseContextin classMetadataResource
-
addUseContext
- Overrides:
addUseContextin classMetadataResource
-
getUseContextFirstRep
- Overrides:
getUseContextFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.useContext, creating it if it does not already exist
-
getJurisdiction
- Overrides:
getJurisdictionin classMetadataResource- Returns:
MetadataResource.jurisdiction(A legal or geographic region in which the code system is intended to be used.)
-
setJurisdiction
- Overrides:
setJurisdictionin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasJurisdiction
- Overrides:
hasJurisdictionin classMetadataResource
-
addJurisdiction
- Overrides:
addJurisdictionin classMetadataResource
-
addJurisdiction
- Overrides:
addJurisdictionin classMetadataResource
-
getJurisdictionFirstRep
- Overrides:
getJurisdictionFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.jurisdiction, creating it if it does not already exist
-
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
-
hasPurpose
-
setPurposeElement
- 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
- Returns:
- Explanation of why this code system is needed and why it has been designed as it has.
-
setPurpose
- Parameters:
value- Explanation of why this code system is needed and why it has been designed as it has.
-
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
-
hasCopyright
-
setCopyrightElement
- 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
- 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
- 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
- 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
-
hasCaseSensitive
-
setCaseSensitiveElement
- 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
- Returns:
- If code comparison is case sensitive when codes within this system are compared to each other.
-
setCaseSensitive
- Parameters:
value- If code comparison is case sensitive when codes within this system are compared to each other.
-
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
-
hasValueSet
-
setValueSetElement
- 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
- Returns:
- Canonical reference to the value set that contains the entire code system.
-
setValueSet
- Parameters:
value- Canonical reference to the value set that contains the entire code system.
-
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
-
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
- Returns:
- The meaning of the hierarchy of concepts as represented in this resource.
-
setHierarchyMeaning
- Parameters:
value- The meaning of the hierarchy of concepts as represented in this resource.
-
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
-
hasCompositional
-
setCompositionalElement
- 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
- Returns:
- The code system defines a compositional (post-coordination) grammar.
-
setCompositional
- Parameters:
value- The code system defines a compositional (post-coordination) grammar.
-
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
-
hasVersionNeeded
-
setVersionNeededElement
- 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
- 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
- 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
- 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
-
hasContent
-
setContentElement
- 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
- Returns:
- The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.
-
setContent
- Parameters:
value- The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.
-
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
-
hasSupplements
-
setSupplementsElement
- 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
- Returns:
- The canonical URL of the code system that this code system supplement is adding designations and properties to.
-
setSupplements
- Parameters:
value- The canonical URL of the code system that this code system supplement is adding designations and properties to.
-
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
-
hasCount
-
setCountElement
- 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
- 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
- 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
- Returns:
filter(A filter that can be used in a value set compose statement when selecting concepts using a filter.)
-
setFilter
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasFilter
-
addFilter
-
addFilter
-
getFilterFirstRep
- Returns:
- The first repetition of repeating field
filter, creating it if it does not already exist
-
getProperty
- Returns:
property(A property defines an additional slot through which additional information can be provided about a concept.)
-
setProperty
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasProperty
-
addProperty
-
addProperty
-
getPropertyFirstRep
- Returns:
- The first repetition of repeating field
property, creating it if it does not already exist
-
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
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasConcept
-
addConcept
-
addConcept
-
getConceptFirstRep
- Returns:
- The first repetition of repeating field
concept, creating it if it does not already exist
-
listChildren
- Overrides:
listChildrenin classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException- Overrides:
getPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException- Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makePropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException- Overrides:
getTypesForPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChildin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classMetadataResource
-
copy
- Specified by:
copyin classMetadataResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeepin classMetadataResource
-
equalsShallow
- Overrides:
equalsShallowin classMetadataResource
-
isEmpty
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classMetadataResource
-
getResourceType
- Specified by:
getResourceTypein classResource
-
getProperty
-
sort
-
sort
public void sort(List<CodeSystem.ConceptDefinitionComponent> list, Comparator<CodeSystem.ConceptDefinitionComponent> comp) -
sort
-