Package com.ibm.fhir.model.resource

Class CodeSystem.Property

java.lang.Object

com.ibm.fhir.model.visitor.AbstractVisitable

com.ibm.fhir.model.type.Element

com.ibm.fhir.model.type.BackboneElement

com.ibm.fhir.model.resource.CodeSystem.Property

All Implemented Interfaces:

Visitable

Enclosing class:

CodeSystem

public static class CodeSystem.Property
extends BackboneElement

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CodeSystem.Property.Builder

Field Summary

Fields inherited from class com.ibm.fhir.model.type.BackboneElement

modifierExtension

Fields inherited from class com.ibm.fhir.model.type.Element

extension, hashCode, id

Method Summary

Modifier and Type	Method	Description
void	accept(java.lang.String elementName, int elementIndex, Visitor visitor)	Accept a Visitor and invoke the appropriate visit methods.
static CodeSystem.Property.Builder	builder()
boolean	equals(java.lang.Object obj)
Code	getCode()	A code that is used to identify the property.
String	getDescription()	A description of the property- why it is defined, and how its value might be used.
PropertyType	getType()	The type of the property value.
Uri	getUri()	Reference to the formal meaning of the property.
boolean	hasChildren()
int	hashCode()
CodeSystem.Property.Builder	toBuilder()	Create a new Builder from the contents of this Element

Methods inherited from class com.ibm.fhir.model.type.BackboneElement

getModifierExtension

Methods inherited from class com.ibm.fhir.model.type.Element

as, getExtension, getId, hasValue, is

Methods inherited from class com.ibm.fhir.model.visitor.AbstractVisitable

accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.fhir.model.visitor.Visitable

accept, accept

Method Detail

getCode

public Code getCode()

A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters.

Returns:

An immutable object of type Code that is non-null.

getUri

public Uri getUri()

Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem- concept-properties.html) code system.

Returns:

An immutable object of type Uri that may be null.

getDescription

public String getDescription()

A description of the property- why it is defined, and how its value might be used.

Returns:

An immutable object of type String that may be null.

getType

public PropertyType getType()

The type of the property value. Properties of type "code" contain a code defined by the code system (e.g. a reference to another defined concept).

Returns:

An immutable object of type PropertyType that is non-null.

hasChildren

public boolean hasChildren()

Overrides:

hasChildren in class BackboneElement

accept

public void accept(java.lang.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

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toBuilder

public CodeSystem.Property.Builder toBuilder()

Description copied from class: Element

Create a new Builder from the contents of this Element

Specified by:

toBuilder in class BackboneElement

builder

public static CodeSystem.Property.Builder builder()