Package com.ibm.fhir.model.resource

Class CodeSystem

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class CodeSystem
extends DomainResource
    The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.

    Maturity level: FMM5 (Normative)

    • Method Detail

      • getUrl

        public Uri getUrl()
        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.
        Returns:
        An immutable object of type Uri that may be null.

      • getIdentifier

        public List<Identifier> getIdentifier()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getVersion

        public String getVersion()
        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.
        Returns:
        An immutable object of type String that may be null.

      • getName

        public String getName()
        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.
        Returns:
        An immutable object of type String that may be null.

      • getTitle

        public String getTitle()
        A short, descriptive, user-friendly title for the code system.
        Returns:
        An immutable object of type String that may be null.

      • getStatus

        public PublicationStatus getStatus()
        The date (and optionally time) when the code system resource was created or revised.
        Returns:
        An immutable object of type PublicationStatus that is non-null.

      • getExperimental

        public Boolean getExperimental()
        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.
        Returns:
        An immutable object of type Boolean that may be null.

      • getDate

        public DateTime getDate()
        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.
        Returns:
        An immutable object of type DateTime that may be null.

      • getPublisher

        public String getPublisher()
        The name of the organization or individual that published the code system.
        Returns:
        An immutable object of type String that may be null.

      • getContact

        public List<ContactDetail> getContact()
        Contact details to assist a user in finding and communicating with the publisher.
        Returns:
        An unmodifiable list containing immutable objects of type ContactDetail that may be empty.

      • getDescription

        public Markdown getDescription()
        A free text natural language description of the code system from a consumer's perspective.
        Returns:
        An immutable object of type Markdown that may be null.

      • getUseContext

        public List<UsageContext> getUseContext()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type UsageContext that may be empty.

      • getJurisdiction

        public List<CodeableConcept> getJurisdiction()
        A legal or geographic region in which the code system is intended to be used.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getPurpose

        public Markdown getPurpose()
        Explanation of why this code system is needed and why it has been designed as it has.
        Returns:
        An immutable object of type Markdown that may be null.

      • getCopyright

        public Markdown getCopyright()
        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.
        Returns:
        An immutable object of type Markdown that may be null.

      • getCaseSensitive

        public Boolean getCaseSensitive()
        If code comparison is case sensitive when codes within this system are compared to each other.
        Returns:
        An immutable object of type Boolean that may be null.

      • getValueSet

        public Canonical getValueSet()
        Canonical reference to the value set that contains the entire code system.
        Returns:
        An immutable object of type Canonical that may be null.

      • getCompositional

        public Boolean getCompositional()
        The code system defines a compositional (post-coordination) grammar.
        Returns:
        An immutable object of type Boolean that may be null.

      • getVersionNeeded

        public Boolean getVersionNeeded()
        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.
        Returns:
        An immutable object of type Boolean that may be null.

      • getContent

        public CodeSystemContentMode getContent()
        The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.
        Returns:
        An immutable object of type CodeSystemContentMode that is non-null.

      • getSupplements

        public Canonical getSupplements()
        The canonical URL of the code system that this code system supplement is adding designations and properties to.
        Returns:
        An immutable object of type Canonical that may be null.

      • getCount

        public UnsignedInt getCount()
        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.
        Returns:
        An immutable object of type UnsignedInt that may be null.

      • getFilter

        public List<CodeSystem.Filter> getFilter()
        A filter that can be used in a value set compose statement when selecting concepts using a filter.
        Returns:
        An unmodifiable list containing immutable objects of type CodeSystem.Filter that may be empty.

      • getProperty

        public List<CodeSystem.Property> getProperty()
        A property defines an additional slot through which additional information can be provided about a concept.
        Returns:
        An unmodifiable list containing immutable objects of type CodeSystem.Property that may be empty.

      • getConcept

        public List<CodeSystem.Concept> getConcept()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type CodeSystem.Concept that may be empty.

      • accept

        public void accept​(String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object