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
public class CodeSystem extends MetadataResource
A code system resource specifies a set of codes drawn from one or more code systems.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCodeSystem.CodeSystemContentModestatic classCodeSystem.CodeSystemContentModeEnumFactorystatic classCodeSystem.CodeSystemFilterComponentstatic classCodeSystem.CodeSystemHierarchyMeaningstatic classCodeSystem.CodeSystemHierarchyMeaningEnumFactorystatic classCodeSystem.ConceptDefinitionComponentstatic classCodeSystem.ConceptDefinitionDesignationComponentstatic classCodeSystem.ConceptPropertyComponentstatic classCodeSystem.FilterOperatorstatic classCodeSystem.FilterOperatorEnumFactorystatic classCodeSystem.PropertyComponentstatic classCodeSystem.PropertyTypestatic classCodeSystem.PropertyTypeEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected BooleanTypecaseSensitiveIf code comparison is case sensitive when codes within this system are compared to each other.static ca.uhn.fhir.rest.gclient.TokenClientParamCODEFluent Client search parameter constant for codeprotected BooleanTypecompositionalTrue If code system defines a post-composition grammar.protected List<CodeSystem.ConceptDefinitionComponent>conceptConcepts that are in the code system.protected Enumeration<CodeSystem.CodeSystemContentMode>contentHow much of the content of the code system - the concepts and codes it defines - are represented in this resource.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTENT_MODEFluent Client search parameter constant for content-modeprotected MarkdownTypecopyrightA copyright statement relating to the code system and/or its contents.protected UnsignedIntTypecountThe total number of concepts defined by the code system.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for datestatic ca.uhn.fhir.rest.gclient.StringClientParamDESCRIPTIONFluent Client search parameter constant for descriptionprotected List<CodeSystem.CodeSystemFilterComponent>filterA filter that can be used in a value set compose statement when selecting concepts using a filter.protected Enumeration<CodeSystem.CodeSystemHierarchyMeaning>hierarchyMeaningThe meaning of the hierarchy of concepts.protected IdentifieridentifierA 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.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.rest.gclient.TokenClientParamJURISDICTIONFluent Client search parameter constant for jurisdictionstatic ca.uhn.fhir.rest.gclient.TokenClientParamLANGUAGEFluent Client search parameter constant for languagestatic ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for nameprotected List<CodeSystem.PropertyComponent>propertyA property defines an additional slot through which additional information can be provided about a concept.static ca.uhn.fhir.rest.gclient.StringClientParamPUBLISHERFluent Client search parameter constant for publisherprotected MarkdownTypepurposeExplaination of why this code system is needed and why it has been designed as it has.static StringSP_CODESearch parameter: codestatic StringSP_CONTENT_MODESearch parameter: content-modestatic StringSP_DATESearch parameter: datestatic StringSP_DESCRIPTIONSearch parameter: descriptionstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_JURISDICTIONSearch parameter: jurisdictionstatic StringSP_LANGUAGESearch parameter: languagestatic StringSP_NAMESearch parameter: namestatic StringSP_PUBLISHERSearch parameter: publisherstatic StringSP_STATUSSearch parameter: statusstatic StringSP_SYSTEMSearch parameter: systemstatic StringSP_TITLESearch parameter: titlestatic StringSP_URLSearch parameter: urlstatic StringSP_VERSIONSearch parameter: versionstatic ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusstatic ca.uhn.fhir.rest.gclient.UriClientParamSYSTEMFluent Client search parameter constant for systemstatic ca.uhn.fhir.rest.gclient.StringClientParamTITLEFluent Client search parameter constant for titlestatic ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for urlprotected UriTypevalueSetCanonical URL of value set that contains the entire code system.static ca.uhn.fhir.rest.gclient.TokenClientParamVERSIONFluent Client search parameter constant for versionprotected BooleanTypeversionNeededThis flag is used to signify that the code system has not (or does not) maintain the definitions, and a version must be specified when referencing this code system.-
Fields inherited from class org.hl7.fhir.dstu3.model.MetadataResource
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version
-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description CodeSystem()ConstructorCodeSystem(Enumeration<Enumerations.PublicationStatus> status, Enumeration<CodeSystem.CodeSystemContentMode> content)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.MetadataResource
checkCanUseUrl, copyValues, toString
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
identifier
protected 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
Explaination 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 UriType valueSet
Canonical URL of value set that contains the entire code system.
-
hierarchyMeaning
protected Enumeration<CodeSystem.CodeSystemHierarchyMeaning> hierarchyMeaning
The meaning of the hierarchy of concepts.
-
compositional
protected BooleanType compositional
True If code system defines a post-composition grammar.
-
versionNeeded
protected BooleanType versionNeeded
This flag is used to signify that the code system has not (or does not) maintain the definitions, and a version must be specified when referencing this code system.
-
content
protected Enumeration<CodeSystem.CodeSystemContentMode> content
How much of the content of the code system - the concepts and codes it defines - are represented in this resource.
-
count
protected UnsignedIntType count
The total number of concepts defined by the code system. Where the code system has a compositional grammar, the count refers to the number of base (primitive) concepts.
-
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 meaning of the hierarchical relationships are.
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: 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 dateDescription: The code system publication date
Type: date
Path: CodeSystem.date
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: 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 identifierDescription: External identifier for the code system
Type: token
Path: CodeSystem.identifier
-
SP_CODE
public static final String SP_CODE
Search parameter: codeDescription: 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 codeDescription: A code defined in the code system
Type: token
Path: CodeSystem.concept.code
-
SP_CONTENT_MODE
public static final String SP_CONTENT_MODE
Search parameter: content-modeDescription: not-present | example | fragment | complete
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-modeDescription: not-present | example | fragment | complete
Type: token
Path: CodeSystem.content
-
SP_JURISDICTION
public static final String SP_JURISDICTION
Search parameter: jurisdictionDescription: 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 jurisdictionDescription: Intended jurisdiction for the code system
Type: token
Path: CodeSystem.jurisdiction
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: 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 descriptionDescription: The description of the code system
Type: string
Path: CodeSystem.description
-
SP_LANGUAGE
public static final String 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
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
public static final String SP_TITLE
Search parameter: titleDescription: 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 titleDescription: The human-friendly name of the code system
Type: string
Path: CodeSystem.title
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: 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 versionDescription: The business version of the code system
Type: token
Path: CodeSystem.version
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: 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 urlDescription: The uri that identifies the code system
Type: uri
Path: CodeSystem.url
-
SP_SYSTEM
public static final String 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
public static final ca.uhn.fhir.rest.gclient.UriClientParam 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
public static final String SP_NAME
Search parameter: nameDescription: 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 nameDescription: Computationally friendly name of the code system
Type: string
Path: CodeSystem.name
-
SP_PUBLISHER
public static final String SP_PUBLISHER
Search parameter: publisherDescription: 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 publisherDescription: Name of the publisher of the code system
Type: string
Path: CodeSystem.publisher
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: 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 statusDescription: The current status of the code system
Type: token
Path: CodeSystem.status
-
-
Constructor Detail
-
CodeSystem
public CodeSystem()
Constructor
-
CodeSystem
public CodeSystem(Enumeration<Enumerations.PublicationStatus> status, Enumeration<CodeSystem.CodeSystemContentMode> content)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType 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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this code system is (or will be) published. The URL SHOULD include the major version of the code system. For more information see [Technical and Business Versions](resource.html#versions). 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:
hasUrlElementin classMetadataResource
-
hasUrl
public boolean hasUrl()
- Overrides:
hasUrlin classMetadataResource
-
setUrlElement
public CodeSystem setUrlElement(UriType value)
- 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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this code system is (or will be) published. The URL SHOULD include the major version of the code system. For more information see [Technical and Business Versions](resource.html#versions). 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:
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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this code system is (or will be) published. The URL SHOULD include the major version of the code system. For more information see [Technical and Business Versions](resource.html#versions). This is used in [Coding]{datatypes.html#Coding}.system.
-
setUrl
public CodeSystem setUrl(String value)
- 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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this code system is (or will be) published. The URL SHOULD include the major version of the code system. For more information see [Technical and Business Versions](resource.html#versions). This is used in [Coding]{datatypes.html#Coding}.system.
-
getIdentifier
public 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.)
-
hasIdentifier
public boolean hasIdentifier()
-
setIdentifier
public CodeSystem setIdentifier(Identifier value)
- Parameters:
value-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.)
-
getVersionElement
public StringType 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
public boolean hasVersionElement()
- Overrides:
hasVersionElementin classMetadataResource
-
hasVersion
public boolean hasVersion()
- Overrides:
hasVersionin classMetadataResource
-
setVersionElement
public CodeSystem setVersionElement(StringType value)
- 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
public String 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
public CodeSystem setVersion(String value)
- 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
public StringType 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
public boolean hasNameElement()
- Overrides:
hasNameElementin classMetadataResource
-
hasName
public boolean hasName()
- Overrides:
hasNamein classMetadataResource
-
setNameElement
public CodeSystem setNameElement(StringType value)
- 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
public String 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
public CodeSystem setName(String value)
- 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
public StringType 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
public boolean hasTitleElement()
- Overrides:
hasTitleElementin classMetadataResource
-
hasTitle
public boolean hasTitle()
- Overrides:
hasTitlein classMetadataResource
-
setTitleElement
public CodeSystem setTitleElement(StringType value)
- 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
public String getTitle()
- Overrides:
getTitlein classMetadataResource- Returns:
- A short, descriptive, user-friendly title for the code system.
-
setTitle
public CodeSystem setTitle(String value)
- Overrides:
setTitlein classMetadataResource- Parameters:
value- A short, descriptive, user-friendly title for the code system.
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Overrides:
getStatusElementin classMetadataResource- Returns:
MetadataResource.status(The status of this code system. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
- Overrides:
hasStatusElementin classMetadataResource
-
hasStatus
public boolean hasStatus()
- Overrides:
hasStatusin classMetadataResource
-
setStatusElement
public CodeSystem setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Overrides:
setStatusElementin classMetadataResource- Parameters:
value-MetadataResource.status(The status of this code system. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Enumerations.PublicationStatus getStatus()
- Overrides:
getStatusin classMetadataResource- Returns:
- The status of this code system. Enables tracking the life-cycle of the content.
-
setStatus
public CodeSystem setStatus(Enumerations.PublicationStatus value)
- Overrides:
setStatusin classMetadataResource- Parameters:
value- The status of this code system. Enables tracking the life-cycle of the content.
-
getExperimentalElement
public BooleanType 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
public boolean hasExperimentalElement()
- Overrides:
hasExperimentalElementin classMetadataResource
-
hasExperimental
public boolean hasExperimental()
- Overrides:
hasExperimentalin classMetadataResource
-
setExperimentalElement
public CodeSystem setExperimentalElement(BooleanType value)
- 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
public boolean 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
public CodeSystem setExperimental(boolean value)
- 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
public DateTimeType getDateElement()
- Overrides:
getDateElementin classMetadataResource- Returns:
MetadataResource.date(The date (and optionally time) when the code system was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the 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:
hasDateElementin classMetadataResource
-
hasDate
public boolean hasDate()
- Overrides:
hasDatein classMetadataResource
-
setDateElement
public CodeSystem setDateElement(DateTimeType value)
- Overrides:
setDateElementin classMetadataResource- Parameters:
value-MetadataResource.date(The date (and optionally time) when the code system was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the 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:
getDatein classMetadataResource- Returns:
- The date (and optionally time) when the code system was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes.
-
setDate
public CodeSystem setDate(Date value)
- Overrides:
setDatein classMetadataResource- Parameters:
value- The date (and optionally time) when the code system was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes.
-
getPublisherElement
public StringType getPublisherElement()
- Overrides:
getPublisherElementin classMetadataResource- Returns:
MetadataResource.publisher(The name of the individual or organization 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:
hasPublisherElementin classMetadataResource
-
hasPublisher
public boolean hasPublisher()
- Overrides:
hasPublisherin classMetadataResource
-
setPublisherElement
public CodeSystem setPublisherElement(StringType value)
- Overrides:
setPublisherElementin classMetadataResource- Parameters:
value-MetadataResource.publisher(The name of the individual or organization 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:
getPublisherin classMetadataResource- Returns:
- The name of the individual or organization that published the code system.
-
setPublisher
public CodeSystem setPublisher(String value)
- Overrides:
setPublisherin classMetadataResource- Parameters:
value- The name of the individual or organization that published the code system.
-
getContact
public List<ContactDetail> getContact()
- Overrides:
getContactin classMetadataResource- Returns:
MetadataResource.contact(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public CodeSystem setContact(List<ContactDetail> theContact)
- Overrides:
setContactin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
- Overrides:
hasContactin classMetadataResource
-
addContact
public ContactDetail addContact()
- Overrides:
addContactin classMetadataResource
-
addContact
public CodeSystem addContact(ContactDetail t)
- Overrides:
addContactin classMetadataResource
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Overrides:
getContactFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.contact, creating it if it does not already exist
-
getDescriptionElement
public MarkdownType 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
public boolean hasDescriptionElement()
- Overrides:
hasDescriptionElementin classMetadataResource
-
hasDescription
public boolean hasDescription()
- Overrides:
hasDescriptionin classMetadataResource
-
setDescriptionElement
public CodeSystem setDescriptionElement(MarkdownType value)
- 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
public String getDescription()
- Overrides:
getDescriptionin classMetadataResource- Returns:
- A free text natural language description of the code system from a consumer's perspective.
-
setDescription
public CodeSystem setDescription(String value)
- Overrides:
setDescriptionin classMetadataResource- Parameters:
value- A free text natural language description of the code system from a consumer's perspective.
-
getUseContext
public List<UsageContext> getUseContext()
- Overrides:
getUseContextin classMetadataResource- Returns:
MetadataResource.useContext(The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate code system instances.)
-
setUseContext
public CodeSystem setUseContext(List<UsageContext> theUseContext)
- Overrides:
setUseContextin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUseContext
public boolean hasUseContext()
- Overrides:
hasUseContextin classMetadataResource
-
addUseContext
public UsageContext addUseContext()
- Overrides:
addUseContextin classMetadataResource
-
addUseContext
public CodeSystem addUseContext(UsageContext t)
- Overrides:
addUseContextin classMetadataResource
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Overrides:
getUseContextFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.useContext, creating it if it does not already exist
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Overrides:
getJurisdictionin classMetadataResource- 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:
setJurisdictionin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
- Overrides:
hasJurisdictionin classMetadataResource
-
addJurisdiction
public CodeableConcept addJurisdiction()
- Overrides:
addJurisdictionin classMetadataResource
-
addJurisdiction
public CodeSystem addJurisdiction(CodeableConcept t)
- Overrides:
addJurisdictionin classMetadataResource
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Overrides:
getJurisdictionFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.jurisdiction, creating it if it does not already exist
-
getPurposeElement
public MarkdownType getPurposeElement()
- Returns:
purpose(Explaination 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(Explaination 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:
- Explaination of why this code system is needed and why it has been designed as it has.
-
setPurpose
public CodeSystem setPurpose(String value)
- Parameters:
value- Explaination 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 UriType getValueSetElement()
- Returns:
valueSet(Canonical URL of 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(UriType value)
- Parameters:
value-valueSet(Canonical URL of 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 URL of value set that contains the entire code system.
-
setValueSet
public CodeSystem setValueSet(String value)
- Parameters:
value- Canonical URL of value set that contains the entire code system.
-
getHierarchyMeaningElement
public Enumeration<CodeSystem.CodeSystemHierarchyMeaning> getHierarchyMeaningElement()
- Returns:
hierarchyMeaning(The meaning of the hierarchy of concepts.). 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.). 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.
-
setHierarchyMeaning
public CodeSystem setHierarchyMeaning(CodeSystem.CodeSystemHierarchyMeaning value)
- Parameters:
value- The meaning of the hierarchy of concepts.
-
getCompositionalElement
public BooleanType getCompositionalElement()
- Returns:
compositional(True If code system defines a post-composition 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(True If code system defines a post-composition 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:
- True If code system defines a post-composition grammar.
-
setCompositional
public CodeSystem setCompositional(boolean value)
- Parameters:
value- True If code system defines a post-composition grammar.
-
getVersionNeededElement
public BooleanType getVersionNeededElement()
- Returns:
versionNeeded(This flag is used to signify that the code system has not (or does not) maintain the definitions, and 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 has not (or does not) maintain the definitions, and 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 has not (or does not) maintain the definitions, and 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 has not (or does not) maintain the definitions, and a version must be specified when referencing this code system.
-
getContentElement
public Enumeration<CodeSystem.CodeSystemContentMode> getContentElement()
- Returns:
content(How much of the content of the code system - the concepts and codes it defines - are represented in this resource.). 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(How much of the content of the code system - the concepts and codes it defines - are represented in this resource.). 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:
- How much of the content of the code system - the concepts and codes it defines - are represented in this resource.
-
setContent
public CodeSystem setContent(CodeSystem.CodeSystemContentMode value)
- Parameters:
value- How much of the content of the code system - the concepts and codes it defines - are represented in this resource.
-
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 count refers to the number of base (primitive) concepts.). 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 count refers to the number of base (primitive) concepts.). 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 count refers to the number of base (primitive) concepts.
-
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 count refers to the number of base (primitive) concepts.
-
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
thisfor 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
thisfor 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 meaning of the hierarchical relationships are.)
-
setConcept
public CodeSystem setConcept(List<CodeSystem.ConceptDefinitionComponent> theConcept)
- Returns:
- Returns a reference to
thisfor 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:
listChildrenin classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classMetadataResource- 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
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- 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
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classMetadataResource
-
copy
public CodeSystem copy()
- Specified by:
copyin classMetadataResource
-
typedCopy
protected CodeSystem typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classMetadataResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classMetadataResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classMetadataResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-