Package org.hl7.fhir.r4.model

Class UsageContext

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.Element

org.hl7.fhir.r4.model.Type

org.hl7.fhir.r4.model.UsageContext

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType

public class UsageContext
extends Type
implements org.hl7.fhir.instance.model.api.ICompositeType

Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Coding	code	A code that identifies the type of context being specified by this usage context.
protected Type	value	A value that defines the context specified in this context of use.

Fields inherited from class org.hl7.fhir.r4.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
UsageContext()	Constructor
UsageContext(Coding code, Type value)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
UsageContext	copy()
void	copyValues(UsageContext dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Coding	getCode()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
String[]	getTypesForProperty(int hash, String name)
Type	getValue()
CodeableConcept	getValueCodeableConcept()
Quantity	getValueQuantity()
Range	getValueRange()
Reference	getValueReference()
boolean	hasCode()
boolean	hasValue()
boolean	hasValueCodeableConcept()
boolean	hasValueQuantity()
boolean	hasValueRange()
boolean	hasValueReference()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
UsageContext	setCode(Coding value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
UsageContext	setValue(Type value)
protected UsageContext	typedCopy()

Methods inherited from class org.hl7.fhir.r4.model.Element

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

Methods 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, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN, setXhtml

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

getUserData, setUserData

Field Details

code

protected Coding code

A code that identifies the type of context being specified by this usage context.

value

protected Type value

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Constructor Details

UsageContext

public UsageContext()

Constructor

UsageContext

public UsageContext(Coding code,
 Type value)

Constructor

Method Details

getCode

public Coding getCode()

Returns:

code (A code that identifies the type of context being specified by this usage context.)

hasCode

public boolean hasCode()

setCode

public UsageContext setCode(Coding value)

Parameters:

value - code (A code that identifies the type of context being specified by this usage context.)

getValue

public Type getValue()

Returns:

value (A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.)

getValueCodeableConcept

public CodeableConcept getValueCodeableConcept()
                                        throws org.hl7.fhir.exceptions.FHIRException

Returns:

value (A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasValueCodeableConcept

public boolean hasValueCodeableConcept()

getValueQuantity

public Quantity getValueQuantity()
                          throws org.hl7.fhir.exceptions.FHIRException

Returns:

value (A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasValueQuantity

public boolean hasValueQuantity()

getValueRange

public Range getValueRange()
                    throws org.hl7.fhir.exceptions.FHIRException

Returns:

value (A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasValueRange

public boolean hasValueRange()

getValueReference

public Reference getValueReference()
                            throws org.hl7.fhir.exceptions.FHIRException

Returns:

value (A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasValueReference

public boolean hasValueReference()

hasValue

public boolean hasValue()

setValue

public UsageContext setValue(Type value)

Parameters:

value - value (A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class Element

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class Element

copy

public UsageContext copy()

Overrides:

copy in class Type

copyValues

public void copyValues(UsageContext dst)

typedCopy

protected UsageContext typedCopy()

Specified by:

typedCopy in class Type

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class Element

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class Element

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class Element