ca.uhn.fhir.model.dstu.composite

Class CodingDt

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.base.composite.BaseCodingDt

ca.uhn.fhir.model.dstu.composite.CodingDt

All Implemented Interfaces:

ICompositeDatatype, ICompositeElement, IDatatype, IElement, IIdentifiableElement, IQueryParameterType, ISupportsUndeclaredExtensions

public class CodingDt
extends BaseCodingDt
implements ICompositeDatatype

HAPI/FHIR CodingDt Datatype (A reference to a code defined by a terminology system)

Definition: A reference to a code defined by a terminology system

Requirements: References to codes are very common in healthcare models

Constructor Summary

Constructors

Constructor and Description
CodingDt() Constructor
CodingDt(String theSystem, String theCode) Creates a new Coding with the given system and code

Method Summary

Methods

Modifier and Type	Method and Description
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
CodeDt	getCode() Gets the value(s) for code (Symbol in syntax defined by the system).
StringDt	getDisplay() Gets the value(s) for display (Representation defined by the system).
BooleanDt	getPrimary() Gets the value(s) for primary (If this code was chosen directly by the user).
UriDt	getSystem() Gets the value(s) for system (Identity of the terminology system).
ResourceReferenceDt	getValueSet() Gets the value(s) for valueSet (Set this coding was chosen from).
StringDt	getVersion() Gets the value(s) for version (Version of the system - if relevant).
boolean	isEmpty()
CodingDt	setCode(CodeDt theValue) Sets the value(s) for code (Symbol in syntax defined by the system)
CodingDt	setCode(String theCode) Sets the value for code (Symbol in syntax defined by the system)
CodingDt	setDisplay(String theString) Sets the value for display (Representation defined by the system)
CodingDt	setDisplay(StringDt theValue) Sets the value(s) for display (Representation defined by the system)
CodingDt	setPrimary(boolean theBoolean) Sets the value for primary (If this code was chosen directly by the user)
CodingDt	setPrimary(BooleanDt theValue) Sets the value(s) for primary (If this code was chosen directly by the user)
CodingDt	setSystem(String theUri) Sets the value for system (Identity of the terminology system)
CodingDt	setSystem(UriDt theValue) Sets the value(s) for system (Identity of the terminology system)
CodingDt	setValueSet(ResourceReferenceDt theValue) Sets the value(s) for valueSet (Set this coding was chosen from)
CodingDt	setVersion(String theString) Sets the value for version (Version of the system - if relevant)
CodingDt	setVersion(StringDt theValue) Sets the value(s) for version (Version of the system - if relevant)

Methods inherited from class ca.uhn.fhir.model.base.composite.BaseCodingDt

getQueryParameterQualifier, getValueAsQueryToken, matchesSystemAndCode, setValueAsQueryToken

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CodingDt

public CodingDt()

Constructor

CodingDt

public CodingDt(String theSystem,
        String theCode)

Creates a new Coding with the given system and code

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getSystem

public UriDt getSystem()

Gets the value(s) for system (Identity of the terminology system). creating it if it does not exist. Will not return null.

Definition: The identification of the code system that defines the meaning of the symbol in the code.

Specified by:

getSystem in class BaseCodingDt

setSystem

public CodingDt setSystem(UriDt theValue)

Sets the value(s) for system (Identity of the terminology system)

Definition: The identification of the code system that defines the meaning of the symbol in the code.

setSystem

public CodingDt setSystem(String theUri)

Sets the value for system (Identity of the terminology system)

Definition: The identification of the code system that defines the meaning of the symbol in the code.

Specified by:

setSystem in class BaseCodingDt

getVersion

public StringDt getVersion()

Gets the value(s) for version (Version of the system - if relevant). creating it if it does not exist. Will not return null.

Definition: The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and When the meaning is not guaranteed to be consistent, the version SHOULD be exchanged

setVersion

public CodingDt setVersion(StringDt theValue)

Sets the value(s) for version (Version of the system - if relevant)

Definition: The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and When the meaning is not guaranteed to be consistent, the version SHOULD be exchanged

setVersion

public CodingDt setVersion(String theString)

Sets the value for version (Version of the system - if relevant)

Definition: The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and When the meaning is not guaranteed to be consistent, the version SHOULD be exchanged

getCode

public CodeDt getCode()

Gets the value(s) for code (Symbol in syntax defined by the system). creating it if it does not exist. Will not return null.

Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)

Specified by:

getCode in class BaseCodingDt

setCode

public CodingDt setCode(CodeDt theValue)

Sets the value(s) for code (Symbol in syntax defined by the system)

Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)

setCode

public CodingDt setCode(String theCode)

Sets the value for code (Symbol in syntax defined by the system)

Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)

Specified by:

setCode in class BaseCodingDt

getDisplay

public StringDt getDisplay()

Gets the value(s) for display (Representation defined by the system). creating it if it does not exist. Will not return null.

Definition: A representation of the meaning of the code in the system, following the rules of the system.

setDisplay

public CodingDt setDisplay(StringDt theValue)

Sets the value(s) for display (Representation defined by the system)

Definition: A representation of the meaning of the code in the system, following the rules of the system.

setDisplay

public CodingDt setDisplay(String theString)

Sets the value for display (Representation defined by the system)

Definition: A representation of the meaning of the code in the system, following the rules of the system.

getPrimary

public BooleanDt getPrimary()

Gets the value(s) for primary (If this code was chosen directly by the user). creating it if it does not exist. Will not return null.

Definition: Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays)

setPrimary

public CodingDt setPrimary(BooleanDt theValue)

Sets the value(s) for primary (If this code was chosen directly by the user)

Definition: Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays)

setPrimary

public CodingDt setPrimary(boolean theBoolean)

Sets the value for primary (If this code was chosen directly by the user)

Definition: Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays)

getValueSet

public ResourceReferenceDt getValueSet()

Gets the value(s) for valueSet (Set this coding was chosen from). creating it if it does not exist. Will not return null.

Definition: The set of possible coded values this coding was chosen from or constrained by

setValueSet

public CodingDt setValueSet(ResourceReferenceDt theValue)

Sets the value(s) for valueSet (Set this coding was chosen from)

Definition: The set of possible coded values this coding was chosen from or constrained by