org.hl7.fhir.dstu3.model

Class Basic

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.BaseResource

org.hl7.fhir.dstu3.model.Resource

org.hl7.fhir.dstu3.model.DomainResource

org.hl7.fhir.dstu3.model.Basic

All Implemented Interfaces:

IElement, Serializable, IAnyResource, IBase, IBaseHasExtensions, IBaseHasModifierExtensions, IBaseResource, IDomainResource

public class Basic
extends DomainResource

Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Reference	author Indicates who was responsible for creating the resource instance.
static ReferenceClientParam	AUTHOR Fluent Client search parameter constant for author
protected Resource	authorTarget The actual object that is the target of the reference (Indicates who was responsible for creating the resource instance.)
protected CodeableConcept	code Identifies the 'type' of resource - equivalent to the resource name for other resources.
static TokenClientParam	CODE Fluent Client search parameter constant for code
protected DateType	created Identifies when the resource was first created.
static DateClientParam	CREATED Fluent Client search parameter constant for created
protected List<Identifier>	identifier Identifier assigned to the resource for business purposes, outside the context of FHIR.
static TokenClientParam	IDENTIFIER Fluent Client search parameter constant for identifier
static Include	INCLUDE_AUTHOR Constant for fluent queries to be used to add include statements.
static Include	INCLUDE_PATIENT Constant for fluent queries to be used to add include statements.
static Include	INCLUDE_SUBJECT Constant for fluent queries to be used to add include statements.
static ReferenceClientParam	PATIENT Fluent Client search parameter constant for patient
static String	SP_AUTHOR Search parameter: author
static String	SP_CODE Search parameter: code
static String	SP_CREATED Search parameter: created
static String	SP_IDENTIFIER Search parameter: identifier
static String	SP_PATIENT Search parameter: patient
static String	SP_SUBJECT Search parameter: subject
protected Reference	subject Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.
static ReferenceClientParam	SUBJECT Fluent Client search parameter constant for subject
protected Resource	subjectTarget The actual object that is the target of the reference (Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.)

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

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor and Description
Basic() Constructor
Basic(CodeableConcept code) Constructor

Method Summary

Modifier and Type	Method and Description
Base	addChild(String name)
Identifier	addIdentifier()
Basic	addIdentifier(Identifier t)
Basic	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
Reference	getAuthor()
Resource	getAuthorTarget()
CodeableConcept	getCode()
Date	getCreated()
DateType	getCreatedElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
Reference	getSubject()
Resource	getSubjectTarget()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAuthor()
boolean	hasCode()
boolean	hasCreated()
boolean	hasCreatedElement()
boolean	hasIdentifier()
boolean	hasSubject()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Base	makeProperty(int hash, String name)
Basic	setAuthor(Reference value)
Basic	setAuthorTarget(Resource value)
Basic	setCode(CodeableConcept value)
Basic	setCreated(Date value)
Basic	setCreatedElement(DateType value)
Basic	setIdentifier(List<Identifier> theIdentifier)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Basic	setSubject(Reference value)
Basic	setSubjectTarget(Resource value)
protected Basic	typedCopy()

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

copyValues, getId, getIdBase, getIdElement, 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, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

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.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

getMeta, getStructureFhirVersionEnum, setId

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Field Detail

identifier

protected List<Identifier> identifier

Identifier assigned to the resource for business purposes, outside the context of FHIR.

code

protected CodeableConcept code

Identifies the 'type' of resource - equivalent to the resource name for other resources.

subject

protected Reference subject

Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.

subjectTarget

protected Resource subjectTarget

The actual object that is the target of the reference (Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.)

created

protected DateType created

Identifies when the resource was first created.

author

protected Reference author

Indicates who was responsible for creating the resource instance.

authorTarget

protected Resource authorTarget

The actual object that is the target of the reference (Indicates who was responsible for creating the resource instance.)

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Business identifier
Type: token
Path: Basic.identifier

See Also:

Constant Field Values

IDENTIFIER

public static final TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: Business identifier
Type: token
Path: Basic.identifier

SP_CODE

public static final String SP_CODE

Search parameter: code

Description: Kind of Resource
Type: token
Path: Basic.code

See Also:

Constant Field Values

CODE

public static final TokenClientParam CODE

Fluent Client search parameter constant for code

Description: Kind of Resource
Type: token
Path: Basic.code

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

Description: Identifies the focus of this resource
Type: reference
Path: Basic.subject

See Also:

Constant Field Values

SUBJECT

public static final ReferenceClientParam SUBJECT

Fluent Client search parameter constant for subject

Description: Identifies the focus of this resource
Type: reference
Path: Basic.subject

INCLUDE_SUBJECT

public static final Include INCLUDE_SUBJECT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Basic:subject".

SP_CREATED

public static final String SP_CREATED

Search parameter: created

Description: When created
Type: date
Path: Basic.created

See Also:

Constant Field Values

CREATED

public static final DateClientParam CREATED

Fluent Client search parameter constant for created

Description: When created
Type: date
Path: Basic.created

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: Identifies the focus of this resource
Type: reference
Path: Basic.subject

See Also:

Constant Field Values

PATIENT

public static final ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: Identifies the focus of this resource
Type: reference
Path: Basic.subject

INCLUDE_PATIENT

public static final Include INCLUDE_PATIENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Basic:patient".

SP_AUTHOR

public static final String SP_AUTHOR

Search parameter: author

Description: Who created
Type: reference
Path: Basic.author

See Also:

Constant Field Values

AUTHOR

public static final ReferenceClientParam AUTHOR

Fluent Client search parameter constant for author

Description: Who created
Type: reference
Path: Basic.author

INCLUDE_AUTHOR

public static final Include INCLUDE_AUTHOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "Basic:author".

Constructor Detail

Basic

public Basic()

Constructor

Basic

public Basic(CodeableConcept code)

Constructor

Method Detail

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Identifier assigned to the resource for business purposes, outside the context of FHIR.)

setIdentifier

public Basic setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public Basic addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

getCode

public CodeableConcept getCode()

Returns:

code (Identifies the 'type' of resource - equivalent to the resource name for other resources.)

hasCode

public boolean hasCode()

setCode

public Basic setCode(CodeableConcept value)

Parameters:

value - code (Identifies the 'type' of resource - equivalent to the resource name for other resources.)

getSubject

public Reference getSubject()

Returns:

subject (Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.)

hasSubject

public boolean hasSubject()

setSubject

public Basic setSubject(Reference value)

Parameters:

value - subject (Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.)

getSubjectTarget

public Resource getSubjectTarget()

Returns:

subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.)

setSubjectTarget

public Basic setSubjectTarget(Resource value)

Parameters:

value - subject The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.)

getCreatedElement

public DateType getCreatedElement()

Returns:

created (Identifies when the resource was first created.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value

hasCreatedElement

public boolean hasCreatedElement()

hasCreated

public boolean hasCreated()

setCreatedElement

public Basic setCreatedElement(DateType value)

Parameters:

value - created (Identifies when the resource was first created.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value

getCreated

public Date getCreated()

Returns:

Identifies when the resource was first created.

setCreated

public Basic setCreated(Date value)

Parameters:

value - Identifies when the resource was first created.

getAuthor

public Reference getAuthor()

Returns:

author (Indicates who was responsible for creating the resource instance.)

hasAuthor

public boolean hasAuthor()

setAuthor

public Basic setAuthor(Reference value)

Parameters:

value - author (Indicates who was responsible for creating the resource instance.)

getAuthorTarget

public Resource getAuthorTarget()

Returns:

author The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Indicates who was responsible for creating the resource instance.)

setAuthorTarget

public Basic setAuthorTarget(Resource value)

Parameters:

value - author The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Indicates who was responsible for creating the resource instance.)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

getProperty

public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException

Overrides:

getProperty in class DomainResource

Throws:

FHIRException

setProperty

public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException

Overrides:

setProperty in class DomainResource

Throws:

FHIRException

setProperty

public Base setProperty(String name,
                        Base value)
                 throws FHIRException

Overrides:

setProperty in class DomainResource

Throws:

FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

FHIRException

addChild

public Base addChild(String name)
              throws FHIRException

Overrides:

addChild in class DomainResource

Throws:

FHIRException

fhirType

public String fhirType()

Overrides:

fhirType in class DomainResource

copy

public Basic copy()

Specified by:

copy in class DomainResource

typedCopy

protected Basic typedCopy()

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource